Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

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 が列挙型に使用する名前空間です。
`events`	これは、GPT がイベントに使用する名前空間です。
`secureSignals`	これは、GPT がセキュアシグナルの管理に使用する名前空間です。

インターフェース
`CommandArray`	コマンド配列は一連の関数を受け取り、それらを順番に呼び出します。
`CompanionAdsService`	コンパニオン広告サービス。
`PrivacySettingsConfig`	プライバシー設定の構成オブジェクト。
`PubAdsService`	パブリッシャー広告サービス。
`RequestHook`	PubAdsService.registerRequestHook を介して登録された場合に、各広告リクエストの前に呼び出されるコールバック関数。
`ResponseInformation`	1 つの広告レスポンスを表すオブジェクト。
`RewardedPayload`	リワード広告に関連付けられた報酬を表すオブジェクト。
`Service`	すべてのサービスに共通するメソッドを含む基本サービスクラス。
`SizeMappingBuilder`	サイズマッピング仕様オブジェクトのビルダー。
`Slot`	スロットは、ページ上の単一の広告スロットを表すオブジェクトです。

型エイリアス
`FluidSize`	広告コンテナが親 div の幅の 100% を占め、クリエイティブコンテンツに合わせて高さを変更するサイズ文字列。
`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 を作成します。

型エイリアス

FluidSize

FluidSize: "fluid"

広告コンテナが親 div の幅を 100% 使用し、クリエイティブコンテンツに合わせて高さを変更するサイズ文字列。ページ上の通常のブロック要素の動作に似ています。ネイティブ広告とバナー広告で使用されます（関連記事を参照）。

GeneralSize

GeneralSize: SingleSize | MultiSize

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

MultiSize

MultiSize: SingleSize[]

有効な単一サイズのリスト。

NamedSize

NamedSize: FluidSize | [FluidSize]

スロットに設定できる名前付きサイズ。ほとんどの場合、サイズは固定サイズの長方形ですが、他の種類のサイズ指定が必要な場合もあります。有効な名前付きサイズは次のとおりです。

fluid: 広告コンテナは親 div の幅の 100% を占め、クリエイティブコンテンツに合わせて高さが変更されます。ページ上の通常のブロック要素と同様に動作します。ネイティブ広告とバナー広告で使用されます（関連記事を参照）。fluid と ['fluid'] はどちらも、スロットサイズを流動として宣言する際に使用できる形式です。

SingleSize

SingleSize: SingleSizeArray | NamedSize

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

SingleSizeArray

SingleSizeArray: [number, number]

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

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

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

SizeMappingArray

SizeMappingArray: SizeMapping[]

サイズマッピングのリスト。

変数

`Const` apiReady

apiReady: boolean | undefined

GPT API が読み込まれ、呼び出し可能であることを示すフラグ。このプロパティは、API の準備が整うまでは単に undefined となります。

非同期を処理する際のおすすめの方法は、googletag.cmd を使用して、GPT の準備が整ったときにコールバックをキューに入れることです。これらのコールバックは、API が設定されると実行されることが保証されているため、googletag.apiReady を確認する必要はありません。

`Const` cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray

GPT 関連の呼び出しを非同期で実行するためのグローバルコマンドキューへの参照。

googletag.cmd 変数は、ページ上の GPT タグ構文によって空の 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");

関連情報

Google パブリッシャータグを使ってみる

パラメータ
`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 パブリッシャーコンソールを無効にします。

関連情報

Google パブリッシャーコンソール

ディスプレイ

display(divOrSlot: string | Element | Slot): void

スロットサービスにスロットをレンダリングするよう指示します。各広告スロットは、ページごとに 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[]): Readonly<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[]`	取得する構成オプションのキー。

戻り値
`Readonly<Pick<PageSettingsConfig, "adsenseAttributes" \| "disableInitialLoad" \| "targeting">>`	ページの構成オプションのフリーズされたコピー。

getVersion

getVersion(): string

GPT の現在のバージョンを返します。

関連情報

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();

関連情報

Google パブリッシャーコンソール

パラメータ
`Optional div: string`	広告スロットの div ID。この値は省略可能です。指定すると、パブリッシャーコンソールが開き、指定した広告スロットの詳細が表示されます。

pubads

pubads(): PubAdsService

PubAdsService への参照を返します。

戻り値
`PubAdsService`	パブリッシャー広告サービス。

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 関数を設定して呼び出すことができるリスナーを登録します。 `Service.addEventListener` メソッドから継承
`getSlots`	このサービスに関連付けられているスロットのリストを取得します。 `Service.getSlots` メソッドから継承
`removeEventListener`	以前に登録されたリスナーを削除します。 `Service.removeEventListener` メソッドから継承
`setRefreshUnfilledSlots`	埋められなかったコンパニオンスロットを自動的にバックフィルするかどうかを設定します。

関連情報

動画とオーディオのコンパニオン広告

メソッド

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void

埋められなかったコンパニオンスロットを自動的にバックフィルするかどうかを設定します。

このメソッドは、ページのライフタイム中に複数回呼び出して、バックフィルをオンまたはオフにすることができます。PubAdsService にも登録されているスロットのみがバックフィルされます。ポリシーの制限により、このメソッドは、Ad Exchange 動画が配信されるときに空のコンパニオンスロットを埋めるようには設計されていません。

例

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript（レガシー）

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

パラメータ
`value: boolean`	`true`: 埋められていないスロットを自動的にバックフィルします。`false`: 変更しません。

googletag.PrivacySettingsConfig

プライバシー設定の構成オブジェクト。

プロパティ
`childDirectedTreatment?`	ページを子供向けとして取り扱うかどうかを指定します。
`limitedAds?`	制限付き広告モードで配信できるようにして、パブリッシャーの規制遵守ニーズをサポートします。
`nonPersonalizedAds?`	非パーソナライズド広告モードで配信を実行できるようにして、パブリッシャーが規制遵守のニーズに対応できるようにします。
`restrictDataProcessing?`	パブリッシャーの規制遵守のニーズをサポートするために、制限付き処理モードで配信を実行できるようにします。
`tagForAgeTreatment?`	年齢制限のある取り扱い。広告リクエストを子ども向け、13 歳以上の未成年者向け、または未指定として扱うかどうかを示します。
`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` tagForAgeTreatment

tagForAgeTreatment?: TagForAgeTreatment

年齢制限のある取り扱い。広告リクエストを子供、13 歳以上、または未指定として扱うかどうかを示します。

法律および規制上の要件に基づき、ユーザーに対する年齢に応じた取り扱いに関する設定を決定するため、顧問弁護士に相談していただく必要があります。この設定について詳しくは、こちらのヘルプセンターの記事をご覧ください。

このプロパティを設定することで、この通知が正確であること、およびサイトの所有者に代わって行動する権限があることを証明したことになります。この設定を不正に利用すると、Google アカウントは削除される場合があります。

例

JavaScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

JavaScript（レガシー）

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

TypeScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

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

メソッド

clear

clear(slots?: Slot[]): boolean

指定されたスロットから広告を削除し、空白のコンテンツに置き換えます。スロットは未取得としてマークされます。

特に、スロットをクリアすると、GPT の長期ページビューから広告が削除されるため、今後のリクエストは、この広告に関連するロードブロッキングや競合他社の除外の影響を受けません。

例

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

JavaScript（レガシー）

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

パラメータ
`Optional slots: Slot[]`	クリアするスロットの配列。配列は省略可能です。指定しない場合、すべてのスロットがクリアされます。

戻り値
`boolean`	スロットがクリアされた場合は `true` を返し、それ以外の場合は `false` を返します。

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService

ページ単位の広告カテゴリの除外ラベルをすべてクリアします。このメソッドは、スロットを更新する場合に便利です。

例

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

JavaScript（レガシー）

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

関連情報

カスタムラベルで広告をブロックする

戻り値
`PubAdsService`	メソッドが呼び出されたサービスオブジェクト。

clearTargeting

clearTargeting(key?: string): PubAdsService

特定のキーまたはすべてのキーのカスタムターゲティングパラメータを消去します。

例

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

JavaScript（レガシー）

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

関連情報

Key-Value ターゲティング

パラメータ
`Optional key: string`	ターゲティングパラメータキー。キーは省略可能です。指定しない場合、すべてのターゲティングパラメータがクリアされます。

戻り値
`PubAdsService`	メソッドが呼び出されたサービスオブジェクト。

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

表示する広告コンテンツがない場合に、スロットの div を折りたたんでページ上のスペースを占有しないようにします。このモードは、サービスを有効にする前に設定する必要があります。

関連情報

パラメータ
`Optional collapseBeforeAdFetch: boolean`	広告が取得される前でもスロットを折りたたむかどうか。このパラメータは省略可能です。指定しない場合、デフォルト値として `false` が使用されます。

戻り値
`boolean`	div 折りたたみモードが有効になっている場合は `true` を返します。サービスが有効になった後にメソッドが呼び出されたために折りたたみモードを有効にできない場合は `false` を返します。

disableInitialLoad

disableInitialLoad(): void

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

関連情報

ディスプレイ

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void

指定された広告ユニットのパスとサイズで広告スロットを作成して表示します。

このメソッドは、googletag.defineSlot を呼び出した直後に googletag.display を呼び出すのと同じです。

このメソッドの動作は、シングルリクエストアーキテクチャ（SRA）が有効になっているかどうかによって異なります。

SRA が有効な場合: この呼び出しの時点までに定義されたすべての広告スロットがバッチ処理され、まとめてリクエストされます。
SRA が無効（デフォルト）: 広告スロットが個別にリクエストされます。

注: このメソッドが呼び出されると、スロットとページの状態のスナップショットが作成され、広告リクエストの送信時とレスポンスのレンダリング時の一貫性が確保されます。このメソッドが呼び出された後にスロットまたはページの状態に加えられた変更（ターゲティング、プライバシー設定、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.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,
  },
});

JavaScript（レガシー）

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

TypeScript

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

関連情報

パラメータ

パラメータ
`Optional config: { fetchMarginPercent?: number; mobileScaling?: number; renderMarginPercent?: number; }`	構成オブジェクトを使用すると、遅延動作をカスタマイズできます。省略された構成には、Google が設定したデフォルトが使用されます。このデフォルトは、時間の経過とともに調整されます。フェッチマージンなどの特定の設定を無効にするには、値を `-1` に設定します。 `fetchMarginPercent` 広告を取得する前にスロットが現在のビューポートから離れている必要がある最小距離（ビューポートサイズに対する割合）。値が 0 の場合は「スロットがビューポートに入ったとき」、100 の場合は「広告が 1 ビューポート離れたとき」を意味します。 `renderMarginPercent` 広告をレンダリングする前に、スロットが現在のビューポートから離れている必要がある最小距離。これにより、広告をプリフェッチし、他のサブリソースのレンダリングとダウンロードを待機できます。この値は、ビューポートの割合として `fetchMarginPercent` と同様に機能します。 `mobileScaling` モバイルデバイスのマージンに適用される乗数。これにより、モバイルとパソコンで異なるマージンを設定できます。たとえば、値を 2.0 に設定すると、モバイルデバイスではすべてのマージンが 2 倍になり、スロットの取得とレンダリングが行われる最小距離が長くなります。

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.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

JavaScript（レガシー）

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

var adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
var pageUrl =
  (adsenseConfig === null || adsenseConfig === void 0 ? void 0 : adsenseConfig.page_url) || null;
// Returns 'http://www.example.com'.

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

関連情報

AdSense の属性

パラメータ
`key: string`	検索する属性の名前。

戻り値
`string`	属性キーの現在の値。キーが存在しない場合は `null`。

getAttributeKeys

getAttributeKeys(): string[]

このサービスに設定されている属性キーを返します。

例

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

JavaScript（レガシー）

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

var adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
var adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

戻り値
`string[]`	このサービスに設定されている属性キーの配列。順序は未定義です。

getTargeting

getTargeting(key: string): string[]

設定されている特定のカスタムサービスレベルターゲティングパラメータを返します。

例

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

JavaScript（レガシー）

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

var targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
var targeting =
  (targetingConfig === null || targetingConfig === void 0
    ? void 0
    : targetingConfig["interests"]) || [];
// Returns ['sports'].

var ageTargeting =
  (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || [];
// Returns [] (empty array).

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

パラメータ
`key: string`	検索するターゲティングキー。

戻り値
`string[]`	このキーに関連付けられた値。そのようなキーがない場合は空の配列。

getTargetingKeys

getTargetingKeys(): string[]

設定されているすべてのカスタムサービスレベルターゲティングキーのリストを返します。

例

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

JavaScript（レガシー）

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

var targetingConfig = googletag.getConfig("targeting").targeting;
var keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// 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 slots: Slot[]`	更新するスロット。配列は省略可能です。指定しない場合は、すべてのスロットが更新されます。
`Optional options: { changeCorrelator: boolean; }`	この更新呼び出しに関連付けられた構成オプション。 `changeCorrelator` 広告を取得するために新しい相関子を生成するかどうかを指定します。広告サーバーは、この correlator 値を短時間（現在は 30 秒ですが、変更される可能性があります）保持します。これにより、同じ correlator 値を持つリクエストが短い間隔で受信された場合、それらのリクエストは 1 回のページビューと見なされます。デフォルトでは、更新のたびに新しい correlator が生成されます。注: このオプションは、GPT の長期間のページビューには影響しません。長期間のページビューは、ページに現在表示されている広告を自動的に反映し、有効期限はありません。

Optional options: { 
  changeCorrelator: boolean; 
}

この更新呼び出しに関連付けられた構成オプション。

changeCorrelator

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

注: このオプションは、GPT の長期間のページビューには影響しません。長期間のページビューは、ページに現在表示されている広告を自動的に反映し、有効期限はありません。

registerRequestHook

registerRequestHook(hook: RequestHook, hookId: string): (() => void)

Experimental: グローバルタイムアウト内で、ページ上の各広告リクエストの前に、登録されている他のフックと並行して実行されるフックを登録します。

例

JavaScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

JavaScript（レガシー）

// Coming soon.

TypeScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

パラメータ
`hook: RequestHook`	リクエストされたスロットのリストを含むオブジェクトを受け取り、すべての非同期アクションが完了すると解決される Promise を返す関数。
`hookId: string`	診断を改善するためにフックにラベルを付ける ID。

戻り値
`(() => void)`	フックの登録を解除する関数。

set

set(key: string, value: string): PubAdsService

パブリッシャー広告サービスの下にあるすべての広告スロットに適用される AdSense 属性の値を設定します。

同じキーに対してこのメソッドを複数回呼び出すと、そのキーに以前設定された値がオーバーライドされます。すべての値は、display または refresh を呼び出す前に設定する必要があります。

例

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

JavaScript（レガシー）

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

関連情報

AdSense の属性

パラメータ
`key: string`	属性名。
`value: string`	属性値。

戻り値
`PubAdsService`	メソッドが呼び出されたサービスオブジェクト。

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService

指定されたラベル名に対してページ単位の広告カテゴリの除外を設定します。

例

JavaScript

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

JavaScript（レガシー）

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

TypeScript

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

関連情報

カスタムラベルで広告をブロックする

パラメータ
`categoryExclusion: string`	追加する広告カテゴリの除外ラベル。

戻り値
`PubAdsService`	メソッドが呼び出されたサービスオブジェクト。

setCentering

setCentering(centerAds: boolean): void

広告の水平方向のセンタリングを有効または無効にします。センタリングはデフォルトで無効になっています。以前の gpt_mobile.js では、中央揃えがデフォルトで有効になっています。

このメソッドは、display または refresh を呼び出す前に呼び出す必要があります。このメソッドを呼び出した後にリクエストされた広告のみが中央揃えになるためです。

例

JavaScript

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

JavaScript（レガシー）

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

TypeScript

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

パラメータ
`centerAds: boolean`	`true` は広告を中央に配置し、`false` は広告を左揃えにします。

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

ページ上のすべての広告を SafeFrame コンテナを使用して強制的にレンダリングするかどうかを設定します。

この API を使用する際は、次の点に注意してください。

この設定は、それぞれのスロットに対して行われる後続の広告リクエストにのみ適用されます。
スロットレベルの設定を指定すると、ページレベルの設定は常にオーバーライドされます。
true に設定すると（スロット単位またはページ単位）、Google アドマネージャーの管理画面での選択に関係なく、広告は常に SafeFrame コンテナを使用してレンダリングされます。
ただし、false に設定するか、指定しないままにした場合、広告はクリエイティブの種類と Google アドマネージャーの管理画面での選択に応じて、SafeFrame コンテナを使用して表示されます。
この API は、iframe からのブレイクアウトを試みるクリエイティブや、パブリッシャーのページに直接レンダリングされることを前提とするクリエイティブの動作に影響する可能性があるため、注意して使用する必要があります。

例

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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");

関連情報

SafeFrame を使用してクリエイティブを表示する

パラメータ
`forceSafeFrame: boolean`	`true` を指定すると、ページ上のすべての広告が SafeFrame でレンダリングされます。`false` を指定すると、以前の設定が false に変更されます。以前に指定されていない場合にこれを `false` に設定しても、何も変更されません。

戻り値
`PubAdsService`	メソッドが呼び出されたサービスオブジェクト。

setLocation

setLocation(address: string): PubAdsService

ウェブサイトから位置情報を渡して、広告申込情報を特定の地域に地域ターゲティングできるようにします。

例

JavaScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

JavaScript（レガシー）

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

TypeScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

パラメータ
`address: string`	自由形式の住所。

戻り値
`PubAdsService`	メソッドが呼び出されたサービスオブジェクト。

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

構成オブジェクトを使用して、1 つの API からすべてのプライバシー設定を構成できます。

例

JavaScript

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

JavaScript（レガシー）

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

TypeScript

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

関連情報

パラメータ
`privacySettings: PrivacySettingsConfig`	プライバシー設定の構成を含むオブジェクト。

戻り値
`PubAdsService`	関数が呼び出されたサービスオブジェクト。

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService

パブリッシャー提供の ID の値を設定します。

例

JavaScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

JavaScript（レガシー）

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

TypeScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

関連情報

パブリッシャー指定の識別子について

パラメータ
`ppid: string`	パブリッシャーが指定する英数字の ID。22 ～ 150 文字で指定してください。

戻り値
`PubAdsService`	メソッドが呼び出されたサービスオブジェクト。

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

SafeFrame 構成のページレベルの設定を指定します。構成オブジェクト内の認識されないキーは無視されます。認識されたキーに無効な値が渡されると、構成全体が無視されます。

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

例

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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");

関連情報

SafeFrame を使用してクリエイティブを表示する

パラメータ
`config: SafeFrameConfig`	構成オブジェクト。

戻り値
`PubAdsService`	メソッドが呼び出されたサービスオブジェクト。

setTargeting

setTargeting(key: string, value: string | string[]): PubAdsService

パブリッシャー広告サービスのすべての広告スロットに適用される、特定のキーのカスタムターゲティングパラメータを設定します。同じキーに対してこのメソッドを複数回呼び出すと、古い値が上書きされます。これらのキーは、Google アドマネージャーアカウントで定義されます。

例

JavaScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

JavaScript（レガシー）

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

関連情報

Key-Value ターゲティング

パラメータ
`key: string`	ターゲティングパラメータキー。
`value: string \| string[]`	ターゲティングパラメータ値または値の配列。

戻り値
`PubAdsService`	メソッドが呼び出されたサービスオブジェクト。

setVideoContent

setVideoContent(videoContentId: string, videoCmsId: string): void

ターゲティングとコンテンツの除外を目的として、広告リクエストとともに送信される動画コンテンツ情報を設定します。このメソッドが呼び出されると、動画広告が自動的に有効になります。videoContentId と videoCmsId には、Google アドマネージャーのコンテンツの取り込みサービスに提供される値を使用します。

関連情報

VAST 広告タグ URL パラメータ

パラメータ
`videoContentId: string`	動画コンテンツ ID。
`videoCmsId: string`	動画の CMS ID。

updateCorrelator

updateCorrelator(): PubAdsService

広告リクエストとともに送信される相関値を変更し、新しいページビューを効果的に開始します。相関値は、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.RequestHook

PubAdsService.registerRequestHook を介して登録された場合に、各広告リクエストの前に呼び出されるコールバック関数。

googletag.ResponseInformation

1 つの広告レスポンスを表すオブジェクト。

プロパティ
`advertiserId`	広告主の ID。
`campaignId`	キャンペーンの ID です。
`creativeId`	クリエイティブの ID。
`creativeTemplateId`	広告のテンプレート ID。
`lineItemId`	広告申込情報の ID。

関連情報

Slot.getResponseInformation

プロパティ

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

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: K`	GPT によって生成されたイベントのタイプを表す文字列。イベントタイプでは大文字と小文字が区別されます。
`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: K`	GPT によって生成されたイベントのタイプを表す文字列。イベントタイプでは大文字と小文字が区別されます。
`listener: ((event: EventTypeMap[K]) => void)`	単一のイベントオブジェクト引数を受け取る関数。

googletag.SizeMappingBuilder

サイズマッピング仕様オブジェクトのビルダー。このビルダーは、サイズ仕様を簡単に作成できるようにするために提供されています。

メソッド
`addSize`	単一サイズの配列（ビューポートを表す）から、スロットを表す単一サイズまたは複数サイズの配列へのマッピングを追加します。
`build`	このビルダーに追加されたマッピングからサイズマップ仕様を構築します。

関連情報

広告サイズ: レスポンシブ広告

メソッド

addSize

addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder

単一サイズの配列（ビューポートを表す）から、スロットを表す単一サイズまたは複数サイズの配列へのマッピングを追加します。

例

JavaScript

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports &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

build(): SizeMappingArray

このビルダーに追加されたマッピングからサイズマッピング仕様を作成します。

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

注: このメソッドを呼び出した後のビルダーの動作は定義されていません。

戻り値
`SizeMappingArray`	このビルダーで構築された結果。無効なサイズマッピングが指定された場合は null になることがあります。

googletag.Slot

スロットは、ページ上の単一の広告スロットを表すオブジェクトです。

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

メソッド

addService

addService(service: Service): Slot

このスロットにサービスを追加します。

例

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")
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// 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")
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// 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")!
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// 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")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

JavaScript（レガシー）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

関連情報

Key-Value ターゲティング

パラメータ
`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")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

JavaScript（レガシー）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

var adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
var pageUrl =
  (adsenseConfig === null || adsenseConfig === void 0 ? void 0 : adsenseConfig.page_url) || null;
// Returns 'http://www.example.com'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

関連情報

AdSense の属性

パラメータ
`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")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

JavaScript（レガシー）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

var adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
var adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

戻り値
`string[]`	属性キーの配列。順序は未定義です。

getCategoryExclusions

getCategoryExclusions(): string[]

このスロットの広告カテゴリの除外ラベルを返します。

例

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

JavaScript（レガシー）

var _a;
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

var exclusions =
  ((_a = slot.getConfig("categoryExclusion")) === null || _a === void 0
    ? void 0
    : _a.categoryExclusion) || [];
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

戻り値
`string[]`	このスロットの広告カテゴリ除外ラベル。設定されていない場合は空の配列。

getConfig

getConfig(keys: string | string[]): Readonly<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[]`	取得する構成オプションのキー。

戻り値
`Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" \| "targeting" \| "categoryExclusion">>`	スロットの構成オプションの固定コピー。

getResponseInformation

getResponseInformation(): ResponseInformation

広告レスポンス情報を返します。これは、スロットの最後の広告レスポンスに基づいています。スロットに広告がないときにこのメソッドが呼び出されると、null が返されます。

戻り値
`ResponseInformation`	最新の広告レスポンス情報。スロットに広告がない場合は `null`。

getSlotElementId

getSlotElementId(): string

スロットの定義時に指定されたスロット div の ID を返します。

例

JavaScript

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

slot.getSlotElementId();
// Returns 'div'.

JavaScript（レガシー）

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

slot.getSlotElementId();
// Returns 'div'.

TypeScript

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

slot.getSlotElementId();
// Returns 'div'.

戻り値
`string`	スロット `div` ID。

getTargeting

getTargeting(key: string): string[]

このスロットに設定されている特定のカスタムターゲティングパラメータを返します。サービスレベルのターゲティングパラメータは含まれません。

例

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

JavaScript（レガシー）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

var targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
var targeting =
  (targetingConfig === null || targetingConfig === void 0
    ? void 0
    : targetingConfig["allow_expandable"]) || [];
// Returns ['true'].

var ageTargeting =
  (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || [];
// Returns [] (empty array).

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

パラメータ
`key: string`	検索するターゲティングキー。

戻り値
`string[]`	このキーに関連付けられた値。そのようなキーがない場合は空の配列。

getTargetingKeys

getTargetingKeys(): string[]

このスロットに設定されているすべてのカスタムターゲティングキーのリストを返します。サービスレベルのターゲティングキーは含まれません。

例

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

JavaScript（レガシー）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

var targetingConfig = slot.getConfig("targeting").targeting;
var keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// 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")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

JavaScript（レガシー）

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

関連情報

AdSense の属性

パラメータ
`key: string`	属性名。
`value: string`	属性値。

戻り値
`Slot`	メソッドが呼び出されたスロットオブジェクト。

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot

このスロットにスロットレベルの広告カテゴリの除外ラベルを設定します。

例

JavaScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

JavaScript（レガシー）

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

TypeScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["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")
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

JavaScript（レガシー）

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

パラメータ
`value: string`	設定するクリック URL。

戻り値
`Slot`	メソッドが呼び出されたスロットオブジェクト。

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot

スロットに広告がない場合に、スロット div を非表示にするかどうかを設定します。これはサービスレベルの設定をオーバーライドします。

例

JavaScript

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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（レガシー）

var slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

var slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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): Slot

このスロットの一般的な構成オプションを設定します。

パラメータ
`slotConfig: SlotSettingsConfig`	構成オブジェクト。

戻り値
`Slot`	メソッドが呼び出されたスロットオブジェクト。

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

このスロットの広告を SafeFrame コンテナを使用して強制的にレンダリングするかどうかを設定します。

この API を使用する際は、次の点に注意してください。

この設定は、それぞれのスロットに対して行われる後続の広告リクエストにのみ適用されます。
スロットレベルの設定を指定すると、ページレベルの設定は常にオーバーライドされます。
true に設定すると（スロット単位またはページ単位）、Google アドマネージャーの管理画面での選択に関係なく、広告は常に SafeFrame コンテナを使用してレンダリングされます。
ただし、false に設定するか、指定しないままにした場合、広告はクリエイティブの種類と Google アドマネージャーの管理画面での選択に応じて、SafeFrame コンテナを使用して表示されます。
この API は、iframe からのブレイクアウトを試みるクリエイティブや、パブリッシャーのページに直接レンダリングされることを前提とするクリエイティブの動作に影響する可能性があるため、注意して使用する必要があります。

例

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

JavaScript（レガシー）

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

関連情報

SafeFrame を使用してクリエイティブを表示する

パラメータ
`forceSafeFrame: boolean`	`true` を指定すると、このスロットのすべての広告が 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");

関連情報

SafeFrame を使用してクリエイティブを表示する

パラメータ
`config: SafeFrameConfig`	構成オブジェクト。

戻り値
`Slot`	メソッドが呼び出されたスロットオブジェクト。

setTargeting

setTargeting(key: string, value: string | string[]): Slot

このスロットにカスタムターゲティングパラメータを設定します。同じキーに対してこのメソッドを複数回呼び出すと、古い値が上書きされます。ここで設定した値は、サービスレベルで設定したターゲティングパラメータを上書きします。これらのキーは、Google アドマネージャーアカウントで定義されます。

例

JavaScript

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

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

JavaScript（レガシー）

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

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

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

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

関連情報

Key-Value ターゲティング

パラメータ
`key: string`	ターゲティングパラメータキー。
`value: string \| string[]`	ターゲティングパラメータ値または値の配列。

戻り値
`Slot`	メソッドが呼び出されたスロットオブジェクト。

updateTargetingFromMap

updateTargetingFromMap(map: { 
  [adUnitPath: string]: string | string[]; 
}): Slot

JSON オブジェクトのキーと値のマップから、このスロットのカスタムターゲティングパラメータを設定します。これは、オブジェクトのすべてのキー値に対して 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 広告の動作を制御する設定。
`AutoRefreshConfig`	自動更新の構成設定。
`ContinueButtonConfig`	続行ボタンの動作を構成する設定。
`InterstitialConfig`	1 つのインタースティシャル広告スロットの動作を定義するオブジェクト。
`LazyLoadConfig`	GPT での遅延読み込みの使用を制御する設定。
`PageSettingsConfig`	ページレベルの設定のメイン構成インターフェース。
`PrivacyTreatmentsConfig`	パブリッシャーのプライバシー処理を管理する設定。
`PublisherProvidedSignalsConfig`	パブリッシャー提供のシグナル（PPS）の設定オブジェクト。
`SafeFrameConfig`	GPT で SafeFrame を制御するための設定。
`SlotSettingsConfig`	スロットレベルの設定のメイン構成インターフェース。
`TaxonomyData`	単一の分類の値を含むオブジェクト。
`VideoAdsConfig`	動画広告関連の設定を構成するための設定。

型エイリアス
`CollapseDivBehavior`	広告スロットの折りたたみ動作を制御するためにサポートされている値。
`InterstitialTrigger`	サポートされているインタースティシャル広告トリガー。
`PrivacyTreatment`	サポートされているパブリッシャーのプライバシーに関する取り扱い。
`Taxonomy`	パブリッシャー提供のシグナル（PPS）でサポートされている分類。

型エイリアス

CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"

広告スロットの折りたたみ動作を制御するためにサポートされている値。

関連情報

InterstitialTrigger

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

注: 2026 年 6 月 15 日より、backward トリガーはサポートされなくなり、有効にしても効果はありません。詳しくは、GPT リリースノートをご覧ください。

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

関連情報

ISO 639 言語コードの一覧

`Optional` page_url

page_url?: string

広告が表示されるページの URL。

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

例: http://www.example.com

googletag.config.AutoRefreshConfig

自動更新の構成設定。

プロパティ
`backForwardCache?`	ページがバックフォワードキャッシュから復元されたときに、GPT がアクティブビューで表示されている広告スロットを自動的に更新するかどうか。
`heavyAds?`	Chrome の重い広告の介入が広告スロットの広告 iframe でトリガーされた場合に、GPT が広告スロットを自動的に更新するかどうか。

プロパティ

`Optional` backForwardCache

backForwardCache?: boolean

ページがバックフォワードキャッシュから復元されたときに、GPT がアクティブに表示されている広告スロットを自動的に更新するかどうか。デフォルトは true です。

例

JavaScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

JavaScript（レガシー）

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

関連情報

バックフォワードキャッシュ

`Optional` heavyAds

heavyAds?: boolean

Chrome の重い広告の介入が広告スロットの広告 iframe でトリガーされた場合に、GPT が広告スロットを自動的に更新するかどうか。デフォルトは true です。

例

JavaScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

JavaScript（レガシー）

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

関連情報

Chrome のリソース消費が多い広告への介入について

googletag.config.ContinueButtonConfig

続行ボタンの動作を構成する設定。

プロパティ
`backgroundColor?`	ボタンの背景色。
`font?`	ボタンテキストのフォントファミリー。
`fontColor?`	ボタンのテキストの色。
`freqCapIntervalMinutes?`	フリークエンシーキャップの間隔（分単位）。
`targetId?`	続行ボタンをレンダリングまたはトリガーする HTML 要素の ID。

関連情報

SlotSettingsConfig.continueButton

プロパティ

`Optional` backgroundColor

backgroundColor?: string

ボタンの背景色。

例: 'blue'、'#94B1FF'

`Optional` フォント

font?: string

ボタンテキストのフォントファミリー。

例: 'Arial'

`Optional` fontColor

fontColor?: string

ボタンのテキストの色。

例: 'white'、'#B73B87'

`Optional` freqCapIntervalMinutes

freqCapIntervalMinutes?: number

フリークエンシーキャップの間隔（分単位）。

1 以上の整数にする必要があります。

`Optional` targetId

targetId?: string

続行ボタンをレンダリングまたはトリガーする HTML 要素の ID。

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?`	広告をレンダリングする前にスロットが現在のビューポートから離れている必要がある最小距離。ビューポートサイズの割合で表されます。

関連情報

PageSettingsConfig.lazyLoad

プロパティ

`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?`	非推奨。
`autoRefresh?`	広告の自動更新動作を構成する設定。
`categoryExclusion?`	広告カテゴリの除外を設定します。
`centering?`	広告を水平方向に中央揃えするかどうかを制御する設定。
`collapseDiv?`	広告スロットの折りたたみ動作を制御する設定。
`disableInitialLoad?`	広告をリクエストするタイミングを制御する設定。
`lazyLoad?`	GPT での遅延読み込みの使用を制御する設定。
`location?`	広告申込情報を地域ターゲティングする地理的位置の設定。
`pps?`	パブリッシャー提供のシグナル（PPS）を管理するための設定。
`privacyTreatments?`	パブリッシャーのプライバシー処理を管理する設定。
`requestHookTimeoutMs?`	登録されたすべてのリクエストフックが完了するまで GPT が待機する最大時間を制御する設定。この時間が経過すると、広告リクエストが続行されます。
`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` autoRefresh

autoRefresh?: AutoRefreshConfig

広告の自動更新の動作を設定します。

例

JavaScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

JavaScript（レガシー）

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

`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?: 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?: PublisherProvidedSignalsConfig

パブリッシャー提供のシグナル（PPS）を管理するための設定。

`Optional` privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig

パブリッシャーのプライバシー処理を管理する設定。

`Optional` `Experimental` requestHookTimeoutMs

requestHookTimeoutMs?: number | "auto"

登録済みのすべてのリクエストフックが完了するまで GPT が待機する最大時間を制御する設定。この時間が経過すると、広告リクエストが続行されます。

登録済みのすべてのリクエストフックは並行して実行されます。このタイムアウトは、並列実行の完了を待機する間に広告リクエストプロセスが一時停止する時間の上限を定義します。

サポートされている値:

正のミリ秒数: カスタマイズされた待機期間。
'auto': GPT は Google が最適化したタイムアウトを使用します。
null: タイムアウトを無効にします（GPT はフックが完了するまで無期限に待機します）。

例

JavaScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

JavaScript（レガシー）

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

TypeScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

`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 } });

関連情報

Key-Value ターゲティング

`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`	Taxonomy マッピングを含むオブジェクト。構成をクリアする場合は 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: Partial<Record<Taxonomy, TaxonomyData>>

Taxonomy マッピングを含むオブジェクト。構成をクリアする場合は 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?: boolean

SafeFrame で HTML5 の sandbox 属性を使用して、ユーザー操作なしでトップレベルナビゲーションが行われないようにするかどうか。有効な値は true のみです（false に強制することはできません）。sandbox 属性を指定すると、プラグイン（Flash など）が無効になります。

`Optional` useUniqueDomain

useUniqueDomain?: boolean

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

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

非推奨: この機能を無効にすることはできなくなりました。useUniqueDomain を設定しても影響はありません。

関連情報

SafeFrame を使用してクリエイティブを表示する

googletag.config.SlotSettingsConfig

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

1 つのスロットに対して 1 回の API 呼び出しで複数の機能を設定できます。

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

例:

Slot.setConfig 呼び出しで指定された機能のみが変更されます。

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

  // Configure feature alpha.
  slot.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  slot.setConfig({
     bravo: {...}
  });

Slot.setConfig を呼び出すたびに、特定の機能のすべての設定が更新されます。

  // Configure feature charlie to echo = 1, foxtrot = true.
  slot.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  slot.setConfig({
      charlie: {
          echo: 2
      }
  });

null を渡すと、機能のすべての設定をクリアできます。

  // Configure features delta, golf, and hotel.
  slot.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

  // Feature delta and hotel are cleared, but feature golf remains set.
  slot.setConfig({
      delta: null,
      hotel: null,
  });

プロパティ
`adExpansion?`	広告拡張を設定するための設定。
`adsenseAttributes?`	AdSense 属性を設定するための設定。
`categoryExclusion?`	広告カテゴリの除外を設定します。
`clickUrl?`	広告をクリックした後にユーザーがリダイレクトされる URL を設定します。
`collapseDiv?`	広告スロットの折りたたみ動作を設定します。
`continueButton?`	コンテンツの一時停止時の広告の続行ボタンの動作を設定します。
`interstitial?`	インタースティシャル広告スロットの動作を構成する設定。
`safeFrame?`	GPT での SafeFrame の使用を設定します。
`targeting?`	Key-Value ターゲティングを設定します。

プロパティ

`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` continueButton

continueButton?: ContinueButtonConfig

コンテンツ一時停止時の広告の [続行] ボタンの動作を構成する設定。

これらの設定により、コンテンツ一時停止フォーマットに関連付けられた終了と読み取りの続行のインタラクションの外観と動作をカスタマイズできます。

setConfig() の呼び出し時に指定されていない [続行] ボタンの設定では、Google が設定したデフォルト値が使用されます。

[続行] ボタンの設定をすべて無効にするか、クリアするには、null を渡します。

例

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

JavaScript（レガシー）

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

`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 });

関連情報

Key-Value ターゲティング

googletag.config.TaxonomyData

単一の分類の値を含むオブジェクト。

プロパティ
`values`	Taxonomy 値のリスト。

プロパティ

値

values: readonly string[]

Taxonomy 値のリスト。

googletag.config.VideoAdsConfig

動画広告関連の設定を構成するための設定。

プロパティ
`enableVideoAds`	ページに動画広告が表示されるかどうか。
`videoCmsId?`	動画コンテンツソース ID。
`videoContentId?`	動画コンテンツ ID。

関連情報

PageSettingsConfig.videoAds

プロパティ

enableVideoAds

enableVideoAds: boolean

動画広告をページに表示するかどうか。

true に設定すると、ディスプレイ広告と動画広告にコンテンツの除外の制約が適用されます。

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

`Optional` videoCmsId

videoCmsId?: string

動画コンテンツソース ID。

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

関連情報

cmsid（コンテンツソース ID）

`Optional` videoContentId

videoContentId?: string

動画コンテンツ ID。

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

関連情報

vid（動画 ID）

googletag.enums

これは、GPT が列挙型に使用する名前空間です。

列挙型
`OutOfPageFormat`	GPT でサポートされているページ外フォーマット。
`TagForAgeTreatment`	GPT でサポートされている年齢に応じた取り扱いの設定。
`TrafficSource`	トラフィックソース（GPT でサポート）。

列挙型

OutOfPageFormat

OutOfPageFormat

GPT でサポートされているページ外フォーマット。

関連情報

defineOutOfPageSlot

列挙メンバー
`AD_INTENTS`	広告インテントフォーマット。
`BOTTOM_ANCHOR`	スロットがビューポートの下部に固定されるアンカーフォーマット。
`GAME_MANUAL_INTERSTITIAL`	ゲームの手動インタースティシャルフォーマット。注: ゲームの手動インタースティシャルは、アクセス制限のあるフォーマットです。
`INTERSTITIAL`	ウェブインタースティシャルクリエイティブフォーマット。
`LEFT_SIDE_RAIL`	左サイドレールフォーマット。
`REWARDED`	リワードフォーマット。
`RIGHT_SIDE_RAIL`	右サイドレールフォーマット。
`TOP_ANCHOR`	スロットがビューポートの上部に固定されるアンカーフォーマット。

TagForAgeTreatment

TagForAgeTreatment

GPT でサポートされている年齢に応じた取り扱いの設定。

関連情報

PrivacySettingsConfig.tagForAgeTreatment

列挙メンバー
`CHILD`	広告リクエストに子ども向け取り扱いを適用することを示します。
`TEEN`	広告リクエストに 13 歳以上の未成年者の取り扱いを適用することを示します。
`UNSPECIFIED`	デフォルト値。広告リクエストに年齢制限に応じた取り扱いシグナルが適用されないことを示します。

TrafficSource

TrafficSource

トラフィックソース（GPT 対応）。

関連情報

PrivacySettingsConfig.trafficSource

列挙メンバー
`ORGANIC`	URL の直接入力、サイト内検索、アプリのダウンロード。
`PURCHASED`	所有プロパティ以外からリダイレクトされたトラフィック（獲得済みまたは報酬提供型のアクティビティ）。

googletag.events

これは、GPT がイベントに使用する名前空間です。コードは、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

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

googletag.events.EventTypeMap

これは、Service.addEventListener と Service.removeEventListener のイベント名を対応するイベントオブジェクトタイプにマッピングする疑似タイプです。これは、参照と型安全性の目的でのみ文書化されています。

プロパティ
`gameManualInterstitialSlotClosed`	events.GameManualInterstitialSlotClosedEvent のエイリアス。
`gameManualInterstitialSlotReady`	events.GameManualInterstitialSlotReadyEvent のエイリアス。
`impressionViewable`	events.ImpressionViewableEvent のエイリアス。
`rewardedSlotClosed`	events.RewardedSlotClosedEvent のエイリアス。
`rewardedSlotGranted`	events.RewardedSlotGrantedEvent のエイリアス。
`rewardedSlotReady`	events.RewardedSlotReadyEvent のエイリアス。
`rewardedSlotVideoCompleted`	events.RewardedSlotVideoCompletedEvent のエイリアス。
`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`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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(): boolean

ゲームの手動インタースティシャル広告をユーザーに表示します。広告が正常に表示されたかどうかを返します。

戻り値
`boolean`

googletag.events.ImpressionViewableEvent

拡張Event

このイベントは、アクティブビューの条件に基づいてインプレッションが視認可能になったときに発生します。

プロパティ
`serviceName`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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

payload: RewardedPayload

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

googletag.events.RewardedSlotReadyEvent

拡張Event

このイベントは、リワード広告を表示する準備ができたときに発生します。パブリッシャーは、広告を表示する前に、広告を視聴するかどうかをユーザーが選択できるようにする必要があります。

プロパティ
`serviceName`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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(): boolean

リワード広告を表示します。このメソッドは、ユーザーが広告の視聴に同意するまで呼び出さないでください。

戻り値
`boolean`	リワード広告が正常に表示されたかどうか。

googletag.events.RewardedSlotVideoCompletedEvent

拡張Event

このイベントは、動画リワード広告の再生が終了したときに呼び出されます。

プロパティ
`serviceName`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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 は、広告レスポンスごとの固有識別子で、
`serviceName`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`size`	レンダリングされたクリエイティブのサイズ（ピクセル単位）を示します。
`slot`	イベントをトリガーしたスロット。 `Event.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`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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`	イベントをトリガーしたサービスの名前。 `Event.serviceName` プロパティから継承
`slot`	イベントをトリガーしたスロット。 `Event.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

SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider

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

googletag.secureSignals.BidderSignalProvider

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

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

コレクタ関数。セキュアシグナルに解決される Promise を返します。
シグナルに関連付けられたビッダーを識別する 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 つの部分で構成されます。

コレクタ関数。セキュアシグナルに解決される Promise を返します。
シグナルに関連付けられているパブリッシャーを識別する 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 オブジェクト。

GPT リファレンス コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

型アノテーション

googletag

型エイリアス

FluidSize

GeneralSize

MultiSize

NamedSize

SingleSize

SingleSizeArray

SizeMapping

SizeMappingArray

変数

Const apiReady

Const cmd

JavaScript

JavaScript（レガシー）

TypeScript

Const pubadsReady

secureSignalProviders

JavaScript

JavaScript（レガシー）

TypeScript

関数

companionAds

defineOutOfPageSlot

JavaScript

JavaScript（レガシー）

TypeScript

defineSlot

JavaScript

JavaScript（レガシー）

TypeScript

destroySlots

JavaScript

JavaScript（レガシー）

TypeScript

disablePublisherConsole

ディスプレイ

enableServices

getConfig

JavaScript

JavaScript（レガシー）

TypeScript

getVersion

openConsole

JavaScript

JavaScript（レガシー）

TypeScript

pubads

setAdIframeTitle

JavaScript

JavaScript（レガシー）

TypeScript

setConfig

sizeMapping

googletag.CommandArray

メソッド

push

JavaScript

JavaScript（レガシー）

TypeScript

googletag.CompanionAdsService

Service.addEventListener メソッドから継承

Service.getSlots メソッドから継承

Service.removeEventListener メソッドから継承

メソッド

setRefreshUnfilledSlots

JavaScript

JavaScript（レガシー）

TypeScript

googletag.PrivacySettingsConfig

プロパティ

Optional childDirectedTreatment

Optional limitedAds

JavaScript

JavaScript（レガシー）

TypeScript

Optional nonPersonalizedAds

Optional restrictDataProcessing

GPT リファレンス

`Const` apiReady

`Const` cmd

`Const` pubadsReady

`Service.addEventListener` メソッドから継承

`Service.getSlots` メソッドから継承

`Service.removeEventListener` メソッドから継承

`Optional` childDirectedTreatment

`Optional` limitedAds

`Optional` nonPersonalizedAds

`Optional` restrictDataProcessing

`Optional` tagForAgeTreatment

`Optional` trafficSource

`Optional` underAgeOfConsent

`Service.addEventListener` メソッドから継承

`Service.getSlots` メソッドから継承

`Service.removeEventListener` メソッドから継承