ダイナミック広告挿入の連続配信広告 VOD API

ダイナミック広告挿入 API を使用すると、DAI オンデマンド ストリームをリクエストして追跡できます。

サービス: dai.google.com

すべての URI は https://dai.google.com を基準にしています。

メソッド: ストリームを作成

このメソッドは、デバイスから直接ストリームを作成し、クライアント アプリケーションが広告の再生とトラッキングを行い、UI 要素を表示するために必要なすべてのリソースを返します。

メソッド
create stream POST: /ondemand/pods/api/v1/network/{network_code}/stream

DAI Pod Serving VOD セッションを作成します。

HTTP リクエスト

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream

パスパラメータ

パラメータ
network_code string

パブリッシャーの Google アド マネージャー ネットワーク コード。

リクエストの本文

リクエストの本文は application/json 型で、CreateStreamRequest オブジェクトを含んでいる必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には新しい CreateStreamResponse オブジェクトが含まれます。

メソッド: ストリームを登録する

このメソッドは、デバイスから Google DAI バックエンドにストリームを登録し、クライアント アプリケーションが広告をトラッキングして UI 要素を表示するために必要なすべてのリソースを返します。create stream メソッドとは異なり、このメソッドはプレイアブル広告のマニフェストを返しません。代わりに、このアクションは別のサーバー呼び出し decision ad pods で実現されます。

メソッド
register stream POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration

DAI Pod Serving VOD セッションを登録します。

HTTP リクエスト

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

パスパラメータ

パラメータ
network_code string

パブリッシャーの Google アド マネージャー ネットワーク コード。

リクエストの本文

リクエストの本文は application/json 型で、StreamRegistrationRequest オブジェクトを含んでいる必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には新しい StreamRegistrationResponse オブジェクトが含まれます。

メソッド: 広告ポッドを取得する

このメソッドは、デバイスからの register stream 呼び出しに続き、コンテンツ マニフェストにステッチする再生可能な広告マニフェストを取得するために必要です。

メソッド
decision ad pods POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

DAI Pod Serving VOD セッションの連続配信広告を決定します。

HTTP リクエスト

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

パスパラメータ

パラメータ
network_code string

パブリッシャーの Google アド マネージャー ネットワーク コード。
stream_id string

stream_registration 呼び出しから受信した stream_id。

リクエストの本文

リクエストの本文は application/json 型で、AdPodDecisionRequest オブジェクトを含んでいる必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には新しい AdPodDecisionResponse オブジェクトが含まれます。

メソッド: 連続配信広告のメタデータ

このメソッドは、クライアント アプリが広告をトラッキングし、適切な UI 要素を正確にレンダリングするために必要なすべての情報を返します。

メソッド
ad pods metadata GET: /ondemand/pods/api/v1/network/.../metadata

特定のセッションの広告ポッドのメタデータを取得します。この URL は StreamRegistrationResponse metadata_url 属性で返されます。

HTTP リクエスト

GET: /ondemand/pods/api/v1/network/.../metadata

レスポンスの本文

成功した場合、レスポンスの本文には Ad pods metadata オブジェクトが含まれます。

API オブジェクト

PodMetadata

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

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

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

広告ブレーク ID でインデックス登録された広告ブレークのマップ。
polling_frequency number

推奨されるメタデータ URL のポーリング頻度（秒単位）。オンデマンドの判定を使用して VOD ストリームに入力されます。

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 string

VAST 内のすべての <Extension> ノードの省略可能なリスト。
companions [object(Companion)]

この広告とともに表示される可能性があるオプションのコンパニオン。
interactive_file object(InteractiveFile)

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

MatchOpts

MatchOpts は、ストリームの厳格なメディア マッチング要件を指定します。
JSON 表現
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
フィールド
audio_channels boolean

コンテンツと広告の音声チャンネルを一致させます。
audio_sample_rate boolean

コンテンツと広告のオーディオ サンプルレートを一致させます。

CreateStreamRequest

CreateStreamRequest は、API を提供する VOD Pod への HTTP リクエストで見つかった情報を記述します。ストリームの作成は、すべてのユーザーに対して、SDK とパブリッシャーに代わって VTP（動画テクノロジー パートナー）によって開始されます。作成されたストリームにより、VTP がステッチする連続配信広告が決定されます。これは、複数のリクエストでストリームと決定広告ポッドを登録する StreamRegistrationRequest+AdPodDecisionRequest フローとは対照的です。
JSON 表現
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}
フィールド
encoding_profiles [object(EncodingProfile)]

エンコード プロファイルのリスト。必須。
ad_tag string

判定用のベース広告タグ。必須。
cuepoints number

キューポイントのリスト（秒単位）。 広告タグのレスポンスで位置時間オフセットを使用する場合は必須です。
manifest_type string

有効なマニフェスト タイプは hls と dash です。デフォルト: hls。省略可。
enable_hls_asset_list boolean

HLS アセットリストのインタースティシャルが有効かどうかを示します。有効にすると、DAI は各広告ブレークのアセットリスト URL を返します。これは HLS インタースティシャルに使用できます。
targeting_parameters string

アド マネージャーの追加のターゲティング パラメータ。省略可。
content_duration_seconds number

ContentDurationSeconds はコンテンツの長さ（秒単位）です。広告タグのレスポンスでパーセント時間オフセットを使用する場合は必須です。
decision_timing_options object(DecisionTimingOptions)

アドポッドの判定を行うタイミングを示します。
enable_inline_manifests boolean

ブレーク マニフェストを JSON レスポンスにインライン化するかどうかを示します。
dai_options object(CreateStreamOptions)

ストリーム作成の DAIOptions。

CreateStreamOptions

CreateStreamOptions は、1 ステップのストリーム作成ワークフローで使用可能なオプションを表します。
JSON 表現
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}
フィールド
dash_profile string

使用する MPEG-DASH プロファイル（live または on-demand）。
match_options object(MatchOpts)

data_sharing_policy_code string

パブリッシャーがネットワークのデフォルトのデータ共有ポリシーをオーバーライドできるようにします。
sam_id string

sam_id はセッションの SAM デバッグキーです（省略可）。
session_title string

session_title は、ストリームの SAM セッション タイトルです（省略可）。
dash_inband_event_stream boolean

dash_inband_event_stream は、DAI が ID3 メッセージを EventStream 要素（マニフェスト内）ではなく、InbandEventStream 要素を使用してインバンド イベント（メディア内）として挿入することを示します。
distinct_ad_profiles boolean

true に設定されている場合、リクエストされたエンコード プロファイルと一致する際に、サーバーが利用可能な広告プロファイルを最大 1 回使用することを示します。
tracking_mode string

tracking_mode は、ストリームで使用する広告トラッキングのタイプです（省略可）。 有効な値は、'ad_media'、'server'、'client' です。
emsg_version uint32

emsg_version は、メディア内 ID3 に特定の emsg バージョンを強制的に使用します。dash_inband_event_stream が true の場合にのみサポートされます。

StreamRegistrationRequest

StreamRegistrationRequest は、将来の広告ポッドの決定のためにデバイスからストリームを登録します。これは、1 つのリクエストでストリームとデシジョン広告ポッドを作成する CreateStreamRequest とは対照的です。
JSON 表現
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
フィールド
targeting_parameters string

アド マネージャーの追加のターゲティング パラメータ。省略可。
dai_options object(StreamRegistrationOptions)

ストリーム登録用の DAIOptions。

StreamRegistrationOptions

StreamRegistrationOptions は、ストリームの作成に使用できるオプションを一覧表示します。
JSON 表現
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
フィールド
sam_id string

sam_id はセッションの SAM デバッグキーです（省略可）。
tracking_mode string

tracking_mode は、ストリームで使用する広告トラッキングのタイプです（省略可）。 有効な値は、'ad_media'、'server'、'client' です。
emsg_version uint32

emsg_version は、メディア内 ID3 に特定の emsg バージョンを強制的に使用します。dash_inband_event_stream が true の場合にのみサポートされます。
skippable_ads_supported boolean

スキップ可能な広告がサポートされているかどうかを示します。

StreamRegistrationResponse

StreamRegistrationResponse は、StreamRegistrationRequest へのレスポンスとしてクライアントに返送される JSON レスポンスを表します。ストリーム ID とデバイスに必要なすべての URL が含まれています。ストリーム ID は、後続の広告ポッドの判定リクエストで参照できます。これは、ストリームの作成と広告ポッドの判定を同時に行うレスポンスを表す CreateStreamResponse とは対照的です。
JSON 表現
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
フィールド
stream_id string

StreamID は、この視聴者の現在のストリームの一意の識別子です。
media_verification_url string

MediaVerificationURL は、以下で説明する広告メディアの確認リクエストで使用される URL 接頭辞です。クライアントサイド ビーコン ストリームの場合は存在しません。
valid_for string

ValidFor は、このストリームが有効な期間を「00h00m00s」形式で表したものです。
valid_until string

ValidUntil は、このストリームが有効な日付と時刻です。
metadata_url string

MetadataURL は、連続配信広告のメタデータのリクエストに使用されるメタデータ URL です。

DecisionTimingOptions

DecisionTimingOptions は、ストリームの広告ブレークの判定のタイミング オプションを記述します。
JSON 表現
{
  "type": string,
  "on_create_breaks": [],
}
フィールド
type string

Type は、ストリームの広告ポッドが決定されるタイミングを表します。有効なタイプは、on_create（デフォルト）、on_demand です。タイプが on_demand の場合、特定のブレークのマニフェストがリクエストされたときに、広告の判定が遅延して行われます。タイプが on_create の場合、ストリームの作成時にすべての広告が判定されます。
on_create_breaks string

OnCreateBreaks は、ストリーム作成時に判定されるべき大文字と小文字が区別される VMAP breakID のリストです。このフィールドは、タイプが on_demand の場合にのみ使用できます。特別な広告ブレーク ID「preroll」と「postroll」を使用して、プリロールまたはポストロールのブレークをストリーム作成時に決定する必要があることを示すことができます。

EncodingProfile

EncodingProfile は、単一のコンテンツ バリアントのエンコードを表します。動画設定のみ、音声設定のみ（メディアタイプの場合）、動画と音声の両方の設定、または字幕の場合はどちらも含まれないことがあります。
JSON 表現
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
フィールド
profile_name string

パブリッシャーが指定したプロファイルの名前。ストリームごとに一意。必須。
type string

有効なタイプは、media、iframe、subtitles です。必須。
container_type string

有効なタイプは mpeg2ts、fmp4cmaf、hls_packed_audio です。Type メディアと iframe では必須です。
video_settings object(VideoSettings)

コンテナタイプが iframe の場合は、動画の設定が必要です。それ以外の場合、プロフィールに動画が含まれている場合にのみ表示されます。
audio_settings object(AudioSettings)

プロファイルに音声が含まれている場合、音声設定が存在します。 音声設定は、コンテナタイプがメディアの場合にのみ許可されます。
subtitle_settings object(SubtitleSettings)

Type 字幕には字幕の設定が必要です。

VideoSettings

VideoSettings は、エンコード プロファイルの動画を表します。動画設定が 1 つ存在する場合は、すべて存在する必要があります。
JSON 表現
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
フィールド
codec string

動画の RFC6381 コーデック文字列。
bitrate int32

エンコード プロファイルの最大動画ビットレート。
frames_per_second number

動画のフレーム/秒。
resolution object(Resolution)

動画の幅 × 高さの解像度。

AudioSettings

AudioSettings は、エンコード プロファイルの音声を表します。オーディオ設定が 1 つ存在する場合は、すべて存在する必要があります。
JSON 表現
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
フィールド
codec string

音声の RFC6381 コーデック文字列。
bitrate int32

エンコード プロファイルの最大音声ビットレート。
channels int32

音声チャンネル数（低周波数チャンネルを含む）。
sample_rate int64

音声のサンプルレート（ヘルツ単位）。

SubtitleSettings

SubtitleSettings は、エンコード プロファイルの字幕を表します。
JSON 表現
{
  "format": string,
  "language": string,
}
フィールド
format string

字幕の形式: hls の場合は webvtt、dash の場合は webvtt または ttml。
language string

マニフェストに挿入する言語。

解決策

解像度は、動画の幅 x 高さを表します。
JSON 表現
{
  "width": int32,
  "height": int32,
}
フィールド
width int32

動画の幅（ピクセル単位）。必須。
height int32

動画の高さ（ピクセル単位）。必須。

AdPodDecisionRequest

AdPodDecisionRequest は、以前に登録されたストリームの広告ポッドを決定するリクエストを表します。
JSON 表現
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}
フィールド
encoding_profiles [object(EncodingProfile)]

エンコード プロファイルのリスト。必須。
ad_tag string

判定用のベース広告タグ。必須。
cuepoints number

キューポイントのリスト（秒単位）。 広告タグのレスポンスで位置時間オフセットを使用する場合は必須です。
manifest_type string

有効なマニフェスト タイプは hls と dash です。デフォルト: hls。省略可。
enable_hls_asset_list boolean

HLS アセットリストのインタースティシャルが有効かどうかを示します。有効にすると、DAI は各広告ブレークのアセットリスト URL を返します。これは HLS インタースティシャルに使用できます。
targeting_parameters string

アド マネージャーの追加のターゲティング パラメータ。省略可。
content_duration_seconds number

ContentDurationSeconds はコンテンツの長さ（秒単位）です。広告タグのレスポンスでパーセント時間オフセットを使用する場合は必須です。
decision_timing_options object(DecisionTimingOptions)

アドポッドの判定を行うタイミングを示します。
enable_inline_manifests boolean

ブレーク マニフェストを JSON レスポンスにインライン化するかどうかを示します。
dai_options object(AdPodDecisionOptions)

連続配信広告の決定に関する DAIOptions。

AdPodDecisionResponse

AdPodDecisionResponse は、以前に登録されたストリームの連続配信広告を決定するためのレスポンスを表します。このストリーム用に決定された広告ポッドのリストが含まれます。
JSON 表現
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
フィールド
valid_for string

ValidFor は、このストリームが有効な期間を「00h00m00s」形式で表したものです。
valid_until string

ValidUntil は、このストリームが有効な日付と時刻です。
ad_pods [object(AdPod)]

挿入順序で並べ替えられた広告ポッドのリスト。

CreateStreamResponse

CreateStreamResponse は、CreateStreamRequest へのレスポンスとしてクライアントに返送される JSON レスポンスを表します。
JSON 表現
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
  "stream_id": string,
  "media_verification_url": string,
  "pod_metadata": object(PodMetadata),
  "metadata_url": string,
}
フィールド
valid_for string

ValidFor は、このストリームが有効な期間を「00h00m00s」形式で表したものです。
valid_until string

ValidUntil は、このストリームが有効な日付と時刻です。
ad_pods [object(AdPod)]

挿入順序で並べ替えられた広告ポッドのリスト。
stream_id string

StreamID は、この視聴者の現在のストリームの一意の識別子です。
media_verification_url string

MediaVerificationURL は、以下で説明する広告メディアの確認リクエストで使用される URL 接頭辞です。クライアントサイド ビーコン ストリームの場合は存在しません。
pod_metadata object(PodMetadata)

PodMetadata には、デバイスで Pod をレンダリングして検証をトリガーするために必要な追加情報が含まれています。ダイナミック広告挿入リニア API ドキュメントで説明されているとおりです。クライアントサイドのビーコン ストリームでのみ含まれます。
metadata_url string

MetadataURL は、連続配信広告のメタデータのリクエストに使用されるメタデータ URL です。

AdPod

AdPod は、再生の準備ができた決定済みの広告ブレークを表します。
JSON 表現
{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
フィールド
manifest_uris string

ManifestURIs は、HLS コンテンツのエンコード プロファイル名と HLS バリアント manifest_uris のマップです。
multivariant_uri string

MultivariantURI は、HLS コンテンツのマルチバリエーション マニフェストの URI です。
mpd_uri string

MPDURI は、DASH コンテンツの MPD の URI です。
manifests string

マニフェストは、エンコード プロファイル名と HLS バリアント マニフェストのマップです。ストリームの enable_inline_manifests が true に設定されている場合にのみ入力されます。
multivariant_manifest string

MultivariantManifest は、HLS コンテンツのマルチバリエーション マニフェストです。ストリームの enable_inline_manifests が true に設定されている場合にのみ入力されます。
mpd_manifest string

MPDManifest は、DASH コンテンツの MPD マニフェストです。ストリームの enable_inline_manifests が true に設定されている場合にのみ入力されます。
asset_list_uri string

AssetListURI は、HLS コンテンツの HLS インタースティシャル アセットリストの URI です。ストリームで HLS アセットリストのインタースティシャルが有効になっている場合にのみ入力されます。
start number

アセット タイムライン内の広告ポッドの開始時間（先行する広告ポッドを含まない）を浮動小数点秒で表します。
duration number

連続配信広告の再生時間（浮動小数点秒単位）。
type string

ミッドロール挿入点のタイプ。
midroll_index number

VMAP ブレーク ID に基づく、ストリーム内のミッドロールの 1 ベースのインデックス。プレロールとポストロールでは省略されます。

AdPodDecisionOptions

AdPodDecisionOptions は、ストリームの追加オプションを表します。
JSON 表現
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}
フィールド
dash_profile string

使用する MPEG-DASH プロファイル（live または on-demand）。
match_options object(MatchOpts)

data_sharing_policy_code string

パブリッシャーがネットワークのデフォルトのデータ共有ポリシーをオーバーライドできるようにします。
sam_id string

sam_id はセッションの SAM デバッグキーです（省略可）。
session_title string

session_title は、ストリームの SAM セッション タイトルです（省略可）。
dash_inband_event_stream boolean

dash_inband_event_stream は、DAI が ID3 メッセージを EventStream 要素（マニフェスト内）ではなく、InbandEventStream 要素を使用してインバンド イベント（メディア内）として挿入することを示します。
distinct_ad_profiles boolean

true に設定されている場合、リクエストされたエンコード プロファイルと一致する際に、サーバーが利用可能な広告プロファイルを最大 1 回使用することを示します。

ストリーム

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

ストリーム識別子。
valid_for string

期間ストリームが有効な期間（「00h00m00s」形式）。
valid_until string

ストリームが有効な日付（RFC 3339 形式）。
media_verification_url string

メディアの確認用 URL。

アイコン

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

ピンを送信するトラッキング イベント。

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 string

VAST の <AdParameters> ノードの値。