Brightcoveライブプログラム広告メタデータAPI

入門

広告メタデータ（ad_server_data）スキーマは、ネストされた要素を含まないフラットな JSON 構文をサポートします（キーと値のペアのみ）。API を介した広告サーバーデータセットは、更新後に受信されるすべての広告ブレークで、データが上書きまたはリセットされるまで使用されます。お客様は、ライブ配信中いつでもデータを更新および/またはリセットすることができます。

このメタデータは、steam アクティベーションの間には保持されません。ストリームアクティベーションの間に持続する必要がある広告メタデータは、SSAI アプリケーションの広告設定で設定する必要があります。API を介したデータセットは、広告サーバーおよびサーバー側のビーコン置換のマクロとして使用できるように設定できます。

広告プログラムのメタデータは、カスタムプレイリストタグを介して SSAI システムに配信され、SSAI システムの既存の動的広告パラメータ (DAP) の優先順位に従います。キューポイントで送信される広告サーバーデータは、ジョブに割り当てられたメタデータよりも優先されます。ジョブ上のキューポイントデータと広告メタデータの間でキーの競合が発生した場合、キューポイント値はより高い優先度とみなされ、マージされたコレクションで使用されます。

キューポイントで提供される広告メタデータは、そのキューポイントに対してのみ使用され、後続のキューポイント挿入では保持されません。プログラム広告メタデータ API で設定された広告メタデータのみが、更新またはリセットされるまで、その後に受け取ったすべての広告ブレークで保持されます。

エンドポイント

エンドポイントの詳細については、Live API リファレンスを参照してください。

追加/更新

ライブプログラム広告のメタデータを追加または更新するには、POST次の宛先にリクエストを送信します。

https://api.bcovlive.io/v1/jobs/{job_id}/cuepointdata

{
  "ad_server_data": {
  	"one":"won",
  	"two":2,
  	"three":false
  }
}

削除

ライブプログラム広告のメタデータを削除するには、DELETE次の宛先にリクエストを送信します。

https://api.bcovlive.io/v1/jobs/{job_id}/cuepointdata