ダイナミック広告挿入 Linear API

Dynamic Ad Insertion API を使用すると、DAI リニア（LIVE）ストリームのリクエストとトラッキングを行うことができます。

サービス: dai.google.com

以下の URI はすべて、https://dai.google.com に対する相対 URI です。

メソッド: stream

メソッド
stream POST /linear/v1/hls/event/{assetKey}/stream

指定されたイベント ID の DAI ストリームを作成します。

HTTP リクエスト

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream

リクエスト ヘッダー

パラメータ
api‑key string

ストリームの作成時に指定する API キーは、パブリッシャーのネットワークに対して有効である必要があります。

API キーは、リクエスト本文ではなく、HTTP Authorization ヘッダーで次の形式で渡すことができます。

Authorization: DCLKDAI key="<api-key>"

パスパラメータ

パラメータ
assetKey string

ストリームのイベント ID。
注: ストリーム アセットキーは識別子で、 アド マネージャーの管理画面にも表示されます。

リクエスト本文

リクエストの本文は application/x-www-form-urlencoded 型で、次のパラメータを含みます。

パラメータ
dai-ssb 任意

サーバーサイド ビーコン ストリームを作成するには、true に設定します。 デフォルトは false です。デフォルト ストリームのトラッキングはクライアントが開始し、サーバー側で ping されます。
アド マネージャーのターゲティング パラメータ 任意 追加のターゲティング パラメータ。
ストリーム パラメータをオーバーライドする 任意 ストリーム作成パラメータのデフォルト値をオーバーライドします。
HMAC 認証 任意 HMAC ベースのトークンを使用して認証します。

レスポンスの本文

成功した場合、レスポンスの本文には新しい Stream が含まれます。サーバーサイド ビーコン ストリームの場合、この Stream には stream_id フィールドと stream_manifest フィールドのみが含まれます。

Open Measurement

DAI API では、Verifications フィールドに Open Measurement のベリフィケーションに関する情報が含まれています。このフィールドには、クリエイティブの再生を検証するために第三者測定コードの実行に必要なリソースとメタデータをリストする Verification 要素が 1 つ以上含まれます。JavaScriptResource のみがサポートされています。詳しくは、IAB Tech Lab と VAST 4.1 仕様をご覧ください。

方法: メディアによるオーナー確認

再生中に広告メディア ID を見つけたら、すぐに上記の stream エンドポイントから取得した media_verification_url を使用してリクエストを送信します。サーバーがメディア検証を開始するサーバーサイド ビーコン ストリームでは、これらのリクエストは不要です。

media verification エンドポイントへのリクエストはべき等です。

メソッド
media verification GET /{media_verification_url}/{ad_media_id}

メディア検証イベントを API に通知します。

HTTP リクエスト

GET https://{media-verification-url}/{ad-media-id}

レスポンスの本文

media verification は次のレスポンスを返します。

  • メディアの検証が成功し、すべての ping が送信された場合は HTTP/1.1 204 No Content。
  • HTTP/1.1 404 Not Found: URL の形式や有効期限が正しくないためにリクエストでメディアを確認できない場合。
  • この ID の前回の確認リクエストが成功した場合は HTTP/1.1 404 Not Found。
  • HTTP/1.1 409 Conflict（別のリクエストがすでに ping を送信している場合）。

広告メディア ID（HLS）

広告メディア識別子は、「ユーザー定義のテキスト情報」フレーム用に予約されているキー TXXX を使用して、HLS タイミング メタデータでエンコードされます。フレームのコンテンツは暗号化されず、常にテキスト "google_" で始まります。

各広告確認リクエストを行う前に、フレームのテキスト コンテンツ全体を広告確認用 URL に追加する必要があります。

メソッド: metadata

metadata_url のメタデータ エンドポイントは、広告 UI の作成に使用される情報を返します。サーバーが広告メディアの確認を開始するサーバーサイド ビーコン ストリームでは、メタデータ エンドポイントを使用できません。

メソッド
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

広告メタデータ情報を取得します。

HTTP リクエスト

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

レスポンスの本文

成功すると、レスポンスは PodMetadata のインスタンスを返します。

メタデータの操作

メタデータには、tags、ads、広告 breaks の 3 つのセクションがあります。データのエントリ ポイントは tags セクションです。その後、タグを順番に調べ、名前が動画ストリーム内の広告メディア ID の接頭辞である最初のエントリを見つけます。たとえば、次のような広告メディア ID があるとします。

google_1234567890

次に、google_12345 という名前のタグ オブジェクトを見つけます。この場合、広告メディア ID と一致します。正しい広告メディア プレフィックス オブジェクトを特定したら、広告 ID、広告ブレーク ID、イベントタイプを調べることができます。広告 ID は ads オブジェクトのインデックス登録に使用され、広告ブレーク ID は breaks オブジェクトのインデックス登録に使用されます。

Response data

ストリーム

Stream は、新しく作成されたストリームのリソースリストを JSON 形式でレンダリングするために使用されます。
JSON 表現
{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}
フィールド
stream_id string

GAM ストリーム識別子。
stream_manifest string

ストリームのマニフェスト URL。HLS のマルチバリエーション再生リストまたは DASH の MPD を取得するために使用されます。
hls_master_playlist string

（非推奨）HLS マルチバリエーション再生リストの URL。代わりに「stream_manifest」を使用してください。
media_verification_url string

再生イベントをトラッキングするためのベース エンドポイントとして使用されるメディア確認 URL。
metadata_url string

今後のストリーミング広告イベントに関する定期的な情報のポーリングに使用するメタデータ URL。
session_update_url string

このストリームのターゲティング パラメータの更新に使用されるセッションの更新 URL。 ターゲティング パラメータの元の値は、最初のストリーム作成リクエストで取得されます。
polling_frequency number

metadata_url または Heartbeat_url をリクエストする際のポーリング頻度（秒単位）。

PodMetadata

PodMetadata には、広告、ミッドロール挿入点、メディア ID タグに関するメタデータ情報が含まれます。
JSON 表現
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
フィールド
tags map[string, object(TagSegment)]

タグ接頭辞でインデックス登録されたタグセグメントのマップ。
ads map[string, object(Ad)]

広告 ID でインデックス登録された広告のマップ。
ad_breaks map[string, object(AdBreak)]

広告ブレーク ID でインデックスに登録されたミッドロール挿入点のマップ。

TagSegment

TagSegment には、広告、その広告ブレーク、イベントタイプへの参照が含まれます。 タイプが「progress」の TagSegment は、広告メディアの検証エンドポイントに ping しないでください。
JSON 表現
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
フィールド
ad string

このタグの広告の ID。
ad_break_id string

このタグの広告ブレークの ID。
type string

このタグのイベントタイプ。

AdBreak

AdBreak は、ストリーム内の 1 つのミッドロール挿入点を表します。長さ、タイプ（mid/pre/post）、広告数が含まれます。
JSON 表現
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
フィールド
type string

有効なブレークタイプは、Pre、mid、post です。
duration number

この広告ブレークの広告の合計再生時間（秒単位）。
expected_duration number

すべての広告とスレートを含む、想定される広告ブレークの長さ（秒単位）。
ads number

ミッドロール挿入点内の広告の数。
広告はストリーム内の広告について記述しています。
JSON 表現
{
  "ad_break_id": string,
  "position": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
フィールド
ad_break_id string

この広告のミッドロール挿入点の ID。
position number

広告ブレーク内でのこの広告の位置（1 から始まる）
duration number

広告の再生時間（秒）。
title string

広告のタイトル（省略可）。
description string

広告の説明（省略可）。
advertiser string

オプションの広告主 ID。
ad_system string

オプションの広告システム。
ad_id string

広告 ID（省略可）。
creative_id string

クリエイティブ ID（省略可）。
creative_ad_id string

オプションのクリエイティブ広告 ID。
deal_id string

取引 ID（省略可）。
clickthrough_url string

（省略可）リンク先 URL。
click_tracking_urls string

クリック トラッキング URL（省略可）
verifications [object(Verification)]

（省略可）Open Measurement の検証エントリ。第三者測定コードを実行してクリエイティブの再生を検証するために必要なリソースとメタデータをリストしたものです。
slate boolean

現在のエントリがスレートであることを示すブール値（省略可）。
icons [object(Icon)]

アイコンのリスト。空の場合は省略されます。
wrappers [object(Wrapper)]

ラッパーのリスト。空の場合は省略されます。
universal_ad_id object(UniversalAdID)

オプションのユニバーサル広告 ID。
extensions string

VAST 内のすべての <Extension> ノードのオプション リスト。
companions [object(Companion)]

この広告と一緒に表示できるオプションのコンパニオンです。
interactive_file object(InteractiveFile)

広告の再生中に表示されるオプションのインタラクティブ クリエイティブ（SIMID）。

Icon

アイコンには、VAST アイコンに関する情報が含まれています。
JSON 表現
{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}
フィールド
click_data object(ClickData)

creative_type string

click_fallback_images [object(FallbackImage)]

height int32

width int32

resource string

type string

x_position string

y_position string

program string

alt_text string

ClickData

ClickData には、アイコンのクリックスルーに関する情報が含まれます。
JSON 表現
{
  "url": string,
}
フィールド
url string

FallbackImage

FallbackImage には、VAST 代替画像に関する情報が含まれます。
JSON 表現
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
フィールド
creative_type string

height int32

width int32

resource string

alt_text string

ラッパー

ラッパーには、ラッパー広告に関する情報が含まれています。取引 ID が存在しない場合、取引 ID は記載されません。
JSON 表現
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
フィールド
system string

広告システムの識別子。
ad_id string

ラッパー広告に使用される広告 ID。
creative_id string

ラッパー広告に使用されるクリエイティブ ID。
creative_ad_id string

ラッパー広告に使用されるクリエイティブ広告 ID。
deal_id string

ラッパー広告の取引 ID（省略可）。

検証

ベリフィケーションでは Open Measurement に関する情報が含まれ、第三者の視認性および検証測定を容易にします。現在サポートされているのは JavaScript リソースのみです。https://iabtechlab.com/standards/open-measurement-sdk/ をご覧ください。
JSON 表現
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
フィールド
vendor string

検証ベンダー。
java_script_resources [object(JavaScriptResource)]

検証用の JavaScript リソースのリスト。
tracking_events [object(TrackingEvent)]

オーナー確認のトラッキング イベントのリスト。
parameters string

ブートストラップ確認コードに渡される不透明な文字列。

JavaScriptResource

JavaScriptResource には、JavaScript で検証するための情報が含まれます。
JSON 表現
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
フィールド
script_url string

JavaScript ペイロードの URI。
api_framework string

APIFramework は、確認コードを実行する動画フレームワークの名前です。
browser_optional boolean

このスクリプトをブラウザの外部で実行できるかどうか。

TrackingEvent

TrackingEvent には、特定の状況でクライアントが ping する必要がある URL が含まれます。
JSON 表現
{
  "event": string,
  "uri": string,
}
フィールド
event string

トラッキング イベントのタイプ。
uri string

ping されるトラッキング イベント。

UniversalAdID

UniversalAdID は、広告システム間で維持される一意のクリエイティブ ID を提供するために使われます。
JSON 表現
{
  "id_value": string,
  "id_registry": string,
}
フィールド
id_value string

広告で選択されたクリエイティブのユニバーサル広告 ID。
id_registry string

選択したクリエイティブのユニバーサル広告 ID がカタログに登録されている登録簿ウェブサイトの URL を識別する文字列。

コンパニオン モード

コンパニオンには、広告とともに表示される可能性のあるコンパニオン広告の情報が含まれます。
JSON 表現
{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}
フィールド
click_data object(ClickData)

このコンパニオンのクリックデータ。
creative_type string

VAST タイプの <StaticResource> ノードの CreativeType 属性（これが静的タイプのコンパニオンの場合）。
height int32

このコンパニオンの高さ（ピクセル単位）。
width int32

このコンパニオンの幅（ピクセル単位）。
resource string

静的コンパニオンと iframe コンパニオンの場合、これは読み込まれて表示される URL です。HTML コンパニオンの場合は、コンパニオンとして表示される HTML スニペットです。
type string

このコンパニオンのタイプ。静的、iframe、HTML のいずれも使用できます。
ad_slot_id string

このコンパニオンのスロット ID。
api_framework string

このコンパニオンの API フレームワーク。
tracking_events [object(TrackingEvent)]

このコンパニオンのトラッキング イベントのリスト。

InteractiveFile

InteractiveFile には、広告の再生中に表示する必要があるインタラクティブ クリエイティブの情報（SIMID など）が含まれます。
JSON 表現
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
フィールド
resource string

インタラクティブ クリエイティブの URL。
type string

リソースとして提供されるファイルの MIME タイプ。
variable_duration boolean

このクリエイティブで再生時間の延長がリクエストされるかどうか。
ad_parameters string

VAST 内の <AdParameters> ノードの値