このリファレンスでは、TypeScript の記法を使用して型を記述しています。次の表に、例を示して簡単に説明します。
式を入力する | |
---|---|
string |
プリミティブ文字列型。 |
string[] |
値が文字列のみの配列型。 |
number | string |
値が数値または文字列のいずれかになるユニオン型。 |
Array<number | string> |
値が複合型(共用体型)の配列型。 |
[number, string] |
タプル型。値は 2 要素の配列で、数値と文字列を順番に含める必要があります。 |
Slot |
オブジェクト型。値は googletag.Slot のインスタンスです。 |
() => void |
定義された引数と戻り値のない関数型。 |
サポートされている型と型式の詳細については、 TypeScript ハンドブック をご覧ください。
型アノテーション
変数名、パラメータ名、プロパティ名、関数シグネチャの後のコロンは、型アノテーションを表します。型アノテーションは、コロン左側の要素が受け入れまたは返すことができる型を記述します。次の表に、このリファレンスで説明する型アノテーションの例を示します。
型アノテーション | |
---|---|
param: string |
param が文字列値を受け取るか返すことを示します。この構文は、変数、パラメータ、プロパティ、戻り値の型に使用されます。 |
param?: number | string |
param は省略可能ですが、指定する場合は数値または文字列を指定できます。この構文は、パラメータとプロパティに使用されます。 |
...params: Array<() => void> |
params が関数を受け入れる
残りパラメータ
であることを示します。残りのパラメータは、指定された型の値を無制限に受け入れます。 |
googletag
名前空間 | |
---|---|
config | ページレベルの設定のメイン構成インターフェース。 |
enums | これは、GPT が列挙型に使用する名前空間です。 |
events | これは、GPT がイベントに使用する Namespace です。 |
secure | これは、GPT がセキュア シグナルの管理に使用する名前空間です。 |
インターフェース | |
---|---|
Command | コマンド アレイは、一連の関数を受け取り、順番に呼び出します。 |
Companion | コンパニオン広告サービス。 |
Privacy | プライバシー設定の構成オブジェクト。 |
Pub | パブリッシャー広告サービス。 |
Response | 1 つの広告レスポンスを表すオブジェクト。 |
Rewarded | リワード広告に関連付けられた報酬を表すオブジェクト。 |
Safe | SafeFrame コンテナの設定オブジェクト。 |
Service | すべてのサービスに共通するメソッドを含むベース サービス クラス。 |
Size | サイズ マッピング仕様オブジェクトのビルダー。 |
Slot | Slot は、ページ上の 1 つの広告スロットを表すオブジェクトです。 |
型エイリアス | |
---|---|
General | スロットの有効なサイズ構成。1 つ以上のサイズにできます。 |
Multi | 有効な単一サイズのリスト。 |
Named | スロットに設定できる名前付きサイズ。 |
Single | スロットに対して有効なサイズを 1 つ指定します。 |
Single | [width, height] を表す 2 つの数値の配列。 |
Size | ビューポートのサイズと広告サイズのマッピング。 |
Size | サイズ マッピングのリスト。 |
変数 | |
---|---|
api | GPT API が読み込まれ、呼び出しの準備が整っていることを示すフラグ。 |
cmd | GPT 関連の呼び出しを非同期で実行するためのグローバル コマンドキューへの参照。 |
pubads | PubAdsService が有効で、読み込まれ、完全に動作していることを示すフラグ。 |
secure | セキュア シグナル プロバイダの配列への参照。 |
関数 | |
---|---|
companion | CompanionAdsService への参照を返します。 |
define | 指定した広告ユニットパスでページ外広告スロットを作成します。 |
define | 指定された広告ユニットのパスとサイズで広告スロットを作成し、広告を表示するページ上の div 要素の ID に関連付けます。 |
destroy | 指定されたスロットを破棄し、それらのスロットに関連するすべてのオブジェクトと参照を GPT から削除します。 |
disable | Google パブリッシャー コンソールを無効にします。 |
display | スロットをレンダリングするようにスロット サービスに指示します。 |
enable | ページ上の広告スロットに定義されているすべての GPT サービスを有効にします。 |
get | GPT の現在のバージョンを返します。 |
open | Google パブリッシャー コンソールが開きます。 |
pubads | PubAdsService への参照を返します。 |
set | PubAdsService によって作成されるすべての広告コンテナ iframe のタイトルを、この時点から設定します。 |
set | ページの一般的な構成オプションを設定します。 |
size | 新しい SizeMappingBuilder を作成します。 |
型エイリアス
GeneralSize
GeneralSize: SingleSize | MultiSize
スロットの有効なサイズ構成。1 つ以上のサイズにできます。
MultiSize
MultiSize: SingleSize[]
有効な単一サイズのリスト。
NamedSize
- フルード: 広告コンテナは親 div の幅の 100% を占有し、クリエイティブ コンテンツに合わせて高さを変更します。ページ上の通常のブロック要素の動作に似ています。ネイティブ広告に使用されます(関連記事を参照)。
fluid
と['fluid']
はどちらも、スロットサイズをフレキシブルとして宣言するための有効な形式です。
NamedSize: "fluid" | ["fluid"]
スロットに設定できる名前付きサイズ。ほとんどの場合、サイズは固定サイズの長方形ですが、他の種類のサイズ指定が必要な場合もあります。有効な名前付きサイズは次のとおりです。
SingleSize
SingleSize: SingleSizeArray | NamedSize
スロットに対して有効なサイズを 1 つ指定します。
SingleSizeArray
SingleSizeArray: [number, number]
[width, height] を表す 2 つの数値の配列。
SizeMapping
SizeMapping: [SingleSizeArray, GeneralSize]
ビューポートのサイズと広告サイズのマッピング。レスポンシブ広告に使用されます。
SizeMappingArray
SizeMappingArray: SizeMapping[]
サイズ マッピングのリスト。
変数
Const
apiReady
apiReady: boolean | undefined
GPT API が読み込まれ、呼び出しの準備ができていることを示すフラグ。このプロパティは、API の準備が整うまで単に undefined
になります。
非同期処理を処理する推奨の方法は、googletag.cmd を使用して、GPT の準備が整うまでコールバックをキューに入れることです。これらのコールバックは、API が設定されると必ず実行されるため、googletag.apiReady を確認する必要はありません。
Const
cmd
- 例
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript(従来版)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
cmd: ((this: typeof globalThis) => void)[] | CommandArray
GPT 関連の呼び出しを非同期で実行するためのグローバル コマンドキューへの参照。googletag.cmd
変数は、ページの GPT タグの構文によって空の JavaScript 配列に初期化されます。cmd.push
は、配列の末尾に要素を追加する標準の Array.push
メソッドです。GPT JavaScript が読み込まれると、配列が検索され、すべての関数が順番に実行されます。スクリプトは、cmd
を CommandArray オブジェクトに置き換えます。このオブジェクトの push メソッドは、渡された関数引数を実行するように定義されています。このメカニズムにより、ブラウザがページのレンダリングを続行できるようにしながら、JavaScript を非同期で取得することで、GPT は認識されるレイテンシを短縮できます。
Const
pubadsReady
pubadsReady: boolean | undefined
PubAdsService が有効で、読み込まれ、完全に動作していることを示すフラグ。enableServices が呼び出され、PubAdsService が読み込まれて初期化されるまで、このプロパティは単なる undefined
になります。
secureSignalProviders
- 例
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript(従来版)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
セキュア シグナル プロバイダ配列への参照。
セキュア シグナル プロバイダ配列は、シグナル生成関数のシーケンスを受け入れ、順番に呼び出します。これは、GPT の読み込み後に呼び出されるシグナル生成関数をキューに追加するために使用される標準配列に代わるものです。
関数
companionAds
companionAds(): CompanionAdsService
CompanionAdsService への参照を返します。
戻り値 | |
---|---|
CompanionAdsService | コンパニオン広告サービス。 |
defineOutOfPageSlot
- 例
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript(従来版)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
指定した広告ユニットパスでページ外広告スロットを作成します。
カスタム ページ外広告の場合、div
は広告を表示する div 要素の ID です。詳しくは、ページ外クリエイティブに関する記事をご覧ください。
GPT で管理されるページ外広告の場合、div
はサポートされている OutOfPageFormat です。
パラメータ | |
---|---|
adUnitPath: string | ネットワーク コードと広告ユニットコードを含む完全な広告ユニットのパス。 |
| この広告ユニットまたは OutOfPageFormat が含まれる div の ID。 |
戻り値 | |
---|---|
Slot | null | 新しく作成されたスロット。スロットを作成できない場合は null です。 |
defineSlot
- 例
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript(従来版)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
指定された広告ユニットのパスとサイズで広告スロットを作成し、広告を表示するページ上の div 要素の ID に関連付けます。
パラメータ | |
---|---|
adUnitPath: string | ネットワーク コードとユニット コードを含む完全な広告ユニットのパス。 |
size: GeneralSize | 追加されたスロットの幅と高さ。これは、レスポンシブ サイズ マッピングが指定されていない場合や、ビューポートのサイズがマッピングで指定された最小サイズより小さい場合に、広告リクエストで使用されるサイズです。 |
| この広告ユニットを含む div の ID。 |
戻り値 | |
---|---|
Slot | null | 新しく作成されたスロット。スロットを作成できない場合は null です。 |
destroySlots
- 例
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript(従来版)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
TypeScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
destroySlots(slots?: Slot[]): boolean
指定されたスロットを破棄し、それらのスロットに関連するすべてのオブジェクトと参照を GPT から削除します。この API は、パスバック スロットとコンパニオン スロットをサポートしていません。
スロットでこの API を呼び出すと、広告が消去され、GPT によって維持される内部状態からスロット オブジェクトが削除されます。スロット オブジェクトでこれ以上関数を呼び出すと、未定義の動作が発生します。ただし、そのスロットへの参照がパブリッシャー ページによって維持されている場合、ブラウザはスロットに関連付けられたメモリを解放しないことがあります。この API を呼び出すと、そのスロットに関連付けられている div を再利用できるようになります。
特に、スロットを破棄すると、GPT の長時間のページビューから広告が削除されるため、今後のリクエストはこの広告に関連するロードブロックや競合排除の影響を受けなくなります。ページからスロットの div を削除する前にこの関数を呼び出さないと、未定義の動作が発生します。
パラメータ | |
---|---|
| 破棄するスロットの配列。配列は省略可能です。指定しない場合、すべてのスロットが破棄されます。 |
戻り値 | |
---|---|
boolean | スロットが破棄されている場合は true 、それ以外の場合は false 。 |
disablePublisherConsole
ディスプレイ
display(divOrSlot: string | Element | Slot): void
スロットをレンダリングするようにスロット サービスに指示します。各広告スロットはページごとに 1 回だけ表示する必要があります。すべてのスロットを定義し、サービスが関連付けられている状態で、初めて表示されます。要素が DOM に存在するまで、表示の呼び出しが行われないようにする必要があります。通常は、メソッド呼び出しで指定した名前の div 要素内のスクリプト ブロック内に配置します。
シングル リクエスト アーキテクチャ(SRA)を使用している場合、このメソッドが呼び出された時点でフェッチされていない広告スロットはすべて一度にフェッチされます。広告スロットを強制的に非表示にするには、div 全体を削除する必要があります。
パラメータ | |
---|---|
divOrSlot: string | Element | Slot | 広告スロットを含む div 要素の ID、div 要素、またはスロット オブジェクト。div 要素を指定する場合は、defineSlot に渡された ID と一致する id 属性を指定する必要があります。 |
enableServices
getVersion
openConsole
- 例
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript(従来版)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
openConsole(div?: string): void
Google パブリッシャー コンソールが開きます。
パラメータ | |
---|---|
| 広告スロットの div ID。この値は省略可能です。指定された広告スロットの詳細が表示された状態でパブリッシャー コンソールが開きます。 |
pubads
pubads(): PubAdsService
PubAdsService への参照を返します。
戻り値 | |
---|---|
PubAdsService | パブリッシャー広告サービス。 |
setAdIframeTitle
- 例
JavaScript
googletag.setAdIframeTitle("title");
JavaScript(従来版)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
setAdIframeTitle(title: string): void
PubAdsService によって作成されるすべての広告コンテナ iframe のタイトルを、この時点から設定します。
パラメータ | |
---|---|
title: string | すべての広告コンテナ iframe の新しいタイトル。 |
setConfig
setConfig(config: PageSettingsConfig): void
ページの一般的な構成オプションを設定します。
パラメータ | |
---|---|
config: PageSettingsConfig |
sizeMapping
- 関連情報
sizeMapping(): SizeMappingBuilder
新しい SizeMappingBuilder を作成します。
戻り値 | |
---|---|
SizeMappingBuilder | 新しいビルダー。 |
googletag.CommandArray
メソッド | |
---|---|
push | 引数で指定された関数のシーケンスを順番に実行します。 |
メソッド
push
- 例
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript(従来版)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
push(...f: ((this: typeof globalThis) => void)[]): number
引数で指定された関数のシーケンスを順番に実行します。
パラメータ | |
---|---|
| 実行する JavaScript 関数。ランタイム バインディングは常に globalThis になります。アロー関数を渡して、囲んでいるレキシカル コンテキストの this 値を保持することを検討してください。 |
戻り値 | |
---|---|
number | これまでに処理されたコマンド数。これは、Array.push の戻り値(配列の現在の長さ)と互換性があります。 |
googletag.CompanionAdsService
Service
を拡張メソッド | |
---|---|
add | ページで特定の GPT イベントが発生したときに JavaScript 関数を設定および呼び出すことができるリスナーを登録します。
|
get | このサービスに関連付けられているスロットのリストを取得します。
|
remove | 以前に登録されたリスナーを削除します。
|
set | 埋められなかったコンパニオン スロットを自動的にバックフィルするかどうかを設定します。 |
メソッド
setRefreshUnfilledSlots
- 例
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript(従来版)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
setRefreshUnfilledSlots(value: boolean): void
埋められなかったコンパニオン スロットを自動的にバックフィルするかどうかを設定します。
このメソッドは、ページの有効期間中に複数回呼び出して、バックフィルをオンまたはオフにできます。バックフィルされるのは、PubAdsService にも登録されているスロットのみです。ポリシー上の制限により、この方法は、Ad Exchange 動画が配信されたときに空のコンパニオン スロットを埋めるようには設計されていません。
パラメータ | |
---|---|
value: boolean | true : 未使用のスロットを自動的にバックフィルします。false : 未使用のスロットを変更しません。 |
googletag.PrivacySettingsConfig
プロパティ | |
---|---|
child | ページを子供向けコンテンツとして扱う必要があるかどうかを示します。 |
limited | パブリッシャーの規制遵守ニーズをサポートするため、配信を制限付き広告モードで実行できるようにします。 |
non | パブリッシャーの規制遵守ニーズをサポートするため、配信を非パーソナライズド広告 モードで実行できるようにします。 |
restrict | 配信を制限付き処理モードで実行できるようにし、パブリッシャーの規制コンプライアンス要件をサポートします。 |
traffic | リクエストが購入済みトラフィックか自然検索トラフィックかを示す。 |
under | 広告リクエストを同意年齢に満たないユーザーからのリクエストとしてマークするかどうかを指定します。 |
- 関連情報
プロパティ
Optional
childDirectedTreatment
childDirectedTreatment?: null | boolean
ページを子供向けコンテンツとして扱うかどうかを示します。構成を消去するには、null
に設定します。
Optional
limitedAds
- IAB TCF v2.0 同意管理プラットフォームからのシグナルを使用して、自動的に。
- 手動で、このフィールドの値を
true
に設定します。 - 例
JavaScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
JavaScript(従来版)
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
TypeScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- 関連情報
limitedAds?: boolean
制限付き広告モードで配信を実行できるようにし、パブリッシャー様の規制遵守ニーズをサポートします。
制限付き広告をリクエストするよう GPT に指示するには、次の 2 つの方法があります。
CMP を使用している場合、制限付き広告を手動で有効にする必要はありません。
Optional
nonPersonalizedAds
nonPersonalizedAds?: boolean
パブリッシャーの規制遵守ニーズをサポートするため、配信を非パーソナライズド広告 モードで実行できるようにします。
Optional
restrictDataProcessing
restrictDataProcessing?: boolean
配信を制限付き処理モードで実行できるようにし、パブリッシャーの規制コンプライアンス要件をサポートします。
Optional
trafficSource
- 例
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript(従来版)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
TypeScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
trafficSource?: TrafficSource
リクエストが購入済みトラフィックか自然検索トラフィックかを示します。この値は、アド マネージャーのレポートの [トラフィック ソース] ディメンションに入力されます。設定されていない場合、レポートではトラフィック ソースがデフォルトで undefined
になります。
Optional
underAgeOfConsent
underAgeOfConsent?: null | boolean
広告リクエストを同意年齢に満たないユーザーからのリクエストとしてマークするかどうかを指定します。構成を消去するには、null
に設定します。
googletag.PubAdsService
Service
を拡張メソッド | |
---|---|
add | ページで特定の GPT イベントが発生したときに JavaScript 関数を設定および呼び出すことができるリスナーを登録します。
|
clear | 指定したスロットから広告を削除し、空白のコンテンツに置き換えます。 |
clear | ページレベルの広告カテゴリ除外ラベルをすべて消去します。 |
clear | 特定のキーまたはすべてのキーのカスタム ターゲティング パラメータを消去します。 |
collapse | スロット div の折りたたみを有効にして、表示する広告コンテンツがないときにページ上のスペースを占有しないようにします。 |
disable | ページの読み込み時に広告のリクエストを無効にしますが、PubAdsService.refresh 呼び出しで広告をリクエストできるようにします。 |
display | 指定された広告ユニットのパスとサイズで広告スロットを作成して表示します。 |
enable | 構成オブジェクトで定義されているように、GPT で遅延読み込みを有効にします。 |
enable | 複数の広告を同時に取得するための単一リクエスト モードを有効にします。 |
enable | ページに動画広告が表示されることを GPT に通知します。 |
get | 指定したキーに関連付けられた AdSense 属性の値を返します。 |
get | このサービスに設定されている属性キーを返します。 |
get | このサービスに関連付けられているスロットのリストを取得します。
|
get | 設定されている特定のカスタム サービスレベル ターゲティング パラメータを返します。 |
get | 設定されているすべてのカスタム サービスレベル ターゲティング キーのリストを返します。 |
is | 以前の PubAdsService.disableInitialLoad 呼び出しで広告の最初のリクエストが正常に無効にされたかどうかを返します。 |
refresh | ページ内の特定のスロットまたはすべてのスロットに対して新しい広告を取得して表示します。 |
remove | 以前に登録されたリスナーを削除します。
|
set | パブリッシャー広告サービス内のすべての広告スロットに適用される AdSense 属性の値を設定します。 |
set | 指定したラベル名に対してページレベルの広告カテゴリの除外を設定します。 |
set | 広告の水平方向の中央揃えを有効または無効にします。 |
set | ページ上のすべての広告を SafeFrame コンテナで強制的にレンダリングするかどうかを設定します。 |
set | ウェブサイトから位置情報を渡して、広告申込情報で特定の地域をターゲットに設定できるようにします。 |
set | 構成オブジェクトを使用して、単一の API からすべてのプライバシー設定を構成できます。 |
set | パブリッシャー提供の ID の値を設定します。 |
set | SafeFrame 構成のページレベルの設定を設定します。 |
set | 特定のキーのカスタム ターゲティング パラメータを設定し、パブリッシャー広告サービスのすべての広告スロットに適用します。 |
set | ターゲティングとコンテンツの除外のために、広告リクエストとともに送信される動画コンテンツ情報を設定します。 |
update | 広告リクエストとともに送信される相関値を変更し、実質的に新しいページビューを開始します。 |
メソッド
クリア
- 例
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript(従来版)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
clear(slots?: Slot[]): boolean
指定したスロットから広告を削除し、空白のコンテンツに置き換えます。スロットはフェッチされていないとマークされます。
特に、スロットを消去すると、GPT の長時間のページビューから広告が削除されるため、今後のリクエストはこの広告に関連するロードブロックや競合排除の影響を受けなくなります。
パラメータ | |
---|---|
| クリアするスロットの配列。配列は省略可能です。指定しない場合、すべてのスロットが消去されます。 |
戻り値 | |
---|---|
boolean | スロットがクリアされている場合は true 、それ以外の場合は false を返します。 |
clearCategoryExclusions
- 例
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript(従来版)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
clearCategoryExclusions(): PubAdsService
ページレベルの広告カテゴリ除外ラベルをすべて消去します。これは、スロットを更新する場合に便利です。
戻り値 | |
---|---|
PubAdsService | メソッドが呼び出されたサービス オブジェクト。 |
clearTargeting
- 例
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript(従来版)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
clearTargeting(key?: string): PubAdsService
特定のキーまたはすべてのキーのカスタム ターゲティング パラメータを消去します。
パラメータ | |
---|---|
| ターゲティング パラメータキー。このキーは省略可能です。指定しない場合、すべてのターゲティング パラメータがクリアされます。 |
戻り値 | |
---|---|
PubAdsService | メソッドが呼び出されたサービス オブジェクト。 |
collapseEmptyDivs
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
スロット div の折りたたみを有効にして、表示する広告コンテンツがないときにページ上のスペースを占有しないようにします。このモードは、サービスを有効にする前に設定する必要があります。
パラメータ | |
---|---|
| 広告の取得前にスロットを閉じるかどうか。このパラメータは省略可能です。指定しない場合、デフォルト値として false が使用されます。 |
戻り値 | |
---|---|
boolean | div 折りたたみモードが有効になっている場合は true が返され、サービスが有効になった後にメソッドが呼び出されるため、折りたたみモードを有効にできない場合は false が返されます。 |
disableInitialLoad
disableInitialLoad(): void
ページの読み込み時に広告のリクエストを無効にしますが、PubAdsService.refresh 呼び出しで広告をリクエストできるようにします。これは、サービスを有効にする前に設定する必要があります。非同期モードを使用する必要があります。使用しない場合、refresh
を使用して広告をリクエストすることはできません。
ディスプレイ
- 例
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript(従来版)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
指定された広告ユニットのパスとサイズで広告スロットを作成して表示します。このメソッドは、単一リクエスト モードでは機能しません。
注: このメソッドが呼び出されると、広告リクエストの送信とレスポンスのレンダリングの整合性を確保するために、スロット ステータスとページ ステータスのスナップショットが作成されます。このメソッドの呼び出し後にスロットまたはページの状態に加えた変更(ターゲティング、プライバシー設定、強制 SafeFrame など)は、後続の display()
リクエストまたは refresh()
リクエストにのみ適用されます。
パラメータ | |
---|---|
adUnitPath: string | レンダリングされるスロットの広告ユニットのパス。 |
size: GeneralSize | スロットの幅と高さ。 |
| スロットを含む div の ID または div 要素自体。 |
| このスロットで使用するクリック URL。 |
enableLazyLoad
- 例
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript(従来版)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
fetchMarginPercent
広告を取得する前にスロットが現在のビューポートから離れている必要がある最小距離(ビューポートのサイズの割合)。値 0 は「スロットがビューポートに入ったとき」、100 は「広告が 1 ビューポート離れたとき」などを意味します。renderMarginPercent
広告のレンダリングを開始する前に、スロットが現在のビューポートから離れている必要がある最小距離。これにより、広告をプリフェッチしながら、他のサブリソースのレンダリングとダウンロードを待機できます。この値は、ビューポートの割合としてfetchMarginPercent
と同じように機能します。mobileScaling
モバイル デバイスの余白に適用される乗数。これにより、モバイルとパソコンで異なる余白を設定できます。たとえば、値を 2.0 にすると、モバイル デバイスのすべてのマージンが 2 倍になり、取得とレンダリングの前にスロットを配置できる最小距離が長くなります。
enableLazyLoad(config?: {
fetchMarginPercent?: number;
mobileScaling?: number;
renderMarginPercent?: number;
}): void
構成オブジェクトで定義されているように、GPT で遅延読み込みを有効にします。詳細な例については、遅延読み込みのサンプルをご覧ください。
注: SRA での遅延フェッチは、すべてのスロットがフェッチ マージンの外側にある場合にのみ機能します。
パラメータ | |
---|---|
| 構成オブジェクトを使用すると、遅延処理の動作をカスタマイズできます。省略された構成には、Google が設定したデフォルトが使用され、時間の経過とともにチューニングされます。取得マージンなどの特定の設定を無効にするには、値を -1 に設定します。 |
enableSingleRequest
enableVideoAds
enableVideoAds(): void
ページに動画広告が表示されることを GPT に通知します。これにより、ディスプレイ広告と動画広告で競合の除外制約を適用できるようになります。動画コンテンツが判明している場合は、ディスプレイ広告でコンテンツの除外を使用できるように PubAdsService.setVideoContent を呼び出します。
get
- 例
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript(従来版)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- 関連情報
get(key: string): null | string
指定したキーに関連付けられた AdSense 属性の値を返します。
パラメータ | |
---|---|
key: string | 検索する属性の名前。 |
戻り値 | |
---|---|
null | string | 属性キーの現在の値。キーが存在しない場合は null です。 |
getAttributeKeys
- 例
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript(従来版)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
getAttributeKeys(): string[]
このサービスに設定されている属性キーを返します。
戻り値 | |
---|---|
string[] | このサービスに設定された属性キーの配列。順序は未定義です。 |
getTargeting
- 例
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript(従来版)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
getTargeting(key: string): string[]
設定されている特定のカスタム サービスレベル ターゲティング パラメータを返します。
パラメータ | |
---|---|
key: string | 検索するターゲティング キー。 |
戻り値 | |
---|---|
string[] | このキーに関連付けられた値。そのようなキーがない場合、空の配列。 |
getTargetingKeys
- 例
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
JavaScript(従来版)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
getTargetingKeys(): string[]
設定されているすべてのカスタム サービスレベル ターゲティング キーのリストを返します。
戻り値 | |
---|---|
string[] | ターゲティング キーの配列。順序は未定義です。 |
isInitialLoadDisabled
isInitialLoadDisabled(): boolean
以前の PubAdsService.disableInitialLoad 呼び出しで広告の最初のリクエストが正常に無効にされたかどうかを返します。
戻り値 | |
---|---|
boolean | PubAdsService.disableInitialLoad の以前の呼び出しが成功した場合は true を返し、それ以外の場合は false を返します。 |
更新
- 例
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript(従来版)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
changeCorrelator
広告の取得に新しいコレレータを生成するかどうかを指定します。Google の広告サーバーは、この correlator 値を短時間(現在は 30 秒間ですが、変更される可能性があります)保持します。これにより、同じ correlator 値を持つリクエストが短時間に受信された場合、それらは 1 つのページビューと見なされます。デフォルトでは、更新ごとに新しいコレレータが生成されます。
注: このオプションは、GPT の長時間のページビューには影響しません。長時間のページビューは、ページに現在表示されている広告を自動的に反映し、有効期限はありません。
refresh(slots?: null | Slot[], options?: {
changeCorrelator: boolean;
}): void
ページ内の特定のスロットまたはすべてのスロットに対して新しい広告を取得して表示します。非同期レンダリング モードでのみ機能します。
すべてのブラウザで適切に動作させるには、refresh
を呼び出す前に広告スロットの display
を呼び出す必要があります。display
の呼び出しを省略すると、更新が予期しない動作をする可能性があります。必要に応じて、PubAdsService.disableInitialLoad メソッドを使用して、display
が広告を取得しないようにできます。
スロットを更新すると、GPT の長時間のページビューから古い広告が削除されるため、今後のリクエストは、その広告に関連するロードブロックや競合排除の影響を受けなくなります。
パラメータ | |
---|---|
| 更新するスロット。配列は省略可能です。指定しない場合、すべてのスロットが更新されます。 |
| この更新呼び出しに関連付けられている構成オプション。 |
set
- 例
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript(従来版)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- 関連情報
set(key: string, value: string): PubAdsService
パブリッシャー広告サービス内のすべての広告スロットに適用される AdSense 属性の値を設定します。
同じキーに対してこの関数を複数回呼び出すと、そのキーに対して以前に設定された値がオーバーライドされます。display
または refresh
を呼び出す前に、すべての値を設定する必要があります。
パラメータ | |
---|---|
key: string | 属性名。 |
value: string | 属性値。 |
戻り値 | |
---|---|
PubAdsService | メソッドが呼び出されたサービス オブジェクト。 |
setCategoryExclusion
- 例
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript(従来版)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
setCategoryExclusion(categoryExclusion: string): PubAdsService
指定したラベル名に対してページレベルの広告カテゴリの除外を設定します。
パラメータ | |
---|---|
categoryExclusion: string | 追加する広告カテゴリ除外ラベル。 |
戻り値 | |
---|---|
PubAdsService | メソッドが呼び出されたサービス オブジェクト。 |
setCentering
- 例
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript(従来版)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
setCentering(centerAds: boolean): void
広告の水平方向の中央揃えを有効または無効にします。中央揃えはデフォルトで無効になっています。従来の gpt_mobile.js では、中央揃えがデフォルトで有効になっています。
このメソッドを呼び出した後にリクエストされた広告のみが中央揃えになるため、このメソッドは display
または refresh
の呼び出し前に呼び出す必要があります。
パラメータ | |
---|---|
centerAds: boolean | true は広告を中央に配置し、false は左揃えにします。 |
setForceSafeFrame
- この設定は、それぞれのスロットに対して行われた後続の広告リクエストにのみ適用されます。
- スロットレベルの設定が指定されている場合は、常にページレベルの設定がオーバーライドされます。
true
に設定した場合(スロット単位またはページ単位)、Google アド マネージャーの UI で選択した内容に関係なく、広告は常に SafeFrame コンテナを使用してレンダリングされます。- ただし、
false
に設定するか、指定しない場合は、クリエイティブのタイプと Google アド マネージャーの管理画面で選択した内容に応じて、SafeFrame コンテナを使用して広告がレンダリングされます。 - この API は、iframe から外部に移動しようとするクリエイティブや、パブリッシャーのページに直接レンダリングされることを前提とするクリエイティブの動作に影響する可能性があるため、慎重に使用してください。
- 例
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript(従来版)
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
ページ上のすべての広告を SafeFrame コンテナを使用して強制的にレンダリングするかどうかを設定します。
この API を使用する際は、次の点にご注意ください。
パラメータ | |
---|---|
forceSafeFrame: boolean | true は、ページ上のすべての広告を SafeFrame でレンダリングするように強制します。false は、前の設定を false に変更します。先ほど指定しなかった場合にこれを false に設定しても、何も変更されません。 |
戻り値 | |
---|---|
PubAdsService | 関数が呼び出されたサービス オブジェクト。 |
setLocation
- 例
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript(従来版)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
setLocation(address: string): PubAdsService
ウェブサイトから位置情報を渡して、広告申込情報で特定の地域をターゲットに設定できるようにします。
パラメータ | |
---|---|
address: string | 自由形式の住所。 |
戻り値 | |
---|---|
PubAdsService | メソッドが呼び出されたサービス オブジェクト。 |
setPrivacySettings
- 例
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript(従来版)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
TypeScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- 関連情報
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
構成オブジェクトを使用して、単一の API からすべてのプライバシー設定を構成できます。
パラメータ | |
---|---|
privacySettings: PrivacySettingsConfig | プライバシー設定の構成を含むオブジェクト。 |
戻り値 | |
---|---|
PubAdsService | 関数が呼び出されたサービス オブジェクト。 |
setPublisherProvidedId
- 例
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript(従来版)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
setPublisherProvidedId(ppid: string): PubAdsService
パブリッシャー提供の ID の値を設定します。
パラメータ | |
---|---|
ppid: string | パブリッシャーが指定する英数字の ID。32 ~ 150 文字で指定してください。 |
戻り値 | |
---|---|
PubAdsService | メソッドが呼び出されたサービス オブジェクト。 |
setSafeFrameConfig
- 例
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript(従来版)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
SafeFrame 構成のページレベルの設定を設定します。構成オブジェクト内の認識されないキーは無視されます。認識されたキーに無効な値が渡された場合、構成全体が無視されます。
これらのページレベルの設定は、指定されている場合はスロットレベルの設定によってオーバーライドされます。
パラメータ | |
---|---|
config: SafeFrameConfig | 構成オブジェクト。 |
戻り値 | |
---|---|
PubAdsService | メソッドが呼び出されたサービス オブジェクト。 |
setTargeting
- 例
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript(従来版)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
setTargeting(key: string, value: string | string[]): PubAdsService
特定のキーのカスタム ターゲティング パラメータを設定し、パブリッシャー広告サービスのすべての広告スロットに適用します。同じキーに対してこの関数を複数回呼び出すと、古い値が上書きされます。これらのキーは Google アド マネージャー アカウントで定義します。
パラメータ | |
---|---|
key: string | ターゲティング パラメータキー。 |
value: string | string[] | ターゲティング パラメータ値または値の配列。 |
戻り値 | |
---|---|
PubAdsService | メソッドが呼び出されたサービス オブジェクト。 |
setVideoContent
updateCorrelator
- 例
JavaScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
JavaScript(従来版)
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
TypeScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
updateCorrelator(): PubAdsService
広告リクエストとともに送信される相関値を変更し、実質的に新しいページビューを開始します。correlator 値は、1 つのページビューからのすべての広告リクエストで同じで、ページビューごとに固有です。非同期モードにのみ適用されます。
注: これは、GPT の長時間のページビューには影響しません。長時間のページビューは、ページに実際に表示されている広告を自動的に反映し、有効期限がありません。
戻り値 | |
---|---|
PubAdsService | 関数が呼び出されたサービス オブジェクト。 |
googletag.ResponseInformation
プロパティ | |
---|---|
advertiser | 広告主の ID。 |
campaign | キャンペーンの ID です。 |
creative | クリエイティブの ID。 |
creative | 広告のテンプレート ID。 |
line | 広告申込情報の ID。 |
プロパティ
advertiserId
advertiserId: null | number
広告主の ID。
campaignId
campaignId: null | number
キャンペーンの ID です。
creativeId
creativeId: null | number
クリエイティブの ID。
creativeTemplateId
creativeTemplateId: null | number
広告のテンプレート ID。
lineItemId
lineItemId: null | number
広告申込情報の ID。
googletag.RewardedPayload
プロパティ | |
---|---|
amount | 特典に含まれるアイテムの数。 |
type | 報酬に含まれるアイテムの種類(「コイン」など)。 |
- 関連情報
プロパティ
金額
amount: number
特典に含まれるアイテムの数。
type
type: string
報酬に含まれるアイテムの種類(「コイン」など)。
googletag.SafeFrameConfig
プロパティ | |
---|---|
allow | SafeFrame で、ページ コンテンツをオーバーレイして広告コンテンツを拡大できるようにするかどうか。 |
allow | SafeFrame でページ コンテンツを押し出して広告コンテンツを展開できるようにするかどうか。 |
sandbox | SafeFrame が HTML5 の sandbox 属性を使用して、ユーザー操作なしでトップレベル ナビゲーションを防ぐかどうか。 |
use | 非推奨。 SafeFrame が予約クリエイティブにランダムなサブドメインを使用するかどうか。 |
プロパティ
Optional
allowOverlayExpansion
allowOverlayExpansion?: boolean
SafeFrame で、ページ コンテンツをオーバーレイして広告コンテンツを展開できるようにするかどうか。
Optional
allowPushExpansion
allowPushExpansion?: boolean
SafeFrame でページ コンテンツを押し出して広告コンテンツを展開できるようにするかどうか。
Optional
サンドボックス
sandbox?: boolean
SafeFrame が HTML5 の sandbox 属性を使用して、ユーザー操作なしでトップレベル ナビゲーションを防ぐかどうか。有効な値は true
のみです(false
に強制することはできません)。サンドボックス属性は、プラグイン(Flash など)を無効にします。
Optional
useUniqueDomain
useUniqueDomain?: null | boolean
SafeFrame が予約クリエイティブにランダムなサブドメインを使用するかどうか。null
を渡して、保存された値を消去します。
注: この機能はデフォルトで有効になっています。
googletag.Service
メソッド | |
---|---|
add | ページで特定の GPT イベントが発生したときに JavaScript 関数を設定および呼び出すことができるリスナーを登録します。 |
get | このサービスに関連付けられているスロットのリストを取得します。 |
remove | 以前に登録されたリスナーを削除します。 |
メソッド
addEventListener
- events.GameManualInterstitialSlotClosedEvent
- events.GameManualInterstitialSlotReadyEvent
- events.ImpressionViewableEvent
- events.RewardedSlotClosedEvent
- events.RewardedSlotGrantedEvent
- events.RewardedSlotReadyEvent
- events.SlotOnloadEvent
- events.SlotRenderEndedEvent
- events.SlotRequestedEvent
- events.SlotResponseReceived
- events.SlotVisibilityChangedEvent
- 例
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
- 関連情報
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service
ページで特定の GPT イベントが発生したときに JavaScript 関数を設定および呼び出すことができるリスナーを登録します。サポートされているイベントは次のとおりです。
パラメータ | |
---|---|
eventType: K | GPT によって生成されたイベントのタイプを表す文字列。イベントタイプでは大文字と小文字が区別されます。 |
listener: ((arg: EventTypeMap[K]) => void) | 単一のイベント オブジェクト引数を取る関数。 |
戻り値 | |
---|---|
Service | メソッドが呼び出されたサービス オブジェクト。 |
getSlots
removeEventListener
- 例
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript(従来版)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void
以前に登録されたリスナーを削除します。
パラメータ | |
---|---|
eventType: K | GPT によって生成されたイベントのタイプを表す文字列。イベントタイプでは大文字と小文字が区別されます。 |
listener: ((event: EventTypeMap[K]) => void) | 単一のイベント オブジェクト引数を取る関数。 |
googletag.SizeMappingBuilder
メソッド | |
---|---|
add | 単一サイズの配列(ビューポートを表す)から、スロットを表す単一サイズまたはマルチサイズの配列へのマッピングを追加します。 |
build | このビルダーに追加されたマッピングからサイズマップ仕様をビルドします。 |
- 関連情報
メソッド
addSize
- 例
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript(従来版)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
TypeScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
単一サイズの配列(ビューポートを表す)から、スロットを表す単一サイズまたはマルチサイズの配列へのマッピングを追加します。
パラメータ | |
---|---|
viewportSize: SingleSizeArray | このマッピング エントリのビューポートのサイズ。 |
slotSize: GeneralSize | このマッピング エントリのスロットのサイズ。 |
戻り値 | |
---|---|
SizeMappingBuilder | このビルダーへの参照。 |
ビルド
build(): null | SizeMappingArray
このビルダーに追加されたマッピングからサイズマップ仕様をビルドします。
無効なマッピングが指定されている場合、このメソッドは null
を返します。そうでない場合は、Slot.defineSizeMapping に渡す正しい形式の仕様を返します。
注: このメソッドの呼び出し後のビルダーの動作は未定義です。
戻り値 | |
---|---|
null | SizeMappingArray | このビルダーによって構築された結果。無効なサイズ マッピングが指定された場合は null になります。 |
googletag.Slot
メソッド | |
---|---|
add | このスロットにサービスを追加します。 |
clear | このスロットのスロットレベルの広告カテゴリ除外ラベルをすべて消去します。 |
clear | このスロットの特定のカスタム スロットレベル ターゲティング パラメータまたはすべてのカスタム スロットレベル ターゲティング パラメータを消去します。 |
define | 最小ビューポート サイズからこのスロットのスロットサイズへのマッピングの配列を設定します。 |
get | このスロットの指定したキーに関連付けられた AdSense 属性の値を返します。 |
get | ネットワーク コードと広告ユニットパスを含む、広告ユニットのフルパスを返します。 |
get | このスロットに設定されている属性キーのリストを返します。 |
get | このスロットの広告カテゴリ除外ラベルを返します。 |
get | 広告レスポンス情報を返します。 |
get | スロットの定義時に指定されたスロット div の ID を返します。 |
get | このスロットに設定された特定のカスタム ターゲティング パラメータを返します。 |
get | このスロットに設定されているすべてのカスタム ターゲティング キーのリストを返します。 |
set | この広告スロットの AdSense 属性の値を設定します。 |
set | このスロットにスロットレベルの広告カテゴリの除外ラベルを設定します。 |
set | 広告のクリック後にユーザーをリダイレクトするクリック URL を設定します。 |
set | スロットに広告がない場合、スロット div を非表示にするかどうかを設定します。 |
set | このスロットの一般的な構成オプションを設定します。 |
set | このスロットの広告を SafeFrame コンテナで強制的にレンダリングするかどうかを設定します。 |
set | SafeFrame 構成のスロットレベルの設定を設定します。 |
set | このスロットのカスタム ターゲティング パラメータを設定します。 |
update | JSON オブジェクトのキーと値のマップから、このスロットのカスタム ターゲティング パラメータを設定します。 |
メソッド
addService
- 例
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript(従来版)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
addService(service: Service): Slot
このスロットにサービスを追加します。
パラメータ | |
---|---|
service: Service | 追加するサービス。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
clearCategoryExclusions
- 例
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript(従来版)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
clearCategoryExclusions(): Slot
このスロットのスロットレベルの広告カテゴリ除外ラベルをすべて消去します。
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
clearTargeting
- 例
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript(従来版)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
clearTargeting(key?: string): Slot
このスロットの特定のカスタム スロットレベル ターゲティング パラメータまたはすべてのカスタム スロットレベル ターゲティング パラメータを消去します。
パラメータ | |
---|---|
| ターゲティング パラメータキー。このキーは省略可能です。指定しない場合、すべてのターゲティング パラメータがクリアされます。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
defineSizeMapping
- 例
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
JavaScript(従来版)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping!);
- 関連情報
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
最小ビューポート サイズからこのスロットのスロットサイズへのマッピングの配列を設定します。
パラメータ | |
---|---|
sizeMapping: SizeMappingArray | サイズ マッピングの配列。SizeMappingBuilder を使用して作成できます。各サイズ マッピングは、SingleSizeArray と GeneralSize の 2 つの要素の配列です。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
get
- 例
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript(従来版)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- 関連情報
get(key: string): null | string
このスロットの指定したキーに関連付けられた AdSense 属性の値を返します。このスロットに継承されたサービスレベルの属性を確認するには、PubAdsService.get を使用します。
パラメータ | |
---|---|
key: string | 検索する属性の名前。 |
戻り値 | |
---|---|
null | string | 属性キーの現在の値。キーが存在しない場合は null です。 |
getAdUnitPath
- 例
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript(従来版)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
getAdUnitPath(): string
ネットワーク コードと広告ユニットパスを含む、広告ユニットのフルパスを返します。
戻り値 | |
---|---|
string | 広告ユニットのパス。 |
getAttributeKeys
- 例
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript(従来版)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
getAttributeKeys(): string[]
このスロットに設定されている属性キーのリストを返します。このスロットに継承されるサービスレベル属性のキーを確認するには、PubAdsService.getAttributeKeys を使用します。
戻り値 | |
---|---|
string[] | 属性キーの配列。順序は未定義です。 |
getCategoryExclusions
- 例
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript(従来版)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
getCategoryExclusions(): string[]
このスロットの広告カテゴリ除外ラベルを返します。
戻り値 | |
---|---|
string[] | このスロットの広告カテゴリ除外ラベル。何も設定されていない場合は空の配列。 |
getResponseInformation
getResponseInformation(): null | ResponseInformation
広告レスポンス情報を返します。これは、スロットの最後の広告レスポンスに基づいています。スロットに広告がない場合、この関数が呼び出されると null
が返されます。
戻り値 | |
---|---|
null | ResponseInformation | 最新の広告レスポンス情報。スロットに広告がない場合、null です。 |
getSlotElementId
- 例
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
JavaScript(従来版)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
getSlotElementId(): string
スロットの定義時に指定されたスロット div
の ID を返します。
戻り値 | |
---|---|
string | スロット div ID。 |
getTargeting
- 例
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript(従来版)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
getTargeting(key: string): string[]
このスロットに設定された特定のカスタム ターゲティング パラメータを返します。サービスレベルのターゲティング パラメータは含まれません。
パラメータ | |
---|---|
key: string | 検索するターゲティング キー。 |
戻り値 | |
---|---|
string[] | このキーに関連付けられた値。そのようなキーがない場合、空の配列。 |
getTargetingKeys
- 例
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript(従来版)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
getTargetingKeys(): string[]
このスロットに設定されているすべてのカスタム ターゲティング キーのリストを返します。サービスレベルのターゲティング キーは含まれません。
戻り値 | |
---|---|
string[] | ターゲティング キーの配列。順序は未定義です。 |
set
- 例
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript(従来版)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- 関連情報
set(key: string, value: string): Slot
この広告スロットの AdSense 属性の値を設定します。これにより、このキーに対してサービスレベルで設定された値が上書きされます。
同じキーに対してこのメソッドを複数回呼び出すと、そのキーに対して以前に設定された値が上書きされます。display
または refresh
を呼び出す前に、すべての値を設定する必要があります。
パラメータ | |
---|---|
key: string | 属性名。 |
value: string | 属性値。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
setCategoryExclusion
- 例
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript(従来版)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
TypeScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
setCategoryExclusion(categoryExclusion: string): Slot
このスロットにスロットレベルの広告カテゴリの除外ラベルを設定します。
パラメータ | |
---|---|
categoryExclusion: string | 追加する広告カテゴリ除外ラベル。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
setClickUrl
- 例
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript(従来版)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
setClickUrl(value: string): Slot
広告をクリックした後にユーザーをリダイレクトするクリック URL を設定します。
クリック URL が置き換えられても、Google アド マネージャーのサーバーではクリックが記録されます。配信されるクリエイティブに関連付けられたランディング ページ URL は、指定された値に追加されます。その後の呼び出しで値が上書きされます。これは SRA 以外のリクエストでのみ機能します。
パラメータ | |
---|---|
value: string | 設定するクリック URL。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
setCollapseEmptyDiv
- 例
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript(従来版)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
スロットに広告がない場合、スロット div
を非表示にするかどうかを設定します。これにより、サービスレベルの設定が上書きされます。
パラメータ | |
---|---|
collapse: boolean | 広告が返されなかった場合にスロットを閉じるかどうか。 |
| 広告が取得される前でもスロットを閉じるかどうか。収縮が true でない場合は無視されます。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
setConfig
setConfig(slotConfig: SlotSettingsConfig): void
このスロットの一般的な構成オプションを設定します。
パラメータ | |
---|---|
slotConfig: SlotSettingsConfig | 構成オブジェクト。 |
setForceSafeFrame
- この設定は、それぞれのスロットに対して行われた後続の広告リクエストにのみ適用されます。
- スロットレベルの設定が指定されている場合は、常にページレベルの設定がオーバーライドされます。
true
に設定した場合(スロット単位またはページ単位)、Google アド マネージャーの UI で選択した内容に関係なく、広告は常に SafeFrame コンテナを使用してレンダリングされます。- ただし、
false
に設定するか、指定しない場合は、クリエイティブのタイプと Google アド マネージャーの管理画面で選択した内容に応じて、SafeFrame コンテナを使用して広告がレンダリングされます。 - この API は、iframe から外部に移動しようとするクリエイティブや、パブリッシャーのページに直接レンダリングされることを前提とするクリエイティブの動作に影響する可能性があるため、慎重に使用してください。
- 例
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript(従来版)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
setForceSafeFrame(forceSafeFrame: boolean): Slot
このスロットの広告を SafeFrame コンテナで強制的にレンダリングするかどうかを設定します。
この API を使用する際は、次の点に注意してください。
パラメータ | |
---|---|
forceSafeFrame: boolean | true : このスロットのすべての広告を SafeFrame でレンダリングするように強制します。false : ページレベルの設定(存在する場合)をオプトアウトします。ページレベルで指定しない場合、この値を false に設定しても何も変更されません。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
setSafeFrameConfig
- 例
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript(従来版)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
setSafeFrameConfig(config: null | SafeFrameConfig): Slot
SafeFrame 構成のスロットレベルの設定を設定します。構成オブジェクト内の認識されないキーは無視されます。認識されたキーに無効な値が渡された場合、構成全体が無視されます。
これらのスロットレベルの設定が指定されている場合、ページレベルの設定はオーバーライドされます。
パラメータ | |
---|---|
config: null | SafeFrameConfig | 構成オブジェクト。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
setTargeting
- 例
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript(従来版)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
setTargeting(key: string, value: string | string[]): Slot
このスロットのカスタム ターゲティング パラメータを設定します。同じキーに対してこのメソッドを複数回呼び出すと、古い値が上書きされます。ここで設定した値は、サービスレベルで設定されたターゲティング パラメータを上書きします。これらのキーは Google アド マネージャー アカウントで定義します。
パラメータ | |
---|---|
key: string | ターゲティング パラメータキー。 |
value: string | string[] | ターゲティング パラメータ値または値の配列。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
updateTargetingFromMap
- 上書きした場合、最後の値のみが保持されます。
- 値が配列の場合、以前の値はマージされず、上書きされます。
- ここで設定した値は、サービスレベルで設定されたターゲティング パラメータをオーバーライドします。
- 例
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript(従来版)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
updateTargetingFromMap(map: {
[adUnitPath: string]: string | string[];
}): Slot
JSON オブジェクトのキーと値のマップから、このスロットのカスタム ターゲティング パラメータを設定します。これは、オブジェクトのすべてのキー値に対して Slot.setTargeting を呼び出す場合と同じです。これらのキーは Google アド マネージャー アカウントで定義されます。
注:
パラメータ | |
---|---|
map: { | ターゲティング パラメータの Key-Value マップ。 |
戻り値 | |
---|---|
Slot | メソッドが呼び出されたスロット オブジェクト。 |
googletag.config
インターフェース | |
---|---|
Ad | 広告の拡張を管理する設定。 |
Component | オンデバイス広告オークション内の単一コンポーネント オークションを表すオブジェクト。 |
Interstitial | 1 つのインタースティシャル広告スロットの動作を定義するオブジェクト。 |
Page | ページレベルの設定のメイン構成インターフェース。 |
Privacy | パブリッシャーのプライバシー処理を管理する設定。 |
Publisher | パブリッシャー提供のシグナル(PPS)の設定オブジェクト。 |
Slot | スロットレベルの設定用のメイン構成インターフェース。 |
Taxonomy | 単一の分類の値を含むオブジェクト。 |
型エイリアス | |
---|---|
Interstitial | サポートされているインタースティシャル広告のトリガー。 |
Privacy | サポートされているパブリッシャーのプライバシーに関する取り扱い。 |
Taxonomy | パブリッシャー提供のシグナル(PPS)でサポートされている分類。 |
型エイリアス
InterstitialTrigger
InterstitialTrigger: "unhideWindow" | "navBar"
サポートされているインタースティシャル広告のトリガー。
PrivacyTreatment
PrivacyTreatment: "disablePersonalization"
サポートされているパブリッシャーのプライバシーに関する取り扱い。
分類
Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
パブリッシャー提供のシグナル(PPS)でサポートされている分類。
googletag.config.AdExpansionConfig
プロパティ | |
---|---|
enabled | 広告の拡張が有効か無効か。 |
- 例
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript(従来版)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
プロパティ
Optional
有効
enabled?: null | boolean
広告の拡張を有効または無効にするかどうか。
この値を設定すると、Google アド マネージャーで構成されたデフォルトがオーバーライドされます。
googletag.config.ComponentAuctionConfig
プロパティ | |
---|---|
auction | このコンポーネント オークションのオークション構成オブジェクト。 |
config | このコンポーネント オークションに関連付けられている構成キー。 |
プロパティ
auctionConfig
- 例
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript(従来版)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
TypeScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
auctionConfig: null | {
auctionSignals?: unknown;
decisionLogicUrl: string;
interestGroupBuyers?: string[];
perBuyerExperimentGroupIds?: {
[buyer: string]: number;
};
perBuyerGroupLimits?: {
[buyer: string]: number;
};
perBuyerSignals?: {
[buyer: string]: unknown;
};
perBuyerTimeouts?: {
[buyer: string]: number;
};
seller: string;
sellerExperimentGroupId?: number;
sellerSignals?: unknown;
sellerTimeout?: number;
trustedScoringSignalsUrl?: string;
}
このコンポーネント オークションのオークション構成オブジェクト。
この値が null
に設定されている場合、指定された configKey
の既存の構成はすべて削除されます。
configKey
configKey: string
このコンポーネント オークションに関連付けられた構成キー。
この値は空でないこと、一意であることが必要です。2 つの ComponentAuctionConfig
オブジェクトが同じ configKey 値を共有している場合、最後に設定された値が以前の設定を上書きします。
googletag.config.InterstitialConfig
プロパティ | |
---|---|
require | このインタースティシャル広告を表示するためにローカル ストレージへの同意が必要かどうか。 |
triggers | このインタースティシャル広告のインタースティシャル トリガーの設定。 |
プロパティ
Optional
requireStorageAccess
- 例
JavaScript
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
JavaScript(従来版)
// Opt out of showing interstitials to users // without local storage consent. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
TypeScript
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
requireStorageAccess?: null | boolean
このインタースティシャル広告を表示するためにローカル ストレージの同意が必要かどうか。
GPT は、ローカル ストレージを使用してインタースティシャル広告のフリークエンシー キャップを適用します。ただし、ローカル ストレージの同意を提供していないユーザーにも、引き続きインタースティシャル広告を配信できます。このプロパティを true
に設定すると、デフォルトの動作がオプトアウトされ、ローカル ストレージの使用に同意したユーザーにのみインタースティシャル広告が表示されます。
Optional
トリガー
- 例
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript(従来版)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
triggers?: null | Partial<Record<InterstitialTrigger, boolean>>
このインタースティシャル広告のインタースティシャル トリガーの設定。
インタースティシャル トリガーの値を true
に設定すると有効になり、false
に設定すると無効になります。これにより、Google アド マネージャーで設定されたデフォルト値がオーバーライドされます。
googletag.config.PageSettingsConfig
1 回の API 呼び出しで複数の機能を設定できます。
以下に示すプロパティはすべて例であり、setConfig を使用する実際の機能は反映していません。機能セットについては、以下の PageSettingsConfig タイプのフィールドをご覧ください。
例:
- googletag.setConfig 呼び出しで指定された機能のみが変更されます。
// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- 特定の機能のすべての設定は、googletag.setConfig の呼び出しごとに更新されます。
// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
null
を渡すことで、特徴のすべての設定を消去できます。// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
プロパティ | |
---|---|
ad | 広告の拡張を管理する設定。 |
ad | 非推奨。 |
pps | パブリッシャー提供のシグナル(PPS)を制御する設定。 |
privacy | パブリッシャーのプライバシー処理を管理する設定。 |
thread | クリエイティブのレンダリング時に GPT が JS スレッドを降伏させるかどうかを制御する設定。 |
プロパティ
Optional
adExpansion
adExpansion?: null | AdExpansionConfig
広告の拡張を管理する設定。
Optional
adYield
adYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Optional
pps
pps?: null | PublisherProvidedSignalsConfig
パブリッシャー提供のシグナル(PPS)を制御する設定。
Optional
privacyTreatments
privacyTreatments?: null | PrivacyTreatmentsConfig
パブリッシャーのプライバシー処理を管理する設定。
Optional
threadYield
null
(デフォルト): GPT は、ビューポート外のスロットの JS スレッドを降伏します。ENABLED_ALL_SLOTS
: GPT は、スロットがビューポート内にあるかどうかにかかわらず、すべてのスロットの JS スレッドを降伏します。DISABLED
: GPT は JS スレッドを yield しません。- 例
JavaScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
JavaScript(従来版)
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
TypeScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
- 関連情報
threadYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
クリエイティブのレンダリング時に GPT が JS スレッドを譲渡するかどうかを制御する設定。
GPT は、Scheduler.postTask API または Scheduler.yield API をサポートするブラウザでのみ譲渡します。
サポートされる値:
googletag.config.PrivacyTreatmentsConfig
プロパティ | |
---|---|
treatments | 有効にするパブリッシャーのプライバシーに関する取り扱いの配列。 |
プロパティ
治療
- 例
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript(従来版)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
TypeScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
treatments: null | "disablePersonalization"[]
有効にするパブリッシャーのプライバシーに関する取り扱いの配列。
googletag.config.PublisherProvidedSignalsConfig
プロパティ | |
---|---|
taxonomies | 分類のマッピングを含むオブジェクト。 |
- 例
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript(従来版)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
プロパティ
分類
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
分類のマッピングを含むオブジェクト。
googletag.config.SlotSettingsConfig
1 つのスロットに対して 1 回の API 呼び出しで複数の機能を設定できます。
以下に示すすべてのプロパティは例であり、setConfig を使用する実際の機能は反映していません。機能セットについては、以下の SlotSettingsConfig タイプのフィールドをご覧ください。
例:
- Slot.setConfig 呼び出しで指定された機能のみが変更されます。
const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- 特定の機能のすべての設定は、Slot.setConfig が呼び出されるたびに更新されます。
// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
null
を渡すことで、特徴のすべての設定を消去できます。// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
プロパティ | |
---|---|
ad | 広告の拡張を管理する設定。 |
component | オンデバイス広告オークションに含めるコンポーネント オークションの配列。 |
interstitial | インタースティシャル広告スロットの動作を制御する設定。 |
プロパティ
Optional
adExpansion
adExpansion?: null | AdExpansionConfig
広告の拡張を管理する設定。
Optional
componentAuction
componentAuction?: null | ComponentAuctionConfig[]
オンデバイス広告オークションに含めるコンポーネント オークションの配列。
Optional
インタースティシャル
interstitial?: null | InterstitialConfig
インタースティシャル広告スロットの動作を制御する設定。
googletag.config.TaxonomyData
プロパティ | |
---|---|
values | 分類値のリスト。 |
プロパティ
値
values: string[]
分類値のリスト。
googletag.enums
列挙型 | |
---|---|
Out | GPT でサポートされているページ外フォーマット。 |
Traffic | GPT でサポートされているトラフィック ソース。 |
列挙型
OutOfPageFormat
TrafficSource
TrafficSource
GPT でサポートされているトラフィック ソース。
列挙型のメンバー | |
---|---|
ORGANIC | URL の直接入力、サイト内検索、アプリのダウンロード。 |
PURCHASED | 所有していないプロパティからリダイレクトされたトラフィック(獲得済みまたは報酬提供型のアクティビティ)。 |
googletag.events
インターフェース | |
---|---|
Event | すべての GPT イベントのベース インターフェース。 |
Event | これは、イベント名を Service.addEventListener と Service.removeEventListener の対応するイベント オブジェクト タイプにマッピングする疑似タイプです。 |
Game | このイベントは、ユーザーがゲームの手動インタースティシャル スロットを閉じたときに発生します。 |
Game | このイベントは、ゲームの手動インタースティシャル スロットをユーザーに表示する準備が整ったときに発生します。 |
Impression | このイベントは、アクティブ ビューの基準に従ってインプレッションが視認可能になったときにトリガーされます。 |
Rewarded | このイベントは、ユーザーがリワード広告スロットを閉じると発生します。 |
Rewarded | このイベントは、リワード広告の視聴に対して報酬が付与されたときに発生します。 |
Rewarded | このイベントは、リワード広告を表示する準備ができたときに発生します。 |
Slot | このイベントは、クリエイティブの iframe が読み込みイベントを発生させたときに発生します。 |
Slot | このイベントは、クリエイティブ コードがスロットに挿入されたときに発生します。 |
Slot | このイベントは、特定のスロットに対して広告がリクエストされたときに発生します。 |
Slot | このイベントは、特定のスロットに対して広告レスポンスが受信されたときに発生します。 |
Slot | このイベントは、広告スロットの画面上の領域の割合が変更されるたびに発生します。 |
googletag.events.Event
プロパティ | |
---|---|
service | イベントをトリガーしたサービスの名前。 |
slot | イベントをトリガーしたスロット。 |
- 関連情報
プロパティ
serviceName
serviceName: string
イベントをトリガーしたサービスの名前。
スロット
slot: Slot
イベントをトリガーしたスロット。
googletag.events.EventTypeMap
プロパティ
gameManualInterstitialSlotClosed
gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent
gameManualInterstitialSlotReady
gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent
impressionViewable
impressionViewable: ImpressionViewableEvent
events.ImpressionViewableEvent のエイリアス。
rewardedSlotClosed
rewardedSlotClosed: RewardedSlotClosedEvent
events.RewardedSlotClosedEvent のエイリアス。
rewardedSlotGranted
rewardedSlotGranted: RewardedSlotGrantedEvent
events.RewardedSlotGrantedEvent のエイリアス。
rewardedSlotReady
rewardedSlotReady: RewardedSlotReadyEvent
events.RewardedSlotReadyEvent のエイリアス。
slotOnload
slotOnload: SlotOnloadEvent
events.SlotOnloadEvent のエイリアス。
slotRenderEnded
slotRenderEnded: SlotRenderEndedEvent
events.SlotRenderEndedEvent のエイリアス。
slotRequested
slotRequested: SlotRequestedEvent
events.SlotRequestedEvent のエイリアス。
slotResponseReceived
slotResponseReceived: SlotResponseReceived
events.SlotResponseReceived のエイリアス。
slotVisibilityChanged
slotVisibilityChanged: SlotVisibilityChangedEvent
googletag.events.GameManualInterstitialSlotClosedEvent
Event
を拡張プロパティ | |
---|---|
service | イベントをトリガーしたサービスの名前。
|
slot | イベントをトリガーしたスロット。
|
- 例
JavaScript
// This listener is called when a game manual interstial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called when a game manual interstial slot is closed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a game manual interstial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.GameManualInterstitialSlotReadyEvent
Event
を拡張プロパティ | |
---|---|
service | イベントをトリガーしたサービスの名前。
|
slot | イベントをトリガーしたスロット。
|
メソッド | |
---|---|
make | ゲームの手動インタースティシャル広告をユーザーに表示します。 |
- 例
JavaScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called when a game manual interstitial slot is ready to // be displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. var displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
メソッド
makeGameManualInterstitialVisible
googletag.events.ImpressionViewableEvent
Event
を拡張プロパティ | |
---|---|
service | イベントをトリガーしたサービスの名前。
|
slot | イベントをトリガーしたスロット。
|
- 例
JavaScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
- 関連情報
googletag.events.RewardedSlotClosedEvent
Event
を拡張プロパティ | |
---|---|
service | イベントをトリガーしたサービスの名前。
|
slot | イベントをトリガーしたスロット。
|
- 例
JavaScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called when the user closes a rewarded ad slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
- 関連情報
googletag.events.RewardedSlotGrantedEvent
Event
を拡張プロパティ | |
---|---|
payload | 付与された報酬に関する情報を含むオブジェクト。 |
service | イベントをトリガーしたサービスの名前。
|
slot | イベントをトリガーしたスロット。
|
- 例
JavaScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called whenever a reward is granted for a // rewarded ad. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", function (event) { var _a, _b; var slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type); console.log( "Reward amount:", (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount, ); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- 関連情報
プロパティ
ペイロード
payload: null | RewardedPayload
付与された報酬に関する情報を含むオブジェクト。
googletag.events.RewardedSlotReadyEvent
Event
を拡張プロパティ | |
---|---|
service | イベントをトリガーしたサービスの名前。
|
slot | イベントをトリガーしたスロット。
|
メソッド | |
---|---|
make | リワード広告を表示します。 |
- 例
JavaScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
- 関連情報
メソッド
makeRewardedVisible
googletag.events.SlotOnloadEvent
Event
を拡張SlotOnloadEvent
は配信されません。プロパティ | |
---|---|
service | イベントをトリガーしたサービスの名前。
|
slot | イベントをトリガーしたスロット。
|
- 例
JavaScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
- 関連情報
googletag.events.SlotRenderEndedEvent
Event
を拡張プロパティ | |
---|---|
advertiser | レンダリングされた広告の広告主 ID。 |
campaign | レンダリングされた広告のキャンペーン ID。 |
company | レンダリングされたバックフィル広告に入札した企業の ID。 |
creative | レンダリングされた予約広告のクリエイティブ ID。 |
creative | レンダリングされた予約広告のクリエイティブ テンプレート ID。 |
is | 広告がバックフィル広告かどうか。 |
is | スロットに対して広告が返されたかどうか。 |
label | 非推奨。 |
line | レンダリングされた予約広告の広告申込情報 ID。 |
service | イベントをトリガーしたサービスの名前。
|
size | レンダリングされたクリエイティブのピクセルサイズを示します。 |
slot | イベントをトリガーしたスロット。
|
slot | レンダリングされた広告でスロット コンテンツが変更されたかどうか。 |
source | レンダリングされた予約広告またはバックフィル広告のクリエイティブ ID。 |
source | レンダリングされた予約広告またはバックフィル広告の広告申込情報 ID。 |
yield | レンダリングされたバックフィル広告の収益グループの ID。 |
- 例
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- 関連情報
プロパティ
advertiserId
advertiserId: null | number
レンダリングされた広告の広告主 ID。空のスロット、バックフィル広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの値は null
です。
campaignId
campaignId: null | number
レンダリングされた広告のキャンペーン ID。空のスロット、バックフィル広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの値は null
です。
companyIds
companyIds: null | number[]
レンダリングされたバックフィル広告に入札した企業の ID。空のスロット、予約広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの値は null
です。
creativeId
creativeId: null | number
レンダリングされた予約広告のクリエイティブ ID。空のスロット、バックフィル広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの値は null
です。
creativeTemplateId
creativeTemplateId: null | number
レンダリングされた予約広告のクリエイティブ テンプレート ID。空のスロット、バックフィル広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの値は null
です。
isBackfill
isBackfill: boolean
広告がバックフィル広告かどうか。広告がバックフィル広告の場合は true
、それ以外の場合は false
です。
isEmpty
isEmpty: boolean
スロットに対して広告が返されたかどうか。広告が返されなかった場合は true
、それ以外の場合は false
です。
labelIds
labelIds: null | number[]
lineItemId
lineItemId: null | number
レンダリングされた予約広告の広告申込情報 ID。空のスロット、バックフィル広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの値は null
です。
サイズ
size: null | string | number[]
レンダリングされたクリエイティブのピクセルサイズを示します。例: [728, 90]
。空の広告スロットの値は null
です。
slotContentChanged
slotContentChanged: boolean
レンダリングされた広告でスロット コンテンツが変更されたかどうか。コンテンツが変更された場合は true
、それ以外の場合は false
です。
sourceAgnosticCreativeId
sourceAgnosticCreativeId: null | number
レンダリングされた予約広告またはバックフィル広告のクリエイティブ ID。広告が純広告または広告申込情報のバックフィルでない場合、またはクリエイティブが PubAdsService 以外のサービスによってレンダリングされている場合、値は null
です。
sourceAgnosticLineItemId
sourceAgnosticLineItemId: null | number
レンダリングされた予約広告またはバックフィル広告の広告申込情報 ID。広告が純広告または広告申込情報のバックフィルでない場合、またはクリエイティブが PubAdsService 以外のサービスによってレンダリングされている場合、値は null
です。
yieldGroupIds
yieldGroupIds: null | number[]
レンダリングされたバックフィル広告の収益グループの ID。空のスロット、予約広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの値は null
です。
googletag.events.SlotRequestedEvent
Event
を拡張プロパティ | |
---|---|
service | イベントをトリガーしたサービスの名前。
|
slot | イベントをトリガーしたスロット。
|
- 例
JavaScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
- 関連情報
googletag.events.SlotResponseReceived
Event
を拡張プロパティ | |
---|---|
service | イベントをトリガーしたサービスの名前。
|
slot | イベントをトリガーしたスロット。
|
- 例
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
- 関連情報
googletag.events.SlotVisibilityChangedEvent
Event
を拡張プロパティ | |
---|---|
in | 広告の表示領域の割合(%)。 |
service | イベントをトリガーしたサービスの名前。
|
slot | イベントをトリガーしたスロット。
|
- 例
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript(従来版)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- 関連情報
プロパティ
inViewPercentage
inViewPercentage: number
広告の表示領域の割合(%)。値は 0 ~ 100 の数値です。
googletag.secureSignals
インターフェース | |
---|---|
Bidder | 特定のビッダーのセキュア シグナルを返します。 |
Publisher | 特定のパブリッシャーのセキュア シグナルを返します。 |
Secure | セキュア シグナルを管理するためのインターフェース。 |
型エイリアス | |
---|---|
Secure | 特定のビッダーまたはプロバイダのセキュア シグナルを返すためのインターフェース。 |
型エイリアス
SecureSignalProvider
SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider
特定のビッダーまたはプロバイダのセキュア シグナルを返すためのインターフェース。id
または networkCode
のいずれかを指定する必要がありますが、両方を指定することはできません。
googletag.secureSignals.BidderSignalProvider
ビッダーのセキュア シグナル プロバイダは、次の 2 つの部分で構成されています。
- セキュア シグナルに解決される
Promise
を返すコレクタ関数。 - シグナルに関連付けられているビッダーを識別する
id
。
プロパティ | |
---|---|
collector | 安全なシグナルに解決される Promise を返す関数。 |
id | Google アド マネージャーに登録されている、このセキュア シグナルに関連付けられたコレクタの一意の識別子。 |
- 例
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript(従来版)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
プロパティ
collectorFunction
collectorFunction: (() => Promise<string>)
安全なシグナルに解決される Promise
を返す関数。
id
id: string
Google アド マネージャーに登録されている、このセキュア シグナルに関連付けられたコレクタの一意の識別子。
googletag.secureSignals.PublisherSignalProvider
パブリッシャー シグナル プロバイダは次の 2 つの部分で構成されています。
- セキュア シグナルに解決される
Promise
を返すコレクタ関数。 - シグナルに関連付けられているパブリッシャーを識別する
networkCode
。
プロパティ | |
---|---|
collector | 安全なシグナルに解決される Promise を返す関数。 |
network | このセキュア シグナルに関連付けられているパブリッシャーのネットワーク コード(広告ユニットパスに表示されるコード)。 |
- 例
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript(従来版)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
プロパティ
collectorFunction
collectorFunction: (() => Promise<string>)
安全なシグナルに解決される Promise
を返す関数。
networkCode
networkCode: string
このセキュア シグナルに関連付けられているパブリッシャーのネットワーク コード(広告ユニットパスに表示されるコード)。
googletag.secureSignals.SecureSignalProvidersArray
メソッド | |
---|---|
clear | すべてのコレクタのすべてのシグナルをキャッシュから消去します。 |
push | シグナル プロバイダ アレイに新しい secureSignals.SecureSignalProvider を追加し、シグナル生成プロセスを開始します。 |
メソッド
clearAllCache
push
push(provider: SecureSignalProvider): void
シグナル プロバイダ アレイに新しい secureSignals.SecureSignalProvider を追加し、シグナル生成プロセスを開始します。
パラメータ | |
---|---|
provider: SecureSignalProvider | 配列に追加する secureSignals.SecureSignalProvider オブジェクト。 |