このリファレンスでは、TypeScript 表記を使用して型を記述します。次の表に、 例による簡単な説明があります。
型式 | |
---|---|
string |
プリミティブ文字列型。 |
string[] |
配列型。値は文字列のみです。 |
number | string |
共用体型。値は数値または文字列のいずれかです。 |
Array<number | string> |
配列型。値は複合型(共用体)です。 |
[number, string] |
タプル型。値は 2 要素の配列で、数値と文字列がこの順序で含まれている必要があります。 |
Slot |
オブジェクト型。値は googletag.Slot のインスタンスです。 |
() => void |
引数が定義されておらず、戻り値もない関数型。 |
サポートされている型と型式について詳しくは、このモジュールの <ph type="x-smartling-placeholder"></ph> TypeScript ハンドブック 。
型アノテーション
変数、パラメータ名、プロパティ名、関数のシグネチャの後のコロンは、 型アノテーションを使用します。型アノテーションは、コロンの左にある要素について記述します。 返品できます。次の表に、 このリファレンスをご覧ください。
型アノテーション | |
---|---|
param: string |
param が文字列値を受け入れるか返すことを示します。この構文は、
をご覧ください。
|
param?: number | string |
param が省略可能だが、数値または文字列のいずれかを受け入れることを示します
有効になります。この構文はパラメータとプロパティに使用されます。
|
...params: Array<() => void> |
params が
<ph type="x-smartling-placeholder"></ph>
休息パラメータ
関数を受け入れる関数です。REST パラメータには、変数の値を無制限に指定できます。
あります。
|
型の定義
型 | |
---|---|
|
SingleSize | MultiSize
|
スロットの有効なサイズ構成(1 つまたは複数のサイズ)。 |
|
|
SingleSize[]
|
1 つの有効なサイズのリスト。 |
|
|
"fluid" | ["fluid"]
|
スロットに設定可能な名前付きのサイズ。ほとんどの場合、サイズはレクタングルの固定サイズですが、他の種類のサイズ仕様が必要になる場合もあります。有効な名前付きサイズは次のとおりです。
|
|
|
SingleSizeArray | NamedSize
|
スロットの単一の有効なサイズ。 |
|
|
[number, number]
|
[幅、高さ] を表す 2 つの数値の配列。 |
|
|
[SingleSizeArray, GeneralSize]
|
ビューポートのサイズと広告サイズのマッピングレスポンシブ広告に使用されます。 |
|
|
SizeMapping[]
|
サイズ マッピングのリスト。 |
|
|
"unhideWindow" | "navBar"
|
サポートされているインタースティシャル広告トリガー。 |
|
|
"disablePersonalization"
|
サポートされるパブリッシャーのプライバシーの取り扱い。 |
|
|
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
|
パブリッシャー提供のシグナル(PPS)でサポートされている分類。 |
|
|
BidderSignalProvider | PublisherSignalProvider
|
特定の入札者またはプロバイダにセキュア シグナルを返すためのインターフェース。 |
列挙型
列挙型 | |
---|---|
googletag.enums.OutOfPageFormat
|
GPT でサポートされているページ外フォーマット。
|
googletag.enums.TrafficSource
|
GPT でサポートされているトラフィック ソース。
|
googletag.enums.OutOfPageFormat
-
GPT でサポートされているページ外フォーマット。
-
- 関連情報
googletag.enums.TrafficSource
-
GPT でサポートされているトラフィック ソース。
-
値 ORGANIC
URL の直接入力、サイト内検索、アプリのダウンロード。PURCHASED
所有していないプロパティからリダイレクトされたトラフィック(獲得アクティビティまたはインセンティブが付与されたアクティビティ)。
googletag
Google パブリッシャー タグで API に使用されるグローバル名前空間。
変数の概要 | |
---|---|
apiReady
|
GPT API が読み込まれ、呼び出しの準備ができたことを示すフラグ。
|
cmd
|
GPT 関連の呼び出しを非同期で実行するためのグローバル コマンドキューへの参照。
|
pubadsReady
|
PubAdsService が有効で、読み込まれ、完全に動作していることを示すフラグ。
|
secureSignalProviders
|
セキュア シグナル プロバイダの配列への参照。
|
関数の概要 | |
---|---|
companionAds
|
CompanionAdsService への参照を返します。
|
defineOutOfPageSlot
|
指定された広告ユニットのパスでページ外広告スロットを作成します。
|
defineSlot
|
指定された広告ユニットのパスとサイズで広告スロットを作成し、広告が表示されるページの div 要素の ID に関連付けます。
|
destroySlots
|
指定されたスロットを破棄し、関連するすべてのオブジェクトとそれらのスロットの参照を GPT から削除します。
|
disablePublisherConsole
|
Google パブリッシャー コンソールを無効にします。
|
display
|
スロットをレンダリングするようスロット サービスに指示します。
|
enableServices
|
ページ上の広告スロットに定義されているすべての GPT サービスを有効にします。
|
getVersion
|
GPT の現在のバージョンを返します。
|
openConsole
|
Google パブリッシャー コンソールを開きます。
|
pubads
|
PubAdsService への参照を返します。
|
setAdIframeTitle
|
今後
PubAdsService で作成されたすべての広告コンテナの iframe にタイトルを設定します。
|
setConfig
|
ページの一般的な構成オプションを設定します。
|
sizeMapping
|
新しい
SizeMappingBuilder を作成します。
|
googletag。apiReady
-
apiReady: boolean | undefined
-
GPT API が読み込まれ、呼び出しの準備ができたことを示すフラグ。API の準備が整うまでは、このプロパティは単に
undefined
になります。
なお、非同期を処理する方法としては、googletag.cmd を使用して、GPT の準備が整うまでコールバックをキューに入れておくことをおすすめします。これらのコールバックは、API が設定されると必ず実行されるため、googletag.apiReady を確認する必要はありません。 -
- 例
-
JavaScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
JavaScript(従来版)
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
TypeScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
googletag。cmd
-
cmd: Array<(this: typeof globalThis) => void> | CommandArray
-
GPT 関連の呼び出しを非同期で実行するためのグローバル コマンドキューへの参照。
googletag.cmd
変数は、ページ上の GPT タグ構文によって空の JavaScript 配列に初期化されます。cmd.push
は、配列の末尾に要素を追加する標準のArray.push
メソッドです。GPT JavaScript が読み込まれると、配列を調べてすべての関数を順番に実行します。次に、このスクリプトはcmd
をCommandArray
オブジェクトに置き換えます。このオブジェクトの push メソッドは、渡された関数引数を実行するように定義されています。このメカニズムにより、ブラウザでページのレンダリングを続行しながら JavaScript を非同期で取得することで、認識される遅延を短縮できます。 -
- 例
-
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()); });
googletag。pubadsReady
-
pubadsReady: boolean | undefined
-
PubAdsService
が有効で、読み込まれ、完全に動作していることを示すフラグ。enableServices
が呼び出され、PubAdsService
が読み込まれて初期化されるまで、このプロパティは単純にundefined
になります。 -
googletag。secureSignalProviders
-
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
-
セキュア シグナル プロバイダの配列への参照。
セキュア シグナル プロバイダの配列は、シグナルを生成する一連の関数を受け入れ、順番に呼び出します。これは、GPT の読み込み後に呼び出されるシグナル生成関数をキューに追加するために使用される標準配列を置き換えるためのものです。 -
- 例
-
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"); }, });
- 関連情報
googletag。companionAds
-
companionAds(): CompanionAdsService
-
CompanionAdsService
への参照を返します。 -
-
戻り値 CompanionAdsService
コンパニオン広告サービス。
googletag。defineOutOfPageSlot
-
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
-
指定された広告ユニットのパスでページ外広告スロットを作成します。
カスタムのページ外広告の場合、div
は広告を格納する div 要素の ID です。詳しくは、ページ外クリエイティブに関する記事をご覧ください。
GPT で管理されるページ外広告の場合、div
は OutOfPageFormat としてサポートされています。 -
- 例
-
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);
- 関連情報
-
パラメータ adUnitPath: string
ネットワーク コードと広告ユニットコードを含む広告ユニットの完全なパス。div?: string | OutOfPageFormat
この広告ユニットまたは OutOfPageFormat を格納する div の ID。 -
戻り値 Slot | null
新しく作成されたスロット。スロットを作成できない場合はnull
。
googletag。defineSlot
-
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
-
指定された広告ユニットのパスとサイズで広告スロットを作成し、広告が表示されるページの div 要素の ID に関連付けます。
-
- 例
-
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");
- 関連情報
-
パラメータ adUnitPath: string
ネットワーク コードとユニットコードを含む広告ユニットの完全なパス。size: GeneralSize
追加されたスロットの幅と高さ。これは、レスポンシブ サイズのマッピングが指定されていない場合や、ビューポートのサイズがマッピングで指定された最小サイズよりも小さい場合に、広告リクエストで使用されるサイズです。div?: string
この広告ユニットを格納する div の ID。 -
戻り値 Slot | null
新しく作成されたスロット。スロットを作成できない場合はnull
。
googletag。destroySlots
-
destroySlots(slots?: Slot[]): boolean
-
指定されたスロットを破棄し、関連するすべてのオブジェクトとそれらのスロットの参照を GPT から削除します。この API は、パスバック スロットとコンパニオン スロットに対応していません。
スロットでこの API を呼び出すと、広告がクリアされ、GPT によって管理される内部状態からスロット オブジェクトが削除されます。スロット オブジェクトに対してこれ以上関数を呼び出すと、未定義の動作が発生します。ただし、該当のスロットへの参照がパブリッシャーのページで管理されている場合、ブラウザはスロットに関連付けられているメモリを解放できないことがあります。この API を呼び出すと、そのスロットに関連付けられている div を再利用できるようになります。
具体的には、スロットを破棄すると、GPT の有効期間が長いページビューからその広告が削除されます。そのため、以降のリクエストは、この広告に関連するロードブロッキングや競合広告の除外の影響を受けなくなります。ページからスロットの div を削除する前にこの関数を呼び出さないと、未定義の動作が発生します。 -
- 例
-
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();
-
パラメータ slots?: Slot[]
破棄するスロットの配列。Array は省略可能です。指定しない場合は、すべてのスロットが破棄されます。 -
戻り値 boolean
スロットが破棄された場合はtrue
、そうでない場合はfalse
。
googletag。disablePublisherConsole
-
disablePublisherConsole(): void
-
Google パブリッシャー コンソールを無効にします。
-
- 関連情報
googletag。display
-
display(divOrSlot: string | Element | Slot): void
-
スロットをレンダリングするようスロット サービスに指示します。各広告スロットは 1 ページに 1 回だけ表示する必要があります。表示される前に、すべてのスロットを定義し、サービスが関連付けられている必要があります。display の呼び出しは、要素が DOM に存在するまで発生しません。通常は、メソッド呼び出しで指定した div 要素内のスクリプト ブロック内に配置します。
シングル リクエスト アーキテクチャ(SRA)が使用されている場合は、このメソッドが呼び出された時点で取得されていないすべての広告スロットが一度に取得されます。特定の広告スロットが表示されないようにするには、div 全体を削除する必要があります。 -
- 例
-
JavaScript
googletag.cmd.push(() => { googletag.display("div-1"); });
JavaScript(従来版)
googletag.cmd.push(function () { googletag.display("div-1"); });
TypeScript
googletag.cmd.push(() => { googletag.display("div-1"); });
- 関連情報
-
パラメータ divOrSlot: string | Element | Slot
広告スロットを含む div 要素の ID、または div 要素、またはスロット オブジェクトの ID。div 要素を指定する場合は、「id」をdefineSlot
に渡された ID に対応する属性です。
googletag。enableServices
-
enableServices(): void
-
ページ上の広告スロットに定義されているすべての GPT サービスを有効にします。
-
googletag。getVersion
-
getVersion(): string
-
GPT の現在のバージョンを返します。
-
- 関連情報
-
戻り値 string
現在実行中の GPT バージョンの文字列。
googletag。openConsole
-
openConsole(div?: string): void
-
Google パブリッシャー コンソールを開きます。
-
- 例
-
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();
- 関連情報
-
パラメータ div?: string
広告スロットの div ID。この値は省略可能です。このフィールドを指定すると、指定した広告スロットの詳細が表示された状態でパブリッシャー コンソールが開くようになります。
googletag。pubads
-
pubads(): PubAdsService
-
PubAdsService
への参照を返します。 -
-
戻り値 PubAdsService
パブリッシャー広告サービス。
googletag。setAdIframeTitle
-
setAdIframeTitle(title: string): void
-
今後
PubAdsService
で作成されたすべての広告コンテナの iframe にタイトルを設定します。 -
- 例
-
JavaScript
googletag.setAdIframeTitle("title");
JavaScript(従来版)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
-
パラメータ title: string
すべての広告コンテナの iframe の新しいタイトル。
googletag。setConfig
-
setConfig(config: PageSettingsConfig): void
-
ページの一般的な構成オプションを設定します。
-
-
パラメータ config: PageSettingsConfig
googletag。sizeMapping
-
sizeMapping(): SizeMappingBuilder
-
新しい
SizeMappingBuilder
を作成します。 -
- 関連情報
-
戻り値 SizeMappingBuilder
新しいビルダー。
googletag。CommandArray
コマンド配列は一連の関数を受け入れ、順番に呼び出します。これは、GPT の読み込み後に呼び出される関数をキューに追加するために使用される標準配列を置き換えるためのものです。
メソッドの概要 | |
---|---|
push
|
引数で指定された一連の関数を順番に実行します。
|
push
-
push(...f: Array<(this: typeof globalThis) => void>): number
-
引数で指定された一連の関数を順番に実行します。
-
- 例
-
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()); });
-
パラメータ ...f: Array<(this: typeof globalThis) => void>
実行される JavaScript 関数。ランタイム バインディングは常にglobalThis
になります。囲む語彙コンテキストのthis
値を保持するために、アロー関数を渡すことを検討してください。 -
戻り値 number
これまでに処理されたコマンドの数。これは、Array.push
の戻り値(配列の現在の長さ)と互換性があります。
googletag。CompanionAdsService
拡張
コンパニオン広告サービス。このサービスは、動画広告でコンパニオン広告を表示するために使用されます。
メソッドの概要 | |
---|---|
addEventListener
|
ページで特定の GPT イベントが発生したときに JavaScript 関数を設定して呼び出せるようにするリスナーを登録します。
|
getSlots
|
このサービスに関連付けられているスロットのリストを取得します。
|
removeEventListener
|
以前に登録されたリスナーを削除します。
|
setRefreshUnfilledSlots
|
埋められなかったコンパニオン スロットを自動的にバックフィルするかどうかを設定します。
|
- 関連情報
setRefreshUnfilledSlots
-
setRefreshUnfilledSlots(value: boolean): void
-
埋められなかったコンパニオン スロットが自動的にバックフィルされるかどうかを設定します。
このメソッドは、ページの有効期間中に複数回呼び出して、バックフィルのオン / オフを切り替えることができます。PubAdsService
にも登録されているスロットのみがバックフィルされます。ポリシーによる制限により、このメソッドは、Ad Exchange 動画の配信時に空のコンパニオン スロットを埋めるようには設計されていません。 -
- 例
-
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript(従来版)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
-
パラメータ value: boolean
埋められなかったスロットを自動的にバックフィルするにはtrue
、変更しないままにするにはfalse
。
googletag。PrivacySettingsConfig
プライバシー設定の構成オブジェクト。
プロパティの概要 | |
---|---|
childDirectedTreatment
|
ページを子ども向けとして扱う必要があるかどうかを示します。
|
limitedAds
|
パブリッシャー様の規制遵守のニーズに対応できるよう、制限付き広告モードでの配信を有効にします。
|
nonPersonalizedAds
|
パブリッシャー様の規制遵守のニーズに対応できるよう、非パーソナライズド広告モードでの配信を有効にします。
|
restrictDataProcessing
|
パブリッシャーの規制遵守のニーズに対応できるように、制限付きの処理モードでの配信を有効にします。
|
trafficSource
|
リクエストが購入トラフィックまたはオーガニック トラフィックのどちらを示しているかを示します。
|
underAgeOfConsent
|
同意年齢に満たないユーザーからの広告リクエストとしてマークを付けるかどうかを指定します。
|
- 関連情報
childDirectedTreatment
-
childDirectedTreatment: null | boolean
-
ページを子ども向けとして扱う必要があるかどうかを示します。構成をクリアするには、
null
に設定します。 -
limitedAds
-
limitedAds: boolean
-
パブリッシャーの規制遵守のニーズに対応するため、制限付き広告モードでの配信を有効にします。
制限付き広告のリクエストを行うには、次の 2 つの方法があります。- IAB TCF v2.0 の同意管理プラットフォームからのシグナルを使用して自動的に作成されます。
- 手動で。このフィールドの値を
true
に設定します。
CMP を使用している場合は、制限付き広告を手動で有効にする必要はありません。 -
- 例
-
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, });
- 関連情報
nonPersonalizedAds
-
nonPersonalizedAds: boolean
-
パブリッシャー様の規制遵守のニーズに対応できるよう、非パーソナライズド広告モードでの配信を有効にします。
-
restrictDataProcessing
-
restrictDataProcessing: boolean
-
パブリッシャーの規制遵守のニーズに対応できるように、制限付きの処理モードでの配信を有効にします。
-
trafficSource
-
trafficSource: TrafficSource
-
リクエストが購入トラフィックまたはオーガニック トラフィックのどちらを示しているかを示します。この値は、アド マネージャーのレポートの [トラフィック ソース] ディメンションに入力されます。設定しない場合、レポートのトラフィック ソースはデフォルトで
undefined
になります。 -
- 例
-
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, });
underAgeOfConsent
-
underAgeOfConsent: null | boolean
-
同意年齢に満たないユーザーからの広告リクエストとしてマークを付けるかどうかを指定します。構成をクリアするには、
null
に設定します。 -
googletag。PubAdsService
拡張
パブリッシャー広告サービス。このサービスは、Google アド マネージャー アカウントから広告を取得して表示するために使用されます。
メソッドの概要 | |
---|---|
addEventListener
|
ページで特定の GPT イベントが発生したときに JavaScript 関数を設定して呼び出せるようにするリスナーを登録します。
|
clear
|
指定されたスロットから広告を削除し、空白のコンテンツに置き換えます。
|
clearCategoryExclusions
|
ページ単位の広告カテゴリの除外ラベルをすべて削除します。
|
clearTargeting
|
特定のキーまたはすべてのキーのカスタム ターゲティング パラメータを消去します。
|
collapseEmptyDivs
|
表示する広告コンテンツがない場合にページのスペースを占有しないように、スロット div の折りたたみを有効にします。
|
disableInitialLoad
|
ページの読み込み時に広告のリクエストを無効にしますが、
PubAdsService.refresh の呼び出しによる広告のリクエストを許可します。
|
display
|
指定された広告ユニットのパスとサイズで、広告スロットを作成して表示します。
|
enableLazyLoad
|
config オブジェクトで定義されているように、GPT の遅延読み込みを有効にします。
|
enableSingleRequest
|
複数の広告を同時に取得するためのシングル リクエスト モードを有効にします。
|
enableVideoAds
|
ページに動画広告が表示されることを GPT に通知します。
|
get
|
指定されたキーに関連付けられた AdSense 属性の値を返します。
|
getAttributeKeys
|
このサービスに設定されている属性キーを返します。
|
getSlots
|
このサービスに関連付けられているスロットのリストを取得します。
|
getTargeting
|
設定されている特定のカスタム サービスレベル ターゲティング パラメータを返します。
|
getTargetingKeys
|
設定されているすべてのカスタム サービスレベル ターゲティング キーのリストを返します。
|
isInitialLoadDisabled
|
広告に対する最初のリクエストが前回の
PubAdsService.disableInitialLoad 呼び出しによって正常に無効にされたかどうかを返します。
|
refresh
|
ページ上の特定またはすべてのスロットの新しい広告を取得して表示します。
|
removeEventListener
|
以前に登録されたリスナーを削除します。
|
set
|
パブリッシャー広告サービスのすべての広告スロットに適用される AdSense 属性の値を設定します。
|
setCategoryExclusion
|
指定されたラベル名に対してページレベルの広告カテゴリの除外を設定します。
|
setCentering
|
広告の水平方向の中央配置を有効または無効にします。
|
setForceSafeFrame
|
ページ上のすべての広告を、SafeFrame コンテナを使って強制的に表示するかどうかを設定します。
|
setLocation
|
広告申込情報を特定の場所に地域ターゲティングできるように、ウェブサイトから位置情報を渡します。
|
setPrivacySettings
|
config オブジェクトを使用して、1 つの API ですべてのプライバシー設定を構成できます。
|
setPublisherProvidedId
|
ニュース メディア指定 ID の値を設定します。
|
setSafeFrameConfig
|
SafeFrame の設定についてページ単位で設定します。
|
setTargeting
|
特定のキーについて、パブリッシャー広告サービスのすべての広告スロットに適用されるカスタム ターゲティング パラメータを設定します。
|
setVideoContent
|
ターゲティングやコンテンツの除外を目的として、広告リクエストとともに動画コンテンツ情報を送信するように設定します。
|
updateCorrelator
|
広告リクエストとともに送信される correlator 値を変更し、実質的に新しいページビューを開始します。
|
clear
-
clear(slots?: Slot[]): boolean
-
指定されたスロットから広告を削除し、空白のコンテンツに置き換えます。スロットは未取得としてマークされます。
具体的には、スロットをクリアすると、GPT の有効期間が長いページビューから広告が削除されます。そのため、今後のリクエストでは、この広告に関連するロードブロッキングや競合広告の除外が影響を受けなくなります。 -
- 例
-
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();
-
パラメータ slots?: Slot[]
消去するスロットの配列。Array は省略可能です。指定しない場合は、すべてのスロットがクリアされます。 -
戻り値 boolean
スロットがクリアされている場合はtrue
を、そうでない場合はfalse
を返します。
clearCategoryExclusions
-
clearCategoryExclusions(): PubAdsService
-
ページ単位の広告カテゴリの除外ラベルをすべて削除します。これはスロットを更新する場合に便利です。
-
- 例
-
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.
- 関連情報
-
戻り値 PubAdsService
メソッドが呼び出されたサービス オブジェクト。
clearTargeting
-
clearTargeting(key?: string): PubAdsService
-
特定のキーまたはすべてのキーのカスタム ターゲティング パラメータを消去します。
-
- 例
-
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.
- 関連情報
-
パラメータ key?: string
ターゲティング パラメータ キー。キーは省略可能です。指定しない場合は、すべてのターゲティング パラメータが消去されます。 -
戻り値 PubAdsService
メソッドが呼び出されたサービス オブジェクト。
collapseEmptyDivs
-
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
-
表示する広告コンテンツがない場合にページのスペースを占有しないように、スロット div の折りたたみを有効にします。このモードは、サービスを有効にする前に設定する必要があります。
-
パラメータ collapseBeforeAdFetch?: boolean
広告の取得前でもスロットを折りたたむかどうか。このパラメータは省略可能です。指定しない場合は、デフォルト値としてfalse
が使用されます。 -
戻り値 boolean
div 折りたたみモードが有効になっていた場合はtrue
を返し、サービスが有効になった後にメソッドが呼び出されたために折りたたみモードを有効にできない場合はfalse
を返します。
disableInitialLoad
-
disableInitialLoad(): void
-
ページの読み込み時に広告のリクエストを無効にしますが、
PubAdsService.refresh
の呼び出しによる広告のリクエストを許可します。これはサービスを有効にする前に設定する必要があります。非同期モードを使用する必要があります。そうしないと、refresh
を使用して広告をリクエストできなくなります。
display
-
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
-
指定された広告ユニットのパスとサイズで、広告スロットを作成して表示します。このメソッドはシングル リクエスト モードでは機能しません。
注: このメソッドが呼び出されると、広告リクエストの送信とレスポンスのレンダリングとの整合性を保つため、スロットとページの状態のスナップショットが作成されます。このメソッドが呼び出された後でスロットやページの状態に加えられた変更(ターゲティング、プライバシー設定、SafeFrame の適用など)は、後続のdisplay()
リクエストまたは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");
- 関連情報
-
パラメータ adUnitPath: string
レンダリングするスロットの広告ユニットのパス。size: GeneralSize
スロットの幅と高さ。div?: string | Element
スロットを含む div の ID、または div 要素自体。clickUrl?: string
このスロットで使用するクリック URL。
enableLazyLoad
-
enableLazyLoad(config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }): void
-
config オブジェクトで定義されているように、GPT の遅延読み込みを有効にします。詳細な例については、遅延読み込みのサンプルをご覧ください。
注: SRA の遅延取得は、すべてのスロットが取得マージンの範囲外にある場合にのみ機能します。 -
- 例
-
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, });
- 関連情報
-
パラメータ config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
Configuration オブジェクトを使用すると、遅延動作をカスタマイズできます。省略した構成では、Google が設定したデフォルトが使用され、徐々に調整されます。取得マージンなどの特定の設定を無効にするには、値を-1
に設定します。fetchMarginPercent
現在のビューポートから広告を取得するために必要な最小距離が、ビューポートのサイズに対する割合として示されます。値が 0 の場合は「スロットがビューポートに入るとき」を、100 は「広告が 1 つのビューポートに表示されるとき」を表します。renderMarginPercent
現在のビューポートからスロットがレンダリングされる最小距離。広告のプリフェッチは可能ですが、他のサブリソースのレンダリングとダウンロードは待機します。この値は、ビューポートの割合としてfetchMarginPercent
と同じように機能します。mobileScaling
モバイル デバイスの余白に適用される調整比。これにより、モバイルとパソコンで異なる利益率を確保できます。たとえば、値を 2.0 にすると、モバイル デバイスではすべてのマージンが 2 倍になるため、取得とレンダリングを行う前のスロットの最小距離が長くなります。
enableSingleRequest
-
enableSingleRequest(): boolean
-
複数の広告を同時に取得するためのシングル リクエスト モードを有効にします。この場合、サービスを有効にする前に、すべてのパブリッシャー広告スロットを定義し、PubAdsService に追加する必要があります。サービスを有効にする前に、シングル リクエスト モードを設定する必要があります。
-
戻り値 boolean
シングル リクエスト モードが有効になっていた場合はtrue
を返し、サービスが有効になった後にメソッドが呼び出されたためにシングル リクエスト モードを有効にできない場合はfalse
を返します。
enableVideoAds
-
enableVideoAds(): void
-
ページに動画広告が表示されることを GPT に通知します。これにより、ディスプレイ広告と動画広告に競合相手の除外の制約を適用できます。動画コンテンツがわかっている場合は、
PubAdsService.setVideoContent
を呼び出して、ディスプレイ広告でコンテンツの除外を使用できるようにします。 -
get
-
get(key: string): null | string
-
指定されたキーに関連付けられた AdSense 属性の値を返します。
-
- 例
-
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'.
- 関連情報
-
パラメータ key: string
検索する属性の名前。 -
戻り値 null | string
属性キーの現在の値。キーが存在しない場合はnull
。
getAttributeKeys
-
getAttributeKeys(): string[]
-
このサービスに設定されている属性キーを返します。
-
- 例
-
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'].
-
戻り値 string[]
このサービスに設定された属性キーの配列。順序が定義されていません。
getTargeting
-
getTargeting(key: string): string[]
-
設定されている特定のカスタム サービスレベル ターゲティング パラメータを返します。
-
- 例
-
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).
-
パラメータ key: string
検索するターゲティング キー。 -
戻り値 string[]
このキーに関連付けられた値、またはそのようなキーがない場合は空の配列。
getTargetingKeys
-
getTargetingKeys(): string[]
-
設定されているすべてのカスタム サービスレベル ターゲティング キーのリストを返します。
-
- 例
-
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'].
-
戻り値 string[]
ターゲティング キーの配列です。順序が定義されていません。
isInitialLoadDisabled
-
isInitialLoadDisabled(): boolean
-
広告の最初のリクエストが前回の
PubAdsService.disableInitialLoad
呼び出しによって正常に無効にされたかどうかを返します。 -
-
戻り値 boolean
refresh
-
refresh(slots?: null | Slot[], options?: { changeCorrelator: boolean }): void
-
ページ上の特定またはすべてのスロットの新しい広告を取得して表示します。非同期レンダリング モードでのみ機能します。
すべてのブラウザで適切に動作させるには、refresh
を呼び出す前に、広告スロットdisplay
を呼び出します。display
の呼び出しを省略すると、Refresh が予期しない動作をすることがあります。必要に応じて、PubAdsService.disableInitialLoad
メソッドを使ってdisplay
による広告の取得を停止できます。
スロットを更新すると、GPT の長期保存ページビューから古い広告が削除されます。そのため、それ以降のリクエストは、その広告に関連するロードブロッキングや競合広告の除外の影響を受けなくなります。 -
- 例
-
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 });
- 関連情報
-
パラメータ slots?: null | Slot[]
更新するスロット。Array は省略可能です。指定しない場合は、すべてのスロットが更新されます。options?: { changeCorrelator: boolean }
この更新呼び出しに関連付けられている設定オプション。changeCorrelator
広告を取得するために新しい correlator を生成するかどうかを指定します。Google の広告サーバーではこの correlator 値が短時間(現在は 30 秒間ですが、変更される可能性あり)あります。そのため、同じ correlator 値が近い間にリクエストを受信した場合も 1 回のページビューとみなされます。デフォルトでは、更新のたびに新しい correlator が生成されます。
注: このオプションは、GPT の有効期間が長いページビューには影響しません。GPT の継続ページビューには、現在ページに掲載されている広告が自動的に反映され、有効期限はありません。
set
-
set(key: string, value: string): PubAdsService
-
パブリッシャー広告サービスのすべての広告スロットに適用される AdSense 属性の値を設定します。
同じキーでこれを複数回呼び出すと、そのキーに以前に設定された値はオーバーライドされます。display
またはrefresh
を呼び出す前に、すべての値を設定する必要があります。 -
- 例
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript(従来版)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- 関連情報
-
パラメータ key: string
属性名。value: string
属性値。 -
戻り値 PubAdsService
メソッドが呼び出されたサービス オブジェクト。
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): PubAdsService
-
指定されたラベル名に対してページレベルの広告カテゴリの除外を設定します。
-
- 例
-
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript(従来版)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- 関連情報
-
パラメータ categoryExclusion: string
追加する広告カテゴリの除外ラベル。 -
戻り値 PubAdsService
メソッドが呼び出されたサービス オブジェクト。
setCentering
-
setCentering(centerAds: boolean): void
-
広告の水平方向の中央配置を有効または無効にします。デフォルトでは、中央処理は無効になっています。従来の gpt_mobile.js では、デフォルトで中央に配置が有効になっています。
このメソッドの呼び出し後にリクエストされた広告のみが中央に配置されるため、このメソッドを呼び出してからdisplay
またはrefresh
を呼び出す必要があります。 -
- 例
-
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript(従来版)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
-
パラメータ centerAds: boolean
広告を中央に配置するにはtrue
、左揃えにするにはfalse
に設定します。
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
-
ページ上のすべての広告を SafeFrame コンテナを使って表示するかどうかを設定します。
この API を使用する場合は、次の点にご注意ください。- この設定は、それぞれのスロットに対して行われた後続の広告リクエストに対してのみ有効になります。
- スロットレベル設定が指定されている場合、常にページレベル設定よりも優先されます。
- (スロットレベルまたはページレベルで)
true
に設定した場合、Google アド マネージャー管理画面での選択に関係なく、広告は常に 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");
- 関連情報
-
パラメータ forceSafeFrame: boolean
true
: ページ上のすべての広告を SafeFrame で表示します。false
: 以前の設定を false に設定します。以前に指定していない場合、これをfalse
に設定しても、何も変更されません。 -
戻り値 PubAdsService
関数が呼び出されたサービス オブジェクト。
setLocation
-
setLocation(address: string): PubAdsService
-
広告申込情報を特定の場所に地域ターゲティングできるように、ウェブサイトから位置情報を渡します。
-
- 例
-
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript(従来版)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
-
パラメータ address: string
自由形式の住所。 -
戻り値 PubAdsService
メソッドが呼び出されたサービス オブジェクト。
setPrivacySettings
-
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
-
config オブジェクトを使用して、1 つの API ですべてのプライバシー設定を構成できます。
-
- 例
-
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, });
- 関連情報
-
パラメータ privacySettings: PrivacySettingsConfig
プライバシー設定の構成を含むオブジェクト。 -
戻り値 PubAdsService
関数が呼び出されたサービス オブジェクト。
setPublisherProvidedId
-
setPublisherProvidedId(ppid: string): PubAdsService
-
ニュース メディア指定 ID の値を設定します。
-
- 例
-
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript(従来版)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- 関連情報
-
パラメータ ppid: string
パブリッシャーが指定した英数字の ID。32 ~ 150 文字で指定してください。 -
戻り値 PubAdsService
メソッドが呼び出されたサービス オブジェクト。
setSafeFrameConfig
-
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
-
SafeFrame の設定についてページ単位で設定します。config オブジェクト内の認識されていないキーは無視されます。認識されたキーに無効な値が渡されると、設定全体が無視されます。
ページレベルの設定は、スロットレベルの設定(指定されている場合)によってオーバーライドされます。 -
- 例
-
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");
- 関連情報
-
パラメータ config: SafeFrameConfig
構成オブジェクト。 -
戻り値 PubAdsService
メソッドが呼び出されたサービス オブジェクト。
setTargeting
-
setTargeting(key: string, value: string | string[]): PubAdsService
-
特定のキーについて、パブリッシャー広告サービスのすべての広告スロットに適用されるカスタム ターゲティング パラメータを設定します。同じキーに対してこれを複数回呼び出すと、古い値が上書きされます。これらのキーは Google アド マネージャー アカウントで定義されます。
-
- 例
-
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"]);
- 関連情報
-
パラメータ key: string
ターゲティング パラメータ キー。value: string | string[]
ターゲティング パラメータ値、または値の配列。 -
戻り値 PubAdsService
メソッドが呼び出されたサービス オブジェクト。
setVideoContent
-
setVideoContent(videoContentId: string, videoCmsId: string): void
-
ターゲティングやコンテンツの除外を目的として、広告リクエストとともに動画コンテンツ情報を送信するように設定します。このメソッドが呼び出されると、動画広告が自動的に有効になります。
videoContentId
とvideoCmsId
には、Google アド マネージャー コンテンツ取り込みサービスに渡される値を使用します。 -
- 関連情報
-
パラメータ videoContentId: string
動画コンテンツ ID。videoCmsId: string
動画の CMS ID。
updateCorrelator
-
updateCorrelator(): PubAdsService
-
広告リクエストとともに送信される correlator 値を変更し、実質的に新しいページビューを開始します。相関値は、1 回のページビューから発生するすべての広告リクエストで同じで、ページビューごとに固有です。非同期モードにのみ適用されます。
注: これは GPT の有効期間が長いページビューには影響しません。GPT の有効期間が長いページビューは、実際のページに表示された広告を自動的に反映し、有効期限はありません。 -
- 例
-
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.
-
戻り値 PubAdsService
関数が呼び出されたサービス オブジェクト。
googletag。ResponseInformation
1 つの広告レスポンスを表すオブジェクト。
プロパティの概要 | |
---|---|
advertiserId
|
広告主の ID。
|
campaignId
|
キャンペーンの ID。
|
creativeId
|
クリエイティブの ID。
|
creativeTemplateId
|
広告のテンプレート ID。
|
lineItemId
|
広告申込情報の 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
-
amount: number
-
報酬に含まれるアイテムの数。
-
type
-
type: string
-
報酬に含まれるアイテムの種類(「コイン」など)。
-
googletag。SafeFrameConfig
SafeFrame コンテナの設定オブジェクトです。
プロパティの概要 | |
---|---|
allowOverlayExpansion
|
SafeFrame でページ コンテンツをオーバーレイして広告コンテンツを展開できるようにするかどうかを指定します。
|
allowPushExpansion
|
SafeFrame で、ページ コンテンツをプッシュして広告コンテンツを展開できるようにするかどうかを指定します。
|
sandbox
|
ユーザーが操作せずにトップレベル ナビゲーションにアクセスできないようにするために SafeFrame で HTML5 サンドボックス属性を使用するかどうかを指定します。
|
useUniqueDomain
|
非推奨。
純広告のクリエイティブに対して、SafeFrame でランダムなサブドメインを使用するかどうかを指定します。
|
allowOverlayExpansion
-
allowOverlayExpansion: boolean
-
SafeFrame でページ コンテンツをオーバーレイして広告コンテンツを展開できるようにするかどうかを指定します。
-
allowPushExpansion
-
allowPushExpansion: boolean
-
SafeFrame でページ コンテンツをプッシュして広告コンテンツをエキスパンドできるようにするかどうかを指定します。
-
sandbox
-
sandbox: boolean
-
ユーザーが操作せずにトップレベル ナビゲーションにアクセスできないようにするために SafeFrame で HTML5 サンドボックス属性を使用するかどうかを指定します。有効な値は
true
のみです(強制的にfalse
に設定することはできません)。sandbox 属性によりプラグイン(Flash など)が無効になります。 -
useUniqueDomain
-
useUniqueDomain: null | boolean
-
純広告のクリエイティブに対して、SafeFrame でランダムなサブドメインを使用するかどうかを指定します。保存されている値を消去するには、
null
を渡します。
注: この機能はデフォルトで有効になっています。
<ph type="x-smartling-placeholder">
googletag。Service
すべてのサービスに共通するメソッドを含む基本サービスクラス。
メソッドの概要 | |
---|---|
addEventListener
|
ページで特定の GPT イベントが発生したときに JavaScript 関数を設定して呼び出せるようにするリスナーを登録します。
|
getSlots
|
このサービスに関連付けられているスロットのリストを取得します。
|
removeEventListener
|
以前に登録されたリスナーを削除します。
|
addEventListener
-
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (arg: EventTypeMap[K]) => void): Service
-
ページで特定の GPT イベントが発生したときに JavaScript 関数を設定して呼び出せるようにするリスナーを登録します。次のイベントがサポートされています。
リスナーが呼び出されると、そのリスナーに適切なイベントタイプのオブジェクトが渡されます。 -
- 例
-
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. } });
- 関連情報
-
パラメータ eventType: K
GPT によって生成されたイベントのタイプを表す文字列。イベントタイプでは大文字と小文字が区別されます。listener: (arg: EventTypeMap[K]) => void
単一のイベント オブジェクト引数を取る関数。 -
戻り値 Service
メソッドが呼び出されたサービス オブジェクト。
getSlots
removeEventListener
-
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (event: EventTypeMap[K]) => void): void
-
以前に登録されたリスナーを削除します。
-
- 例
-
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(); });
-
パラメータ eventType: K
GPT によって生成されたイベントのタイプを表す文字列。イベントタイプでは大文字と小文字が区別されます。listener: (event: EventTypeMap[K]) => void
単一のイベント オブジェクト引数を取る関数。
googletag。SizeMappingBuilder
サイズ マッピング指定オブジェクトのビルダー。このビルダーは、サイズ指定を簡単に作成できるように提供されています。
メソッドの概要 | |
---|---|
addSize
|
単一サイズの配列(ビューポートを表す)から、スロットを表す単一サイズまたは複数サイズの配列へのマッピングを追加します。
|
build
|
このビルダーに追加されたマッピングからサイズマップの仕様を作成します。
|
- 関連情報
addSize
-
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
-
単一サイズの配列(ビューポートを表す)から、スロットを表す単一サイズまたは複数サイズの配列へのマッピングを追加します。
-
- 例
-
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]
-
パラメータ viewportSize: SingleSizeArray
このマッピング エントリのビューポートのサイズ。slotSize: GeneralSize
このマッピング エントリのスロットのサイズ。 -
戻り値 SizeMappingBuilder
このビルダーへの参照。
build
-
build(): null | SizeMappingArray
-
このビルダーに追加されたマッピングからサイズマップの仕様を作成します。
無効なマッピングが指定された場合、このメソッドはnull
を返します。それ以外の場合は、Slot.defineSizeMapping
に渡す正しい形式の仕様を返します。
注: このメソッドを呼び出した後のビルダーの動作は未定義です。 -
-
戻り値 null | SizeMappingArray
このビルダーで構築された結果。無効なサイズ マッピングが指定されている場合は null になる可能性があります。
googletag。Slot
Slot は、ページ上の 1 つの広告スロットを表すオブジェクトです。
メソッドの概要 | |
---|---|
addService
|
Service をこのスロットに追加します。
|
clearCategoryExclusions
|
このスロットのスロットレベルの広告カテゴリの除外ラベルをすべて削除します。
|
clearTargeting
|
このスロットの特定またはすべてのカスタム スロットレベルのターゲティング パラメータを削除します。
|
defineSizeMapping
|
最小ビューポート サイズからこのスロットのスロットサイズへのマッピングの配列を設定します。
|
get
|
このスロットの指定されたキーに関連付けられている AdSense 属性の値を返します。
|
getAdUnitPath
|
広告ユニットのフルパスを、ネットワーク コードと広告ユニットのパスとともに返します。
|
getAttributeKeys
|
このスロットに設定されている属性キーのリストを返します。
|
getCategoryExclusions
|
このスロットの広告カテゴリの除外ラベルを返します。
|
getResponseInformation
|
広告レスポンス情報を返します。
|
getSlotElementId
|
スロットが定義されたときに提供されたスロット
div の ID を返します。
|
getTargeting
|
このスロットに設定された特定のカスタム ターゲティング パラメータを返します。
|
getTargetingKeys
|
このスロットに設定されているすべてのカスタム ターゲティング キーのリストを返します。
|
set
|
この広告スロットの AdSense 属性の値を設定します。
|
setCategoryExclusion
|
このスロットにスロットレベルの広告カテゴリの除外ラベルを設定します。
|
setClickUrl
|
ユーザーが広告をクリックしたときにリダイレクトされるクリック URL を設定します。
|
setCollapseEmptyDiv
|
スロットに広告がない場合にスロット
div を非表示にするかどうかを設定します。
|
setConfig
|
このスロットの一般的な構成オプションを設定します。
|
setForceSafeFrame
|
このスロットの広告を SafeFrame コンテナを使って表示するかどうかを設定します。
|
setSafeFrameConfig
|
SafeFrame の設定についてスロットレベルで設定します。
|
setTargeting
|
このスロットのカスタム ターゲティング パラメータを設定します。
|
updateTargetingFromMap
|
JSON オブジェクトの Key-Value マップから、このスロットのカスタム ターゲティング パラメータを設定します。
|
addService
-
Service
をこのスロットに追加します。 -
- 例
-
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());
- 関連情報
-
パラメータ service: Service
追加するサービス。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
clearCategoryExclusions
-
clearCategoryExclusions(): Slot
-
このスロットのスロットレベルの広告カテゴリの除外ラベルをすべて削除します。
-
- 例
-
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.
-
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
clearTargeting
-
clearTargeting(key?: string): Slot
-
このスロットの特定またはすべてのカスタム スロットレベルのターゲティング パラメータを削除します。
-
- 例
-
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.
- 関連情報
-
パラメータ key?: string
ターゲティング パラメータ キー。キーは省略可能です。指定しない場合は、すべてのターゲティング パラメータが消去されます。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
defineSizeMapping
-
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
-
最小ビューポート サイズからこのスロットのスロットサイズへのマッピングの配列を設定します。
-
- 例
-
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!);
- 関連情報
-
パラメータ sizeMapping: SizeMappingArray
サイズ マッピングの配列。SizeMappingBuilder
を使用して作成できます。各サイズ マッピングは、SingleSizeArray
とGeneralSize
の 2 つの要素の配列です。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
get
-
get(key: string): null | string
-
このスロットの指定されたキーに関連付けられている AdSense 属性の値を返します。このスロットに継承されたサービスレベルの属性を表示するには、
PubAdsService.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'.
- 関連情報
-
パラメータ key: string
検索する属性の名前。 -
戻り値 null | string
属性キーの現在の値。キーが存在しない場合はnull
。
getAdUnitPath
-
getAdUnitPath(): string
-
広告ユニットのフルパスを、ネットワーク コードと広告ユニットのパスとともに返します。
-
- 例
-
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'.
-
戻り値 string
広告ユニットのパス。
getAttributeKeys
-
getAttributeKeys(): string[]
-
このスロットに設定されている属性キーのリストを返します。このスロットに継承されたサービスレベル属性のキーを表示するには、
PubAdsService.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'].
-
戻り値 string[]
属性キーの配列。順序が定義されていません。
getCategoryExclusions
-
getCategoryExclusions(): string[]
-
このスロットの広告カテゴリの除外ラベルを返します。
-
- 例
-
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'].
-
戻り値 string[]
このスロットの広告カテゴリの除外ラベル。設定されていない場合は空の配列。
getResponseInformation
-
getResponseInformation(): null | ResponseInformation
-
広告レスポンス情報を返します。これは、スロットに対する最後の広告レスポンスに基づきます。スロットに広告がないときにこのメソッドが呼び出されると、
null
が返されます。 -
-
戻り値 null | ResponseInformation
最新の広告レスポンス情報。スロットに広告がない場合はnull
。
getSlotElementId
-
getSlotElementId(): string
-
スロットが定義されたときに提供されたスロット
div
の ID を返します。 -
- 例
-
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'.
-
戻り値 string
スロットdiv
ID。
getTargeting
-
getTargeting(key: string): string[]
-
このスロットに設定された特定のカスタム ターゲティング パラメータを返します。サービスレベルのターゲティング パラメータは含まれません。
-
- 例
-
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).
-
パラメータ key: string
検索するターゲティング キー。 -
戻り値 string[]
このキーに関連付けられた値、またはそのようなキーがない場合は空の配列。
getTargetingKeys
-
getTargetingKeys(): string[]
-
このスロットに設定されているすべてのカスタム ターゲティング キーのリストを返します。サービスレベルのターゲティング キーは含まれません。
-
- 例
-
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'].
-
戻り値 string[]
ターゲティング キーの配列です。順序が定義されていません。
set
-
set(key: string, value: string): Slot
-
この広告スロットの AdSense 属性の値を設定します。これにより、このキーのサービスレベルで設定された値がすべてオーバーライドされます。
同じキーに対してこのメソッドを複数回呼び出すと、そのキーに以前に設定された値がオーバーライドされます。display
またはrefresh
を呼び出す前に、すべての値を設定する必要があります。 -
- 例
-
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());
- 関連情報
-
パラメータ key: string
属性名。value: string
属性値。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): Slot
-
このスロットにスロットレベルの広告カテゴリの除外ラベルを設定します。
-
- 例
-
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());
- 関連情報
-
パラメータ categoryExclusion: string
追加する広告カテゴリの除外ラベル。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
setClickUrl
-
setClickUrl(value: string): Slot
-
広告をクリックしたユーザーをリダイレクトするクリック URL を設定します。
クリック URL が置き換えられても、Google アド マネージャーのサーバーはクリックを記録します。配信されるクリエイティブに関連付けられているランディング ページ URL は、指定した値に追加されます。それ以降の呼び出しでは値が上書きされます。これは SRA 以外のリクエストに対してのみ有効です。 -
- 例
-
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());
-
パラメータ value: string
設定するクリック URL。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
setCollapseEmptyDiv
-
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
-
スロットに広告がない場合にスロット
div
を非表示にするかどうかを設定します。これはサービスレベルの設定をオーバーライドします。 -
- 例
-
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.
- 関連情報
-
パラメータ collapse: boolean
広告が返されない場合にスロットを閉じるかどうかを指定します。collapseBeforeAdFetch?: boolean
広告の取得前でもスロットを閉じるかどうかを指定します。折りたたみがtrue
でない場合は無視されます。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
setConfig
-
setConfig(slotConfig: SlotSettingsConfig): void
-
このスロットの一般的な構成オプションを設定します。
-
-
パラメータ slotConfig: SlotSettingsConfig
構成オブジェクト。
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): Slot
-
このスロットの広告を SafeFrame コンテナを使って表示するかどうかを設定します。
この API を使用する場合は、次の点にご注意ください。- この設定は、それぞれのスロットに対して行われた後続の広告リクエストに対してのみ有効になります。
- スロットレベル設定が指定されている場合、常にページレベル設定よりも優先されます。
- (スロットレベルまたはページレベルで)
true
に設定した場合、Google アド マネージャー管理画面での選択に関係なく、広告は常に 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());
- 関連情報
-
パラメータ forceSafeFrame: boolean
true
: このスロットのすべての広告を SafeFrame で表示します。false
: ページ単位の設定を無効にします(存在する場合)。ページレベルで指定されていない場合は、これをfalse
に設定しても、何も変更されません。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
setSafeFrameConfig
-
setSafeFrameConfig(config: null | SafeFrameConfig): Slot
-
SafeFrame の設定についてスロットレベルで設定します。config オブジェクト内の認識されないキーは無視されます。認識されたキーに無効な値が渡されると、設定全体が無視されます。
これらのスロットレベル設定を指定すると、ページレベル設定がオーバーライドされます。 -
- 例
-
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");
- 関連情報
-
パラメータ config: null | SafeFrameConfig
構成オブジェクト。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
setTargeting
-
setTargeting(key: string, value: string | string[]): Slot
-
このスロットのカスタム ターゲティング パラメータを設定します。同じキーに対してこのメソッドを複数回呼び出すと、古い値が上書きされます。ここで設定した値により、サービスレベルで設定されたターゲティング パラメータが上書きされます。これらのキーは Google アド マネージャー アカウントで定義されます。
-
- 例
-
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"]);
- 関連情報
-
パラメータ key: string
ターゲティング パラメータ キー。value: string | string[]
ターゲティング パラメータ値、または値の配列。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
updateTargetingFromMap
-
updateTargetingFromMap(map: { [adUnitPath: string]: string | string[] }): Slot
-
JSON オブジェクトの Key-Value マップから、このスロットのカスタム ターゲティング パラメータを設定します。これは、オブジェクトのすべてのキー値に対して
Slot.setTargeting
を呼び出す場合と同じです。これらのキーは Google アド マネージャー アカウントで定義されています。
注:- 上書きする場合、最後の値のみが保持されます。
- 値が配列の場合、以前の値はマージされず、上書きされます。
- ここで設定した値により、サービスレベルで設定されたターゲティング パラメータが上書きされます。
-
- 例
-
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"], });
-
パラメータ map: { [adUnitPath: string]: string | string[] }
ターゲティング パラメータの Key-Value マップ。 -
戻り値 Slot
メソッドが呼び出されたスロット オブジェクト。
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 }, });
enabled
-
enabled: boolean
-
広告拡張が有効か無効か。
この値を設定すると、Google アド マネージャーで設定されたデフォルト設定がオーバーライドされます。
googletag.config.ComponentAuctionConfig
デバイス上の広告オークションにおける単一コンポーネントのオークションを表すオブジェクト。
プロパティの概要 | |
---|---|
auctionConfig
|
このコンポーネントのオークション設定オブジェクト。
|
configKey
|
このコンポーネントのオークションに関連付けられている設定キー。
|
auctionConfig
-
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
の既存の設定はすべて削除されます。 -
- 例
-
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, }, ], });
- 関連情報
configKey
-
configKey: string
-
このコンポーネントのオークションに関連付けられている設定キーです。
この値は空にできず、一意である必要があります。2 つのComponentAuctionConfig
オブジェクトが同じ configKey 値を共有している場合、最後に設定されるオブジェクトが以前の構成を上書きします。 -
googletag.config.InterstitialConfig
1 つのインタースティシャル広告スロットの動作を定義するオブジェクト。
プロパティの概要 | |
---|---|
triggers
|
このインタースティシャル広告のインタースティシャル トリガー設定。
|
triggers
-
triggers: Partial<Record<InterstitialTrigger, boolean>>
-
このインタースティシャル広告のインタースティシャル トリガー設定。
インタースティシャル トリガーの値をtrue
に設定すると有効になり、false
に設定すると無効になります。これにより、Google アド マネージャーで設定されているデフォルト値がオーバーライドされます。 -
- 例
-
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, }, }, });
- 関連情報
googletag.config.PageSettingsConfig
ページレベル設定用のメイン設定インターフェース。
1 回の API 呼び出しで複数の機能を設定できます。
以下のプロパティはすべて例であり、setConfig を使用する実際の機能を反映したものではありません。一連の機能については、下記の PageSettingsConfig タイプのフィールドをご覧ください。
例:
setConfig
呼び出しで指定された対象物のみが変更されます。// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- 特定の機能のすべての設定は、
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, });
を渡します。
プロパティの概要 | |
---|---|
adExpansion
|
広告拡張を管理するための設定です。
|
adYield
|
クリエイティブのレンダリング時に GPT で JS スレッドを生成するかどうかを制御する設定です。
|
pps
|
パブリッシャー提供のシグナル(PPS)を管理するための設定です。
|
privacyTreatments
|
パブリッシャーのプライバシーの取り扱いを管理するための設定です。
|
adExpansion
-
adExpansion: null | AdExpansionConfig
-
広告拡張を管理するための設定です。
-
adYield
-
adYield: null | "DISABLED" | "ENABLED_ALL_SLOTS"
-
クリエイティブのレンダリング時に GPT で JS スレッドを生成するかどうかを制御する設定です。
GPT は、Scheduler.postTask API をサポートするブラウザでのみ生成されます。
サポートされている値:null
(デフォルト): GPT はビューポートの外部にあるスロットに対して JS スレッドを生成します。ENABLED_ALL_SLOTS
: スロットがビューポート内にあるかどうかにかかわらず、GPT はすべてのスロットに対して JS スレッドを生成します。DISABLED
: GPT は JS スレッドを生成しません。
-
- 例
-
JavaScript
// Disable yielding. googletag.setConfig({ adYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ adYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ adYield: null });
JavaScript(従来版)
// Disable yielding. googletag.setConfig({ adYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ adYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ adYield: null });
TypeScript
// Disable yielding. googletag.setConfig({ adYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ adYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ adYield: null });
- 関連情報
pps
-
pps: null | PublisherProvidedSignalsConfig
-
パブリッシャー提供のシグナル(PPS)を管理するための設定です。
-
privacyTreatments
-
privacyTreatments: null | PrivacyTreatmentsConfig
-
パブリッシャーのプライバシーの取り扱いを管理するための設定です。
-
googletag.config.PrivacyTreatmentsConfig
パブリッシャーのプライバシーの取り扱いを管理するための設定です。
プロパティの概要 | |
---|---|
treatments
|
有効にできるニュース メディア向けのさまざまなプライバシーの取り扱い。
|
treatments
-
treatments: "disablePersonalization"[]
-
有効にできるニュース メディア向けのさまざまなプライバシーの取り扱い。
-
- 例
-
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"] }, });
googletag.config.PublisherProvidedSignalsConfig
パブリッシャー提供のシグナル(PPS)設定オブジェクト。
プロパティの概要 | |
---|---|
taxonomies
|
Taxonomy マッピングを含むオブジェクト。
|
- 例
-
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '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 | 18-20' // '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 | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
- 関連情報
taxonomies
-
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
-
Taxonomy マッピングを含むオブジェクト。
-
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, });
を渡します。
プロパティの概要 | |
---|---|
adExpansion
|
広告拡張を管理するための設定です。
|
componentAuction
|
デバイス上の広告オークションに参加するコンポーネント オークションの配列。
|
interstitial
|
インタースティシャル広告スロットの動作を制御する設定です。
|
adExpansion
-
adExpansion: AdExpansionConfig
-
広告拡張を管理するための設定です。
-
componentAuction
-
componentAuction: ComponentAuctionConfig[]
-
デバイス上の広告オークションに参加するコンポーネント オークションの配列。
-
interstitial
-
interstitial: InterstitialConfig
-
インタースティシャル広告スロットの動作を制御する設定です。
-
googletag.config.TaxonomyData
単一の Taxonomy の値を含むオブジェクト。
プロパティの概要 | |
---|---|
values
|
Taxonomy の値のリスト。
|
values
-
values: string[]
-
Taxonomy の値のリスト。
-
googletag.events.Event
すべての GPT イベントの基本インターフェース。以下のすべての GPT イベントには、次のフィールドがあります。
プロパティの概要 | |
---|---|
serviceName
|
イベントをトリガーしたサービスの名前。
|
slot
|
イベントをトリガーしたスロット。
|
- 関連情報
serviceName
-
serviceName: string
-
イベントをトリガーしたサービスの名前。
-
slot
-
slot: Slot
-
イベントをトリガーしたスロット。
-
googletag.events.EventTypeMap
これは、Service.addEventListener
と Service.removeEventListener
の対応するイベント オブジェクト タイプにイベント名をマッピングする疑似型です。参照と型安全性のためにのみ文書化しています。
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.ImpressionViewableEvent
拡張
このイベントは、アクティブ ビューの条件に沿って、インプレッションが視認可能になると発生します。
プロパティの概要 | |
---|---|
serviceName
|
イベントをトリガーしたサービスの名前。
|
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
拡張
このイベントは、リワード広告スロットがユーザーによって閉じられたときに発生します。このアラートは、報酬が付与された前または後に発行されます。報酬が付与されているかどうかを確認するには、代わりに events.RewardedSlotGrantedEvent
を使用します。
プロパティの概要 | |
---|---|
serviceName
|
イベントをトリガーしたサービスの名前。
|
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
拡張
このイベントは、リワード広告の視聴に対して特典が付与されると発生します。報酬を付与するための条件が満たされる前に広告が閉じられた場合、このイベントは起動しません。
プロパティの概要 | |
---|---|
payload
|
付与された報酬に関する情報を含むオブジェクト。
|
serviceName
|
イベントをトリガーしたサービスの名前。
|
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
-
payload: null | RewardedPayload
-
付与された報酬に関する情報を含むオブジェクト。
-
googletag.events.RewardedSlotReadyEvent
拡張
このイベントは、リワード広告を表示する準備が整うと発生します。パブリッシャーは、広告を表示する前に、表示するオプションをユーザーに提示します。
プロパティの概要 | |
---|---|
serviceName
|
イベントをトリガーしたサービスの名前。
|
slot
|
イベントをトリガーしたスロット。
|
メソッドの概要 | |
---|---|
makeRewardedVisible
|
リワード広告を表示します。
|
- 例
-
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
-
makeRewardedVisible(): void
-
リワード広告を表示します。このメソッドは、ユーザーが広告の表示に同意するまで呼び出さないでください。
-
googletag。events.SlotOnloadEvent
拡張
このイベントは、クリエイティブの iframe で読み込みイベントが発生すると発生します。同期レンダリング モードでリッチメディア広告をレンダリングする場合、iframe は使用されないため、SlotOnloadEvent
は呼び出されません。
プロパティの概要 | |
---|---|
serviceName
|
イベントをトリガーしたサービスの名前。
|
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
拡張
このイベントは、クリエイティブ コードがスロットに挿入されると発生します。このイベントはクリエイティブのリソースが取得される前に発生するため、クリエイティブがまだ表示されていない可能性があります。あるスロットのすべてのクリエイティブ リソースの読み込みが完了したタイミングを確認する必要がある場合は、代わりに events.SlotOnloadEvent
の使用を検討してください。
プロパティの概要 | |
---|---|
advertiserId
|
レンダリングされた広告の広告主 ID。
|
campaignId
|
レンダリングされた広告のキャンペーン ID。
|
companyIds
|
レンダリングされたバックフィル広告に入札した企業の ID。
|
creativeId
|
レンダリングされた予約広告のクリエイティブ ID。
|
creativeTemplateId
|
レンダリングされた純広告のクリエイティブ テンプレート ID。
|
isBackfill
|
広告がバックフィル広告かどうか。
|
isEmpty
|
スロットで広告が返されたかどうか。
|
labelIds
|
レンダリングされた広告のラベル ID。
|
lineItemId
|
レンダリングされた純広告の広告申込情報 ID。
|
serviceName
|
イベントをトリガーしたサービスの名前。
|
size
|
レンダリングされたクリエイティブのピクセルサイズを示します。
|
slot
|
イベントをトリガーしたスロット。
|
slotContentChanged
|
レンダリングされた広告とともにスロット コンテンツが変更されたかどうか。
|
sourceAgnosticCreativeId
|
レンダリングされた予約広告のクリエイティブ ID またはバックフィル広告のクリエイティブ ID。
|
sourceAgnosticLineItemId
|
レンダリングされた予約広告またはバックフィル広告の広告申込情報 ID。
|
yieldGroupIds
|
レンダリングされたバックフィル広告の収益グループの 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("Label IDs:", event.labelIds); 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("Label IDs:", event.labelIds); 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("Label IDs:", event.labelIds); 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[]
-
レンダリングされた広告のラベル ID。空のスロット、バックフィル広告、
PubAdsService
以外のサービスでレンダリングされたクリエイティブの場合、値はnull
です。 -
lineItemId
-
lineItemId: null | number
-
レンダリングされた純広告の広告申込情報 ID。空のスロット、バックフィル広告、
PubAdsService
以外のサービスでレンダリングされたクリエイティブの場合、値はnull
です。 -
size
-
size: null | string | number[]
-
レンダリングされたクリエイティブのピクセルサイズを示します。例:
[728, 90]
。空の広告スロットの値はnull
です。 -
slotContentChanged
-
slotContentChanged: boolean
-
レンダリングされた広告とともにスロット コンテンツが変更されたかどうか。コンテンツが変更された場合、値は
true
、それ以外の場合はfalse
です。 -
sourceAgnosticCreativeId
-
sourceAgnosticCreativeId: null | number
-
レンダリングされた予約広告のクリエイティブ ID またはバックフィル広告のクリエイティブ ID。広告が予約広告または広告申込情報のバックフィルでない場合、またはクリエイティブが
PubAdsService
以外のサービスによってレンダリングされる場合、値はnull
になります。 -
sourceAgnosticLineItemId
-
sourceAgnosticLineItemId: null | number
-
レンダリングされた予約広告またはバックフィル広告の広告申込情報 ID。広告が予約広告または広告申込情報のバックフィルでない場合、またはクリエイティブが
PubAdsService
以外のサービスによってレンダリングされる場合、値はnull
になります。 -
yieldGroupIds
-
yieldGroupIds: null | number[]
-
レンダリングされたバックフィル広告の収益グループの ID。空のスロット、純広告、
PubAdsService
以外のサービスでレンダリングされたクリエイティブの場合、値はnull
です。 -
googletag.events.SlotRequestedEvent
拡張
このイベントは、特定のスロットで広告がリクエストされると発生します。
プロパティの概要 | |
---|---|
serviceName
|
イベントをトリガーしたサービスの名前。
|
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
拡張
このイベントは、特定のスロットで広告レスポンスを受信すると発生します。
プロパティの概要 | |
---|---|
serviceName
|
イベントをトリガーしたサービスの名前。
|
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
拡張
このイベントは、画面上の広告スロットの領域の割合が変化するたびに発生します。このイベントはスロットリングされ、200 ミリ秒に 1 回を超える頻度では発生しません。
プロパティの概要 | |
---|---|
inViewPercentage
|
広告領域のうち視認可能な部分の割合。
|
serviceName
|
イベントをトリガーしたサービスの名前。
|
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.BidderSignalProvider
特定のビッダーのセキュア シグナルを返します。
ビッダーのセキュア シグナル プロバイダは、次の 2 つの部分で構成されます。
- セキュア シグナルに解決される
Promise
を返すコレクタ関数。 - シグナルに関連付けられているビッダーを識別する
id
。
secureSignals.PublisherSignalProvider
を使用します。
プロパティの概要 | |
---|---|
collectorFunction
|
をタップします。
|
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>
-
id
-
id: string
-
このセキュア シグナルに関連付けられたコレクタの一意の識別子(Google アド マネージャーに登録されている)。
-
googletag.secureSignals.PublisherSignalProvider
特定のパブリッシャーのセキュア シグナルを返します。
パブリッシャー シグナルのプロバイダは、次の 2 つの部分で構成されます。
- セキュア シグナルに解決される
Promise
を返すコレクタ関数。 - シグナルに関連付けられているパブリッシャーを識別する
networkCode
。
secureSignals.BidderSignalProvider
を使用します。
プロパティの概要 | |
---|---|
collectorFunction
|
をタップします。
|
networkCode
|
このセキュア シグナルに関連付けられているパブリッシャーのネットワーク コード(広告ユニットのパスに表示される)。
|
- 例
-
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>
-
networkCode
-
networkCode: string
-
このセキュア シグナルに関連付けられているパブリッシャーのネットワーク コード(広告ユニットのパスに表示される)。
-
googletag.secureSignals.SecureSignalProvidersArray
セキュア シグナルを管理するためのインターフェース。
メソッドの概要 | |
---|---|
clearAllCache
|
すべてのコレクタのすべてのシグナルをキャッシュから消去します。
|
push
|
新しい
secureSignals.SecureSignalProvider をシグナル プロバイダの配列に追加し、シグナルの生成プロセスを開始します。
|
clearAllCache
-
clearAllCache(): void
-
キャッシュからすべてのコレクタのすべてのシグナルを消去します。
このメソッドを呼び出すと、現在および将来のページビューの広告リクエストにシグナルが含まれる可能性が低下する可能性があります。そのため、新しいユーザーを示すイベント(ログイン、ログアウト、登録など)など、意味のある状態変化が発生した場合にのみ呼び出す必要があります。 -
push
-
push(provider: SecureSignalProvider): void
-
新しい
secureSignals.SecureSignalProvider
をシグナル プロバイダの配列に追加し、シグナルの生成プロセスを開始します。 -
-
パラメータ provider: SecureSignalProvider
配列に追加するsecureSignals.SecureSignalProvider
オブジェクト。