この記事では、デジタル屋外広告の実装で広告を配信するために使用される VAST 広告タグに必要なパラメータと推奨パラメータのリストを示します。
このページの内容
デジタル屋外広告の必須パラメータと推奨パラメータ
広告配信に必要なパラメータ
correlator（相関値）
説明
「相関値」パラメータ（correlator）には、同じページビューからの複数のリクエストに共有される変数値を設定します。競合相手の除外を実装するときに使用します。これには Cookie のない環境での実装も含まれます。
使用例
correlator=4345645667
要件と推奨事項
ウェブ、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告で広告配信を実装する場合、このパラメータは必須です。
SDK の使用
- IMA SDK を使用している場合、correlator 値は自動的に設定されます。プレーヤーによってこの値が設定されたとしても、IMA SDK によって独自の値で上書きされます。
- IMA SDK を使用していない場合は、複数のページビューで再利用されない、真にランダムな正の整数値を設定するようにしてください。
env（環境）
説明
「環境」パラメータ（env）には、インストリーム リクエスト、または特に動画プレーヤーからのリクエストであることを示す定数値を設定します。
有効な値は、動画広告とオーディオ広告に使用できる instream、または動画広告にのみ使用できる vp です。
使用例
動画、オーディオ、またはその両方:
env=instream
動画のみ:
env=vp
gdfp_req（スキーマ インジケータ）
説明
「Google アド マネージャーのスキーマ インジケータ」パラメータ（gdfp_req）には、広告リクエストが Google アド マネージャーの広告枠を対象としていることを示す定数値を設定します。
使用例
gdfp_req=1
iu（広告ユニット）
説明
「広告ユニット」パラメータ（iu）には、変数値を /network_code/.../ad_unit の形式で設定します。この値は、現在の広告ユニットに設定されます。
使用例
iu=/6062/videodemo
output（出力）
説明
出力形式パラメータ（output）には、広告の出力形式を示す定数値を指定します。
使用例
ネットワークのデフォルトの VAST バージョンを使用する:
output=vast
VAST 4 を使用する（特定のタグに特定のバージョンを設定できます）:
output=xml_vast4
ネットワークのデフォルトの VMAP 設定を使用する:
output=vmap
VMAP 1 を使用する:
output=xml_vmap1
VMAP 1 を使用して VAST 4 を返す（VMAP 内部で VAST を返す場合）:
output=xml_vmap1_vast4
要件と推奨事項
ウェブ、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告で広告配信を実装する場合、このパラメータは必須です。正しい広告配信レスポンス形式を出力する必要があります。
SDK の使用
VAST については、動画プレーヤーで IMA SDK を使用している場合、動画広告リクエストの output パラメータは常に output=xml_vast4 に設定されます。IMA SDK は第三者広告サーバーが配信するすべての VAST バージョンと下位互換性があるため、信頼性に関する問題が発生することはありません。
sz（サイズ）
説明
サイズ（sz）パラメータには、マスター動画広告スロットのサイズを示す変数値を設定します。
複数のサイズを指定する場合は、パイプ文字（|）で区切ります。
サイズの末尾に「v」を付けないでください。
使用例
1 つのサイズを指定する場合:sz=400x300
複数のサイズを指定する場合:sz=300x250|400x300
要件と推奨事項
ウェブ、モバイルアプリ、コネクテッド テレビ、デジタル屋外広告で広告配信を実装する場合、このパラメータは必須です。
ad_type=audio のみをリクエストする場合は省略できます。
url（URL）
説明
URL（url）パラメータには、リクエスト送信元の完全な URL を示す変数値を設定します。この値は、リクエストがどこから送信されているかを購入者が把握するために必要となります。可能な限り、この値は広告リクエストに動的に含めるようにしてください。
- ウェブの場合は、動画プレーヤーを表示しているページの URL を指定します。
- ウェブ以外の環境の場合は、収益化する動画またはオーディオ広告枠を最も正確に表す URL を指定する必要があります。たとえば、ユーザーがモバイルアプリで視聴している動画をデスクトップでも視聴できる場合は、その動画の URL を指定します*。
注: url は広告リクエストが行われた場所を指すのに対し、description_url は動画の内容を説明しているウェブクロール可能なページを指すという点で、url と description_url は異なります。
このパラメータの値はエンコードする必要があります。
使用例
url=https%3A%2F%2Fwww.example.com%2Fvideo.html
* アプリ環境でこのパラメータに変数の URL 値を設定できない場合は、次の形式を使用することをおすすめします。url=https%3A%2F%2F<app/bundleid>.example.com
要件と推奨事項
ウェブ、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告で広告配信を実装する場合、このパラメータは必須です。
SDK の使用
IMA SDK を使用している場合は、URL 値が自動的に設定されます。プレーヤーで値が設定された場合、IMA SDK では設定された値が優先されます。
vpmute（動画のミュート再生）
説明
ミュート時の動画再生（vpmute）パラメータには、動画プレーヤーがミュートされているときに広告の再生を開始するかどうかを示す定数値を設定します。このパラメータは動画プレーヤーの状態を変更するものではなく、再生処理は動画プレーヤーで直接行う必要があります。
使用例
ミュートされているときに再生する場合:
vpmute=1
ミュートが解除されているときに再生する場合:
vpmute=0
要件と推奨事項
ウェブ、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告でプログラマティックな収益化を行う場合、このパラメータは必須です。
このパラメータは、Media Rating Council（MRC）の動画測定ガイドラインでも推奨されています。
プログラマティックに必要なパラメータ
idtype（デバイスの種類）
説明
リセット可能なデバイス識別子（rdid、idtype、is_lat）パラメータには、変数値を設定します。この値は広告識別子（IFA）とも呼ばれます。
Android または iOS 向け IMA SDK を使用しているモバイルアプリでは、IMA SDK によって、ユーザー ターゲティングに使用できるリセット可能なデバイス識別子が rdid、idtype、is_lat のパラメータとともにストリーム リクエストに渡されます。
IMA SDK を使用していない場合、またはサーバーサイド ビーコン処理（SSB）を使用している場合は、これらのパラメータを明示的に渡す必要があります。詳しくは、デバイス識別子に関する説明をご覧ください。
これらの値は、ほぼすべてのプログラマティック動画広告の配信で必要となります。
|
iOS 14.5 以降、Apple は |
使用例
リセット可能なデバイス識別子の詳細な例をご確認ください。
要件と推奨事項
これらのパラメータが広告の配信に必要となる実装タイプはありませんが、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告でプログラマティックな収益化を行う場合は必須です。
ウェブの実装環境では、リセット可能なデバイス識別子は使用されません。
SDK の使用
IMA SDK ではこのフィールドは自動的に渡されますが、PAL SDK を使用している場合は手動でこれらのパラメータを渡します。
is_lat（広告トラッキングを制限）
説明
リセット可能なデバイス識別子（rdid、idtype、is_lat）パラメータには、変数値を設定します。この値は広告識別子（IFA）とも呼ばれます。
Android または iOS 向け IMA SDK を使用しているモバイルアプリでは、IMA SDK によって、ユーザー ターゲティングに使用できるリセット可能なデバイス識別子が rdid、idtype、is_lat のパラメータとともにストリーム リクエストに渡されます。
IMA SDK を使用していない場合、またはサーバーサイド ビーコン処理（SSB）を使用している場合は、これらのパラメータを明示的に渡す必要があります。詳しくは、デバイス識別子に関する説明をご覧ください。
これらの値は、ほぼすべてのプログラマティック動画広告の配信で必要となります。
|
iOS 14.5 以降、Apple は |
使用例
リセット可能なデバイス識別子の詳細な例をご確認ください。
要件と推奨事項
これらのパラメータが広告の配信に必要となる実装タイプはありませんが、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告でプログラマティックな収益化を行う場合は必須です。
ウェブの実装環境では、リセット可能なデバイス識別子は使用されません。
SDK の使用
IMA SDK ではこのフィールドは自動的に渡されますが、PAL SDK を使用している場合は手動でこれらのパラメータを渡します。
plcmt（プレースメント）
説明
プレースメント パラメータ（plcmt）には、IAB 仕様のガイダンスにあるとおり、インストリーム広告枠を「インストリーム」または「不随」として宣言するかどうかを示す定数値を指定します。
インストリーム以外のリクエストでは、宣言された広告枠のフォーマットに基づいて購入者に自動入力され、インストリームまたは付随する宣言がある場合はオーバーライドされます。
使用例
インストリームのリクエスト:
plcmt=1
付随するコンテンツのリクエスト:
plcmt=2
rdid（リセット可能なデバイス識別子）
説明
リセット可能なデバイス識別子（rdid、idtype、is_lat）パラメータには、変数値を設定します。この値は広告識別子（IFA）とも呼ばれます。
Android または iOS 向け IMA SDK を使用しているモバイルアプリでは、IMA SDK によって、ユーザー ターゲティングに使用できるリセット可能なデバイス識別子が rdid、idtype、is_lat のパラメータとともにストリーム リクエストに渡されます。
IMA SDK を使用していない場合、またはサーバーサイド ビーコン処理（SSB）を使用している場合は、これらのパラメータを明示的に渡す必要があります。詳しくは、デバイス識別子に関する説明をご覧ください。
これらの値は、ほぼすべてのプログラマティック動画広告の配信で必要となります。
|
iOS 14.5 以降、Apple は |
使用例
リセット可能なデバイス識別子の詳細な例をご確認ください。
要件と推奨事項
これらのパラメータが広告の配信に必要となる実装タイプはありませんが、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告でプログラマティックな収益化を行う場合は必須です。
ウェブの実装環境では、リセット可能なデバイス識別子は使用されません。
SDK の使用
IMA SDK ではこのフィールドは自動的に渡されますが、PAL SDK を使用している場合は手動でこれらのパラメータを渡します。
sid（セッション ID）
説明
セッション ID（sid）パラメータには、フリークエンシー キャップにのみ使用できる、プライバシーに配慮した広告 ID の変数値を設定します。
セッション ID は、コネクテッド テレビのインストリーム動画リクエストと、モバイルアプリ デバイスのインストリーム動画広告枠でサポートされています。現在のところ、ウェブではサポートされていません。
セッション ID を渡さないようにするには、sid=0 を設定します。
使用例
sid=123e4567-e89b-12d3-a456-426614174000
IAB の IFA ガイドラインで規定されているとおり、このパラメータは UUID 形式で指定する必要があります。詳しくは、ユーザー ターゲティングで使用できるリセット可能なデバイス識別子についての説明をご覧ください。
要件と推奨事項
このパラメータが広告の配信に必要となる実装タイプはありませんが、デジタル屋外広告でプログラマティックな収益化を行う場合は必須です。
モバイルアプリ、コネクテッド テレビ、オーディオでプログラマティックな収益化を行う場合、このパラメータは推奨されます。
SDK の使用
このパラメータは IMA SDK によって自動的に送信されます。
venuetype（施設の種類）
説明
施設タイプ（venuetype）パラメータは、屋外の施設タイプを示すために使用されます。値には、IAB OpenOOH 施設タイプの 1.1 の分類でサポートされている整数列挙の ID を使用できます。
使用例
ホテルの客室の場合:
venuetype=80703
タクシーの後部座席にあるタブレットの場合:
venuetype=103
プログラマティックに推奨されるパラメータ
aconp（オーディオの連続再生）
説明
「音声の連続再生」パラメータ（aconp）には、プレーヤーがオーディオ コンテンツを連続再生するかどうかを示す定数値を指定します。これにより、Google アド マネージャーでユーザー エクスペリエンスに最適な広告が選択されます。
使用例
連続再生オン:
aconp=2
連続再生オフ:
aconp=1
音声が連続再生されるかどうかわからない場合は、このパラメータを未設定のままにするか、aconp=0 に設定します。
要件と推奨事項
このパラメータが広告配信に必須となる実装タイプはありませんが、ウェブ、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告でプログラマティック収益化を行う場合は推奨されます。
このパラメータは、Media Rating Council（MRC）の音声測定ガイドラインでも推奨されています。
説明
アプリ ID パラメータ（msid）とアプリ名パラメータ（an）には、変数値を指定します。ほとんどのプログラマティック動画広告で必須のため、モバイルアプリとコネクテッド テレビ デバイスから送信するリクエストには、これらのパラメータを適用する必要があります。
iOS と tvOS ではアプリ名を人間が読める形式にする必要がある一方、IMA SDK はアプリ ID にアクセスできません。この場合、IMA SDK から msid パラメータは送信されず、アプリバンドルが an パラメータ経由で送信されます。
使用例
msid=com.package.publisher&an=sample%20app
アプリ ID の名前と形式は、アプリストアによって異なります。アプリの識別に関する IAB ガイドラインまたは一般的な一意の識別子の例をご覧ください。
アプリストアが存在しないプラットフォームの場合、IAB はストア ID として com.publisher.deviceplatform の形式を使用することを推奨しています。
要件と推奨事項
広告配信にこのパラメータが必要となる実装タイプはありませんが、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告でのプログラマティック収益化には推奨されます。
ブランド保護と購入者への透明性の確保のため、アプリ情報の提供を強くおすすめします。
SDK の使用
IMA SDK を使用する場合はこれらのパラメータが自動的に入力されますが、非 SDK 環境（VAST を直接呼び出す場合など）や、Programmatic Access Library（PAL）またはパブリッシャー認証済み広告枠（PAI）を使用する場合は手動で指定する必要があります。
注: HTML5 IMA SDK を使用している場合、アプリ情報は使用されません。
dth（デバイスの種類のヒント）
説明
「デバイスタイプのヒント」パラメータ（dth）には、特にコネクテッド テレビやセットトップ ボックス環境でデバイスの分類ミスを減らすのに役立つ定数値を設定します。
デバイスの分類ミスは、パブリッシャーまたはコネクテッド テレビの OEM 側での意図しないエラーが原因で発生することがあります。このパラメータは、コネクテッド テレビの広告枠が再分類される可能性のあるインスタンスを Google が自動的に報告できるように、他のシグナルと組み合わせて使用されます。
使用例
リクエスト元:
- フィーチャー フォン:
dth=1 - スマートフォン:
dth=2 - パソコン:
dth=3 - タブレット:
dth=4 - コネクテッド テレビ:
dth=5 - ゲーム機:
dth=6 - セットトップ ボックス:
dth=7
要件と推奨事項
このパラメータが広告配信に必須となる実装タイプはありませんが、ウェブ、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告でプログラマティック収益化を行う場合は推奨されます。
SDK の使用
このパラメータは、PAL および PAI（SDK 以外）実装で推奨されます。IMA SDK、DAI SDK では必要ありません。
givn（動画ノンス）
説明
Programmatic Access Library（PAL）を使用する統合の場合、video nonce パラメータには変数の文字列値を指定します。
ノンスは URL セーフです。URL エンコードする必要はありません。
注: 以前に従来の paln パラメータを使用してノンスを指定していた場合は、givn パラメータに移行して paln の送信を停止することを強くおすすめします。両方のパラメータを指定しないでください。
使用例
このパラメータに渡される値の詳細については、PAL のスタートガイドをご覧ください。
hl（言語）
説明
「言語」パラメータ（hl）には、定数値を設定します。特定の言語の広告をリクエストしたり、広告を選択する際や、ダイナミック アロケーションで Ad Exchange または AdSense の動画広告をレンダリングする際の言語を指定したりするために使用します。
使用例
イタリア語の広告をリクエスト:
hl=it
ISO 639-1（2 文字）または ISO 639-2（3 文字）のコードを使用できます。詳しくは、有効なコードのリストをご参照ください。
省略した場合は、Ad Exchange の言語による広告のターゲティングで指定された言語のいずれかがデフォルトで使用されます。
要件と推奨事項
このパラメータが広告配信に必須となる実装タイプはありませんが、ウェブ、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告でプログラマティック収益化を行う場合は推奨されます。
msid（アプリ ID）
説明
アプリ ID パラメータ（msid）とアプリ名パラメータ（an）には、変数値を指定します。ほとんどのプログラマティック動画広告で必須のため、モバイルアプリとコネクテッド テレビ デバイスから送信するリクエストには、これらのパラメータを適用する必要があります。
iOS と tvOS ではアプリ名を人間が読める形式にする必要がある一方、IMA SDK はアプリ ID にアクセスできません。この場合、IMA SDK から msid パラメータは送信されず、アプリバンドルが an パラメータ経由で送信されます。
使用例
msid=com.package.publisher&an=sample%20app
アプリ ID の名前と形式は、アプリストアによって異なります。アプリの識別に関する IAB ガイドラインまたは一般的な一意の識別子の例をご覧ください。
アプリストアが存在しないプラットフォームの場合、IAB はストア ID として com.publisher.deviceplatform の形式を使用することを推奨しています。
要件と推奨事項
広告配信にこのパラメータが必要となる実装タイプはありませんが、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告でのプログラマティック収益化には推奨されます。
ブランド保護と購入者への透明性の確保のため、アプリ情報の提供を強くおすすめします。
SDK の使用
IMA SDK を使用する場合はこれらのパラメータが自動的に入力されますが、非 SDK 環境（VAST を直接呼び出す場合など）や、Programmatic Access Library（PAL）またはパブリッシャー認証済み広告枠（PAI）を使用する場合は手動で指定する必要があります。
注: HTML5 IMA SDK を使用している場合、アプリ情報は使用されません。
omid_p（OMID パートナー名）
説明
OMID パートナー名パラメータ（omid_p）には、OMID 測定を統合するパートナーの名前とパートナー バージョンを示す変数値を指定します。
サポートされている SDK API パラメータ（sdk_apis）には、サポートされている API の単一の値またはカンマ区切りのリストの変数値を指定します。
これらのパラメータは、視認性と広告の検証に使用される一連のパラメータの一部です。
使用例
PAL を使用しない場合:
omid_p=examplepartnername/1.0.0.0&sdk_apis=7
API フレームワークの値のリストをご確認ください。
PAL を使用する場合:
request.omidPartnerName = 'examplepartnername'
request.omidPartnerVersion = '1.0.0.0'
要件と推奨事項
広告配信にこのパラメータが必要となる実装タイプはありませんが、ウェブ、モバイルアプリ、コネクテッド テレビ、オーディオ、デジタル屋外広告のプログラマティック収益化には推奨されます。
SDK の使用
- このパラメータは、Open Measurement SDK（OM SDK）の使用時にアクティブ ビューの測定を必要とするパブリッシャーにのみ適用されます。
- Programmatic Access Library（PAL）の使用時に OMID のサポートを指定するには、
omidPartnerNameとomidPartnerVersionを使用してパートナーの名前とバージョンを設定する必要があります。PAL または IMA SDK を使用しない場合は、omid_pパラメータとsdk_apisパラメータを設定する必要があります。 - IMA SDK を使用するときは自動的に設定されるため、使用しないでください。