GPT リファレンス

このリファレンスでは、TypeScript 表記を使用して型を記述しています。次の表に、例を挙げて簡単に説明します。

型式
string プリミティブ文字列型。
string[] 値が文字列のみの配列型。
number | string 値が数値または文字列のいずれかになる可能性がある共用体型。
Array<number | string> 配列型。値は複合（共用体）型です。
[number, string] タプル型。値は 2 つの要素の配列で、数値と文字列をこの順序で含める必要があります。
Slot オブジェクト型。値は googletag.Slot のインスタンスです。
() => void 引数と戻り値が定義されていない関数型。

サポートされている型と型式の詳細については、 TypeScript ハンドブック をご覧ください。

型アノテーション

変数、パラメータ名、プロパティ名、関数シグネチャの後のコロンは、型アノテーションを示します。型アノテーションは、コロンの左側の要素が受け入れるか返すことができる型を記述します。次の表に、このリファレンスで表示される可能性のある型アノテーションの例を示します。

型アノテーション
param: string param が文字列値を受け取るか、文字列値を返すことを示します。この構文は、変数、パラメータ、プロパティ、戻り値の型に使用されます。
param?: number | string param は省略可能ですが、指定する場合は数値または文字列のいずれかを受け入れることを示します。この構文は、パラメータとプロパティに使用されます。
...params: Array<() => void> params が関数を受け入れる 残余パラメータ であることを示します。残りのパラメータは、指定された型の値を無制限に受け入れます。

googletag

Google パブリッシャー タグが API に使用するグローバル名前空間。
名前空間
config
ページ単位の設定のメイン構成インターフェース。
enums
これは、GPT が列挙型に使用する Namespace です。
events
これは、GPT がイベントに使用する Namespace です。
secureSignals
これは、GPT がセキュア シグナルの管理に使用する名前空間です。
インターフェース
CommandArray
コマンド配列は関数シーケンスを受け取り、順番に呼び出します。
CompanionAdsService
コンパニオン広告サービス。
PrivacySettingsConfig
プライバシー設定の構成オブジェクト。
PubAdsService
パブリッシャー広告サービス。
ResponseInformation
単一の広告レスポンスを表すオブジェクト。
RewardedPayload
リワード広告に関連付けられた報酬を表すオブジェクト。
Service
すべてのサービスに共通のメソッドを含むベース サービス クラス。
SizeMappingBuilder
サイズ マッピング仕様オブジェクトのビルダー。
Slot
スロットは、ページ上の 1 つの広告スロットを表すオブジェクトです。
型エイリアス
GeneralSize
スロットの有効なサイズ構成。1 つまたは複数のサイズを指定できます。
MultiSize
有効な単一サイズのリスト。
NamedSize
スロットが持つことができる名前付きサイズ。
SingleSize
スロットの有効なサイズが 1 つ。
SingleSizeArray
[幅、高さ] を表す 2 つの数値の配列。
SizeMapping
ビューポート サイズと広告サイズの対応付け。
SizeMappingArray
サイズ マッピングのリスト。
変数
apiReady
GPT API が読み込まれ、呼び出しの準備が整ったことを示すフラグ。
cmd
GPT 関連の呼び出しを非同期で実行するためのグローバル コマンドキューへの参照。
pubadsReady
PubAdsService が有効化され、読み込まれ、完全に動作していることを示すフラグ。
secureSignalProviders
セキュア シグナル プロバイダの配列への参照。
関数
companionAds
CompanionAdsService への参照を返します。
defineOutOfPageSlot
指定した広告ユニットのパスでページ外広告スロットを作成します。
defineSlot
指定された広告ユニットのパスとサイズで広告スロットを作成し、広告を表示するページの div 要素の ID に関連付けます。
destroySlots
指定されたスロットを破棄し、それらのスロットに関連するすべてのオブジェクトと参照を GPT から削除します。
disablePublisherConsole
Google パブリッシャー コンソールを無効にします。
display
スロットをレンダリングするようスロットサービスに指示します。
enableServices
ページ上の広告スロットに定義されているすべての GPT サービスを有効にします。
getConfig
setConfig で設定されたページの一般的な構成オプションを取得します。
getVersion
GPT の現在のバージョンを返します。
openConsole
Google パブリッシャー コンソールが開きます。
pubads
PubAdsService への参照を返します。
setAdIframeTitle
この時点以降に PubAdsService によって作成されるすべての広告コンテナ iframe のタイトルを設定します。
setConfig
ページの一般的な構成オプションを設定します。
sizeMapping
新しい SizeMappingBuilder を作成します。

型エイリアス

GeneralSize

GeneralSize: SingleSize | MultiSize
スロットの有効なサイズ構成。1 つまたは複数のサイズを指定できます。

MultiSize

MultiSize: SingleSize[]
有効な単一サイズのリスト。

NamedSize

NamedSize: "fluid" | ["fluid"]
スロットが持つことができる名前付きサイズ。ほとんどの場合、サイズは固定サイズの長方形ですが、他の種類のサイズ指定が必要な場合もあります。有効な名前付きサイズは次のとおりです。
  • fluid: 広告コンテナは親 div の幅を 100% 取得し、クリエイティブ コンテンツに合わせて高さを調整します。ページ上の通常のブロック要素の動作と同様です。ネイティブ広告に使用されます（関連する記事を参照）。fluid と ['fluid'] の両方で、スロットサイズを流動的として宣言できます。

SingleSize

スロットの有効なサイズが 1 つ。

SingleSizeArray

SingleSizeArray: [number, number]
[幅、高さ] を表す 2 つの数値の配列。

SizeMapping

ビューポート サイズと広告サイズの対応付け。レスポンシブ広告で使用されます。

SizeMappingArray

SizeMappingArray: SizeMapping[]
サイズ マッピングのリスト。

変数

Const apiReady

apiReady: boolean | undefined
GPT API が読み込まれ、呼び出しの準備が整ったことを示すフラグ。このプロパティは、API の準備が整うまで undefined になります。

非同期処理の推奨方法は、GPT の準備が整ったときにコールバックをキューに入れるために googletag.cmd を使用することです。これらのコールバックは、API の設定が完了すると必ず実行されるため、googletag.apiReady をチェックする必要はありません。

Const cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray
GPT 関連の呼び出しを非同期で実行するためのグローバル コマンドキューへの参照。

ページの GPT タグ構文によって googletag.cmd 変数が空の JavaScript 配列に初期化され、cmd.push は配列の末尾に要素を追加する標準の Array.push メソッドです。GPT JavaScript が読み込まれると、配列が確認され、すべての関数が順に実行されます。次に、スクリプトは cmd を CommandArray オブジェクトに置き換えます。このオブジェクトの push メソッドは、渡された関数引数を実行するように定義されています。このメカニズムにより、GPT は 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());
});

Const pubadsReady

pubadsReady: boolean | undefined
PubAdsService が有効化され、読み込まれ、完全に動作していることを示すフラグ。このプロパティは、enableServices が呼び出され、PubAdsService が読み込まれて初期化されるまで、単に undefined になります。

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");
  },
});
関連情報

関数

companionAds

companionAds(): CompanionAdsService
CompanionAdsService への参照を返します。
戻り値
CompanionAdsServiceコンパニオン広告サービス。

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ネットワーク コードと広告ユニット コードを含む完全な広告ユニットのパス。
Optional div: string | OutOfPageFormatこの広告ユニットまたは OutOfPageFormat を含む div の ID。
戻り値
Slot | null新しく作成されたスロット。スロットを作成できない場合は null。

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追加されたスロットの幅と高さ。レスポンシブ サイズのマッピングが指定されていない場合、またはビューポートのサイズがマッピングで指定された最小サイズよりも小さい場合は、このサイズが広告リクエストで使用されます。
Optional div: stringこの広告ユニットを含む div の ID。
戻り値
Slot | null新しく作成されたスロット。スロットを作成できない場合は null。

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();
パラメータ
Optional slots: Slot[]破棄するスロットの配列。配列は省略可能です。指定しない場合、すべてのスロットが破棄されます。
戻り値
booleanスロットが破棄された場合は true、それ以外の場合は false。

disablePublisherConsole

disablePublisherConsole(): void
Google サイト運営者コンソールを無効にします。
関連情報

ディスプレイ

display(divOrSlot: string | Element | Slot): void
スロット サービスにスロットのレンダリングを指示します。各広告スロットは 1 ページに 1 回のみ表示する必要があります。スロットはすべて定義され、サービスが関連付けられてから表示される必要があります。要素が DOM に存在しない限り、表示呼び出しは行われません。通常、この処理は、メソッド呼び出しで指定された div 要素内のスクリプト ブロックに配置することで実現します。

シングル リクエスト アーキテクチャ（SRA）を使用している場合、このメソッドが呼び出された時点で取得されていないすべての広告スロットが一度に取得されます。広告スロットを強制的に非表示にするには、div 全体を削除する必要があります。
関連情報
パラメータ
divOrSlot: string | Element | Slot広告スロットを含む div 要素の ID、div 要素、またはスロット オブジェクトのいずれか。div 要素が指定されている場合、defineSlot に渡された ID と一致する「id」属性が必要です。

enableServices

enableServices(): void
ページ上の広告スロットに定義されているすべての GPT サービスを有効にします。

getConfig

getConfig(keys: string | string[]): Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">
setConfig で設定されたページの一般的な構成オプションを取得します。

このメソッドでは、すべての setConfig() プロパティがサポートされているわけではありません。サポートされているプロパティは次のとおりです。
例

JavaScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

JavaScript（従来）

// Get the value of the `targeting` setting.
var targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
var config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

TypeScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
パラメータ
keys: string | string[]取得する構成オプションのキー。
戻り値
Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">スロットの構成オプション。

getVersion

getVersion(): string
GPT の現在のバージョンを返します。
関連情報
戻り値
string現在実行中の GPT バージョン文字列。

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();
関連情報
パラメータ
Optional div: string広告スロットの div ID。この値は省略可能です。指定された場合、パブリッシャー コンソールは、指定された広告スロットの詳細を表示した状態で開こうとします。

pubads

pubads(): PubAdsService
PubAdsService への参照を返します。
戻り値
PubAdsServicePublisher Ads サービス。

setAdIframeTitle

setAdIframeTitle(title: string): void
この時点以降に PubAdsService によって作成されるすべての広告コンテナ iframe のタイトルを設定します。
例

JavaScript

googletag.setAdIframeTitle("title");

JavaScript（従来）

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");
パラメータ
title: stringすべての広告コンテナ iframe の新しいタイトル。

setConfig

setConfig(config: PageSettingsConfig): void
ページの一般的な構成オプションを設定します。
パラメータ
config: PageSettingsConfig

sizeMapping

sizeMapping(): SizeMappingBuilder
新しい SizeMappingBuilder を作成します。
関連情報
戻り値
SizeMappingBuilder新しいビルダー。

googletag.CommandArray

コマンド配列は関数シーケンスを受け取り、順番に呼び出します。これは、GPT の読み込み後に呼び出す関数をキューに入れるために使用される標準配列を置き換えることを目的としています。
メソッド
push
引数で指定された一連の関数を順番に実行します。

メソッド

push

push(...f: ((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());
});
パラメータ
Rest ...f: ((this: typeof globalThis) => void)[]実行される JavaScript 関数。ランタイム バインディングは常に globalThis になります。アロー関数を渡して、囲みレキシカル コンテキストの this 値を保持することを検討してください。
戻り値
numberこれまでに処理されたコマンドの数。これは Array.push の戻り値（配列の現在の長さ）と互換性があります。

googletag.CompanionAdsService

Service を拡張
コンパニオン広告サービス。このサービスは、動画広告でコンパニオン広告を表示するために使用されます。
メソッド
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: booleantrue: 未入力のスロットを自動的にバックフィルします。false: 未入力のスロットを変更しません。

googletag.PrivacySettingsConfig

プライバシー設定の構成オブジェクト。
プロパティ
childDirectedTreatment?
ページを子供向けとして扱うかどうかを示します。
limitedAds?
パブリッシャー様の規制遵守のニーズに対応するため、配信を制限付き広告モードで実行できるようにします。
nonPersonalizedAds?
パブリッシャーの規制遵守のニーズに対応するため、非パーソナライズド広告モードで配信を実行できるようにします。
restrictDataProcessing?
パブリッシャーの規制遵守のニーズに対応するため、配信を制限付き処理モードで実行できるようにします。
trafficSource?
リクエストが購入したトラフィックか自然検索トラフィックかを示します。
underAgeOfConsent?
広告リクエストを同意年齢に満たないユーザーからのものとしてマークするかどうかを示します。
関連情報

プロパティ

Optional childDirectedTreatment

childDirectedTreatment?: boolean
ページを子供向けとして扱うかどうかを示します。構成をクリアするには、null に設定します。

Optional limitedAds

limitedAds?: boolean
パブリッシャーの規制遵守のニーズに対応するため、制限付き広告モードで配信を実行できるようにします。

GPT で制限付き広告をリクエストするには、次の 2 つの方法があります。
  • IAB TCF v2.0 の同意管理プラットフォームからのシグナルを使用して自動的に行われます。
  • このフィールドの値を true に設定して手動で。
制限付き広告を手動で設定できるのは、GPT が制限付き広告 URL から読み込まれた場合のみです。GPT が標準の URL から読み込まれた状態でこの設定を変更しようとすると、パブリッシャー コンソールの警告が生成されます。

なお、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,
});
関連情報

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean
パブリッシャーの規制遵守のニーズに対応するため、非パーソナライズド広告モードで配信を実行できるようにします。

Optional restrictDataProcessing

restrictDataProcessing?: boolean
パブリッシャーの規制遵守のニーズに対応するため、配信を制限付き処理モードで実行できるようにします。

Optional 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,
});

Optional underAgeOfConsent

underAgeOfConsent?: boolean
広告リクエストを同意年齢に満たないユーザーからのものとしてマークするかどうかを示します。構成をクリアするには、null に設定します。

googletag.PubAdsService

Service を拡張
パブリッシャー広告サービス。このサービスは、Google アド マネージャー アカウントから広告を取得して表示するために使用されます。
メソッド
addEventListener
ページで特定の GPT イベントが発生したときに JavaScript 関数を設定して呼び出すことができるリスナーを登録します。
clear
指定されたスロットから広告を削除し、空白のコンテンツに置き換えます。
clearCategoryExclusions
非推奨。 ページ単位の広告カテゴリの除外ラベルをすべてクリアします。
clearTargeting
非推奨。 特定のキーまたはすべてのキーのカスタム ターゲティング パラメータをクリアします。
collapseEmptyDivs
非推奨。 広告コンテンツが表示されない場合に、スロットの div がページ上のスペースを占有しないように、スロットの div を折りたたむことができます。
disableInitialLoad
非推奨。 ページの読み込み時に広告のリクエストを無効にしますが、PubAdsService.refresh 呼び出しで広告をリクエストすることはできます。
display
指定された広告ユニットのパスとサイズで広告スロットを作成して表示します。
enableLazyLoad
非推奨。 構成オブジェクトで定義されているとおりに、GPT で遅延読み込みを有効にします。
enableSingleRequest
非推奨。 複数の広告を同時に取得するための単一リクエスト モードを有効にします。
enableVideoAds
非推奨。 動画広告がページに表示されることを GPT に通知します。
get
非推奨。 指定されたキーに関連付けられた AdSense 属性の値を返します。
getAttributeKeys
非推奨。 このサービスに設定されている属性キーを返します。
getSlots
このサービスに関連付けられているスロットのリストを取得します。
getTargeting
非推奨。 設定されている特定のカスタム サービスレベル ターゲティング パラメータを返します。
getTargetingKeys
非推奨。 設定されているすべてのカスタム サービスレベル ターゲティング キーのリストを返します。
isInitialLoadDisabled
非推奨。 以前の PubAdsService.disableInitialLoad 呼び出しで広告の初回リクエストが正常に無効化されたかどうかを返します。
refresh
ページ上の特定のスロットまたはすべてのスロットの新しい広告を取得して表示します。
removeEventListener
以前に登録されたリスナーを削除します。
set
非推奨。 Publisher Ads サービスのすべての広告スロットに適用される AdSense 属性の値を設定します。
setCategoryExclusion
非推奨。 指定されたラベル名に対してページレベルの広告カテゴリの除外を設定します。
setCentering
非推奨。 広告の水平方向の中央揃えを有効または無効にします。
setForceSafeFrame
非推奨。 ページのすべての広告を SafeFrame コンテナで強制的に表示するかどうかを設定します。
setLocation
非推奨。 ウェブサイトから位置情報を渡すことで、特定の地域をターゲットに広告申込情報を設定できます。
setPrivacySettings
構成オブジェクトを使用して、単一の API からすべてのプライバシー設定を構成できます。
setPublisherProvidedId
パブリッシャー提供 ID の値を設定します。
setSafeFrameConfig
非推奨。 SafeFrame 構成のページレベルの設定を行います。
setTargeting
非推奨。 すべての Publisher Ads サービス広告スロットに適用される、指定されたキーのカスタム ターゲティング パラメータを設定します。
setVideoContent
非推奨。 ターゲティングとコンテンツ除外の目的で、広告リクエストとともに送信する動画コンテンツ情報を設定します。
updateCorrelator
広告リクエストとともに送信される相関値を変更し、事実上新しいページビューを開始します。

メソッド

クリア

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();
パラメータ
Optional slots: Slot[]クリアするスロットの配列。配列は省略可能です。指定しない場合、すべてのスロットがクリアされます。
戻り値
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.
関連情報
パラメータ
Optional key: stringターゲティング パラメータのキー。キーは省略可能です。指定しない場合、すべてのターゲティング パラメータがクリアされます。
戻り値
PubAdsServiceメソッドが呼び出されたサービス オブジェクト。

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
表示する広告コンテンツがないときに、スロットの div がページ上のスペースを占有しないように、スロットの div を折りたたみます。このモードは、サービスを有効にする前に設定する必要があります。
関連情報
パラメータ
Optional collapseBeforeAdFetch: boolean広告が取得される前でもスロットを折りたたむかどうか。このパラメータは省略可能です。指定しない場合、デフォルト値として false が使用されます。
戻り値
booleandiv の折りたたみモードが有効になっている場合は true を返し、サービスが有効になった後にメソッドが呼び出されたため折りたたみモードを有効にできない場合は false を返します。

disableInitialLoad

disableInitialLoad(): void
ページの読み込み時の広告リクエストを無効にしますが、PubAdsService.refresh 呼び出しで広告をリクエストすることは許可します。これは、サービスを有効にする前に設定する必要があります。非同期モードを使用する必要があります。そうしないと、refresh を使用して広告をリクエストすることができません。
関連情報

ディスプレイ

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スロットの幅と高さ。
Optional div: string | Elementスロットを含む div の ID または div 要素自体。
Optional clickUrl: stringこのスロットで使用するクリック URL。

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void
構成オブジェクトで定義されているとおりに、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,
});
関連情報
パラメータ
Optional config: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}		構成オブジェクトを使用すると、遅延動作をカスタマイズできます。省略された構成には、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): 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検索する属性の名前。
戻り値
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以前の PubAdsService.disableInitialLoad の呼び出しが成功した場合は true、それ以外の場合は false を返します。

更新

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void
ページ上の特定のスロットまたはすべてのスロットの新しい広告を取得して表示します。非同期レンダリング モードでのみ機能します。

すべてのブラウザで正しく動作させるには、refresh を呼び出す前に、広告スロットの display を呼び出す必要があります。display の呼び出しを省略すると、更新が予期しない動作をする可能性があります。必要に応じて、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 });
関連情報
パラメータ
Optional slots: Slot[]更新するスロット。配列は省略可能です。指定しない場合は、すべてのスロットが更新されます。
Optional options: {
  changeCorrelator: boolean;
}		この更新呼び出しに関連付けられた構成オプション。
  • changeCorrelator

    広告を取得するために新しい相関関係子を生成するかどうかを指定します。Google の広告サーバーは、この correlator 値を短時間（現在は 30 秒間ですが、変更される可能性があります）保持します。そのため、同じ correlator 値を持つリクエストがほぼ同時に受信された場合、それらは 1 つのページビューと見なされます。デフォルトでは、更新ごとに新しい相関関係子が生成されます。

    注: このオプションは、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: booleantrue で広告を中央に配置し、false で左揃えにします。

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
ページ上のすべての広告を SafeFrame コンテナで強制的に表示するかどうかを設定します。

この API を使用する際は、次の点にご注意ください。
  • この設定は、それぞれのスロットに対して行われる後続の広告リクエストにのみ適用されます。
  • スロットレベルの設定が指定されている場合、常にページレベルの設定がオーバーライドされます。
  • true（スロット単位またはページ単位）に設定されている場合、Google アド マネージャーの UI での選択に関係なく、広告は常に SafeFrame コンテナを使用してレンダリングされます。
  • ただし、false に設定されている場合や、指定されていない場合は、クリエイティブのタイプと Google アド マネージャーの UI での選択に応じて、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: booleantrue は、ページ上のすべての広告を 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
構成オブジェクトを使用して、単一の 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 構成のページレベルの設定を行います。構成オブジェクト内の認識されないキーは無視されます。認識されたキーに無効な値が渡されると、構成全体が無視されます。

これらのページレベルの設定は、スロットレベルの設定が指定されている場合は、スロットレベルの設定によってオーバーライドされます。
例

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
すべての Publisher Ads サービスの広告スロットに適用される、特定のキーのカスタム ターゲティング パラメータを設定します。同じキーに対して複数回呼び出すと、古い値が上書きされます。これらのキーは 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 の長期間のページビューには影響しません。長期間のページビューは、ページに実際に表示されている広告を自動的に反映し、有効期限がありません。
例

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

単一の広告レスポンスを表すオブジェクト。
プロパティ
advertiserId
広告主の ID。
campaignId
キャンペーンの ID です。
creativeId
クリエイティブの ID。
creativeTemplateId
広告のテンプレート ID。
lineItemId
広告申込情報の ID。
関連情報

プロパティ

advertiserId

advertiserId: number
広告主の ID。

campaignId

campaignId: number
キャンペーンの ID です。

creativeId

creativeId: number
クリエイティブの ID。

creativeTemplateId

creativeTemplateId: number
広告のテンプレート ID。

lineItemId

lineItemId: number
広告申込情報の ID。

googletag.RewardedPayload

リワード広告に関連付けられた報酬を表すオブジェクト
プロパティ
amount
特典に含まれるアイテムの数。
type
リワードに含まれるアイテムのタイプ（「コイン」など）。
関連情報

プロパティ

金額

amount: number
特典に含まれるアイテムの数。

type

type: string
リワードに含まれるアイテムのタイプ（「コイン」など）。

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: KGPT によって生成されたイベントのタイプを表す文字列。イベント タイプでは大文字と小文字が区別されます。
listener: ((arg: EventTypeMap[K]) => void)単一のイベント オブジェクト引数を取る関数。
戻り値
Serviceメソッドが呼び出されたサービス オブジェクト。

getSlots

getSlots(): Slot[]
このサービスに関連付けられているスロットのリストを取得します。
戻り値
Slot[]サービスに追加された順序でスロット。

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: KGPT によって生成されたイベントのタイプを表す文字列。イベント タイプでは大文字と小文字が区別されます。
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 &lt; 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 &lt; 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 &lt; 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(): SizeMappingArray
このビルダーに追加されたマッピングからサイズマップ仕様をビルドします。

無効なマッピングが指定されている場合、このメソッドは null を返します。それ以外の場合は、Slot.defineSizeMapping に渡すための正しい形式の仕様を返します。

注: このメソッドを呼び出した後のビルダーの動作は未定義です。
戻り値
SizeMappingArrayこのビルダーで構築された結果。無効なサイズ マッピングが指定された場合は null になることがあります。

googletag.Slot

スロットは、ページ上の 1 つの広告スロットを表すオブジェクトです。
メソッド
addService
このスロットに Service を追加します。
clearCategoryExclusions
非推奨。 このスロットのすべてのスロットレベルの広告カテゴリ除外ラベルをクリアします。
clearTargeting
非推奨。 このスロットの特定のカスタム スロットレベルのターゲティング パラメータまたはすべてのカスタム スロットレベルのターゲティング パラメータをクリアします。
defineSizeMapping
このスロットの最小ビューポート サイズからスロットサイズへのマッピングの配列を設定します。
get
非推奨。 このスロットの指定されたキーに関連付けられた AdSense 属性の値を返します。
getAdUnitPath
ネットワーク コードと広告ユニットのパスを含む、広告ユニットの完全なパスを返します。
getAttributeKeys
非推奨。 このスロットに設定された属性キーのリストを返します。
getCategoryExclusions
非推奨。 このスロットの広告カテゴリ除外ラベルを返します。
getConfig
setConfig で設定されたスロットの一般的な構成オプションを取得します。
getResponseInformation
広告レスポンス情報を返します。
getSlotElementId
スロットの定義時に指定されたスロットの ID div を返します。
getTargeting
非推奨。 このスロットに設定された特定のカスタム ターゲティング パラメータを返します。
getTargetingKeys
非推奨。 このスロットに設定されているすべてのカスタム ターゲティング キーのリストを返します。
set
非推奨。 この広告スロットの AdSense 属性の値を設定します。
setCategoryExclusion
非推奨。 このスロットにスロットレベルの広告カテゴリの除外ラベルを設定します。
setClickUrl
非推奨。 ユーザーが広告をクリックした後にリダイレクトされるクリック URL を設定します。
setCollapseEmptyDiv
非推奨。 スロットに広告がない場合にスロット div を非表示にするかどうかを設定します。
setConfig
このスロットの一般的な構成オプションを設定します。
setForceSafeFrame
非推奨。 このスロットの広告を SafeFrame コンテナで強制的に表示するかどうかを設定します。
setSafeFrameConfig
非推奨。 SafeFrame 構成のスロットレベルの優先設定を設定します。
setTargeting
非推奨。 このスロットのカスタム ターゲティング パラメータを設定します。
updateTargetingFromMap
非推奨。 JSON オブジェクトの key:value マップから、このスロットのカスタム ターゲティング パラメータを設定します。

メソッド

addService

addService(service: Service): Slot
このスロットに 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.
関連情報
パラメータ
Optional 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): 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検索する属性の名前。
戻り値
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[]このスロットの広告カテゴリ除外ラベル。設定されていない場合は空の配列。

getConfig

getConfig(keys: string | string[]): Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">
setConfig で設定されたスロットの一般的な構成オプションを取得します。

このメソッドでは、すべての setConfig() プロパティがサポートされているわけではありません。サポートされているプロパティは次のとおりです。
例

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

JavaScript（従来）

var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
var targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
var config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
パラメータ
keys: string | string[]取得する構成オプションのキー。
戻り値
Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">スロットの構成オプション。

getResponseInformation

getResponseInformation(): ResponseInformation
広告レスポンス情報を返します。これは、スロットの最後の広告レスポンスに基づいています。スロットに広告がないときに呼び出されると、null が返されます。
戻り値
ResponseInformation最新の広告レスポンス情報。スロットに広告がない場合は null。

getSlotElementId

getSlotElementId(): string
スロットの定義時に指定されたスロットの ID div を返します。
例

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広告が返されなかった場合にスロットを折りたたむかどうか。
Optional collapseBeforeAdFetch: boolean広告が取得される前でもスロットを折りたたむかどうか。collapse が true でない場合は無視されます。
戻り値
Slotメソッドが呼び出されたスロット オブジェクト。

setConfig

setConfig(slotConfig: SlotSettingsConfig): void
このスロットの一般的な構成オプションを設定します。
パラメータ
slotConfig: SlotSettingsConfig構成オブジェクト。

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot
このスロットの広告を SafeFrame コンテナで強制的に表示するかどうかを設定します。

この API を使用する際は、次の点に注意してください。
  • この設定は、それぞれのスロットに対して行われる後続の広告リクエストにのみ適用されます。
  • スロットレベルの設定が指定されている場合、常にページレベルの設定がオーバーライドされます。
  • true（スロット単位またはページ単位）に設定されている場合、Google アド マネージャーの UI での選択に関係なく、広告は常に SafeFrame コンテナを使用してレンダリングされます。
  • ただし、false に設定されている場合や、指定されていない場合は、クリエイティブのタイプと Google アド マネージャーの UI での選択に応じて、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: booleantrue を使用すると、このスロットのすべての広告が SafeFrame でレンダリングされます。false を使用すると、ページレベルの設定（存在する場合）が無効になります。ページレベルで指定されていない場合に false に設定しても、何も変更されません。
戻り値
Slotメソッドが呼び出されたスロット オブジェクト。

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot
SafeFrame 構成のスロットレベルの優先設定を設定します。構成オブジェクト内の認識されないキーは無視されます。認識されたキーに無効な値が渡されると、構成全体が無視されます。

これらのスロットレベルの設定は、指定されている場合、ページレベルの設定よりも優先されます。
例

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: 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
広告の拡張を制御する設定。
AdSenseAttributesConfig
AdSense 広告の動作を制御する設定。
ComponentAuctionConfig
デバイス上の広告オークションにおける単一のコンポーネント オークションを表すオブジェクト。
InterstitialConfig
1 つのインタースティシャル広告スロットの動作を定義するオブジェクト。
LazyLoadConfig
GPT での遅延読み込みの使用を制御する設定。
PageSettingsConfig
ページ単位の設定のメイン構成インターフェース。
PrivacyTreatmentsConfig
パブリッシャーのプライバシー処理を制御する設定。
PublisherProvidedSignalsConfig
パブリッシャー提供のシグナル（PPS）構成オブジェクト。
SafeFrameConfig
GPT で SafeFrame を制御する設定。
SlotSettingsConfig
スロットレベルの設定のメイン構成インターフェース。
TaxonomyData
単一の Taxonomy の値を含むオブジェクト。
VideoAdsConfig
動画広告関連の設定を構成するための設定。
型エイリアス
CollapseDivBehavior
広告スロットの折りたたみ動作を制御するためにサポートされている値。
InterstitialTrigger
サポートされているインタースティシャル広告のトリガー。
PrivacyTreatment
サポートされているパブリッシャーのプライバシーに関する取り扱い。
Taxonomy
パブリッシャー提供のシグナル（PPS）でサポートされている分類。

型エイリアス

CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"
広告スロットの折りたたみ動作を制御するためにサポートされている値。
関連情報

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"
サポートされているインタースティシャル広告のトリガー。

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"
サポートされているパブリッシャーのプライバシーに関する取り扱い。

分類

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
パブリッシャー提供のシグナル（PPS）でサポートされている分類。
関連情報

googletag.config.AdExpansionConfig

広告の拡張を制御する設定。
プロパティ
enabled?
広告の拡張が有効か無効か。
例

JavaScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

JavaScript（従来）

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

TypeScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

プロパティ

Optional 有効

enabled?: boolean
広告の拡張が有効か無効か。

この値を設定すると、Google アド マネージャーで設定されたデフォルトがオーバーライドされます。
関連情報

googletag.config.AdSenseAttributesConfig

AdSense 広告の動作を制御する設定。

これらの属性は、リクエストごとにサーバーサイドの設定をオーバーライドするために使用できます。
プロパティ
adsense_ad_format?
AdSense 広告フォーマット。
adsense_channel_ids?
AdSense チャネル ID。
adsense_test_mode?
テストモードが有効かどうか。
document_language?
広告が表示されるページの言語。
page_url?
広告が表示されるページの URL。
関連情報

プロパティ

Optional adsense_ad_format

adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"
AdSense 広告フォーマット。

Optional adsense_channel_ids

adsense_channel_ids?: string
AdSense チャネル ID。

指定できる値は、チャネル ID を「+」で区切ったものです。

例: 271828183+314159265
関連情報

Optional adsense_test_mode

adsense_test_mode?: "on"
テストモードが有効かどうか。

on に設定すると、広告はテスト専用としてマークされ、カウントや請求の対象にはなりません。本番環境のテスト以外のトラフィックでは、この設定を解除する必要があります。

Optional document_language

document_language?: string
広告が表示されるページの言語。

有効な ISO 639-1 言語コードが使用できます。

例: en
関連情報

Optional page_url

page_url?: string
広告が表示されるページの URL。

有効な URL を指定できます。

例: http://www.example.com

googletag.config.ComponentAuctionConfig

デバイス上の広告オークションにおける単一のコンポーネント オークションを表すオブジェクト。
プロパティ
auctionConfig
このコンポーネント オークションのオークション構成オブジェクト。
configKey
このコンポーネント オークションに関連付けられた構成キー。
関連情報

プロパティ

auctionConfig

auctionConfig: {
  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 つのインタースティシャル広告スロットの動作を定義するオブジェクト。
プロパティ
requireStorageAccess?
このインタースティシャル広告を表示するためにローカル ストレージの同意が必要かどうか。
triggers?
このインタースティシャル広告のインタースティシャル トリガー構成。

プロパティ

Optional requireStorageAccess

requireStorageAccess?: boolean
このインタースティシャル広告を表示するためにローカル ストレージの使用への同意が必要かどうか。

GPT はローカル ストレージを使用して、インタースティシャル広告のフリークエンシー キャップを適用します。ただし、ローカル ストレージの使用に同意していないユーザーにも、引き続きインタースティシャル広告が配信されます。このプロパティを true に設定すると、デフォルトの動作がオプトアウトされ、ローカル ストレージの同意を提供したユーザーにのみインタースティシャル広告が表示されるようになります。
例

JavaScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

JavaScript（従来）

// Opt out of showing interstitials to users
// without local storage consent.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

TypeScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});
関連情報

Optional トリガー

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.LazyLoadConfig

GPT での遅延読み込みの使用を制御する設定。
プロパティ
fetchMarginPercent?
広告をリクエストする前にスロットが現在のビューポートから離れていなければならない最小距離。ビューポート サイズの割合で表します。
mobileScaling?
モバイル デバイスのマージンに適用される乗数。
renderMarginPercent?
広告をレンダリングする前にスロットが現在のビューポートから離れていなければならない最小距離。ビューポート サイズの割合で表します。
関連情報

プロパティ

Optional fetchMarginPercent

fetchMarginPercent?: number
広告をリクエストする前にスロットが現在のビューポートから離れていなければならない最小距離。ビューポート サイズの割合で表します。

renderMarginPercent と組み合わせて使用すると、この設定により広告のプリフェッチが可能になりますが、他のサブリソースのレンダリングとダウンロードは待機します。そのため、この値は常に renderMarginPercent 以上にする必要があります。

0 は「スロットがビューポートに入ったとき」、100 は「広告がビューポートから 1 つ離れたとき」などを意味します。

Optional mobileScaling

mobileScaling?: number
モバイル デバイスの余白に適用される乗数。この乗数は fetchMarginPercent と renderMarginPercent の両方に適用されます。

これにより、ビューポートのサイズやスクロール速度が異なるモバイルとパソコンで、異なるマージンを設定できます。たとえば、値を 2.0 にすると、モバイル デバイスですべてのマージンが 2 倍になり、スロットがフェッチされてレンダリングされる前にビューポートから離れることができる最小距離が大きくなります。

Optional renderMarginPercent

renderMarginPercent?: number
広告をレンダリングする前にスロットが現在のビューポートから離れていなければならない最小距離。ビューポート サイズの割合で表します。

fetchMarginPercent と組み合わせて使用すると、広告のプリフェッチが可能になりますが、他のサブリソースのレンダリングとダウンロードは待機します。そのため、この値は常に fetchMarginPercent 以下にする必要があります。

0 は「スロットがビューポートに入ったとき」、100 は「広告がビューポートから 1 つ離れたとき」などを意味します。

googletag.config.PageSettingsConfig

ページレベルの設定のメイン構成インターフェース。

1 回の API 呼び出しで複数の機能を設定できます。

以下に記載されているプロパティはすべて例であり、setConfig を使用する実際の機能は反映されていません。機能のセットについては、以下の PageSettingsConfig タイプのフィールドをご覧ください。

例:
  • googletag.setConfig 呼び出しで指定された機能のみが変更されます。
      // Configure feature alpha.
  googletag.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  googletag.setConfig({
     bravo: {...}
  });
  • 特定の機能のすべての設定は、googletag.setConfig が呼び出されるたびに更新されます。
      // Configure feature charlie to echo = 1, foxtrot = true.
  googletag.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  googletag.setConfig({
      charlie: {
          echo: 2
      }
  });
  • null を渡すことで、機能のすべての設定をクリアできます。
      // Configure features delta, golf, and hotel.
  googletag.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

  // Feature delta and hotel are cleared, but feature golf remains set.
  googletag.setConfig({
      delta: null,
      hotel: null,
  });
プロパティ
adExpansion?
広告の拡張を制御する設定。
adsenseAttributes?
AdSense の属性を設定するための設定。
adYield?
非推奨。 
categoryExclusion?
広告カテゴリの除外を設定する設定。
centering?
広告の水平方向の中央揃えを制御する設定。
collapseDiv?
広告スロットの折りたたみ動作を制御する設定。
disableInitialLoad?
広告がリクエストされるタイミングを制御する設定。
lazyLoad?
GPT での遅延読み込みの使用を制御する設定。
location?
広告申込情報のターゲット地域を設定します。
pps?
パブリッシャー提供のシグナル（PPS）を制御する設定。
privacyTreatments?
パブリッシャーのプライバシー処理を制御する設定。
safeFrame?
GPT での SafeFrame の使用を制御する設定。
singleRequest?
シングル リクエスト アーキテクチャ（SRA）を有効または無効にする設定。
targeting?
Key-Value ターゲティングを制御する設定。
threadYield?
クリエイティブのリクエストとレンダリング時に GPT が JS スレッドを譲るかどうかを制御する設定。
videoAds?
動画広告を制御する設定。

プロパティ

Optional adExpansion

adExpansion?: AdExpansionConfig
広告の拡張を制御する設定。

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
AdSense の属性を設定する設定。

この設定で構成された AdSense の属性は、ページ上のすべての広告スロットに適用されます。この設定は、複数の属性値を定義したり、既存の値を上書きしたりするために複数回呼び出すことができます。

AdSense 属性の変更は、このメソッドが呼び出された後にリクエストされた広告にのみ適用されます。そのため、googletag.display または PubAdsService.refresh の呼び出しよりも前に、このメソッドを呼び出すことをおすすめします。
例

JavaScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

JavaScript（従来）

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

TypeScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Optional categoryExclusion

categoryExclusion?: string[]
広告カテゴリの除外を設定する設定。
例

JavaScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

JavaScript（従来）

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

TypeScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });
関連情報

Optional 中央揃え

centering?: boolean
広告の水平方向の中央揃えを制御する設定。デフォルトでは中央揃えは無効になっています。

水平方向の中央揃えの変更は、このメソッドが呼び出された後にリクエストされた広告にのみ適用されます。そのため、googletag.display または PubAdsService.refresh の呼び出しよりも前に、このメソッドを呼び出すことをおすすめします。
例

JavaScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

JavaScript（従来）

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

TypeScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

Optional collapseDiv

collapseDiv?: CollapseDivBehavior
広告スロットの折りたたみ動作を制御する設定。

折りたたまれた広告スロットは、ページ上のスペースを占有しません。

サポートされている値:
  • null（デフォルト）: スロットは折りたたまれません。
  • DISABLED: 広告が返されるかどうかにかかわらず、スロットは折りたたまれません。
  • BEFORE_FETCH: スロットは最初は折りたたまれており、広告が返されると展開されます。
  • ON_NO_FILL: スロットは最初は展開され、広告が返されなかった場合は折りたたまれます。
例

JavaScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

JavaScript（従来）

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

TypeScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });
関連情報

Optional disableInitialLoad

disableInitialLoad?: boolean
広告がリクエストされるタイミングを制御する設定。

デフォルトでは、googletag.display メソッドは広告スロットを登録し、その広告スロットの広告をリクエストします。ただし、広告コンテンツが読み込まれるタイミングをより正確に制御するために、これらのアクションを分離した方がよい場合もあります。

この設定を有効にすると、display() メソッドが呼び出されたときに、登録済みのスロットに対して広告がリクエストされなくなります。代わりに、広告リクエストを開始するには、PubAdsService.refresh への個別の呼び出しを行う必要があります。

このメソッドは、googletag.enableServices を呼び出す前に呼び出す必要があります。
例

JavaScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

JavaScript（従来）

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

TypeScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });
関連情報

Optional lazyLoad

lazyLoad?: LazyLoadConfig
GPT での遅延読み込みの使用を制御する設定。

遅延読み込みは、広告がユーザーのビューポートに近づくまで、広告のリクエストとレンダリングを遅らせる手法です。詳細な例については、遅延読み込みのサンプルをご覧ください。

注: singleRequest が有効になっている場合、遅延フェッチはすべてのスロットがフェッチ マージンの外にある場合にのみ機能します。

setConfig() の呼び出し時に指定されていない遅延読み込みの設定は、Google が設定したデフォルト値を使用します。これらのデフォルト値は、時間の経過とともに調整される可能性があります。特定の設定を無効にするには、値を null に設定します。
例

JavaScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

JavaScript（従来）

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

TypeScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });
関連情報

Optional location

location?: string
広告申込情報のターゲット地域を設定します。
例

JavaScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

JavaScript（従来）

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

TypeScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });
関連情報

Optional pps

パブリッシャー提供のシグナル（PPS）を制御する設定。

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig
パブリッシャーのプライバシー処理を制御する設定。

Optional safeFrame

safeFrame?: SafeFrameConfig
GPT で SafeFrame の使用を制御する設定。

この設定で構成された値は、ページのすべての広告スロットに適用されます。個々の広告スロットは、SlotSettingsConfig.safeFrame を介してこれらの値をオーバーライドできます。
例

JavaScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

JavaScript（従来）

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

TypeScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

Optional singleRequest

singleRequest?: boolean
シングル リクエスト アーキテクチャ（SRA）を有効または無効にする設定。

SRA が有効になっている場合、googletag.display または PubAdsService.refresh 呼び出しの前に定義されたすべての広告スロットが 1 つの広告リクエストにバッチ処理されます。これにより、パフォーマンスが向上するだけでなく、ロードブロッキングや競合相手の除外が確実に適用されるようになります。

SRA が無効になっている場合、各広告スロットは個別にリクエストされます。これは GPT のデフォルトの動作です。

このメソッドは、googletag.enableServices を呼び出す前に呼び出す必要があります。
例

JavaScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

JavaScript（従来）

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

TypeScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });
関連情報

Optional ターゲティング

targeting?: Record<string, string | string[]>
Key-Value ターゲティングを制御する設定。

この設定で構成されたターゲティングは、ページのすべての広告スロットに適用されます。この設定は、複数のターゲティング Key-Value を定義したり、既存の値を上書きしたりするために複数回呼び出すことができます。ターゲティング キーは Google アド マネージャー アカウントで定義します。
例

JavaScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

JavaScript（従来）

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

TypeScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });
関連情報

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"
クリエイティブをリクエストしてレンダリングする際に、GPT が JS スレッドを譲るかどうかを制御する設定。

GPT は、Scheduler.postTask API または Scheduler.yield API をサポートするブラウザでのみ譲ります。

サポートされている値:
  • null（デフォルト）: GPT は、ビューポート外のスロットの JS スレッドを生成します。
  • ENABLED_ALL_SLOTS: スロットがビューポート内にあるかどうかに関係なく、すべてのスロットで GPT が JS スレッドを生成します。
  • DISABLED: GPT は JS スレッドを生成しません。
例

JavaScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

JavaScript（従来）

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

TypeScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });
関連情報

Optional videoAds

videoAds?: VideoAdsConfig
動画広告を管理する設定。
例

JavaScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

JavaScript（従来）

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

TypeScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});
関連情報

googletag.config.PrivacyTreatmentsConfig

パブリッシャーのプライバシー処理を制御する設定。
プロパティ
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
分類マッピングを含むオブジェクト。構成をクリアする場合は null。
例

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

JavaScript（従来）

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

TypeScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});
関連情報

プロパティ

taxonomies

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
分類マッピングを含むオブジェクト。構成をクリアする場合は null。

googletag.config.SafeFrameConfig

GPT で SafeFrame を制御する設定。
プロパティ
allowOverlayExpansion?
SafeFrame で、広告コンテンツがページ コンテンツに重なって拡大することを許可するかどうか。
allowPushExpansion?
SafeFrame で、ページ コンテンツをプッシュして広告コンテンツを拡大できるようにするかどうか。
forceSafeFrame?
広告を SafeFrame コンテナを使用して強制的にレンダリングするかどうか。
sandbox?
SafeFrame で HTML5 sandbox 属性を使用して、ユーザー操作なしでトップレベル ナビゲーションを防ぐかどうか。
useUniqueDomain?
非推奨。 SafeFrame で予約クリエイティブにランダムなサブドメインを使用するかどうか。
関連情報

プロパティ

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean
SafeFrame で、広告コンテンツがページ コンテンツに重なって拡大することを許可するかどうか。

Optional allowPushExpansion

allowPushExpansion?: boolean
SafeFrame で、ページ コンテンツをプッシュして広告コンテンツを拡大できるようにするかどうか。

Optional forceSafeFrame

forceSafeFrame?: boolean
広告を SafeFrame コンテナを使用して強制的にレンダリングするかどうか。

Optional sandbox

sandbox?: boolean
SafeFrame で HTML5 sandbox 属性を使用して、ユーザー操作なしでトップレベル ナビゲーションを防ぐかどうか。有効な値は true のみです（false に強制することはできません）。サンドボックス属性はプラグイン（Flash など）を無効にします。

Optional useUniqueDomain

useUniqueDomain?: boolean
SafeFrame で予約クリエイティブにランダムなサブドメインを使用するかどうか。保存された値をクリアするには、null を渡します。

注: この機能はデフォルトで有効になっています。
関連情報

googletag.config.SlotSettingsConfig

スロットレベルの設定のメイン構成インターフェース。

単一のスロットに対して単一の 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?
広告の拡張を設定するための設定。
adsenseAttributes?
AdSense の属性を設定するための設定。
categoryExclusion?
広告カテゴリの除外を設定する設定。
clickUrl?
広告をクリックした後にユーザーがリダイレクトされる URL を設定する設定。
collapseDiv?
広告スロットの折りたたみ動作を構成する設定。
componentAuction?
オンデバイス広告オークションに含めるコンポーネント オークションの配列。
interstitial?
インタースティシャル広告スロットの動作を構成する設定。
safeFrame?
GPT で SafeFrame の使用を構成する設定。
targeting?
キー値ターゲティングを構成する設定。

プロパティ

Optional adExpansion

adExpansion?: AdExpansionConfig
広告の拡大を設定する設定。
関連情報

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
AdSense の属性を設定する設定。

この設定で構成された AdSense の属性は、広告スロットにのみ適用されます。この設定は、複数の属性値を定義したり、既存の値を上書きしたりするために複数回呼び出すことができます。

AdSense 属性の変更は、このメソッドが呼び出された後にリクエストされた広告にのみ適用されます。そのため、googletag.display または PubAdsService.refresh の呼び出しよりも前に、このメソッドを呼び出すことをおすすめします。
例

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

JavaScript（従来）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

Optional categoryExclusion

categoryExclusion?: string[]
広告カテゴリの除外を設定する設定。
例

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

JavaScript（従来）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });
関連情報

Optional clickUrl

clickUrl?: string
ユーザーが広告をクリックした後にリダイレクトされる URL を設定する設定。

クリック URL が置き換えられても、Google アド マネージャーのサーバーはクリックを記録します。配信されるクリエイティブに関連付けられているランディング ページ URL は、指定された値に追加されます。この値を複数回設定すると、以前に構成された値が上書きされます。null を渡すと、値がクリアされます。

注: この設定は、SRA 以外のリクエストにのみ適用されます。
例

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

JavaScript（従来）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

Optional collapseDiv

collapseDiv?: CollapseDivBehavior
広告スロットの折りたたみ動作を設定する設定。

折りたたまれた広告スロットは、ページ上のスペースを占有しません。

サポートされている値:
  • null（デフォルト）: スロットは折りたたまれません。
  • DISABLED: 広告が返されるかどうかにかかわらず、スロットは折りたたまれません。
  • BEFORE_FETCH: スロットは最初は折りたたまれており、広告が返されると展開されます。
  • ON_NO_FILL: スロットは最初は展開され、広告が返されなかった場合は折りたたまれます。
例

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

JavaScript（従来）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});
関連情報

Optional componentAuction

componentAuction?: ComponentAuctionConfig[]
オンデバイス広告オークションに含めるコンポーネント オークションの配列。

Optional インタースティシャル

interstitial?: InterstitialConfig
インタースティシャル広告スロットの動作を構成する設定。
関連情報

Optional safeFrame

safeFrame?: SafeFrameConfig
GPT で SafeFrame の使用を構成する設定。

この設定で構成された値は広告スロットにのみ適用され、PageSettingsConfig.safeFrame で設定された値をオーバーライドします。
例

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

JavaScript（従来）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

Optional ターゲティング

targeting?: Record<string, string | string[]>
Key-Value ターゲティングを設定するための設定。

この設定で構成されたターゲティングは、広告スロットにのみ適用されます。この設定は、複数のターゲティング Key-Value を定義したり、既存の値を上書きしたりするために複数回呼び出すことができます。ターゲティング キーは Google アド マネージャー アカウントで定義します。
例

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

JavaScript（従来）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });
関連情報

googletag.config.TaxonomyData

単一の Taxonomy の値を含むオブジェクト。
プロパティ
values
Taxonomy 値のリスト。

プロパティ

values

values: readonly string[]
Taxonomy 値のリスト。

googletag.config.VideoAdsConfig

動画広告関連の設定を構成するための設定。
プロパティ
enableVideoAds
ページに動画広告が表示されるかどうか。
videoCmsId?
動画コンテンツ ソース ID。
videoContentId?
動画コンテンツ ID。
関連情報

プロパティ

enableVideoAds

enableVideoAds: boolean
ページに動画広告が表示されるかどうか。

true に設定すると、ディスプレイ広告と動画広告のコンテンツ除外制約が有効になります。

動画コンテンツがわかっている場合は、videoContentId と videoCmsId を Google アド マネージャーのコンテンツ取り込みサービスに提供された値に設定して、ディスプレイ広告のコンテンツ除外を利用します。

Optional videoCmsId

videoCmsId?: string
動画コンテンツ ソース ID。

これは、Google アド マネージャーのコンテンツ取り込みサービスによって割り当てられる一意の値で、videoContentId で指定された動画コンテンツのソースを識別するために使用されます。
関連情報

Optional videoContentId

videoContentId?: string
動画コンテンツ ID。

これは、videoCmsId で指定されたコンテンツ ソースから特定の動画を識別する一意の値です。この値は、動画コンテンツをホストする CMS によって割り当てられます。
関連情報

googletag.enums

これは、GPT が列挙型に使用する Namespace です。
列挙型
OutOfPageFormat
GPT でサポートされているページ外フォーマット。
TrafficSource
GPT でサポートされているトラフィック ソース。

列挙型

OutOfPageFormat

OutOfPageFormat
GPT でサポートされているページ外フォーマット。
関連情報
列挙型メンバー
AD_INTENTS
広告インテント フォーマット。
BOTTOM_ANCHOR
スロットがビューポートの下部に固定されるアンカー フォーマット。
GAME_MANUAL_INTERSTITIAL
ゲーム マニュアル インタースティシャル フォーマット。

注: ゲーム マニュアル インタースティシャルは、アクセスが制限されたフォーマットです。
INTERSTITIAL
ウェブ インタースティシャル クリエイティブ フォーマット。
LEFT_SIDE_RAIL
左サイドレールの形式。
REWARDED
リワード形式。
RIGHT_SIDE_RAIL
右サイドレールの形式。
TOP_ANCHOR
スロットがビューポートの上部に固定されるアンカー形式。

TrafficSource

TrafficSource
GPT でサポートされているトラフィック ソース。
関連情報
列挙型メンバー
ORGANIC
URL の直接入力、サイト内検索、アプリのダウンロード。
PURCHASED
所有していないプロパティからリダイレクトされたトラフィック（集客によるアクティビティや他の報酬提供によるアクティビティ）。

googletag.events

これは、GPT がイベントに使用する Namespace です。コードでは、Service.addEventListener を使用してこれらのイベントに対応できます。
インターフェース
Event
すべての GPT イベントの基本インターフェース。
EventTypeMap
これは、Service.addEventListener と Service.removeEventListener のイベント名を対応するイベント オブジェクト タイプにマッピングする疑似型です。
GameManualInterstitialSlotClosedEvent
このイベントは、ユーザーがゲームマニュアルのインタースティシャル スロットを閉じたときに発生します。
GameManualInterstitialSlotReadyEvent
このイベントは、ゲームの手動インタースティシャル スロットをユーザーに表示する準備ができたときに発生します。
ImpressionViewableEvent
このイベントは、アクティブ ビューの基準に従ってインプレッションが視認可能になったときに発生します。
RewardedSlotClosedEvent
このイベントは、ユーザーがリワード広告スロットを閉じたときに発生します。
RewardedSlotGrantedEvent
このイベントは、リワード広告の視聴に対して報酬が付与されたときに発生します。
RewardedSlotReadyEvent
このイベントは、リワード広告を表示する準備ができたときに発生します。
RewardedSlotVideoCompletedEvent
このイベントは、リワード動画広告の再生が終了したときに発生します。
SlotOnloadEvent
このイベントは、クリエイティブの iframe が読み込みイベントを発生させたときに発生します。
SlotRenderEndedEvent
このイベントは、クリエイティブ コードがスロットに挿入されたときに発生します。
SlotRequestedEvent
このイベントは、特定のスロットの広告がリクエストされたときに発生します。
SlotResponseReceived
このイベントは、特定のスロットの広告レスポンスを受信したときに発生します。
SlotVisibilityChangedEvent
このイベントは、広告スロットの領域の画面上の割合が変化するたびに発生します。

googletag.events.Event

すべての GPT イベントの基本インターフェース。以下のすべての GPT イベントには、次のフィールドがあります。
プロパティ
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。
関連情報

プロパティ

serviceName

serviceName: string
イベントをトリガーしたサービスの名前。

slot

slot: Slot
イベントをトリガーしたスロット。

googletag.events.EventTypeMap

これは、Service.addEventListener と Service.removeEventListener のイベント名を対応するイベント オブジェクト タイプにマッピングする疑似型です。これは参照と型安全性の目的でのみドキュメント化されています。
プロパティ
gameManualInterstitialSlotClosed
gameManualInterstitialSlotReady
impressionViewable
events.ImpressionViewableEvent のエイリアス。
rewardedSlotClosed
events.RewardedSlotClosedEvent のエイリアス。
rewardedSlotGranted
events.RewardedSlotGrantedEvent のエイリアス。
rewardedSlotReady
events.RewardedSlotReadyEvent のエイリアス。
rewardedSlotVideoCompleted
slotOnload
events.SlotOnloadEvent のエイリアス。
slotRenderEnded
events.SlotRenderEndedEvent のエイリアス。
slotRequested
events.SlotRequestedEvent のエイリアス。
slotResponseReceived
events.SlotResponseReceived のエイリアス。
slotVisibilityChanged
events.SlotVisibilityChangedEvent のエイリアス。

プロパティ

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent
events.GameManualInterstitialSlotClosedEvent のエイリアス。

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent
events.GameManualInterstitialSlotReadyEvent のエイリアス。

impressionViewable

impressionViewable: ImpressionViewableEvent
events.ImpressionViewableEvent のエイリアス。

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent
events.RewardedSlotClosedEvent のエイリアス。

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent
events.RewardedSlotGrantedEvent のエイリアス。

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent
events.RewardedSlotReadyEvent のエイリアス。

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent
events.RewardedSlotVideoCompletedEvent のエイリアス。

slotOnload

slotOnload: SlotOnloadEvent
events.SlotOnloadEvent のエイリアス。

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent
events.SlotRenderEndedEvent のエイリアス。

slotRequested

slotRequested: SlotRequestedEvent
events.SlotRequestedEvent のエイリアス。

slotResponseReceived

slotResponseReceived: SlotResponseReceived
events.SlotResponseReceived のエイリアス。

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent
events.SlotVisibilityChangedEvent のエイリアス。

googletag.events.GameManualInterstitialSlotClosedEvent

Event を拡張
このイベントは、ユーザーがゲームの手動インタースティシャル スロットを閉じたときに発生します。

注: ゲームの手動インタースティシャルは、アクセス制限のあるフォーマットです。
プロパティ
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。
例

JavaScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript（従来）

// This listener is called when a game manual interstitial slot is closed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) {
    var slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
関連情報

googletag.events.GameManualInterstitialSlotReadyEvent

Event を拡張
このイベントは、ゲームの手動インタースティシャル広告スロットをユーザーに表示する準備ができたときに発生します。

注: ゲームの手動インタースティシャルは、アクセス制限のあるフォーマットです。
プロパティ
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。
メソッド
makeGameManualInterstitialVisible
ゲームの手動インタースティシャル広告をユーザーに表示します。
例

JavaScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    const displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript（従来）

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) {
    var slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    var displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    const displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
関連情報

メソッド

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): void
ゲームの手動インタースティシャル広告をユーザーに表示します。

googletag.events.ImpressionViewableEvent

Event を拡張
このイベントは、アクティブ ビューの基準に従ってインプレッションが視認可能になったときに発生します。
プロパティ
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

Event を拡張
このイベントは、ユーザーがリワード広告スロットを閉じたときに発生します。報酬が付与される前または後に発火する可能性があります。報酬が付与されたかどうかを確認するには、代わりに events.RewardedSlotGrantedEvent を使用します。
プロパティ
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。
例

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  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（従来）

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  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

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
関連情報

googletag.events.RewardedSlotGrantedEvent

Event を拡張
このイベントは、リワード広告の視聴に対して報酬が付与されたときに発生します。報酬付与の条件が満たされる前に広告が閉じられた場合、このイベントは発生しません。
プロパティ
payload
付与された報酬に関する情報を含むオブジェクト。
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。
例

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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（従来）

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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

付与された報酬に関する情報を含むオブジェクト。

googletag.events.RewardedSlotReadyEvent

Event を拡張
このイベントは、リワード広告を表示する準備ができたときに発生します。広告を表示する前に、広告を視聴するかどうかをユーザーに選択させるのは、パブリッシャーの責任です。
プロパティ
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。
メソッド
makeRewardedVisible
リワード広告を表示します。
例

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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.RewardedSlotVideoCompletedEvent

Event を拡張
このイベントは、リワード動画広告の再生が終了したときに発生します。
プロパティ
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。
例

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript（従来）

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", function (event) {
    var slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
関連情報

googletag.events.SlotOnloadEvent

Event を拡張
このイベントは、クリエイティブの 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

Event を拡張
このイベントは、クリエイティブ コードがスロットに挿入されたときに発生します。このイベントはクリエイティブのリソースが取得される前に発生するため、クリエイティブがまだ表示されていない可能性があります。スロットのすべてのクリエイティブ リソースの読み込みが完了したタイミングを知る必要がある場合は、代わりに events.SlotOnloadEvent を検討してください。
プロパティ
advertiserId
レンダリングされた広告の広告主 ID。
campaignId
レンダリングされた広告のキャンペーン ID。
companyIds
レンダリングされたバックフィル広告に入札した会社の ID。
creativeId
レンダリングされた予約広告のクリエイティブ ID。
creativeTemplateId
レンダリングされた予約広告のクリエイティブ テンプレート ID。
isBackfill
広告がバックフィル広告かどうか。
isEmpty
スロットに対して広告が返されたかどうか。
labelIds
非推奨。 
lineItemId
レンダリングされた予約広告の広告申込情報 ID。
responseIdentifier
レスポンス ID は、広告レスポンスごとに固有の ID です。
serviceName
イベントをトリガーしたサービスの名前。
size
レンダリングされたクリエイティブのピクセルサイズを示します。
slot
イベントをトリガーしたスロット。
slotContentChanged
スロットのコンテンツがレンダリングされた広告で変更されたかどうか。
sourceAgnosticCreativeId
レンダリングされた予約広告またはバックフィル広告のクリエイティブ 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("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript（従来）

// This listener is called when a slot has finished rendering.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", function (event) {
  var slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
関連情報

プロパティ

advertiserId

advertiserId: number
レンダリングされた広告の広告主 ID。値は、空のスロット、バックフィル広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの場合は null です。

campaignId

campaignId: number
レンダリングされた広告のキャンペーン ID。値は、空のスロット、バックフィル広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの場合は null です。

companyIds

companyIds: number[]
レンダリングされたバックフィル広告に入札した会社の ID。空のスロット、予約広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの場合、値は null です。

creativeId

creativeId: number
レンダリングされた予約広告のクリエイティブ ID。値は、空のスロット、バックフィル広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの場合は null です。

creativeTemplateId

creativeTemplateId: number
レンダリングされた予約広告のクリエイティブ テンプレート ID。値は、空のスロット、バックフィル広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの場合は null です。

isBackfill

isBackfill: boolean
広告がバックフィル広告かどうか。広告がバックフィル広告の場合は true、それ以外の場合は false。

isEmpty

isEmpty: boolean
スロットに対して広告が返されたかどうか。広告が返されなかった場合は true、それ以外の場合は false になります。

labelIds

labelIds: number[]

lineItemId

lineItemId: number
レンダリングされた予約広告の広告申込情報 ID。値は、空のスロット、バックフィル広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの場合は null です。

responseIdentifier

responseIdentifier: string
レスポンス ID は、広告レスポンスごとに固有の ID で、この値は、広告レビュー センター（ARC）で広告を識別してブロックするために使用できます。

size

size: string | number[]
レンダリングされたクリエイティブのピクセルサイズを示します。例: [728, 90]。空の広告スロットの場合、値は null です。

slotContentChanged

slotContentChanged: boolean
スロットのコンテンツがレンダリングされた広告で変更されたかどうか。コンテンツが変更された場合は true、それ以外の場合は false。

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number
レンダリングされた予約広告またはバックフィル広告のクリエイティブ ID。広告が純広告または広告申込情報のバックフィルではない場合、またはクリエイティブが PubAdsService 以外のサービスによってレンダリングされる場合、値は null になります。

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number
レンダリングされた予約広告またはバックフィル広告の広告申込情報 ID。広告が純広告または広告申込情報のバックフィルではない場合、またはクリエイティブが PubAdsService 以外のサービスによってレンダリングされる場合、値は null になります。

yieldGroupIds

yieldGroupIds: number[]
レンダリングされたバックフィル広告の収益グループの ID。空のスロット、予約広告、PubAdsService 以外のサービスによってレンダリングされたクリエイティブの場合、値は null です。

googletag.events.SlotRequestedEvent

Event を拡張
このイベントは、特定のスロットの広告がリクエストされたときに発生します。
プロパティ
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

Event を拡張
このイベントは、特定のスロットの広告レスポンスを受信したときに発生します。
プロパティ
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

Event を拡張
このイベントは、広告スロットの領域の画面上の割合が変化するたびに発生します。イベントはスロットリングされ、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

これは、GPT がセキュア シグナルの管理に使用する名前空間です。
インターフェース
BidderSignalProvider
特定のビッダーのセキュア シグナルを返します。
PublisherSignalProvider
特定のパブリッシャーのセキュア シグナルを返します。
SecureSignalProvidersArray
セキュア シグナルを管理するためのインターフェース。
型エイリアス
SecureSignalProvider
特定のビッダーまたはプロバイダのセキュア シグナルを返すためのインターフェース。

型エイリアス

SecureSignalProvider

特定のビッダーまたはプロバイダのセキュア シグナルを返すためのインターフェース。id と networkCode のいずれか一方を指定する必要があります。両方を指定することはできません。

googletag.secureSignals.BidderSignalProvider

特定のビッダーのセキュア シグナルを返します。

ビッダー セキュア シグナル プロバイダは 2 つの部分で構成されます。

  1. コレクタ関数。セキュア シグナルに解決される Promise を返します。
  2. シグナルに関連付けられている入札者を識別する id。
パブリッシャーのセキュア シグナルを返すには、代わりに secureSignals.PublisherSignalProvider を使用します。
プロパティ
collectorFunction
安全なシグナルに解決される Promise を返す関数。
id
このセキュア シグナルに関連付けられているコレクタの固有識別子。Google アド マネージャーに登録されているもの。
例

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript（従来）

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// id is provided
googletag.secureSignalProviders!.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
関連情報

プロパティ

collectorFunction

collectorFunction: (() => Promise<string>)
安全なシグナルに解決される Promise を返す関数。

id

id: string
このセキュア シグナルに関連付けられているコレクタの固有識別子。Google アド マネージャーに登録されているもの。

googletag.secureSignals.PublisherSignalProvider

特定のパブリッシャーのセキュア シグナルを返します。

パブリッシャー シグナル プロバイダは、次の 2 つの部分で構成されます。

  1. コレクタ関数。セキュア シグナルに解決される Promise を返します。
  2. シグナルに関連付けられているパブリッシャーを識別する networkCode。
ビッダーのセキュア シグナルを返すには、代わりに secureSignals.BidderSignalProvider を使用します。
プロパティ
collectorFunction
安全なシグナルに解決される Promise を返す関数。
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>)
安全なシグナルに解決される Promise を返す関数。

networkCode

networkCode: string
このセキュア シグナルに関連付けられているパブリッシャーのネットワーク コード（広告ユニットのパスに表示されます）。

googletag.secureSignals.SecureSignalProvidersArray

セキュア シグナルを管理するためのインターフェース。
メソッド
clearAllCache
すべてのコレクタのすべてのシグナルをキャッシュからクリアします。
push
シグナル プロバイダ配列に新しい secureSignals.SecureSignalProvider を追加し、シグナル生成プロセスを開始します。

メソッド

clearAllCache

clearAllCache(): void
すべての収集者のすべてのシグナルをキャッシュからクリアします。

このメソッドを呼び出すと、現在および今後のページビューの広告リクエストにシグナルが含められなくなる可能性があります。このため、意味のある状態の変化（ログイン、ログアウト、登録といった新規ユーザーを示すイベントなど）が発生した場合にのみ呼び出す必要があります。

push

push(provider: SecureSignalProvider): void
シグナル プロバイダ配列に新しい secureSignals.SecureSignalProvider を追加し、シグナル生成プロセスを開始します。
パラメータ
provider: SecureSignalProvider配列に追加する secureSignals.SecureSignalProvider オブジェクト。