ダイナミック広告挿入 API を使用すると、DAI ライブ配信をリクエストしてトラッキングできます。
サービス: dai.google.com
すべての URI は https://dai.google.com を基準にしています。
メソッド: stream
| メソッド | |
|---|---|
stream |
POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream
DAI Pod Serving のライブ ストリーム セッションを登録します。 |
HTTP リクエスト
POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream
パスパラメータ
| パラメータ | |
|---|---|
network_code |
string
パブリッシャーの Google アド マネージャー ネットワーク コード。 |
custom_asset_key |
string
Google アド マネージャーでこのイベントに関連付けられているカスタム ID。 |
リクエストの本文
リクエストの本文は application/x-www-form-urlencoded 型で、次のパラメータが含まれています。
| パラメータ | ||
|---|---|---|
| DFP ターゲティング パラメータ | 省略可 | 追加のターゲット設定パラメータ。 |
| ストリーム パラメータをオーバーライドする | 省略可 | ストリーム作成パラメータのデフォルト値をオーバーライドします。 |
| HMAC 認証 | 省略可 | HMAC ベースのトークンを使用して認証します。 |
レスポンスの本文
成功した場合、レスポンスの本文には新しい Stream オブジェクトが含まれます。
Open Measurement
DAI API の Verifications フィールドには、Open Measurement 検証の情報が含まれています。このフィールドには、クリエイティブの再生を検証するためにサードパーティの測定コードを実行するために必要なリソースとメタデータをリストする 1 つ以上の Verification 要素が含まれます。JavaScriptResource のみがサポートされています。詳しくは、IAB Tech Lab と VAST 4.1 の仕様をご覧ください。
方法: pod セグメント
| メソッド | |
|---|---|
pod segment |
GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}
指定されたイベント ID の DAI ストリームを作成します。 |
HTTP リクエスト
GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}
パスパラメータ
| パラメータ | |
|---|---|
network_code |
string
パブリッシャーの Google アド マネージャー ネットワーク コード。 |
custom_asset_key |
string
Google アド マネージャーでこのイベントに関連付けられているカスタム ID。 |
pod_identifier |
次の形式がサポートされています。 pod/{integer}
現在の広告ブレークの数値識別子。広告ポッド ID は、各広告ブレーク イベントに対して ad_break_id/{string}
現在の広告ブレークの文字列 ID。パブリッシャー指定の広告ブレーク ID には、連続配信広告 ID と同じ制約はありません。このエンドポイントに不明な広告ブレーク ID が指定された場合は、ライブ配信イベントの新しい広告ブレークが作成されます。 |
profile_name |
string
リクエストされた Google アド マネージャー DAI エンコード プロファイルの名前。エンコード プロファイルは、選択したイベント用に構成されたエンコード プロファイルのいずれかである必要があります。 |
segment_number |
integer
現在の広告ポッド内のリクエストされたセグメントのインデックス(0 から開始)。 |
segment_format |
string
リクエストされたセグメント形式に関連付けられているファイル拡張子。使用できる拡張子は、 |
クエリ パラメータ
| パラメータ | ||||||
|---|---|---|---|---|---|---|
stream_id |
必須 |
string
現在のユーザー セッションのストリーム ID。この値は、 |
||||
sd |
required1
|
integer
リクエストされたセグメントの再生時間(ミリ秒単位)。 |
||||
so |
省略可 |
広告ポッド内のリクエストされたセグメントのオフセット(ミリ秒単位)。 |
||||
pd |
必須2 |
integer
連続配信広告の再生時間(ミリ秒単位)。 |
||||
auth-token |
必須 |
string
現在の広告ポッドの署名付き URL エンコード HMAC トークン。 |
||||
last |
省略可 |
boolean
広告ブレークの最後のセグメントを示します。他のすべてのセグメントでは、このパラメータを省略します。 |
||||
scte35 |
省略可 |
string
この広告ブレークの Base64 エンコードされた SCTE-35 信号。 |
||||
cust_params |
省略可 |
string
アド マネージャー キャンペーンのターゲティングに使用される Key-Value ペアのセット。これらのペアは、URL エンコードされたクエリ文字列として表す必要があります。 例:
|
||||
脚注
例
GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST
GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST
レスポンスの本文
成功した場合、レスポンスの本文は、リクエストで指定された形式とパラメータに一致する再生可能なストリーム セグメントになります。
方法: HLS ポッド マニフェスト
クライアントの動画プレーヤーが読み込んで再生できるライブ配信の HLS 広告ポッド マニフェストを取得します。
| メソッド | |
|---|---|
GET |
GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;
広告ポッドの HLS マルチバリエーション再生リストを取得する API。 |
HTTP リクエスト
GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}
パスパラメータ
| パラメータ | |
|---|---|
network_code |
string
パブリッシャーの Google アド マネージャー ネットワーク コード。 |
custom_asset_key |
string
Google アド マネージャーでこのイベントに関連付けられているカスタム ID |
pod_identifier |
次の形式がサポートされています。 pod/{integer}
現在の広告ブレークの数値識別子。広告ポッド ID は、各広告ブレーク イベントに対して ad_break_id/{string}
現在の広告ブレークの文字列 ID。パブリッシャー指定の広告ブレーク ID には、連続配信広告 ID と同じ制約はありません。このエンドポイントに不明な広告ブレーク ID が指定された場合は、ライブ配信イベントの新しい広告ブレークが作成されます。 |
クエリ パラメータ
| パラメータ | ||||||
|---|---|---|---|---|---|---|
stream_id |
必須 |
string
現在のユーザー セッションのストリーム ID。この値は、 |
||||
pd |
必須 |
integer
連続配信広告の再生時間(ミリ秒単位)。 |
||||
scte35 |
省略可 |
string
この広告ブレークの Base64 エンコードされた SCTE-35 信号。 |
||||
cust_params |
省略可 |
string
アド マネージャー キャンペーンのターゲティングに使用される Key-Value ペアのセット。これらのペアは、URL エンコードされたクエリ文字列として表す必要があります。 例:
|
||||
レスポンスの本文
成功した場合、レスポンスの本文は HLS マルチバリアント プレイリストになります。
メソッド: DASH ポッド マニフェスト
クライアントの動画プレーヤーが読み込んで再生できるライブ ストリームの MPEG-DASH 広告ポッド マニフェストを取得します。
| メソッド | |
|---|---|
GET |
GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd
広告ポッドの MPEG-DASH mpd 再生リストを取得する API。 |
HTTP リクエスト
GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}
パスパラメータ
| パラメータ | |
|---|---|
network_code |
string
パブリッシャーの Google アド マネージャー ネットワーク コード。 |
custom_asset_key |
string
Google アド マネージャーでこのイベントに関連付けられているカスタム ID |
stream_id |
string
現在のユーザー セッションのストリーム ID。この値は、 |
pod_id |
integer
現在の広告ブレークの数値識別子。広告ポッド ID は、各広告ブレーク イベントに対して |
クエリ パラメータ
| パラメータ | ||||||
|---|---|---|---|---|---|---|
pd |
必須 |
integer
連続配信広告の再生時間(ミリ秒単位)。 |
||||
scte35 |
省略可 |
string
この広告ブレークの Base64 エンコードされた SCTE-35 信号。 |
||||
cust_params |
省略可 |
string
アド マネージャー キャンペーンのターゲティングに使用される Key-Value ペアのセット。これらのペアは、URL エンコードされたクエリ文字列として表す必要があります。 例:
|
||||
レスポンスの本文
成功した場合、レスポンスの本文は MPEG-DASH mpd プレイリストになります。
メソッド: DASH Pod 期間テンプレート
| メソッド | |
|---|---|
pods |
GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json
Google アド マネージャーから DASH 期間テンプレートをリクエストします。このテンプレートには、ストリーム パラメータを入力する必要があるマクロが含まれています。これらのマクロが入力されると、テンプレートが広告ブレーク期間になり、DASH マニフェストにステッチできます。 |
HTTP リクエスト
GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json
パスパラメータ
| パラメータ | |
|---|---|
network_code |
string
パブリッシャーの Google アド マネージャー ネットワーク コード。 |
custom_asset_key |
string
Google アド マネージャーでこのイベントに関連付けられているカスタム ID。 |
クエリ パラメータ
| パラメータ | ||
|---|---|---|
stream_id |
必須 |
string
現在のユーザー セッションのストリーム ID。この値は、 |
tv |
省略可 |
integer
テンプレートのバージョン。デフォルトは
|
レスポンスの本文
成功した場合、レスポンスの本文には新しい PodTemplateResponse オブジェクトが含まれます。
メソッド: 連続配信広告のタイミング メタデータ
| メソッド | |
|---|---|
ad pod timing metadata |
GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json
連続配信広告のタイミング メタデータを取得します。 |
HTTP リクエスト
GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json
パスパラメータ
| パラメータ | |
|---|---|
network_code |
string
パブリッシャーの Google アド マネージャー ネットワーク コード。 |
custom_asset_key |
string
Google アド マネージャーでこのライブ ストリームに関連付けられているカスタム識別子。 |
クエリ パラメータ
| パラメータ | ||
|---|---|---|
stream_id |
必須 |
string
クライアント動画プレーヤー アプリからのアド マネージャー ストリーム ID。 |
ad_break_id |
必須 |
string
次に予定されている広告ブレークの ID。 広告ブレーク ID はスティッチング サーバーまたは VTP によって提供され、同じ広告ブレークの早期広告ブレーク通知、広告ポッドのタイミング メタデータ リクエスト、セグメント リダイレクト リクエスト間で一致している必要があります。 カスタム広告ブレーク ID には次の制限が適用されます。
|
auth-token |
必須 |
string
|
timeout |
省略可 |
integer
DAI が広告判定を待つためにこのリクエストをブロックできるミリ秒数。このパラメータは、プリロール広告ブレークなど、最初のリクエストで広告が入力された状態で返される必要があるリクエストで使用します。 タイムアウトを超過した場合、リクエストは保留ステータスを返します。 指定する場合、タイムアウト値は 1,000 ~ 15,000 ミリ秒の範囲で指定する必要があります。省略した場合、広告の判定を待つためにレスポンスが遅延することはありません。 |
final |
省略可 |
boolean
デフォルトは |
広告決定パラメータ |
||
pd |
省略可 |
integer
広告ブレークの長さ(ミリ秒単位)。広告ポッドの長さとも呼ばれます。 EABN を使用する場合、pd 値は広告ブレーク通知で指定された期間と一致する必要があります。期間が一致しない場合は、EABN 値が優先されます。 |
cust_params |
省略可 |
string
アド マネージャー ヘルプセンターで説明されている広告ブレーク ターゲティングのカスタム パラメータ。 |
scte35 |
省略可 |
string
Base64 でエンコードされた SCTE-35 信号。
シグナルが無効な場合、レスポンスの |
レスポンスの本文
成功した場合、レスポンスの本文には新しい AdPodTimingMetadataResponse オブジェクトが含まれます。
方法: メディアの確認
再生中に広告メディア 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。 - URL の形式が正しくないか、期限切れのため、リクエストでメディアを検証できない場合は
HTTP/1.1 404 Not Found。 - この ID の以前の確認リクエストが成功した場合は
HTTP/1.1 404 Not Found。 - 別のリクエストがこの時点で ping を送信している場合は
HTTP/1.1 409 Conflict。
広告メディア ID
広告メディア ID は、個別のメタデータ トラックにエンコードされます。HLS トランスポート ストリームの場合はタイムド メタデータ、mp4 ファイルの場合は emsg です。広告メディアの識別子は常に文字列 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 オブジェクトのインデックス登録に使用されます。
API オブジェクト
ストリーム
Stream は、新しく作成されたストリームのリソースのリストを JSON 形式でレンダリングするために使用されます。| JSON 表現 |
|---|
{
"stream_id": string,
"media_verification_url": string,
"metadata_url": string,
"session_update_url": string,
"heartbeat_url": string,
"polling_frequency": number,
"pod_manifest_url": string,
"manifest_format": string,
} |
| フィールド | |
|---|---|
stream_id |
stringGAM ストリーム ID。 |
media_verification_url |
string再生イベントのトラッキングのベース エンドポイントとして使用されるメディア検証 URL。 |
metadata_url |
string今後のストリーム広告イベントに関する定期的な情報をポーリングするために使用されるメタデータ URL。 |
session_update_url |
stringこのストリームのターゲティング パラメータを更新するために使用されるセッションの更新 URL。ターゲット設定パラメータの元の値は、最初のストリーム作成リクエストでキャプチャされます。 |
heartbeat_url |
stringサーバーサイドのビーコン処理ストリームを維持するために使用されるハートビート URL。{PollingFrequency} 秒ごとに ping を送信する必要があります。サーバーサイド ビーコン処理ストリームの場合に設定されます。 |
polling_frequency |
numbermetadata_url または heartbeat_url をリクエストする際のポーリング頻度(秒単位)。 |
pod_manifest_url |
stringポッド マニフェスト URL テンプレートは、ストリームのポッド マニフェストを取得するための URL を生成するために使用されます。これは、HLS のマルチバリアント プレイリストの URL または DASH の MPD に対応します。ダイナミック広告挿入タイプ POD_SERVING_MANIFEST のライブ ストリーム イベントに対して入力されます。 https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType |
manifest_format |
stringマニフェスト形式は、pod_manifest_url から取得されたマニフェストの形式(dash または hls)です。 |
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広告ブレーク内の広告の数。 |
広告
Ad は、ストリーム内の広告を表します。| 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広告主様の識別子(省略可)。 |
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)]Wrapper のリスト。空の場合は省略されます。 |
universal_ad_id |
object(UniversalAdID)オプションのユニバーサル広告 ID。 |
extensions |
stringVAST 内のすべての <Extension> ノードの省略可能なリスト。 |
companions |
[object(Companion)]この広告とともに表示される可能性があるオプションのコンパニオン。 |
interactive_file |
object(InteractiveFile)広告の再生中に表示されるオプションのインタラクティブ クリエイティブ(SIMID)。 |
PodTemplateResponse
PodTemplateResponse は、ポッド ステッチングのために VTP に返される JSON ペイロードを表します。| JSON 表現 |
|---|
{
"dash_period_template": string,
"segment_duration_ms": int64,
} |
| フィールド | |
|---|---|
dash_period_template |
stringDashPeriodTemplate は、スティッチングの前に適切なデータで埋められる期間の XML テンプレートです。 |
segment_duration_ms |
int64SegmentDurationMS は、期間セグメントの長さ(ミリ秒単位)です。 |
AdpodTimingMetadataResponse
AdpodTimingMetadataResponse には、広告ポッドと、そのセグメント URL を作成する方法に関する情報が含まれています。| JSON 表現 |
|---|
{
"status": string,
"ads": [object(AdRendering)],
"slate": object(SlateRendering),
"dash_representations": map[string, object(DASHRepresentation)],
"dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
} |
| フィールド | |
|---|---|
status |
string連続配信広告の決定ステータス。 |
ads |
[object(AdRendering)]広告セグメントの URL をレンダリングする方法を記述する Ad オブジェクトの配列。インデックスは 0 から始まります。 |
slate |
object(SlateRendering)スレート セグメントの URL をレンダリングする方法を説明するスレート。 |
dash_representations |
map[string, object(DASHRepresentation)]DASH マニフェストでレンダリングされる広告ポッドの DASH 表現のリスト。 |
dash_adaptation_sets |
map[string, object(DASHAdaptationSet)]DASH マニフェストでレンダリングされる広告ポッドの DASH アダプテーション セットのリスト。 |
AdRendering
AdRendering は、決定された広告をレンダリングする方法を記述します。| JSON 表現 |
|---|
{ "duration_ms": number, "variants": map[string, object(VariantRendering)], } |
| フィールド | |
|---|---|
duration_ms |
number広告の再生時間(ミリ秒単位、整数)。 |
variants |
map[string, object(VariantRendering)]UI から設定された、パターン/プロファイル ID でインデックス付けされたパターン オブジェクトのディクショナリ(下記を参照)。 |
SlateRendering
SlateRendering は、スレート コンテンツをレンダリングする方法を記述します。| JSON 表現 |
|---|
{ "duration_ms": number, "variants": map[string, object(VariantRendering)], } |
| フィールド | |
|---|---|
duration_ms |
numberスレートの再生時間(ミリ秒単位の整数)。 |
variants |
map[string, object(VariantRendering)]パターン/プロファイル ID でインデックス登録されたパターン オブジェクトのディクショナリ。スレートの長さが要件を満たすまで、スレートの再生時間をループさせる必要があります。その際、HLS の場合はループの間に不連続点を挿入し、MPEG-DASH の場合は新しい期間をループさせます。 |
VariantRendering
VariantRendering は、広告/スレート内の 1 つのバリエーション/プロファイルを記述します。| JSON 表現 |
|---|
{
"segment_extension": string,
"segment_durations": object(SegmentDurations),
} |
| フィールド | |
|---|---|
segment_extension |
stringString。ts、mp4、aac、ac3、ec3、m4a、m4v のいずれか。 セグメント URL のファイル名拡張子部分。 |
segment_durations |
object(SegmentDurations)SegmentDurations オブジェクト。各セグメントの再生時間はセグメント URL に変換できます。 |
SegmentDurations
SegmentDurations は、指定された時間単位でセグメントのシーケンスの期間を表します。| JSON 表現 |
|---|
{
"timescale": number,
"values": [],
} |
| フィールド | |
|---|---|
timescale |
numberタイムスケールは 1 秒あたりの単位数(int)です。 HLS の場合は 1000(ミリ秒)、DASH 動画の場合は 90000(PTS)、DASH 音声の場合は音声サンプル レートになることが想定されます。 |
values |
numberタイムスケール単位のセグメントの長さの整数配列。 |
DASHRepresentation
DASHRepresentation は、DASH マニフェストでレンダリングされる Representation ノードを記述します。| JSON 表現 |
|---|
{
"codecs": string,
"bandwidth": number,
"width": number,
"height": number,
"frame_rate": string,
"audio_sampling_rate": number,
"audio_channel_config": object(SchemeIDURIAndValue),
} |
| フィールド | |
|---|---|
codecs |
string表現のコーデック。 |
bandwidth |
number表現の帯域幅。 |
width |
number表現の幅。 |
height |
number表現の高さ。 |
frame_rate |
string表現のフレームレート。 |
audio_sampling_rate |
number表現の音声サンプリング レート。 |
audio_channel_config |
object(SchemeIDURIAndValue)表現のオーディオ チャンネル構成。 |
DASHAdaptationSet
DASHAdaptationSet は、DASH マニフェストでレンダリングされる AdaptationSet ノードを記述します。| JSON 表現 |
|---|
{ "content_type": string, "mime_type": string, "role": object(SchemeIDURIAndValue), "inband_event_stream": object(SchemeIDURIAndValue), "min_frame_rate": string, "max_frame_rate": string, "scan_type": string, "start_with_sap": string, "segment_alignment": boolean, "representations": [], } |
| フィールド | |
|---|---|
content_type |
stringアダプテーション セットのコンテンツ タイプ。 |
mime_type |
stringアダプテーション セットの MIME タイプ。 |
role |
object(SchemeIDURIAndValue)アダプテーション セットの役割。 |
inband_event_stream |
object(SchemeIDURIAndValue)アダプテーション セットのインバンド イベント ストリーム。 |
min_frame_rate |
stringアダプテーション セットの最小フレームレート。 |
max_frame_rate |
stringアダプテーション セットの最大フレームレート。 |
scan_type |
string適応セットのスキャンタイプ。 |
start_with_sap |
stringアダプテーション セットの SAP から開始します。 |
segment_alignment |
booleanアダプテーション セットのセグメントの配置。 |
representations |
stringアダプテーション セットの表現。 |
SchemeIDURIAndValue
SchemeIDURIAndValue は、スキーム ID とその値のペアです。| JSON 表現 |
|---|
{
"scheme_id_uri": string,
"value": string,
} |
| フィールド | |
|---|---|
scheme_id_uri |
string値のスキーム ID URI。 |
value |
stringスキーム ID URI の値。 |
アイコン
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 |
stringJavaScript ペイロードの URI。 |
api_framework |
stringAPIFramework は、検証コードを実行する動画フレームワークの名前です。 |
browser_optional |
booleanこのスクリプトをブラウザの外部で実行できるかどうか。 |
TrackingEvent
TrackingEvent には、特定の状況でクライアントが ping を送信する必要がある URL が含まれます。| JSON 表現 |
|---|
{
"event": string,
"uri": string,
} |
| フィールド | |
|---|---|
event |
stringトラッキング イベントのタイプ。 |
uri |
stringピンを送信するトラッキング イベント。 |
UniversalAdID
UniversalAdID は、広告システム全体で維持される一意のクリエイティブ識別子を提供するために使用されます。| JSON 表現 |
|---|
{ "id_value": string, "id_registry": string, } |
| フィールド | |
|---|---|
id_value |
string広告用に選択されたクリエイティブのユニバーサル広告 ID。 |
id_registry |
string選択したクリエイティブのユニバーサル広告 ID がカタログに登録されているレジストリ ウェブサイトの URL を識別するために使用される文字列。 |
コンパニオン モード
Companion には、広告とともに表示されるコンパニオン広告の情報が含まれます。| 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 |
stringVAST の <AdParameters> ノードの値。 |