VAST 広告タグ URL パラメータ

VAST 広告タグは、プレーヤーで動画広告とオーディオ広告の取得に使用されます。適切なパラメータを使って VAST 広告タグ URL を作成するには、下の表を参照してください。URL を作成したら、VAST Suite Inspector でテストできます。

VAST 広告タグでは、https と http の URL がサポートされます。インプレッション URL と VAST トラッキング URL では SSL 設定が考慮され、適宜 https または http が返されます。リンク先 URL とクリック トラッキング URL は、別のページからリダイレクトされるため、http となります。

ライブ ストリーム動画の場合は、すべての広告ブレークが同時に配信されるため、広告タグ URL のパスに「/live」を含めてトラフィックの集中に対応できるようにする必要があります

オーディオ広告を配信するには、オーディオ広告の広告タグ URL の ad_type パラメータを必ず audio または audio_video に設定します。

パラメータを指定し、値を割り当てたサンプルの VAST 広告タグ URL は次のようになります。

https://securepubads.g.doubleclick.net/gampad/ads?env=vp&gdfp_req=1&output=vast&iu=/1234/video-demo&sz=400x300&unviewed_position_start=1&ciu_szs=728x90,300x250

こちらのサンプルタグを使用して、確認、テストを行うこともできます。

パラメータのタイプと要件の詳細

必須パラメータと定数値

次のパラメータはすべての VAST 広告タグ URL に必須で、各パラメータの値は定数になります。たとえば、env パラメータの値が vp の場合は、動画プレーヤーからのリクエストであることを示します。

env
gdfp_req
unviewed_position_start

必須パラメータと変数値

次のパラメータはすべての VAST 広告タグ URL に必須で、各パラメータの値は変数になります。説明と値の例をご確認ください。

correlator
description_url
iu
output
sz
url

省略可能なパラメータ

次のパラメータは任意で、各パラメータの値は変数になります。説明と値の例をご確認ください。

aconp
ad_rule
ciu_szs
cmsid | vid
cust_params
hl
msid | an
nofb
pp
ppid
rdid | idtype | is_lat
rdp
tfcd
npa
vconp
vpa
vpi
vpmute

カスタム SDK パラメータ

次のパラメータは、Google IMA SDK で設定されるデフォルトのパラメータです。VAST 広告タグに以下のパラメータを設定するのは、IMA SDK を使用しない場合のみとしてください。

現在のアド マネージャーのアーキテクチャでは、ストリーム内とページ上で過去に表示された広告に関する情報が動画広告リクエストに含まれている必要があります。この情報は、広告の除外と重複の確認に加え、過去のアクティビティの概要を把握するのに役立ちます。

afvsz
excl_cat
lip
max_ad_duration | min_ad_duration
mridx
pmad
pmnd | pmxd
pod
ppos
sid
scor
vad_type
vpos
wta
パラメータ説明要件
env

(環境)

インストリーム リクエストまたは動画プレーヤーからのリクエストであることを示します。

有効な値は、動画広告とオーディオ広告に使用できる instream、または動画広告にのみ使用できる vp です。


例:

動画、オーディオ:
env=instream

動画のみ:
env=vp

必須

gdfp_req

(アド マネージャーのスキーマ インジケータ)

ユーザーがアド マネージャー スキーマ上に存在することを示します。


例:

gdfp_req=1

必須

unviewed_position_start

(後発インプレッション)

この値を「1」に設定すると、動画に後発インプレッションが使用されます。


例:

unviewed_position_start=1

必須

output

(広告の出力形式)

広告の出力形式。

ネットワークで有効にしている VAST バージョン(VAST 4 など)を返す場合は、output=vast を使用します。特定の広告タグやサイトの一部で、output=xml_vast3 を使用して VAST 3 を明示的にリクエストする(または output=xml_vmap1 を使用して VMAP 1 を明示的にリクエストする)こともできます。

VAST については、動画プレーヤーで IMA SDK を使用している場合、動画広告リクエストの output パラメータは常に output=xml_vast4 に設定されます。SDK は第三者広告サーバーが配信するすべての VAST バージョンと下位互換性があるため、信頼性に関する問題が発生することはありません。

ネットワークで有効にしているデフォルトの VMAP バージョン(VMAP 1 など)を返す場合は、output=vmap を使用します。VMAP 内部の VAST を返す場合は、xml_vmap1_vast3 または xml_vmap1_vast4 を使用して、返す VAST バージョンを指定できます。


例:

vast(ネットワークのデフォルトの VAST 設定)
xml_vast3(VAST 3 の場合)
xml_vast4(VAST 4 の場合)

vmap(ネットワークのデフォルトの VMAP 設定)
output=xml_vmap1(VMAP1 の場合)
xml_vmap1_vast3(VMAP1 で VAST3 を返す場合)
xml_vmap1_vast4(VMAP1 で VAST4 を返す場合)

必須

iu

(広告ユニット)

現在の広告ユニットです。

次の形式を使用します。
/network_id/.../ad_unit


例:

iu=/6062/videodemo

必須

sz

(サイズ)

マスター動画広告スロットのサイズ。複数のサイズを指定する場合は、パイプ文字(|)で区切ります。

サイズの末尾に「v」を付けないでください。


例:

sz=400x300

必須
(「ad_type=audio」のみをリクエストする場合は省略可)

description_url

(説明の URL)

ページで再生される動画について説明しているページの URL。通常は動画プレーヤーが置かれているページの URL になりますが、動画の説明を別途記載したページを指定することもできます。*

ウェブページの動画プレーヤーの場合は、常に description_url を URL エンコードする必要があります。

モバイルアプリ内の動画プレーヤーの場合は、エンコードされていない description_url 値を送信する必要があります。

このフィールドは、Ad Exchange を使用している場合は必須です。詳細

* インターネット テレビでは、このパラメータは IMA SDK で自動的に設定されないため、手動で設定する必要があります。


例:

URL エンコード:
description_url=https%3A%2F%2Fwww.sample.com%2Fgolf.html

エンコードなし:
description_url=https://www.sample.com/golf.html

必須

url

(URL)

広告リクエストの送信元の完全な URL。ウェブページの場合は、動画プレーヤーを表示しているページの URL になります。アプリの場合はパッケージ名になります。*

IMA SDK を使用している場合は URL 値が自動的に設定されます。プレーヤーで値が設定された場合でも、IMA SDK によって上書きされ、独自の値が設定されます。

* インターネット テレビでは、このパラメータは IMA SDK で自動的に設定されないため、手動で設定する必要があります。


例:

url=https://www.videoad.com/golf.html

必須

correlator

(相関値)

正のランダムな数値。同じページビューから送信される複数のリクエストに共通の値となります。

correlator は、競合相手の除外を実装するときに使用します。これには Cookie のない環境での実装も含まれます。

IMA SDK を使用している場合、correlator の値は自動的に設定されます。プレーヤーによってこの値が設定されたとしても、IMA SDK によって独自のランダム値で上書きされます。

IMA SDK を使用していない場合は、複数のページで再利用されない、真にランダムな値を設定するようにしてください。


例:

correlator=4345645667

必須

aconp

(音声の連続再生)

MRC の音声測定ガイドラインで推奨

プレーヤーで音声コンテンツを連続再生するかどうかを示します。

連続再生をオンにする場合は「2」、オフにする場合は「1」の値を指定します。

不明な場合はこのパラメータを未設定のままにします。


例:

連続再生オン:
aconp=2

連続再生オフ:
aconp=1

任意

ad_rule

(広告ルール)

VAST クリエイティブと広告ルールのどちらを返すかを示します。広告ルールを使用している場合は ad_rule=1 を指定します。それ以外のリクエストでは ad_rule=0 を指定します(またはこのパラメータ自体を削除します)。

広告ルールの詳細。


例:

ad_rule=0 はクリエイティブ(VAST)のリクエストを示します

ad_rule=1 は広告ルール(VMAP)のリクエストを示します

任意

ad_type

(広告タイプ)

リクエストに対して返す広告のタイプを示します。*

有効な値は、オーディオ広告のみを返す audio、動画広告のみを返す video、オーディオ広告または動画広告のいずれかを返す audio_video です。

* 現在のところ、動画広告のみを返す場合はこのパラメータは不要です。


例:

オーディオ広告を返す:
ad_type=audio

オーディオ広告または動画広告を返す:
ad_type=audio_video

オーディオ広告の場合はこのパラメータを渡す必要があります

ciu_szs

(コンパニオン サイズ)

コンパニオン サイズのカンマ区切りリスト。

パイプ(|)区切りの値は、複数サイズの広告スロットを表します。


例:

ciu_szs=728x90,300x250

サイズ(複数サイズのスロットあり):
ciu_szs=728x90,300x200|300x250

任意

cmsid
vid

(コンテンツソース ID、動画 ID)

動画コンテンツを広告のターゲットにするには、マスター動画タグに cmsidvid の両方を含める必要があります。

cmsid は、各コンテンツ ソースを識別する固有の番号です。アド マネージャーでこの番号を確認するには、[動画] 次に [コンテンツ ソース] をクリックして、該当のコンテンツ ソース名を選択します。

vid は、特定の動画コンテンツを識別する文字列または番号です。この ID はコンテンツをホストする CMS によって割り当てられます。アド マネージャーでこの番号を確認するには、[動画] 次に [コンテンツ] をクリックして、表示されたリストで該当のコンテンツを選択します。


例:

cmsid=[value]&vid=[value]

ビデオ オンデマンドでダイナミック広告挿入のタグを作成している場合は、正しい cmsidvid を動的に挿入するマクロを使用する必要があります。

例:

cmsid=%%CMS_ID%%&vid=%%VIDEO_ID%%

任意

cust_params

(カスタム Key-Value パラメータ)

Key-Value ペアを追加する方法の例をご確認ください。

任意

hl

(言語)

特定の言語の広告をリクエストするときの言語コード。

このパラメータは、広告を選択する際の言語と、ダイナミック アロケーションで Ad Exchange または AdSense の動画広告をレンダリングする際の言語で使用されます。

ISO 639-1(2 文字)または ISO 639-2(3 文字)のコードを使用できます。詳しくは、有効なコードのリストをご参照ください。

省略した場合は、Ad Exchange の言語による広告のターゲティングで指定された言語のいずれかがデフォルトで使用されます。


例:

hl=it

任意

msid
an

(アプリの ID と名前)

msid パラメータはアプリ ID を、an パラメータはアプリ名を表します。

ほとんどのプログラマティック動画広告で必要となるため、モバイルアプリとインターネット テレビ デバイスから送信されるリクエストには、これらのパラメータを適用する必要があります。*

IMA SDK ではこれらのパラメータが自動的に入力されますが、VAST を直接呼び出す場合(非 SDK 環境)は手動で指定する必要があります。

* iOS と tvOS ではアプリ名を人間が読める形式にする必要がある一方、SDK では 9 桁の App Store ID にアクセスできません。この場合、SDK では msid パラメータは送信されず、an パラメータ(com.package.publisher 形式)経由でアプリバンドルが送信されます。


例:

msid=com.package.publisher an=sample%20app

任意

nofb

(代替不可)

広告リクエストが「動画の代替」広告の再生リストを返すかどうかを示します。

詳しくは、動画の代替についての説明をご確認ください。


例:

nofb=1

任意

pp

(動画とオーディオ クリエイティブのプロファイル)

動画とオーディオ クリエイティブのプロファイルで設定されている内容に基づいて、配信対象のクリエイティブを決定します。

詳しくは、クリエイティブのプロファイルについての説明をご覧ください。


例:

pp=creative_profile

任意

ppid

(サイト運営者指定の識別子)

フリークエンシー キャップ、オーディエンス セグメンテーションとターゲティング、広告の順次ローテーション、オーディエンスに基づくその他の広告配信設定を複数のデバイスに適用する場合、サイト運営者またはパブリッシャーは、これらの機能に使用する識別子としてサイト運営者指定の識別子(PPID)を送信できます。

詳細


例:

ppid=12JD92JD8078S8J29SDOAKC0EF230337

任意

rdid
idtype
is_lat

(リセット可能なデバイス識別子)

(通常のウェブやモバイルウェブではなく)ネイティブ アプリケーションの場合は、SDK によって、ユーザー ターゲティング用のリセット可能なデバイス識別子が rdididtypeis_lat のパラメータとともにストリーム リクエストに渡されます。SSB ストリームでは、クライアントサイドの動画ソリューション広告リクエストの場合と同様に、これらのパラメータを明示的に渡す必要があります。詳細

これらの値は、ほぼすべてのプログラマティック動画広告の配信で必要となります。

iOS 14 以降、Apple では LAT シグナルがサポートされなくなったため、デフォルトでオプトアウトすることはできません。

サイト運営者(パブリッシャー)が確認済みの場合、Google では代わりにゼロ以外の IDFA の有無に基づいて、トラッキングが無効化されていないかどうかを判断します。そのため、適切な OS バージョンを示す有効な UserAgent が必要です。

 


リセット可能なデバイス識別子の詳細な例をご確認ください。

任意

rdp

(データ処理の制限)

広告リクエストにタグを設定して、
データ処理を制限します。

データ処理を制限するには、rdp=1 と明示的に指定するか、rdp(設定値なし)と指定します。このパラメータが見つからないか、rdp=0 に設定されている広告リクエストは、制限付きデータ処理のネットワーク設定が有効になっていない限り制限されません。


例:

rdp=1

任意

tfcd

(子供向け取り扱い)

広告リクエストに子供向け取り扱いのタグを設定します。

詳しくは、tfcd についての説明をご覧ください。


例:

tfcd=1

任意

npa

(パーソナライズされていない広告)

広告リクエストにパーソナライズされていない広告のタグを設定します。

リクエストをパーソナライズされていない広告としてタグ設定する場合、npa=1 と明示的に指定するか、npa(設定値なし)と指定します。広告リクエストでこのパラメータが見つからないか、nap=0 と指定されている場合は、デフォルトのパーソナライズド広告が返されます。

詳しくは、広告のパーソナライズについての説明をご覧ください。


例:

npa=1

任意

vconp

(動画の連続再生)

Recommended per MRC の動画測定ガイドラインで推奨

テレビ放送のように、プレーヤーでコンテンツ動画を連続再生するかどうかを示します。

連続再生をオンにする場合は「2」、オフにする場合は「1」の値を指定します。

不明な場合はこのパラメータを未設定のままにします。


例:

連続再生オン:
vconp=2

連続再生オフ:
vconp=1

任意

vpa

(動画の自動再生)

Recommended per MRC の動画測定ガイドラインで推奨

広告を自動再生するか、クリックで再生するかを示します。

ページでユーザーの操作を待機する場合は「click」、動画を自動再生する場合は「auto」の値を指定します。

不明な場合はこのパラメータを未設定のままにします。


例:

自動再生:
vpa=auto

クリックして再生:
vpa=click

任意

vpi

(動画再生リストの内部リダイレクト)

インライン VMAP を配信する(VMAP 内部の VAST を返す)かどうかを示します。

このパラメータを使用すると、待ち時間が短縮されるとともに、動画ストリーム全体でフリークエンシー キャップと競合相手の除外を確実に適用できます。

VAST を返す場合は「1」の値を指定します。リダイレクト タグを返す場合は「0」の値を指定するか、このパラメータを未設定のままにします。


例:

VAST を返す:
vpi=1

リダイレクトを返す:
vpi=0

省略可

vpmute

(ミュート時の動画再生)

Recommended per MRC の動画測定ガイドラインで推奨

動画プレーヤーがミュートされているときに広告を再生するかどうかを示します。

ミュート中に再生する場合は「1」、ミュート解除中に再生する場合は「0」の値を指定します。

不明な場合はこのパラメータを未設定のままにします。


例:

ミュート中に再生:
vpmute=1

ミュート解除中に再生:
vpmute=0

任意

afvsz

(ノンリニア広告サイズ)

動画広告スロットに表示できるノンリニア広告サイズのカンマ区切りリスト。

サポートされているサイズ:

  • 200×200
  • 250×250
  • 300×250
  • 336×280
  • 450x50
  • 468×60
  • 480x90
  • 729x90

IMA SDK を使用している場合、このフィールドの値は、指定された nonLinearAdSlotWidthnonLinearAdSlotHeight において表示可能なすべてのサイズで自動的に上書きされます。


例:

すべてのサイズを表示できる場合:
afvsz=200x200,250x250,
300x250,336x280,
450x50,468x60,
480x90,728x90

幅が最大 250 の場合:
afvsz=200x200,250x250

高さが最大 60 の場合:
afvsz=450x50,468x60

幅が最大 100 の場合:
//空白。対応する値なし

ノンリニア サイズに対応していない場合、パラメータは未設定のままにするか、空白にすることができます。

pod

(連続配信広告の番号)

動画内の連続配信広告を表します。最初の連続配信広告の場合は pod=1、2 番目の連続配信広告の場合は pod=2 のように渡します。競合相手の除外とフリークエンシー キャップ、それらの関連機能で使用されます。


例:

pod=3

競合相手の除外やフリークエンシー キャップ、関連機能を正常に動作させるには、このパラメータを渡す必要があります。

ppos

(連続配信広告内の位置)

連続配信広告内の位置を表します。コンパニオンの自動入力に必要です。最初の位置の場合は &ppos=1、2 番目の位置の場合は &ppos=2 のように渡します。競合相手の除外とフリークエンシー キャップ、それらの関連機能で使用されます。

このパラメータは標準の連続配信広告にのみ使用します。


例:

ppos=2

競合相手の除外やフリークエンシー キャップ、関連機能を正常に動作させるには、このパラメータを渡す必要があります。

vpos

(プレロール、ミッドロール、ポストロール)

広告リクエストがプレロール、ミッドロール、ポストロールのどれから送信されたかを表します。


例:

vpos=preroll
vpos=midroll
vpos=postroll

任意

mridx

(ミッドロールの番号)

リクエストが発生したミッドロールの位置(1 番目、2 番目、3 番目など)を表すインデックス番号です。


例:

mridx=2

任意

lip

(標準の連続配信広告の最後の位置)

連続配信広告内の最後の位置からのリクエストを表すにはこのパラメータを追加します。

このパラメータは標準の連続配信広告にのみ使用します。


例:

lip=true

標準の連続配信広告の場合は必須

min_ad_duration
max_ad_duration

(広告の再生時間)

値は一緒に取得され、再生時間の長さを示します。この範囲内に広告が一致する必要があります。時間はミリ秒単位です。

単一の広告のリクエストに使用されます。


例:

min_ad_duration=15000&max_ad_duration=30000

任意

pmnd
pmxd

(連続配信広告の再生時間)

これらの値は一緒に取得され、再生時間の長さを示します。この範囲内に連続配信広告が一致する必要があります。時間はミリ秒単位です。

複数の広告のリクエスト(連続配信広告など)に使用されます。

最適化された連続配信広告に固有のパラメータです。拡張版の動画パッケージをご利用の場合に使用できます。VMAP(ad_rule=1)の場合は使用できません。


例:

pmnd=0&pmxd=60000

最適化された連続配信広告の場合は必須

pmad

(連続配信広告の最大数)

連続配信広告内の広告の最大数。

最適化された連続配信広告に固有のパラメータです。拡張版の動画パッケージをご利用の場合に使用できます。VMAP(ad_rule=1)の場合は使用できません。


例:

pmad=4

任意

excl_cat

(除外カテゴリ)

該当の除外ラベルを含んでいる広告申込情報をブロックし、特定の広告リクエストに対して配信候補とならないようにします。cust_params と組み合わせて使用します。


例:

&custom_params=excl_cat
%3Dairline_excl_label%7C

任意

scor

(動画ストリームの固有の番号)

動画ストリームごとに生成される整数。この数字は、ストリーム内で同一であり、かつページビュー内で固有である必要があります。ユーザーが同じページで複数の動画を再生する場合に、競合相手の除外、フリークエンシー キャップ、関連機能に使用されます。


例:

scor=17

競合相手の除外やフリークエンシー キャップ、関連機能を正常に動作させるには、このパラメータを渡す必要があります。

sid

(セッション ID)

フリークエンシー キャップの目的でのみ使用できる、プライバシーに配慮した広告 ID です。IAB の IFA ガイドラインで規定されているとおり、このパラメータは UUID 形式で指定する必要があります。詳細

セッション ID を渡さないようにするには、sid=0 を設定します。


例:

123e4567-e89b-12d3-a456-426614174000

リクエストに PPID や他のユーザー ID(CTV / OTT では通常 RDID)が含まれていない場合、またはユーザーに対して「広告トラッキング制限(LAT)」が有効になっている(is_lat=1)場合、CTV / OTT プラットフォームで競合相手の除外やフリークエンシー キャップ、その他関連機能を動作させるには、このパラメータを渡す必要があります。

vad_type

(リニア広告またはノンリニア広告)

リクエストに対して返す広告が、リニア広告であるかノンリニア広告であるかを示します。


例:

vad_type=linear
vad_type=nonlinear

任意

wta

(広告の表示について)

動画プレーヤーが「広告の表示について」の表示をサポートしているかどうかを示します。

IMA SDK を使用している場合、この表示は自動的にサポートされます。IMA SDK を使用していない場合は、IAB VAST 規格ドキュメントに沿って動画プレーヤーに VAST の IconIconClickFallbackImage のサポートを実装する必要があります。

このフィールドは、Ad Exchange を使用している場合は必須です。詳細

公開オークションの場合やコンパニオン スロットがない場合、オーディオ広告リクエストでは wta=0 を送信する必要があります。コンパニオン スロットがあり、オーディエンス ターゲティングを使用する広告主のすべてのキャンペーンで「広告の表示について」を表示するコンパニオンを配信している場合は、wta パラメータを省略するか、1 に設定できます。


例:

サポートしている場合:
1

サポートしていない場合:
0

Ad Exchange を使用している場合は、正確に設定する必要があります。