Early ad break notification v1

Early Ad Break Notification API の使用

  • 広告ブレークが作成される対応するライブ ストリームの ID。この識別子は次のいずれかです。
  • ライブ ストリームの「アセットキー」。
  • ライブ配信の「カスタム アセットキー」。独自の ID 文字列を指定して、独自のキースペースを管理できます。
  • ライブ配信の「コンテンツ ソース ID」と「コンテンツ ID」。

注: この ID タイプを使用するには、有効にする必要があります。詳しくは、アカウント マネージャーにお問い合わせください。

  • 次のミッドロール挿入点の推定時間。時間は、実際のミッドロール挿入点の長さにできるだけ近づける必要があります。

これらの必須フィールドに加えて、カスタム ターゲティング パラメータ、適用する広告連続配信テンプレートの名前、SCTE35 キューアウト データ（利用可能な場合）を送信することもできます。

前提条件

EABN API を使用するには、サービス アカウントを作成して、そのアカウントを Google アド マネージャー ネットワークに追加する必要があります。

サービス アカウントの作成

EABN API を呼び出すサービス アカウントを作成するには、次の手順を完了します。- Google Cloud アカウントがある場合は、IAM モジュールを使用してサービス アカウントを作成します。詳細については、サービス アカウントの作成と管理をご覧ください。- Google Cloud アカウントをお持ちでない場合は、Google API Console で次の手順に沿ってアカウントを作成します。

  1. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。
  2. [認証情報] ページで、[サービス アカウントを管理] をクリックします。
  3. [サービス アカウント] ページで、[サービス アカウントを作成] をクリックします。
  4. [サービス アカウントを作成] ページで、アカウントの詳細を入力します。次に、[作成] をクリックします。

サービス アカウントを作成したら、認証に使用されるアカウントの JSON キーをコピーします。

サービス アカウントを Google アド マネージャー ネットワークに追加する

サービス アカウントをネットワークに追加するには、API アクセス用のサービス アカウント ユーザーを追加するの手順を完了します。

API の有効化

サービス アカウントを作成したら、アカウント マネージャーに次の情報を提供して、アカウントで API を有効にします。

  • Google Cloud アカウントのメールアドレス
  • サービス アカウント
  • Google アド マネージャー ネットワークのネットワーク コード。

アカウント マネージャーが API を有効にしたら、次の手順で API を有効にします。

  1. Google API ライブラリで「Google Ad Manager Video API」を検索します。
  2. [有効にする] をクリックします。

注: 検索結果に API が表示されない場合は、アカウントで DAI API が有効になっていることをアカウント マネージャーにご確認ください。

API の使用

EABN API は、JSON/REST リクエストを使用して呼び出すことができます。

承認

EABN API を承認済みで呼び出すには、サービス アカウントの JSON キーとスコープ https://www.googleapis.com/auth/video-ads を使用して OAuth2 サービス アカウントの認証情報を生成する必要があります。詳細については、サーバー間アプリケーションに OAuth 2.0 を使用するをご覧ください。

生成された承認トークンは、EABN API の呼び出しごとに Auth ヘッダーとして含める必要があります。

早期広告ブレーク通知の送信

早期広告ブレーク通知を送信するには、ライブ配信を指定する方法に応じて、3 つの有効な EABN URL のいずれかに POST リクエストを送信します。以降のセクションでは、URL の違いについて説明します。また、リクエストとレスポンスの例も示します。

URL

早期広告ブレーク通知に使用できる有効な URL は 3 つあります。3 つのタイプすべてを使用して、ミッドロール挿入点（POST）を作成したり、割り当てられたミッドロール挿入点のリストを取得したりできます（GET）。

ライブ ストリームのアセットキーを使用するには、次のコマンドを使用します。

POST admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks

ライブ ストリームのカスタム アセットキーを使用するには、次のコマンドを使用します。

POST admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks

コンテンツ ソース ID と Content ID のアプローチを使用するには、次の手順を行います。

POST admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks

すべてのパラメータの場合:

  • network_code は、Google アド マネージャー ネットワークのネットワーク コードを表します。
  • asset_key は、ライブ配信の詳細ページに表示されるアセットキーを表します。
  • custom_asset_key は、ライブ配信のカスタム アセットキーを表します。
  • content_source_id は、Google アド マネージャーのコンテンツ ソースの ID を表します。
  • content_id は、Google アド マネージャーのコンテンツの ID を表します。

注: 指定した content_source_id/content_id ペアは、Google アド マネージャーのライブ ストリームに関連付けられている必要があります。

リクエスト本文 - ミッドロール挿入点の作成にのみ使用（POST）

オブジェクト

expectedDuration

 必須 このミッドロール挿入点の継続時間です。Google の標準の再生時間形式（xx.xxxs で、xx.xxx は秒数）で指定します。

customParams

 省略可 アド マネージャー 360 でカスタム条件をターゲティングする際に、この広告ブレークで広告リクエストに含める Key-Value ペアです。キーと値を

=

と

&

.
例:

key=value&key2=value2,value3


ターゲティングについて詳しくは、ストリームにターゲティング パラメータを指定するをご覧ください。

podTemplateName

 省略可 連続配信広告のテンプレート名

scte35CueOut

 省略可 scte35 キューアウトの Base64 エンコード データです。次を含めることができます。

splice_insert()

または

time_signal()

コマンドを使用します。
例:

  • time_signal():

    /DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==

  • splice_insert():

    /DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=

リクエストの例

ミッドロール挿入点を作成する
POST admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
{
    "expectedDuration": "30s",
    "scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
    "customParams": "param1=value1&param2=value2",
    "podTemplateName": "podtemplate"
}
レスポンスの本文

レスポンスの本文には、adBreak オブジェクトで送信されたすべてのパラメータと、作成されたミッドロール挿入点の Google 全体の標準 ID を含む追加の name フィールドが含まれます。このフィールドは次の形式で返されます。

networks/{network_code}/assets/{asset_key}/adBreaks/{ad_break_id}
レスポンスの例
HTTP/1.1 200 OK
{
  "name": "networks/.../assets/.../adBreaks/1",
  "expectedDuration": "30s",
  "scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
  "customParams": "param1=value1&param2=value2",
  "podTemplateName": "podtemplate"
}
割り当てられたミッドロール挿入点を一覧表示する
GET admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
レスポンスの本文

レスポンスの本文には、ストリームに割り当てられた広告ブレークごとに追加の breakState フィールドを持つ広告ブレークが含まれます。breakState フィールドは、次の値をサポートしています。

 // Ad break decisioning has started.
BREAK_STATE_DECISIONED

// Break has started to be delivered to end users.
BREAK_STATE_COMPLETE
レスポンスの例
HTTP/1.1 200 OK
{
  "name": "networks/.../assets/.../adBreaks/1",
  "expectedDuration": "30s",
  "breakState": "BREAK_STATE_COMPLETE"
}