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

型エイリアス


GeneralSize

    GeneralSize: SingleSize | MultiSize

    スロットの有効なサイズ構成。1 つ以上のサイズにできます。


MultiSize

    MultiSize: SingleSize[]

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


NamedSize

    NamedSize: "fluid" | ["fluid"]

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

    • フルード: 広告コンテナは親 div の幅の 100% を占有し、クリエイティブ コンテンツに合わせて高さを変更します。ページ上の通常のブロック要素の動作に似ています。ネイティブ広告に使用されます(関連記事を参照)。fluid['fluid'] はどちらも、スロットサイズをフレキシブルとして宣言するための有効な形式です。


SingleSize


SingleSizeArray

    SingleSizeArray: [number, number]

    [width, height] を表す 2 つの数値の配列。


SizeMapping

    ビューポートのサイズと広告サイズのマッピング。レスポンシブ広告に使用されます。


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 が読み込まれると、配列が検索され、すべての関数が順番に実行されます。スクリプトは、cmdCommandArray オブジェクトに置き換えます。このオブジェクトの push メソッドは、渡された関数引数を実行するように定義されています。このメカニズムにより、ブラウザがページのレンダリングを続行できるようにしながら、JavaScript を非同期で取得することで、GPT は認識されるレイテンシを短縮できます。

    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


defineOutOfPageSlot

    defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null

    指定した広告ユニットパスでページ外広告スロットを作成します。

    カスタム ページ外広告の場合、div は広告を表示する div 要素の ID です。詳しくは、ページ外クリエイティブに関する記事をご覧ください。

    GPT で管理されるページ外広告の場合、div はサポートされている OutOfPageFormat です。

    JavaScript

    // Define a custom out-of-page ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", "div-1");
    
    // Define a GPT managed web interstitial ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
    

    JavaScript(従来版)

    // Define a custom out-of-page ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", "div-1");
    
    // Define a GPT managed web interstitial ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
    

    TypeScript

    // Define a custom out-of-page ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", "div-1");
    
    // Define a GPT managed web interstitial ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
    
    関連情報
    パラメータ
    adUnitPath: stringネットワーク コードと広告ユニットコードを含む完全な広告ユニットのパス
    Optional div: string | OutOfPageFormatこの広告ユニットまたは OutOfPageFormat が含まれる div の ID。
    戻り値
    Slot | null新しく作成されたスロット。スロットを作成できない場合は null です。


defineSlot

    defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null

    指定された広告ユニットのパスとサイズで広告スロットを作成し、広告を表示するページ上の div 要素の ID に関連付けます。

    JavaScript

    googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    

    JavaScript(従来版)

    googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    

    TypeScript

    googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    
    関連情報
    パラメータ
    adUnitPath: stringネットワーク コードとユニット コードを含む完全な広告ユニットのパス
    size: GeneralSize追加されたスロットの幅と高さ。これは、レスポンシブ サイズ マッピングが指定されていない場合や、ビューポートのサイズがマッピングで指定された最小サイズより小さい場合に、広告リクエストで使用されるサイズです。
    Optional div: stringこの広告ユニットを含む div の ID。
    戻り値
    Slot | null新しく作成されたスロット。スロットを作成できない場合は null です。


destroySlots

    destroySlots(slots?: Slot[]): boolean

    指定されたスロットを破棄し、それらのスロットに関連するすべてのオブジェクトと参照を GPT から削除します。この API は、パスバック スロットとコンパニオン スロットをサポートしていません。

    スロットでこの API を呼び出すと、広告が消去され、GPT によって維持される内部状態からスロット オブジェクトが削除されます。スロット オブジェクトでこれ以上関数を呼び出すと、未定義の動作が発生します。ただし、そのスロットへの参照がパブリッシャー ページによって維持されている場合、ブラウザはスロットに関連付けられたメモリを解放しないことがあります。この API を呼び出すと、そのスロットに関連付けられている div を再利用できるようになります。

    特に、スロットを破棄すると、GPT の長時間のページビューから広告が削除されるため、今後のリクエストはこの広告に関連するロードブロックや競合排除の影響を受けなくなります。ページからスロットの div を削除する前にこの関数を呼び出さないと、未定義の動作が発生します。

    JavaScript

    // The calls to construct an ad and display contents.
    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    googletag.display("div-1");
    const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
    googletag.display("div-2");
    
    // This call to destroy only slot1.
    googletag.destroySlots([slot1]);
    
    // This call to destroy both slot1 and slot2.
    googletag.destroySlots([slot1, slot2]);
    
    // This call to destroy all slots.
    googletag.destroySlots();
    

    JavaScript(従来版)

    // The calls to construct an ad and display contents.
    var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    googletag.display("div-1");
    var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
    googletag.display("div-2");
    
    // This call to destroy only slot1.
    googletag.destroySlots([slot1]);
    
    // This call to destroy both slot1 and slot2.
    googletag.destroySlots([slot1, slot2]);
    
    // This call to destroy all slots.
    googletag.destroySlots();
    

    TypeScript

    // The calls to construct an ad and display contents.
    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
    googletag.display("div-1");
    const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
    googletag.display("div-2");
    
    // This call to destroy only slot1.
    googletag.destroySlots([slot1]);
    
    // This call to destroy both slot1 and slot2.
    googletag.destroySlots([slot1, slot2]);
    
    // This call to destroy all slots.
    googletag.destroySlots();
    
    パラメータ
    Optional slots: Slot[]破棄するスロットの配列。配列は省略可能です。指定しない場合、すべてのスロットが破棄されます。
    戻り値
    booleanスロットが破棄されている場合は true、それ以外の場合は false


disablePublisherConsole


ディスプレイ

    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 サービスを有効にします。


getVersion

    getVersion(): string

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

    関連情報
    戻り値
    string現在実行中の GPT バージョン文字列。


openConsole

    openConsole(div?: string): void

    Google パブリッシャー コンソールが開きます。

    JavaScript

    // Calling with div ID.
    googletag.openConsole("div-1");
    
    // Calling without div ID.
    googletag.openConsole();
    

    JavaScript(従来版)

    // Calling with div ID.
    googletag.openConsole("div-1");
    
    // Calling without div ID.
    googletag.openConsole();
    

    TypeScript

    // Calling with div ID.
    googletag.openConsole("div-1");
    
    // Calling without div ID.
    googletag.openConsole();
    
    関連情報
    パラメータ
    Optional div: string広告スロットの div ID。この値は省略可能です。指定された広告スロットの詳細が表示された状態でパブリッシャー コンソールが開きます。


pubads


setAdIframeTitle

    setAdIframeTitle(title: string): void

    PubAdsService によって作成されるすべての広告コンテナ iframe のタイトルを、この時点から設定します。

    JavaScript

    googletag.setAdIframeTitle("title");
    

    JavaScript(従来版)

    googletag.setAdIframeTitle("title");
    

    TypeScript

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


setConfig


sizeMapping


googletag.CommandArray

コマンド アレイは、一連の関数を受け取り、順番に呼び出します。これは、GPT の読み込み後に呼び出される関数をキューに追加するために使用される標準配列に代わるものです。
メソッド
push
引数で指定された関数のシーケンスを順番に実行します。

メソッド


push

    push(...f: ((this: typeof globalThis) => void)[]): number

    引数で指定された関数のシーケンスを順番に実行します。

    JavaScript

    googletag.cmd.push(() => {
      googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
    });
    

    JavaScript(従来版)

    googletag.cmd.push(function () {
      googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
    });
    

    TypeScript

    googletag.cmd.push(() => {
      googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
    });
    
    パラメータ
    Rest ...f: ((this: typeof globalThis) => void)[]実行する JavaScript 関数。ランタイム バインディングは常に globalThis になります。アロー関数を渡して、囲んでいるレキシカル コンテキストの this 値を保持することを検討してください。
    戻り値
    numberこれまでに処理されたコマンド数。これは、Array.push の戻り値(配列の現在の長さ)と互換性があります。


googletag.CompanionAdsService

Service を拡張
コンパニオン広告サービス。このサービスは、動画広告でコンパニオン広告を表示するために使用されます。
メソッド
addEventListener
ページで特定の GPT イベントが発生したときに JavaScript 関数を設定および呼び出すことができるリスナーを登録します。
getSlots
このサービスに関連付けられているスロットのリストを取得します。
removeEventListener
以前に登録されたリスナーを削除します。
setRefreshUnfilledSlots
埋められなかったコンパニオン スロットを自動的にバックフィルするかどうかを設定します。
関連情報

メソッド


setRefreshUnfilledSlots

    setRefreshUnfilledSlots(value: boolean): void

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

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

    JavaScript

    googletag.companionAds().setRefreshUnfilledSlots(true);
    

    JavaScript(従来版)

    googletag.companionAds().setRefreshUnfilledSlots(true);
    

    TypeScript

    googletag.companionAds().setRefreshUnfilledSlots(true);
    
    パラメータ
    value: booleantrue: 未使用のスロットを自動的にバックフィルします。false: 未使用のスロットを変更しません。


googletag.PrivacySettingsConfig

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

プロパティ


Optional childDirectedTreatment


Optional limitedAds

    limitedAds?: boolean

    制限付き広告モードで配信を実行できるようにし、パブリッシャー様の規制遵守ニーズをサポートします。

    制限付き広告をリクエストするよう GPT に指示するには、次の 2 つの方法があります。

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

    CMP を使用している場合、制限付き広告を手動で有効にする必要はありません。

    JavaScript

    // Manually enable limited ads serving.
    // GPT must be loaded from the limited ads URL to configure this setting.
    googletag.pubads().setPrivacySettings({
      limitedAds: true,
    });
    

    JavaScript(従来版)

    // Manually enable limited ads serving.
    // GPT must be loaded from the limited ads URL to configure this setting.
    googletag.pubads().setPrivacySettings({
      limitedAds: true,
    });
    

    TypeScript

    // Manually enable limited ads serving.
    // GPT must be loaded from the limited ads URL to configure this setting.
    googletag.pubads().setPrivacySettings({
      limitedAds: true,
    });
    
    関連情報

Optional nonPersonalizedAds

    nonPersonalizedAds?: boolean

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


Optional restrictDataProcessing

    restrictDataProcessing?: boolean

    配信を制限付き処理モードで実行できるようにし、パブリッシャーの規制コンプライアンス要件をサポートします。


Optional trafficSource

    trafficSource?: TrafficSource

    リクエストが購入済みトラフィックか自然検索トラフィックかを示します。この値は、アド マネージャーのレポートの [トラフィック ソース] ディメンションに入力されます。設定されていない場合、レポートではトラフィック ソースがデフォルトで undefined になります。

    JavaScript

    // Indicate requests represent organic traffic.
    googletag.pubads().setPrivacySettings({
      trafficSource: googletag.enums.TrafficSource.ORGANIC,
    });
    
    // Indicate requests represent purchased traffic.
    googletag.pubads().setPrivacySettings({
      trafficSource: googletag.enums.TrafficSource.PURCHASED,
    });
    

    JavaScript(従来版)

    // Indicate requests represent organic traffic.
    googletag.pubads().setPrivacySettings({
      trafficSource: googletag.enums.TrafficSource.ORGANIC,
    });
    
    // Indicate requests represent purchased traffic.
    googletag.pubads().setPrivacySettings({
      trafficSource: googletag.enums.TrafficSource.PURCHASED,
    });
    

    TypeScript

    // Indicate requests represent organic traffic.
    googletag.pubads().setPrivacySettings({
      trafficSource: googletag.enums.TrafficSource.ORGANIC,
    });
    
    // Indicate requests represent purchased traffic.
    googletag.pubads().setPrivacySettings({
      trafficSource: googletag.enums.TrafficSource.PURCHASED,
    });
    

Optional underAgeOfConsent

    underAgeOfConsent?: null | boolean

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


googletag.PubAdsService

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

メソッド


クリア

    clear(slots?: Slot[]): boolean

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

    特に、スロットを消去すると、GPT の長時間のページビューから広告が削除されるため、今後のリクエストはこの広告に関連するロードブロックや競合排除の影響を受けなくなります。

    JavaScript

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    googletag.display("div-1");
    const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
    googletag.display("div-2");
    
    // This call to clear only slot1.
    googletag.pubads().clear([slot1]);
    
    // This call to clear both slot1 and slot2.
    googletag.pubads().clear([slot1, slot2]);
    
    // This call to clear all slots.
    googletag.pubads().clear();
    

    JavaScript(従来版)

    var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    googletag.display("div-1");
    var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
    googletag.display("div-2");
    
    // This call to clear only slot1.
    googletag.pubads().clear([slot1]);
    
    // This call to clear both slot1 and slot2.
    googletag.pubads().clear([slot1, slot2]);
    
    // This call to clear all slots.
    googletag.pubads().clear();
    

    TypeScript

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
    googletag.display("div-1");
    const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
    googletag.display("div-2");
    
    // This call to clear only slot1.
    googletag.pubads().clear([slot1]);
    
    // This call to clear both slot1 and slot2.
    googletag.pubads().clear([slot1, slot2]);
    
    // This call to clear all slots.
    googletag.pubads().clear();
    
    パラメータ
    Optional slots: Slot[]クリアするスロットの配列。配列は省略可能です。指定しない場合、すべてのスロットが消去されます。
    戻り値
    booleanスロットがクリアされている場合は true、それ以外の場合は false を返します。


clearCategoryExclusions

    clearCategoryExclusions(): PubAdsService

    ページレベルの広告カテゴリ除外ラベルをすべて消去します。これは、スロットを更新する場合に便利です。

    JavaScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    
    // Make ad requests. No ad with 'AirlineAd' label will be returned.
    
    // Clear category exclusions so all ads can be returned.
    googletag.pubads().clearCategoryExclusions();
    
    // Make ad requests. Any ad can be returned.
    

    JavaScript(従来版)

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    
    // Make ad requests. No ad with 'AirlineAd' label will be returned.
    
    // Clear category exclusions so all ads can be returned.
    googletag.pubads().clearCategoryExclusions();
    
    // Make ad requests. Any ad can be returned.
    

    TypeScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    
    // Make ad requests. No ad with 'AirlineAd' label will be returned.
    
    // Clear category exclusions so all ads can be returned.
    googletag.pubads().clearCategoryExclusions();
    
    // Make ad requests. Any ad can be returned.
    
    関連情報
    戻り値
    PubAdsServiceメソッドが呼び出されたサービス オブジェクト。


clearTargeting

    clearTargeting(key?: string): PubAdsService

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

    JavaScript

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    googletag.pubads().setTargeting("fruits", "apple");
    
    googletag.pubads().clearTargeting("interests");
    // Targeting 'colors' and 'fruits' are still present, while 'interests'
    // was cleared.
    
    googletag.pubads().clearTargeting();
    // All targeting has been cleared.
    

    JavaScript(従来版)

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    googletag.pubads().setTargeting("fruits", "apple");
    
    googletag.pubads().clearTargeting("interests");
    // Targeting 'colors' and 'fruits' are still present, while 'interests'
    // was cleared.
    
    googletag.pubads().clearTargeting();
    // All targeting has been cleared.
    

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    googletag.pubads().setTargeting("fruits", "apple");
    
    googletag.pubads().clearTargeting("interests");
    // Targeting 'colors' and 'fruits' are still present, while 'interests'
    // was cleared.
    
    googletag.pubads().clearTargeting();
    // All targeting has been cleared.
    
    関連情報
    パラメータ
    Optional key: stringターゲティング パラメータキー。このキーは省略可能です。指定しない場合、すべてのターゲティング パラメータがクリアされます。
    戻り値
    PubAdsServiceメソッドが呼び出されたサービス オブジェクト。


collapseEmptyDivs

    collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

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

    関連情報
    パラメータ
    Optional collapseBeforeAdFetch: boolean広告の取得前にスロットを閉じるかどうか。このパラメータは省略可能です。指定しない場合、デフォルト値として false が使用されます。
    戻り値
    booleandiv 折りたたみモードが有効になっている場合は true が返され、サービスが有効になった後にメソッドが呼び出されるため、折りたたみモードを有効にできない場合は false が返されます。


disableInitialLoad

    disableInitialLoad(): void

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

    関連情報


ディスプレイ

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

    指定された広告ユニットのパスとサイズで広告スロットを作成して表示します。このメソッドは、単一リクエスト モードでは機能しません。

    注: このメソッドが呼び出されると、広告リクエストの送信とレスポンスのレンダリングの整合性を確保するために、スロット ステータスとページ ステータスのスナップショットが作成されます。このメソッドの呼び出し後にスロットまたはページの状態に加えた変更(ターゲティング、プライバシー設定、強制 SafeFrame など)は、後続の display() リクエストまたは refresh() リクエストにのみ適用されます。

    JavaScript

    googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
    

    JavaScript(従来版)

    googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
    

    TypeScript

    googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
    
    関連情報
    パラメータ
    adUnitPath: stringレンダリングされるスロットの広告ユニットのパス
    size: GeneralSizeスロットの幅と高さ。
    Optional div: string | Elementスロットを含む div の ID または div 要素自体。
    Optional clickUrl: stringこのスロットで使用するクリック URL。


enableLazyLoad

    enableLazyLoad(config?: {
      fetchMarginPercent?: number;
      mobileScaling?: number;
      renderMarginPercent?: number;
    }): void

    構成オブジェクトで定義されているように、GPT で遅延読み込みを有効にします。詳細な例については、遅延読み込みのサンプルをご覧ください。

    注: SRA での遅延フェッチは、すべてのスロットがフェッチ マージンの外側にある場合にのみ機能します。

    JavaScript

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

    JavaScript(従来版)

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

    TypeScript

    googletag.pubads().enableLazyLoad({
      // Fetch slots within 5 viewports.
      fetchMarginPercent: 500,
      // Render slots within 2 viewports.
      renderMarginPercent: 200,
      // Double the above values on mobile.
      mobileScaling: 2.0,
    });
    
    関連情報
    パラメータ
    Optional config: {
      fetchMarginPercent?: number;
      mobileScaling?: number;
      renderMarginPercent?: number;
    }
    構成オブジェクトを使用すると、遅延処理の動作をカスタマイズできます。省略された構成には、Google が設定したデフォルトが使用され、時間の経過とともにチューニングされます。取得マージンなどの特定の設定を無効にするには、値を -1 に設定します。
    • fetchMarginPercent

      広告を取得する前にスロットが現在のビューポートから離れている必要がある最小距離(ビューポートのサイズの割合)。値 0 は「スロットがビューポートに入ったとき」、100 は「広告が 1 ビューポート離れたとき」などを意味します。
    • renderMarginPercent

      広告のレンダリングを開始する前に、スロットが現在のビューポートから離れている必要がある最小距離。これにより、広告をプリフェッチしながら、他のサブリソースのレンダリングとダウンロードを待機できます。この値は、ビューポートの割合として fetchMarginPercent と同じように機能します。
    • mobileScaling

      モバイル デバイスの余白に適用される乗数。これにより、モバイルとパソコンで異なる余白を設定できます。たとえば、値を 2.0 にすると、モバイル デバイスのすべてのマージンが 2 倍になり、取得とレンダリングの前にスロットを配置できる最小距離が長くなります。


enableSingleRequest

    enableSingleRequest(): boolean

    複数の広告を同時に取得するための単一リクエスト モードを有効にします。そのため、このサービスを有効にする前に、すべてのパブリッシャー広告スロットを定義して PubAdsService に追加する必要があります。サービスを有効にする前に、単一リクエスト モードを設定する必要があります。

    関連情報
    戻り値
    booleanシングル リクエスト モードが有効になっている場合は true を、サービスが有効になった後にメソッドが呼び出されたためにシングル リクエスト モードを有効にできない場合は false を返します。


enableVideoAds

    enableVideoAds(): void

    ページに動画広告が表示されることを GPT に通知します。これにより、ディスプレイ広告と動画広告で競合の除外制約を適用できるようになります。動画コンテンツが判明している場合は、ディスプレイ広告でコンテンツの除外を使用できるように PubAdsService.setVideoContent を呼び出します。


get

    get(key: string): null | string

    指定したキーに関連付けられた AdSense 属性の値を返します。

    JavaScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().get("adsense_background_color");
    // Returns '#FFFFFF'.
    

    JavaScript(従来版)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().get("adsense_background_color");
    // Returns '#FFFFFF'.
    

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().get("adsense_background_color");
    // Returns '#FFFFFF'.
    
    関連情報
    パラメータ
    key: string検索する属性の名前。
    戻り値
    null | string属性キーの現在の値。キーが存在しない場合は null です。


getAttributeKeys

    getAttributeKeys(): string[]

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

    JavaScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().set("adsense_border_color", "#AABBCC");
    googletag.pubads().getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    

    JavaScript(従来版)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().set("adsense_border_color", "#AABBCC");
    googletag.pubads().getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().set("adsense_border_color", "#AABBCC");
    googletag.pubads().getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    
    戻り値
    string[]このサービスに設定された属性キーの配列。順序は未定義です。


getTargeting

    getTargeting(key: string): string[]

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

    JavaScript

    googletag.pubads().setTargeting("interests", "sports");
    
    googletag.pubads().getTargeting("interests");
    // Returns ['sports'].
    
    googletag.pubads().getTargeting("age");
    // Returns [] (empty array).
    

    JavaScript(従来版)

    googletag.pubads().setTargeting("interests", "sports");
    
    googletag.pubads().getTargeting("interests");
    // Returns ['sports'].
    
    googletag.pubads().getTargeting("age");
    // Returns [] (empty array).
    

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");
    
    googletag.pubads().getTargeting("interests");
    // Returns ['sports'].
    
    googletag.pubads().getTargeting("age");
    // Returns [] (empty array).
    
    パラメータ
    key: string検索するターゲティング キー。
    戻り値
    string[]このキーに関連付けられた値。そのようなキーがない場合、空の配列。


getTargetingKeys

    getTargetingKeys(): string[]

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

    JavaScript

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    
    googletag.pubads().getTargetingKeys();
    // Returns ['interests', 'colors'].
    

    JavaScript(従来版)

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    
    googletag.pubads().getTargetingKeys();
    // Returns ['interests', 'colors'].
    

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    
    googletag.pubads().getTargetingKeys();
    // Returns ['interests', 'colors'].
    
    戻り値
    string[]ターゲティング キーの配列。順序は未定義です。


isInitialLoadDisabled

    isInitialLoadDisabled(): boolean

    以前の PubAdsService.disableInitialLoad 呼び出しで広告の最初のリクエストが正常に無効にされたかどうかを返します。

    戻り値
    booleanPubAdsService.disableInitialLoad の以前の呼び出しが成功した場合は true を返し、それ以外の場合は false を返します。


更新

    refresh(slots?: null | 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: null | Slot[]更新するスロット。配列は省略可能です。指定しない場合、すべてのスロットが更新されます。
    Optional options: {
      changeCorrelator: boolean;
    }
    この更新呼び出しに関連付けられている構成オプション。
    • changeCorrelator

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

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


set

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

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

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

    JavaScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    

    JavaScript(従来版)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    
    関連情報
    パラメータ
    key: string属性名。
    value: string属性値。
    戻り値
    PubAdsServiceメソッドが呼び出されたサービス オブジェクト。


setCategoryExclusion

    setCategoryExclusion(categoryExclusion: string): PubAdsService

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

    JavaScript

    // Label = AirlineAd.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    

    JavaScript(従来版)

    // Label = AirlineAd.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    

    TypeScript

    // Label = AirlineAd.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    
    関連情報
    パラメータ
    categoryExclusion: string追加する広告カテゴリ除外ラベル。
    戻り値
    PubAdsServiceメソッドが呼び出されたサービス オブジェクト。


setCentering

    setCentering(centerAds: boolean): void

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

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

    JavaScript

    // Make ads centered.
    googletag.pubads().setCentering(true);
    

    JavaScript(従来版)

    // Make ads centered.
    googletag.pubads().setCentering(true);
    

    TypeScript

    // Make ads centered.
    googletag.pubads().setCentering(true);
    
    パラメータ
    centerAds: booleantrue は広告を中央に配置し、false は左揃えにします。


setForceSafeFrame

    setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

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

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

    • この設定は、それぞれのスロットに対して行われた後続の広告リクエストにのみ適用されます。
    • スロットレベルの設定が指定されている場合は、常にページレベルの設定がオーバーライドされます。
    • true に設定した場合(スロット単位またはページ単位)、Google アド マネージャーの UI で選択した内容に関係なく、広告は常に SafeFrame コンテナを使用してレンダリングされます。
    • ただし、false に設定するか、指定しない場合は、クリエイティブのタイプと Google アド マネージャーの管理画面で選択した内容に応じて、SafeFrame コンテナを使用して広告がレンダリングされます。
    • この API は、iframe から外部に移動しようとするクリエイティブや、パブリッシャーのページに直接レンダリングされることを前提とするクリエイティブの動作に影響する可能性があるため、慎重に使用してください。

    JavaScript

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will be opted-out of the page-level force
    // SafeFrame instruction.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setForceSafeFrame(false)
      .addService(googletag.pubads());
    
    // The following slot will have SafeFrame forced.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    JavaScript(従来版)

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will be opted-out of the page-level force
    // SafeFrame instruction.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setForceSafeFrame(false)
      .addService(googletag.pubads());
    
    // The following slot will have SafeFrame forced.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    TypeScript

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will be opted-out of the page-level force
    // SafeFrame instruction.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")!
      .setForceSafeFrame(false)
      .addService(googletag.pubads());
    
    // The following slot will have SafeFrame forced.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    
    関連情報
    パラメータ
    forceSafeFrame: booleantrue は、ページ上のすべての広告を SafeFrame でレンダリングするように強制します。false は、前の設定を false に変更します。先ほど指定しなかった場合にこれを false に設定しても、何も変更されません。
    戻り値
    PubAdsService関数が呼び出されたサービス オブジェクト。


setLocation

    setLocation(address: string): PubAdsService

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

    JavaScript

    // Postal code:
    googletag.pubads().setLocation("10001,US");
    

    JavaScript(従来版)

    // Postal code:
    googletag.pubads().setLocation("10001,US");
    

    TypeScript

    // Postal code:
    googletag.pubads().setLocation("10001,US");
    
    パラメータ
    address: string自由形式の住所。
    戻り値
    PubAdsServiceメソッドが呼び出されたサービス オブジェクト。


setPrivacySettings

    setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

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

    JavaScript

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

    JavaScript(従来版)

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

    TypeScript

    googletag.pubads().setPrivacySettings({
      restrictDataProcessing: true,
    });
    
    // Set multiple privacy settings at the same time.
    googletag.pubads().setPrivacySettings({
      childDirectedTreatment: true,
      underAgeOfConsent: true,
    });
    
    // Clear the configuration for childDirectedTreatment.
    googletag.pubads().setPrivacySettings({
      childDirectedTreatment: null,
    });
    
    関連情報
    パラメータ
    privacySettings: PrivacySettingsConfigプライバシー設定の構成を含むオブジェクト。
    戻り値
    PubAdsService関数が呼び出されたサービス オブジェクト。


setPublisherProvidedId

    setPublisherProvidedId(ppid: string): PubAdsService

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

    JavaScript

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

    JavaScript(従来版)

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

    TypeScript

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
    
    関連情報
    パラメータ
    ppid: stringパブリッシャーが指定する英数字の ID。32 ~ 150 文字で指定してください。
    戻り値
    PubAdsServiceメソッドが呼び出されたサービス オブジェクト。


setSafeFrameConfig

    setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

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

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

    JavaScript

    googletag.pubads().setForceSafeFrame(true);
    
    const pageConfig = {
      allowOverlayExpansion: true,
      allowPushExpansion: true,
      sandbox: true,
    };
    
    const slotConfig = { allowOverlayExpansion: false };
    
    googletag.pubads().setSafeFrameConfig(pageConfig);
    
    // The following slot will not allow for expansion by overlay.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setSafeFrameConfig(slotConfig)
      .addService(googletag.pubads());
    
    // The following slot will inherit the page level settings, and hence
    // would allow for expansion by overlay.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    JavaScript(従来版)

    googletag.pubads().setForceSafeFrame(true);
    
    var pageConfig = {
      allowOverlayExpansion: true,
      allowPushExpansion: true,
      sandbox: true,
    };
    
    var slotConfig = { allowOverlayExpansion: false };
    
    googletag.pubads().setSafeFrameConfig(pageConfig);
    
    // The following slot will not allow for expansion by overlay.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setSafeFrameConfig(slotConfig)
      .addService(googletag.pubads());
    
    // The following slot will inherit the page level settings, and hence
    // would allow for expansion by overlay.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    TypeScript

    googletag.pubads().setForceSafeFrame(true);
    
    const pageConfig = {
      allowOverlayExpansion: true,
      allowPushExpansion: true,
      sandbox: true,
    };
    
    const slotConfig = { allowOverlayExpansion: false };
    
    googletag.pubads().setSafeFrameConfig(pageConfig);
    
    // The following slot will not allow for expansion by overlay.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")!
      .setSafeFrameConfig(slotConfig)
      .addService(googletag.pubads());
    
    // The following slot will inherit the page level settings, and hence
    // would allow for expansion by overlay.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    
    関連情報
    パラメータ
    config: SafeFrameConfig構成オブジェクト。
    戻り値
    PubAdsServiceメソッドが呼び出されたサービス オブジェクト。


setTargeting

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

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

    JavaScript

    // Example with a single value for a key.
    googletag.pubads().setTargeting("interests", "sports");
    
    // Example with multiple values for a key inside in an array.
    googletag.pubads().setTargeting("interests", ["sports", "music"]);
    

    JavaScript(従来版)

    // Example with a single value for a key.
    googletag.pubads().setTargeting("interests", "sports");
    
    // Example with multiple values for a key inside in an array.
    googletag.pubads().setTargeting("interests", ["sports", "music"]);
    

    TypeScript

    // Example with a single value for a key.
    googletag.pubads().setTargeting("interests", "sports");
    
    // Example with multiple values for a key inside in an array.
    googletag.pubads().setTargeting("interests", ["sports", "music"]);
    
    関連情報
    パラメータ
    key: stringターゲティング パラメータキー。
    value: string | string[]ターゲティング パラメータ値または値の配列。
    戻り値
    PubAdsServiceメソッドが呼び出されたサービス オブジェクト。


setVideoContent

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

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

    関連情報
    パラメータ
    videoContentId: string動画コンテンツ ID。
    videoCmsId: string動画の CMS ID。


updateCorrelator

    updateCorrelator(): PubAdsService

    広告リクエストとともに送信される相関値を変更し、実質的に新しいページビューを開始します。correlator 値は、1 つのページビューからのすべての広告リクエストで同じで、ページビューごとに固有です。非同期モードにのみ適用されます。

    注: これは、GPT の長時間のページビューには影響しません。長時間のページビューは、ページに実際に表示されている広告を自動的に反映し、有効期限がありません。

    JavaScript

    // Assume that the correlator is currently 12345. All ad requests made
    // by this page will currently use that value.
    
    // Replace the current correlator with a new correlator.
    googletag.pubads().updateCorrelator();
    
    // The correlator will now be a new randomly selected value, different
    // from 12345. All subsequent ad requests made by this page will use
    // the new value.
    

    JavaScript(従来版)

    // Assume that the correlator is currently 12345. All ad requests made
    // by this page will currently use that value.
    
    // Replace the current correlator with a new correlator.
    googletag.pubads().updateCorrelator();
    
    // The correlator will now be a new randomly selected value, different
    // from 12345. All subsequent ad requests made by this page will use
    // the new value.
    

    TypeScript

    // Assume that the correlator is currently 12345. All ad requests made
    // by this page will currently use that value.
    
    // Replace the current correlator with a new correlator.
    googletag.pubads().updateCorrelator();
    
    // The correlator will now be a new randomly selected value, different
    // from 12345. All subsequent ad requests made by this page will use
    // the new value.
    
    戻り値
    PubAdsService関数が呼び出されたサービス オブジェクト。


googletag.ResponseInformation

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

プロパティ


advertiserId

    advertiserId: null | number

    広告主の ID。


campaignId

    campaignId: null | number

    キャンペーンの ID です。


creativeId

    creativeId: null | number

    クリエイティブの ID。


creativeTemplateId

    creativeTemplateId: null | number

    広告のテンプレート ID。


lineItemId

    lineItemId: null | number

    広告申込情報の ID。


googletag.RewardedPayload

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

プロパティ


金額

    amount: number

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


type

    type: string

    報酬に含まれるアイテムの種類(「コイン」など)。


googletag.SafeFrameConfig

SafeFrame コンテナの設定オブジェクト。
プロパティ
allowOverlayExpansion?
SafeFrame で、ページ コンテンツをオーバーレイして広告コンテンツを拡大できるようにするかどうか。
allowPushExpansion?
SafeFrame でページ コンテンツを押し出して広告コンテンツを展開できるようにするかどうか。
sandbox?
SafeFrame が HTML5 の sandbox 属性を使用して、ユーザー操作なしでトップレベル ナビゲーションを防ぐかどうか。
useUniqueDomain?
非推奨。 SafeFrame が予約クリエイティブにランダムなサブドメインを使用するかどうか。
関連情報

プロパティ


Optional allowOverlayExpansion

    allowOverlayExpansion?: boolean

    SafeFrame で、ページ コンテンツをオーバーレイして広告コンテンツを展開できるようにするかどうか。


Optional allowPushExpansion

    allowPushExpansion?: boolean

    SafeFrame でページ コンテンツを押し出して広告コンテンツを展開できるようにするかどうか。


Optional サンドボックス

    sandbox?: boolean

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


Optional useUniqueDomain

    useUniqueDomain?: null | boolean

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

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

    関連情報

googletag.Service

すべてのサービスに共通するメソッドを含むベース サービス クラス。
メソッド
addEventListener
ページで特定の GPT イベントが発生したときに JavaScript 関数を設定および呼び出すことができるリスナーを登録します。
getSlots
このサービスに関連付けられているスロットのリストを取得します。
removeEventListener
以前に登録されたリスナーを削除します。

メソッド


addEventListener

    addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service

    ページで特定の GPT イベントが発生したときに JavaScript 関数を設定および呼び出すことができるリスナーを登録します。サポートされているイベントは次のとおりです。

    リスナーが呼び出されると、適切なイベントタイプのオブジェクトがリスナーに渡されます。

    JavaScript

    // 1. Adding an event listener for the PubAdsService.
    googletag.pubads().addEventListener("slotOnload", (event) => {
      console.log("Slot has been loaded:");
      console.log(event);
    });
    
    // 2. Adding an event listener with slot specific logic.
    // Listeners operate at service level, which means that you cannot add
    // a listener for an event for a specific slot only. You can, however,
    // programmatically filter a listener to respond only to a certain ad
    // slot, using this pattern:
    const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
    googletag.pubads().addEventListener("slotOnload", (event) => {
      if (event.slot === targetSlot) {
        // Slot specific logic.
      }
    });
    

    JavaScript(従来版)

    // 1. Adding an event listener for the PubAdsService.
    googletag.pubads().addEventListener("slotOnload", function (event) {
      console.log("Slot has been loaded:");
      console.log(event);
    });
    
    // 2. Adding an event listener with slot specific logic.
    // Listeners operate at service level, which means that you cannot add
    // a listener for an event for a specific slot only. You can, however,
    // programmatically filter a listener to respond only to a certain ad
    // slot, using this pattern:
    var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
    googletag.pubads().addEventListener("slotOnload", function (event) {
      if (event.slot === targetSlot) {
        // Slot specific logic.
      }
    });
    

    TypeScript

    // 1. Adding an event listener for the PubAdsService.
    googletag.pubads().addEventListener("slotOnload", (event) => {
      console.log("Slot has been loaded:");
      console.log(event);
    });
    
    // 2. Adding an event listener with slot specific logic.
    // Listeners operate at service level, which means that you cannot add
    // a listener for an event for a specific slot only. You can, however,
    // programmatically filter a listener to respond only to a certain ad
    // slot, using this pattern:
    const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
    googletag.pubads().addEventListener("slotOnload", (event) => {
      if (event.slot === targetSlot) {
        // Slot specific logic.
      }
    });
    
    関連情報
    パラメータ
    eventType: KGPT によって生成されたイベントのタイプを表す文字列。イベントタイプでは大文字と小文字が区別されます。
    listener: ((arg: EventTypeMap[K]) => void)単一のイベント オブジェクト引数を取る関数。
    戻り値
    Serviceメソッドが呼び出されたサービス オブジェクト。


getSlots

    getSlots(): Slot[]

    このサービスに関連付けられているスロットのリストを取得します。

    戻り値
    Slot[]サービスに追加された順序でスロット。


removeEventListener

    removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void

    以前に登録されたリスナーを削除します。

    JavaScript

    googletag.cmd.push(() => {
      // Define a new ad slot.
      googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());
    
      // Define a new function that removes itself via removeEventListener
      // after the impressionViewable event fires.
      const onViewableListener = (event) => {
        googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
        setTimeout(() => {
          googletag.pubads().refresh([event.slot]);
        }, 30000);
      };
    
      // Add onViewableListener as a listener for impressionViewable events.
      googletag.pubads().addEventListener("impressionViewable", onViewableListener);
      googletag.enableServices();
    });
    

    JavaScript(従来版)

    googletag.cmd.push(function () {
      // Define a new ad slot.
      googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());
    
      // Define a new function that removes itself via removeEventListener
      // after the impressionViewable event fires.
      var onViewableListener = function (event) {
        googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
        setTimeout(function () {
          googletag.pubads().refresh([event.slot]);
        }, 30000);
      };
    
      // Add onViewableListener as a listener for impressionViewable events.
      googletag.pubads().addEventListener("impressionViewable", onViewableListener);
      googletag.enableServices();
    });
    

    TypeScript

    googletag.cmd.push(() => {
      // Define a new ad slot.
      googletag
        .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")!
        .addService(googletag.pubads());
    
      // Define a new function that removes itself via removeEventListener
      // after the impressionViewable event fires.
      const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => {
        googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
        setTimeout(() => {
          googletag.pubads().refresh([event.slot]);
        }, 30000);
      };
    
      // Add onViewableListener as a listener for impressionViewable events.
      googletag.pubads().addEventListener("impressionViewable", onViewableListener);
      googletag.enableServices();
    });
    
    パラメータ
    eventType: KGPT によって生成されたイベントのタイプを表す文字列。イベントタイプでは大文字と小文字が区別されます。
    listener: ((event: EventTypeMap[K]) => void)単一のイベント オブジェクト引数を取る関数。


googletag.SizeMappingBuilder

サイズ マッピング仕様オブジェクトのビルダー。このビルダーは、サイズ仕様を簡単に作成できるように用意されています。
メソッド
addSize
単一サイズの配列(ビューポートを表す)から、スロットを表す単一サイズまたはマルチサイズの配列へのマッピングを追加します。
build
このビルダーに追加されたマッピングからサイズマップ仕様をビルドします。
関連情報

メソッド


addSize

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

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

    JavaScript

    // Mapping 1
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [728, 90])
      .addSize([640, 480], "fluid")
      .addSize([0, 0], [88, 31]) // All viewports &lt; 640x480
      .build();
    
    // Mapping 2
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [])
      .addSize([640, 480], [120, 60])
      .addSize([0, 0], [])
      .build();
    
    // Mapping 2 will not show any ads for the following viewport sizes:
    // [1024, 768] > size >= [980, 690] and
    // [640, 480] > size >= [0, 0]
    

    JavaScript(従来版)

    // Mapping 1
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [728, 90])
      .addSize([640, 480], "fluid")
      .addSize([0, 0], [88, 31]) // All viewports &lt; 640x480
      .build();
    
    // Mapping 2
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [])
      .addSize([640, 480], [120, 60])
      .addSize([0, 0], [])
      .build();
    
    // Mapping 2 will not show any ads for the following viewport sizes:
    // [1024, 768] > size >= [980, 690] and
    // [640, 480] > size >= [0, 0]
    

    TypeScript

    // Mapping 1
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [728, 90])
      .addSize([640, 480], "fluid")
      .addSize([0, 0], [88, 31]) // All viewports &lt; 640x480
      .build();
    
    // Mapping 2
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [])
      .addSize([640, 480], [120, 60])
      .addSize([0, 0], [])
      .build();
    
    // Mapping 2 will not show any ads for the following viewport sizes:
    // [1024, 768] > size >= [980, 690] and
    // [640, 480] > size >= [0, 0]
    
    パラメータ
    viewportSize: SingleSizeArrayこのマッピング エントリのビューポートのサイズ。
    slotSize: GeneralSizeこのマッピング エントリのスロットのサイズ。
    戻り値
    SizeMappingBuilderこのビルダーへの参照。


ビルド

    build(): null | SizeMappingArray

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

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

    注: このメソッドの呼び出し後のビルダーの動作は未定義です。

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


googletag.Slot

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

メソッド


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")
      .setCategoryExclusion("AirlineAd")
      .addService(googletag.pubads());
    
    // Make an ad request. No ad with 'AirlineAd' label will be returned
    // for the slot.
    
    // Clear category exclusions so all ads can be returned.
    slot.clearCategoryExclusions();
    
    // Make an ad request. Any ad can be returned for the slot.
    

    JavaScript(従来版)

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setCategoryExclusion("AirlineAd")
      .addService(googletag.pubads());
    
    // Make an ad request. No ad with 'AirlineAd' label will be returned
    // for the slot.
    
    // Clear category exclusions so all ads can be returned.
    slot.clearCategoryExclusions();
    
    // Make an ad request. Any ad can be returned for the slot.
    

    TypeScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setCategoryExclusion("AirlineAd")
      .addService(googletag.pubads());
    
    // Make an ad request. No ad with 'AirlineAd' label will be returned
    // for the slot.
    
    // Clear category exclusions so all ads can be returned.
    slot.clearCategoryExclusions();
    
    // Make an ad request. Any ad can be returned for the slot.
    
    戻り値
    Slotメソッドが呼び出されたスロット オブジェクト。


clearTargeting

    clearTargeting(key?: string): Slot

    このスロットの特定のカスタム スロットレベル ターゲティング パラメータまたはすべてのカスタム スロットレベル ターゲティング パラメータを消去します。

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .setTargeting("color", "red")
      .addService(googletag.pubads());
    
    slot.clearTargeting("color");
    // Targeting 'allow_expandable' and 'interests' are still present,
    // while 'color' was cleared.
    
    slot.clearTargeting();
    // All targeting has been cleared.
    

    JavaScript(従来版)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .setTargeting("color", "red")
      .addService(googletag.pubads());
    
    slot.clearTargeting("color");
    // Targeting 'allow_expandable' and 'interests' are still present,
    // while 'color' was cleared.
    
    slot.clearTargeting();
    // All targeting has been cleared.
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .setTargeting("color", "red")
      .addService(googletag.pubads());
    
    slot.clearTargeting("color");
    // Targeting 'allow_expandable' and 'interests' are still present,
    // while 'color' was cleared.
    
    slot.clearTargeting();
    // All targeting has been cleared.
    
    関連情報
    パラメータ
    Optional key: stringターゲティング パラメータキー。このキーは省略可能です。指定しない場合、すべてのターゲティング パラメータがクリアされます。
    戻り値
    Slotメソッドが呼び出されたスロット オブジェクト。


defineSizeMapping

    defineSizeMapping(sizeMapping: SizeMappingArray): Slot

    最小ビューポート サイズからこのスロットのスロットサイズへのマッピングの配列を設定します。

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .addService(googletag.pubads());
    
    const mapping = googletag
      .sizeMapping()
      .addSize([100, 100], [88, 31])
      .addSize(
        [320, 400],
        [
          [320, 50],
          [300, 50],
        ],
      )
      .build();
    
    slot.defineSizeMapping(mapping);
    

    JavaScript(従来版)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .addService(googletag.pubads());
    
    var mapping = googletag
      .sizeMapping()
      .addSize([100, 100], [88, 31])
      .addSize(
        [320, 400],
        [
          [320, 50],
          [300, 50],
        ],
      )
      .build();
    
    slot.defineSizeMapping(mapping);
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .addService(googletag.pubads());
    
    const mapping = googletag
      .sizeMapping()
      .addSize([100, 100], [88, 31])
      .addSize(
        [320, 400],
        [
          [320, 50],
          [300, 50],
        ],
      )
      .build();
    
    slot.defineSizeMapping(mapping!);
    
    関連情報
    パラメータ
    sizeMapping: SizeMappingArrayサイズ マッピングの配列。SizeMappingBuilder を使用して作成できます。各サイズ マッピングは、SingleSizeArrayGeneralSize の 2 つの要素の配列です。
    戻り値
    Slotメソッドが呼び出されたスロット オブジェクト。


get

    get(key: string): null | string

    このスロットの指定したキーに関連付けられた AdSense 属性の値を返します。このスロットに継承されたサービスレベルの属性を確認するには、PubAdsService.get を使用します。

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    
    slot.get("adsense_background_color");
    // Returns '#FFFFFF'.
    

    JavaScript(従来版)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    
    slot.get("adsense_background_color");
    // Returns '#FFFFFF'.
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    
    slot.get("adsense_background_color");
    // Returns '#FFFFFF'.
    
    関連情報
    パラメータ
    key: string検索する属性の名前。
    戻り値
    null | string属性キーの現在の値。キーが存在しない場合は null です。


getAdUnitPath

    getAdUnitPath(): string

    ネットワーク コードと広告ユニットパスを含む、広告ユニットのフルパスを返します。

    JavaScript

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

    JavaScript(従来版)

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

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .addService(googletag.pubads());
    
    slot.getAdUnitPath();
    // Returns '/1234567/sports'.
    
    戻り値
    string広告ユニットのパス。


getAttributeKeys

    getAttributeKeys(): string[]

    このスロットに設定されている属性キーのリストを返します。このスロットに継承されるサービスレベル属性のキーを確認するには、PubAdsService.getAttributeKeys を使用します。

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .set("adsense_border_color", "#AABBCC")
      .addService(googletag.pubads());
    
    slot.getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    

    JavaScript(従来版)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .set("adsense_border_color", "#AABBCC")
      .addService(googletag.pubads());
    
    slot.getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .set("adsense_background_color", "#FFFFFF")
      .set("adsense_border_color", "#AABBCC")
      .addService(googletag.pubads());
    
    slot.getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    
    戻り値
    string[]属性キーの配列。順序は未定義です。


getCategoryExclusions

    getCategoryExclusions(): string[]

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

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setCategoryExclusion("AirlineAd")
      .setCategoryExclusion("TrainAd")
      .addService(googletag.pubads());
    
    slot.getCategoryExclusions();
    // Returns ['AirlineAd', 'TrainAd'].
    

    JavaScript(従来版)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setCategoryExclusion("AirlineAd")
      .setCategoryExclusion("TrainAd")
      .addService(googletag.pubads());
    
    slot.getCategoryExclusions();
    // Returns ['AirlineAd', 'TrainAd'].
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setCategoryExclusion("AirlineAd")
      .setCategoryExclusion("TrainAd")
      .addService(googletag.pubads());
    
    slot.getCategoryExclusions();
    // Returns ['AirlineAd', 'TrainAd'].
    
    戻り値
    string[]このスロットの広告カテゴリ除外ラベル。何も設定されていない場合は空の配列。


getResponseInformation

    getResponseInformation(): null | ResponseInformation

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

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


getSlotElementId

    getSlotElementId(): string

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

    JavaScript

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

    JavaScript(従来版)

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

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .addService(googletag.pubads());
    
    slot.getSlotElementId();
    // Returns 'div'.
    
    戻り値
    stringスロット div ID。


getTargeting

    getTargeting(key: string): string[]

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

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .addService(googletag.pubads());
    
    slot.getTargeting("allow_expandable");
    // Returns ['true'].
    
    slot.getTargeting("age");
    // Returns [] (empty array).
    

    JavaScript(従来版)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .addService(googletag.pubads());
    
    slot.getTargeting("allow_expandable");
    // Returns ['true'].
    
    slot.getTargeting("age");
    // Returns [] (empty array).
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setTargeting("allow_expandable", "true")
      .addService(googletag.pubads());
    
    slot.getTargeting("allow_expandable");
    // Returns ['true'].
    
    slot.getTargeting("age");
    // Returns [] (empty array).
    
    パラメータ
    key: string検索するターゲティング キー。
    戻り値
    string[]このキーに関連付けられた値。そのようなキーがない場合、空の配列。


getTargetingKeys

    getTargetingKeys(): string[]

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

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .addService(googletag.pubads());
    
    slot.getTargetingKeys();
    // Returns ['interests', 'allow_expandable'].
    

    JavaScript(従来版)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .addService(googletag.pubads());
    
    slot.getTargetingKeys();
    // Returns ['interests', 'allow_expandable'].
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .addService(googletag.pubads());
    
    slot.getTargetingKeys();
    // Returns ['interests', 'allow_expandable'].
    
    戻り値
    string[]ターゲティング キーの配列。順序は未定義です。


set

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

    この広告スロットの AdSense 属性の値を設定します。これにより、このキーに対してサービスレベルで設定された値が上書きされます。

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

    JavaScript

    // Setting an attribute on a single ad slot.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    

    JavaScript(従来版)

    // Setting an attribute on a single ad slot.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    

    TypeScript

    // Setting an attribute on a single ad slot.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    
    関連情報
    パラメータ
    key: string属性名。
    value: string属性値。
    戻り値
    Slotメソッドが呼び出されたスロット オブジェクト。


setCategoryExclusion

    setCategoryExclusion(categoryExclusion: string): Slot

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

    JavaScript

    // Label = AirlineAd
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setCategoryExclusion("AirlineAd")
      .addService(googletag.pubads());
    

    JavaScript(従来版)

    // Label = AirlineAd
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setCategoryExclusion("AirlineAd")
      .addService(googletag.pubads());
    

    TypeScript

    // Label = AirlineAd
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setCategoryExclusion("AirlineAd")
      .addService(googletag.pubads());
    
    関連情報
    パラメータ
    categoryExclusion: string追加する広告カテゴリ除外ラベル。
    戻り値
    Slotメソッドが呼び出されたスロット オブジェクト。


setClickUrl

    setClickUrl(value: string): Slot

    広告をクリックした後にユーザーをリダイレクトするクリック URL を設定します。

    クリック URL が置き換えられても、Google アド マネージャーのサーバーではクリックが記録されます。配信されるクリエイティブに関連付けられたランディング ページ URL は、指定された値に追加されます。その後の呼び出しで値が上書きされます。これは SRA 以外のリクエストでのみ機能します。

    JavaScript

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

    JavaScript(従来版)

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

    TypeScript

    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setClickUrl("http://www.example.com?original_click_url=")
      .addService(googletag.pubads());
    
    パラメータ
    value: string設定するクリック URL。
    戻り値
    Slotメソッドが呼び出されたスロット オブジェクト。


setCollapseEmptyDiv

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

    スロットに広告がない場合、スロット div を非表示にするかどうかを設定します。これにより、サービスレベルの設定が上書きされます。

    JavaScript

    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setCollapseEmptyDiv(true, true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // when the page is loaded, before ads are requested.
    
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-2")
      .setCollapseEmptyDiv(true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // only after GPT detects that no ads are available for the slot.
    

    JavaScript(従来版)

    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setCollapseEmptyDiv(true, true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // when the page is loaded, before ads are requested.
    
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-2")
      .setCollapseEmptyDiv(true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // only after GPT detects that no ads are available for the slot.
    

    TypeScript

    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")!
      .setCollapseEmptyDiv(true, true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // when the page is loaded, before ads are requested.
    
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-2")!
      .setCollapseEmptyDiv(true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // only after GPT detects that no ads are available for the slot.
    
    関連情報
    パラメータ
    collapse: boolean広告が返されなかった場合にスロットを閉じるかどうか。
    Optional collapseBeforeAdFetch: boolean広告が取得される前でもスロットを閉じるかどうか。収縮が true でない場合は無視されます。
    戻り値
    Slotメソッドが呼び出されたスロット オブジェクト。


setConfig

    setConfig(slotConfig: SlotSettingsConfig): void

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

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


setForceSafeFrame

    setForceSafeFrame(forceSafeFrame: boolean): Slot

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

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

    • この設定は、それぞれのスロットに対して行われた後続の広告リクエストにのみ適用されます。
    • スロットレベルの設定が指定されている場合は、常にページレベルの設定がオーバーライドされます。
    • true に設定した場合(スロット単位またはページ単位)、Google アド マネージャーの UI で選択した内容に関係なく、広告は常に SafeFrame コンテナを使用してレンダリングされます。
    • ただし、false に設定するか、指定しない場合は、クリエイティブのタイプと Google アド マネージャーの管理画面で選択した内容に応じて、SafeFrame コンテナを使用して広告がレンダリングされます。
    • この API は、iframe から外部に移動しようとするクリエイティブや、パブリッシャーのページに直接レンダリングされることを前提とするクリエイティブの動作に影響する可能性があるため、慎重に使用してください。

    JavaScript

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

    JavaScript(従来版)

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

    TypeScript

    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setForceSafeFrame(true)
      .addService(googletag.pubads());
    
    関連情報
    パラメータ
    forceSafeFrame: booleantrue: このスロットのすべての広告を SafeFrame でレンダリングするように強制します。false: ページレベルの設定(存在する場合)をオプトアウトします。ページレベルで指定しない場合、この値を false に設定しても何も変更されません。
    戻り値
    Slotメソッドが呼び出されたスロット オブジェクト。


setSafeFrameConfig

    setSafeFrameConfig(config: null | SafeFrameConfig): Slot

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

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

    JavaScript

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will have a sandboxed safeframe that only
    // disallows top-level navigation.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setSafeFrameConfig({ sandbox: true })
      .addService(googletag.pubads());
    
    // The following slot will inherit page-level settings.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    JavaScript(従来版)

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will have a sandboxed safeframe that only
    // disallows top-level navigation.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setSafeFrameConfig({ sandbox: true })
      .addService(googletag.pubads());
    
    // The following slot will inherit page-level settings.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    TypeScript

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will have a sandboxed safeframe that only
    // disallows top-level navigation.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")!
      .setSafeFrameConfig({ sandbox: true })
      .addService(googletag.pubads());
    
    // The following slot will inherit page-level settings.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    
    関連情報
    パラメータ
    config: null | SafeFrameConfig構成オブジェクト。
    戻り値
    Slotメソッドが呼び出されたスロット オブジェクト。


setTargeting

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

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

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .addService(googletag.pubads());
    
    // Example with a single value for a key.
    slot.setTargeting("allow_expandable", "true");
    
    // Example with multiple values for a key inside in an array.
    slot.setTargeting("interests", ["sports", "music"]);
    

    JavaScript(従来版)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .addService(googletag.pubads());
    
    // Example with a single value for a key.
    slot.setTargeting("allow_expandable", "true");
    
    // Example with multiple values for a key inside in an array.
    slot.setTargeting("interests", ["sports", "music"]);
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .addService(googletag.pubads());
    
    // Example with a single value for a key.
    slot.setTargeting("allow_expandable", "true");
    
    // Example with multiple values for a key inside in an array.
    slot.setTargeting("interests", ["sports", "music"]);
    
    関連情報
    パラメータ
    key: stringターゲティング パラメータキー。
    value: string | string[]ターゲティング パラメータ値または値の配列。
    戻り値
    Slotメソッドが呼び出されたスロット オブジェクト。


updateTargetingFromMap

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

    JSON オブジェクトのキーと値のマップから、このスロットのカスタム ターゲティング パラメータを設定します。これは、オブジェクトのすべてのキー値に対して 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
広告の拡張を管理する設定。
ComponentAuctionConfig
オンデバイス広告オークション内の単一コンポーネント オークションを表すオブジェクト。
InterstitialConfig
1 つのインタースティシャル広告スロットの動作を定義するオブジェクト。
PageSettingsConfig
ページレベルの設定のメイン構成インターフェース。
PrivacyTreatmentsConfig
パブリッシャーのプライバシー処理を管理する設定。
PublisherProvidedSignalsConfig
パブリッシャー提供のシグナル(PPS)の設定オブジェクト。
SlotSettingsConfig
スロットレベルの設定用のメイン構成インターフェース。
TaxonomyData
単一の分類の値を含むオブジェクト。
型エイリアス
InterstitialTrigger
サポートされているインタースティシャル広告のトリガー。
PrivacyTreatment
サポートされているパブリッシャーのプライバシーに関する取り扱い。
Taxonomy
パブリッシャー提供のシグナル(PPS)でサポートされている分類。

型エイリアス


InterstitialTrigger

    InterstitialTrigger: "unhideWindow" | "navBar"

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


PrivacyTreatment

    PrivacyTreatment: "disablePersonalization"

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


分類


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 有効


googletag.config.ComponentAuctionConfig

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

プロパティ


auctionConfig

    auctionConfig: null | {
      auctionSignals?: unknown;
      decisionLogicUrl: string;
      interestGroupBuyers?: string[];
      perBuyerExperimentGroupIds?: {
        [buyer: string]: number;
      };
      perBuyerGroupLimits?: {
        [buyer: string]: number;
      };
      perBuyerSignals?: {
        [buyer: string]: unknown;
      };
      perBuyerTimeouts?: {
        [buyer: string]: number;
      };
      seller: string;
      sellerExperimentGroupId?: number;
      sellerSignals?: unknown;
      sellerTimeout?: number;
      trustedScoringSignalsUrl?: string;
    }

    このコンポーネント オークションのオークション構成オブジェクト。

    この値が null に設定されている場合、指定された configKey の既存の構成はすべて削除されます。

    JavaScript

    const componentAuctionConfig = {
      // Seller URL should be https and the same as decisionLogicUrl's origin
      seller: "https://testSeller.com",
      decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
      interestGroupBuyers: ["https://example-buyer.com"],
      auctionSignals: { auction_signals: "auction_signals" },
      sellerSignals: { seller_signals: "seller_signals" },
      perBuyerSignals: {
        // listed on interestGroupBuyers
        "https://example-buyer.com": {
          per_buyer_signals: "per_buyer_signals",
        },
      },
    };
    
    const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);
    
    // To add configKey to the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: componentAuctionConfig,
        },
      ],
    });
    
    // To remove configKey from the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: null,
        },
      ],
    });
    

    JavaScript(従来版)

    var componentAuctionConfig = {
      // Seller URL should be https and the same as decisionLogicUrl's origin
      seller: "https://testSeller.com",
      decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
      interestGroupBuyers: ["https://example-buyer.com"],
      auctionSignals: { auction_signals: "auction_signals" },
      sellerSignals: { seller_signals: "seller_signals" },
      perBuyerSignals: {
        // listed on interestGroupBuyers
        "https://example-buyer.com": {
          per_buyer_signals: "per_buyer_signals",
        },
      },
    };
    
    var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);
    
    // To add configKey to the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: componentAuctionConfig,
        },
      ],
    });
    
    // To remove configKey from the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: null,
        },
      ],
    });
    

    TypeScript

    const componentAuctionConfig = {
      // Seller URL should be https and the same as decisionLogicUrl's origin
      seller: "https://testSeller.com",
      decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
      interestGroupBuyers: ["https://example-buyer.com"],
      auctionSignals: { auction_signals: "auction_signals" },
      sellerSignals: { seller_signals: "seller_signals" },
      perBuyerSignals: {
        // listed on interestGroupBuyers
        "https://example-buyer.com": {
          per_buyer_signals: "per_buyer_signals",
        },
      },
    };
    
    const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!;
    
    // To add configKey to the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: componentAuctionConfig,
        },
      ],
    });
    
    // To remove configKey from the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: null,
        },
      ],
    });
    
    関連情報

configKey

    configKey: string

    このコンポーネント オークションに関連付けられた構成キー。

    この値は空でないこと、一意であることが必要です。2 つの ComponentAuctionConfig オブジェクトが同じ configKey 値を共有している場合、最後に設定された値が以前の設定を上書きします。


googletag.config.InterstitialConfig

1 つのインタースティシャル広告スロットの動作を定義するオブジェクト。
プロパティ
requireStorageAccess?
このインタースティシャル広告を表示するためにローカル ストレージへの同意が必要かどうか。
triggers?
このインタースティシャル広告のインタースティシャル トリガーの設定。

プロパティ


Optional requireStorageAccess

    requireStorageAccess?: null | 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?: null | Partial<Record<InterstitialTrigger, boolean>>

    このインタースティシャル広告のインタースティシャル トリガーの設定。

    インタースティシャル トリガーの値を true に設定すると有効になり、false に設定すると無効になります。これにより、Google アド マネージャーで設定されたデフォルト値がオーバーライドされます。

    JavaScript

    // Define a GPT managed web interstitial ad slot.
    const interstitialSlot = googletag.defineOutOfPageSlot(
      "/1234567/sports",
      googletag.enums.OutOfPageFormat.INTERSTITIAL,
    );
    
    // Enable optional interstitial triggers.
    // Change this value to false to disable.
    const enableTriggers = true;
    
    interstitialSlot.setConfig({
      interstitial: {
        triggers: {
          navBar: enableTriggers,
          unhideWindow: enableTriggers,
        },
      },
    });
    

    JavaScript(従来版)

    // Define a GPT managed web interstitial ad slot.
    var interstitialSlot = googletag.defineOutOfPageSlot(
      "/1234567/sports",
      googletag.enums.OutOfPageFormat.INTERSTITIAL,
    );
    
    // Enable optional interstitial triggers.
    // Change this value to false to disable.
    var enableTriggers = true;
    
    interstitialSlot.setConfig({
      interstitial: {
        triggers: {
          navBar: enableTriggers,
          unhideWindow: enableTriggers,
        },
      },
    });
    

    TypeScript

    // Define a GPT managed web interstitial ad slot.
    const interstitialSlot = googletag.defineOutOfPageSlot(
      "/1234567/sports",
      googletag.enums.OutOfPageFormat.INTERSTITIAL,
    )!;
    
    // Enable optional interstitial triggers.
    // Change this value to false to disable.
    const enableTriggers = true;
    
    interstitialSlot.setConfig({
      interstitial: {
        triggers: {
          navBar: enableTriggers,
          unhideWindow: enableTriggers,
        },
      },
    });
    
    関連情報

googletag.config.PageSettingsConfig

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

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

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

例:
  • 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?
広告の拡張を管理する設定。
adYield?
非推奨。 
pps?
パブリッシャー提供のシグナル(PPS)を制御する設定。
privacyTreatments?
パブリッシャーのプライバシー処理を管理する設定。
threadYield?
クリエイティブのレンダリング時に GPT が JS スレッドを降伏させるかどうかを制御する設定。

プロパティ


Optional adExpansion


Optional adYield

    adYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"


Optional pps


Optional privacyTreatments

    privacyTreatments?: null | PrivacyTreatmentsConfig

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


Optional threadYield

    threadYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"

    クリエイティブのレンダリング時に GPT が JS スレッドを譲渡するかどうかを制御する設定。

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

    サポートされる値:

    • null(デフォルト): GPT は、ビューポート外のスロットの JS スレッドを降伏します。
    • ENABLED_ALL_SLOTS: GPT は、スロットがビューポート内にあるかどうかにかかわらず、すべてのスロットの JS スレッドを降伏します。
    • DISABLED: GPT は JS スレッドを yield しません。

    JavaScript

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

    JavaScript(従来版)

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

    TypeScript

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

googletag.config.PrivacyTreatmentsConfig

パブリッシャーのプライバシー処理を管理する設定。
プロパティ
treatments
有効にするパブリッシャーのプライバシーに関する取り扱いの配列。

プロパティ


治療

    treatments: null | "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
分類のマッピングを含むオブジェクト。

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

プロパティ


分類


googletag.config.SlotSettingsConfig

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

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

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

例:
  • Slot.setConfig 呼び出しで指定された機能のみが変更されます。
      const slot = googletag.defineSlot("/1234567/example", [160, 600]);
    
      // Configure feature alpha.
      slot.setConfig({
          alpha: {...}
      });
    
      // Configure feature bravo. Feature alpha is unchanged.
      slot.setConfig({
         bravo: {...}
      });
    
  • 特定の機能のすべての設定は、Slot.setConfig が呼び出されるたびに更新されます。
      // Configure feature charlie to echo = 1, foxtrot = true.
      slot.setConfig({
          charlie: {
              echo: 1,
              foxtrot: true,
          }
      });
    
      // Update feature charlie to echo = 2. Since foxtrot was not specified,
      // the value is cleared.
      slot.setConfig({
          charlie: {
              echo: 2
          }
      });
    
  • null を渡すことで、特徴のすべての設定を消去できます。
      // Configure features delta, golf, and hotel.
      slot.setConfig({
          delta: {...},
          golf: {...},
          hotel: {...},
      });
    
      // Feature delta and hotel are cleared, but feature golf remains set.
      slot.setConfig({
          delta: null,
          hotel: null,
      });
    
プロパティ
adExpansion?
広告の拡張を管理する設定。
componentAuction?
オンデバイス広告オークションに含めるコンポーネント オークションの配列。
interstitial?
インタースティシャル広告スロットの動作を制御する設定。

プロパティ


Optional adExpansion


Optional componentAuction

    componentAuction?: null | ComponentAuctionConfig[]

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


Optional インタースティシャル

    interstitial?: null | InterstitialConfig

    インタースティシャル広告スロットの動作を制御する設定。


googletag.config.TaxonomyData

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

プロパティ


    values: string[]

    分類値のリスト。


googletag.enums

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

列挙型


OutOfPageFormat

    OutOfPageFormat

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

    関連情報
    列挙型のメンバー
    BOTTOM_ANCHOR
    スロットがビューポートの下部に固定されるアンカー フォーマット。
    GAME_MANUAL_INTERSTITIAL
    ゲーム マニュアル インタースティシャル フォーマット。

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

TrafficSource

    TrafficSource

    GPT でサポートされているトラフィック ソース

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

googletag.events

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

googletag.events.Event

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

プロパティ


serviceName

    serviceName: string

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


スロット

    slot: Slot

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


googletag.events.EventTypeMap

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

プロパティ


gameManualInterstitialSlotClosed


gameManualInterstitialSlotReady


impressionViewable


rewardedSlotClosed


rewardedSlotGranted


rewardedSlotReady


slotOnload


slotRenderEnded


slotRequested


slotResponseReceived


slotVisibilityChanged


googletag.events.GameManualInterstitialSlotClosedEvent

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

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

JavaScript

// This listener is called when a game manual interstial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

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

JavaScript(従来版)

// This listener is called when a game manual interstial slot is closed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) {
  var slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

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

TypeScript

// This listener is called when a game manual interstial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

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

googletag.events.GameManualInterstitialSlotReadyEvent

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

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

JavaScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
  const slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

JavaScript(従来版)

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) {
  var slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

TypeScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
  const slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

メソッド


makeGameManualInterstitialVisible

    makeGameManualInterstitialVisible(): void

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


googletag.events.ImpressionViewableEvent

Event を拡張
このイベントは、アクティブ ビューの基準に従ってインプレッションが視認可能になったときにトリガーされます。
プロパティ
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。

JavaScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

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

JavaScript(従来版)

// This listener is called when an impression becomes viewable.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", function (event) {
  var slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

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

TypeScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

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

googletag.events.RewardedSlotClosedEvent

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

JavaScript

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

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

JavaScript(従来版)

// This listener is called when the user closes a rewarded ad slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

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

TypeScript

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

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

googletag.events.RewardedSlotGrantedEvent

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

JavaScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
  const slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", event.payload?.type);
  console.log("Reward amount:", event.payload?.amount);
  console.groupEnd();

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

JavaScript(従来版)

// This listener is called whenever a reward is granted for a
// rewarded ad.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", function (event) {
  var _a, _b;
  var slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type);
  console.log(
    "Reward amount:",
    (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount,
  );
  console.groupEnd();

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

TypeScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
  const slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", event.payload?.type);
  console.log("Reward amount:", event.payload?.amount);
  console.groupEnd();

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

プロパティ


ペイロード

    payload: null | RewardedPayload

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


googletag.events.RewardedSlotReadyEvent

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

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

JavaScript(従来版)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

メソッド


makeRewardedVisible

    makeRewardedVisible(): void

    リワード広告を表示します。このメソッドは、ユーザーが広告の表示に同意するまで呼び出すべきではありません。


googletag.events.SlotOnloadEvent

Event を拡張
このイベントは、クリエイティブの iframe が読み込みイベントを発生させたときに発生します。同期レンダリング モードでリッチメディア広告をレンダリングする場合、iframe は使用されないため、SlotOnloadEvent は配信されません。
プロパティ
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。

JavaScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

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

JavaScript(従来版)

// This listener is called when a creative iframe load event fires.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  var slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

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

TypeScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

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

googletag.events.SlotRenderEndedEvent

Event を拡張
このイベントは、クリエイティブ コードがスロットに挿入されたときに発生します。このイベントはクリエイティブのリソースが取得される前に発生するため、クリエイティブはまだ表示されていない場合があります。スロットのすべてのクリエイティブ リソースの読み込みが完了したタイミングを知る必要がある場合は、代わりに events.SlotOnloadEvent を検討してください。
プロパティ
advertiserId
レンダリングされた広告の広告主 ID。
campaignId
レンダリングされた広告のキャンペーン ID。
companyIds
レンダリングされたバックフィル広告に入札した企業の ID。
creativeId
レンダリングされた予約広告のクリエイティブ ID。
creativeTemplateId
レンダリングされた予約広告のクリエイティブ テンプレート ID。
isBackfill
広告がバックフィル広告かどうか。
isEmpty
スロットに対して広告が返されたかどうか。
labelIds
非推奨。 
lineItemId
レンダリングされた予約広告の広告申込情報 ID。
serviceName
イベントをトリガーしたサービスの名前。
size
レンダリングされたクリエイティブのピクセルサイズを示します。
slot
イベントをトリガーしたスロット。
slotContentChanged
レンダリングされた広告でスロット コンテンツが変更されたかどうか。
sourceAgnosticCreativeId
レンダリングされた予約広告またはバックフィル広告のクリエイティブ ID。
sourceAgnosticLineItemId
レンダリングされた予約広告またはバックフィル広告の広告申込情報 ID。
yieldGroupIds
レンダリングされたバックフィル広告の収益グループの ID。

JavaScript

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

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

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

JavaScript(従来版)

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

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

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

TypeScript

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

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

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

プロパティ


advertiserId

    advertiserId: null | number

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


campaignId

    campaignId: null | number

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


companyIds

    companyIds: null | number[]

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


creativeId

    creativeId: null | number

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


creativeTemplateId

    creativeTemplateId: null | number

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


isBackfill

    isBackfill: boolean

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


isEmpty

    isEmpty: boolean

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


labelIds

    labelIds: null | number[]


lineItemId

    lineItemId: null | number

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


サイズ

    size: null | string | number[]

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


slotContentChanged

    slotContentChanged: boolean

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


sourceAgnosticCreativeId

    sourceAgnosticCreativeId: null | number

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


sourceAgnosticLineItemId

    sourceAgnosticLineItemId: null | number

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


yieldGroupIds

    yieldGroupIds: null | number[]

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


googletag.events.SlotRequestedEvent

Event を拡張
このイベントは、特定のスロットに対して広告がリクエストされたときに発生します。
プロパティ
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。

JavaScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

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

JavaScript(従来版)

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", function (event) {
  var slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

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

TypeScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

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

googletag.events.SlotResponseReceived

Event を拡張
このイベントは、特定のスロットに対して広告レスポンスが受信されたときに発生します。
プロパティ
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。

JavaScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

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

JavaScript(従来版)

// This listener is called when an ad response has been received
// for a slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", function (event) {
  var slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

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

TypeScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

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

googletag.events.SlotVisibilityChangedEvent

Event を拡張
このイベントは、広告スロットの画面上の領域の割合が変更されるたびに発生します。このイベントはスロットリングされ、200 ミリ秒ごとに 1 回しか発生しません。
プロパティ
inViewPercentage
広告の表示領域の割合(%)。
serviceName
イベントをトリガーしたサービスの名前。
slot
イベントをトリガーしたスロット。

JavaScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

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

JavaScript(従来版)

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", function (event) {
  var slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", "".concat(event.inViewPercentage, "%"));
  console.groupEnd();

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

TypeScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

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

プロパティ


inViewPercentage

    inViewPercentage: number

    広告の表示領域の割合(%)。値は 0 ~ 100 の数値です。


googletag.secureSignals

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

型エイリアス


SecureSignalProvider

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


googletag.secureSignals.BidderSignalProvider

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

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

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

JavaScript

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

JavaScript(従来版)

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

TypeScript

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

プロパティ


collectorFunction

    collectorFunction: (() => Promise<string>)

    安全なシグナルに解決される Promise を返す関数。


id

    id: string

    Google アド マネージャーに登録されている、このセキュア シグナルに関連付けられたコレクタの一意の識別子。


googletag.secureSignals.PublisherSignalProvider

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

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

  1. セキュア シグナルに解決される Promise を返すコレクタ関数。
  2. シグナルに関連付けられているパブリッシャーを識別する networkCode
ビッダーのセキュア シグナルを返すには、代わりに secureSignals.BidderSignalProvider を使用してください。
プロパティ
collectorFunction
安全なシグナルに解決される Promise を返す関数。
networkCode
このセキュア シグナルに関連付けられているパブリッシャーのネットワーク コード(広告ユニットパスに表示されるコード)。

JavaScript

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

JavaScript(従来版)

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

TypeScript

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

プロパティ


collectorFunction

    collectorFunction: (() => Promise<string>)

    安全なシグナルに解決される Promise を返す関数。


networkCode

    networkCode: string

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


googletag.secureSignals.SecureSignalProvidersArray

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

メソッド


clearAllCache

    clearAllCache(): void

    すべてのコレクタのシグナルをキャッシュから消去します。

    このメソッドを呼び出すと、現在のページビューやそれ以降のページビューの広告リクエストにシグナルが含まれる可能性が低下する可能性があります。そのため、このメソッドは、新しいユーザーを示すイベント(ログイン、ログアウト、登録など)など、有意な状態変化が発生した場合にのみ呼び出す必要があります。


push