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

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

サービス: dai.google.com

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

メソッド: stream

Methods
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 されます。
Chronicle のターゲティング パラメータ 任意 追加のターゲティング パラメータ。
ストリーム パラメータをオーバーライドする 任意 ストリーム作成パラメータのデフォルト値をオーバーライドします。
HMAC 認証 任意 HMAC ベースのトークンを使用して認証します。

レスポンスの本文

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

Open Measurement

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

方法: メディアの確認

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

media verification エンドポイントへのリクエストはべき等になります。

Methods
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 の形式が正しくないため、または有効期限が原因でメディアを検証できない場合。
  • HTTP/1.1 404 Not Found: この ID の以前の確認リクエストが成功した場合。
  • HTTP/1.1 409 Conflict: この時点で別のリクエストがすでに ping を送信している場合。

広告メディア ID（HLS）

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

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

メソッド: metadata

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

Methods
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

ストリーム

ストリームは、新しく作成されたストリームのリソースリストを 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

ストリーム識別子。
stream_manifest string

HLS のマスター再生リストまたは DASH の MPD に対応するストリームのマニフェスト。サーバーサイド ビーコン ストリームの作成時にレスポンスに存在する、「stream_id」以外の唯一のフィールドです。
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

推奨されるメタデータ 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 には、広告、広告ブレーク、イベントタイプへの参照が含まれます。type="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 つの広告ブレークを示します。再生時間、タイプ（途中/前/後）、広告の数を含みます。
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 が存在しない場合は表示されません。
JSON 表現
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
フィールド
system string

広告システム ID。
ad_id string

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

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

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

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

検証

Verification には 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

トラッキング イベントのタイプ。現時点では、VAST 4.1 仕様で指定されている「verificationNotExecuted」のみがオプションです。
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,
}
フィールド
click_data object(ClickData)

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

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

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

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

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

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

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> ノードの値。