bytesに対するSum meterで各顧客の帯域幅を合計し、請求に利用できます。このblueprintは@dodopayments/ingestion-blueprints npm packageにtrackStreamBytes()として含まれています。
ユースケース
Stream Blueprintは次のシナリオに適しています：Video Platforms
動画の帯域幅消費量とstreaming qualityに対して顧客に請求します。
Music Streaming
subscription tierごとに、ユーザーあたりのaudio streaming usageを追跡します。
Live Events
live streamの消費量を監視し、帯域幅の使用量に対して請求します。
Real-Time Data
IoTおよびtelemetry applicationのreal-time data transferを追跡します。
動画・音声streaming platform、live streaming service、real-time data applicationで利用できます。
クイックスタート
streaming usageを追跡するには、packageをインストールし、meterを作成して、各顧客が消費したバイト数を送信します。1
Install the SDK
Dodo Payments Ingestion Blueprints packageをインストールします：
2
Get Your API Keys
Dodo Payments dashboardで、Developer → API KeysからDodo Payments API keyを作成し、
DODO_PAYMENTS_API_KEY environment variableに保存します。開発中はtest mode keyを使用してください。test mode keyはtest_modeでのみ機能します。3
Create a Meter
Dodo Payments dashboardで、Products → Metersに移動し、Create Meterをクリックします。次のフィールドを設定します：
- Meter Name：
Stream Bandwidthなどの、内容を説明する名前。 - Event Name：
stream_consumption、または任意の名前。コード内のeventNameと完全に一致している必要があります（大文字と小文字を区別）。 - Aggregation Type：ストリーミングされたバイト数を合計するためのSum。
- Over Property：帯域幅の使用量に基づいて請求するための
bytes。 - Measurement Unit：請求書に表示する単位。たとえば
bytes。
4
Track Stream Usage
顧客と消費したバイト数を指定して
trackStreamBytes()を呼び出します：設定
Ingestion Configuration
これらのoptionsをnew Ingestion()に渡します：
string
必須
dashboardから取得したDodo Payments API key。
string
Environment mode：
test_modeまたはlive_mode。デフォルトはtest_modeです。Dodo Payments SDKsのデフォルトはlive_modeであるため、本番環境ではlive_modeを明示的に設定してください。string
必須
meterのEvent Nameと一致するevent name（大文字と小文字を区別）。
Track Stream Bytes Options
これらのoptionsをtrackStreamBytes()に渡します：
string
必須
streamに対して請求するDodo Payments customer ID。例：
cus_123。number
streamで消費したバイト数。帯域幅ベースの請求に必須です。省略すると、eventに
bytes valueは含まれませんが、Count meterにはカウントされます。object
streamに関する任意のmetadata。stream type、quality、session IDなどを指定できます。各valueはstring、number、またはbooleanである必要があります。
ベストプラクティス
trackStreamBytes()を呼び出すたびに個別のeventが送信され、Sum meterが各chunkを合計します。