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

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

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

例

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript（従来版）

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

ページを子供向けコンテンツとして扱うかどうかを示します。構成を消去するには、null に設定します。

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

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

• IAB TCF v2.0 同意管理プラットフォームからのシグナルを使用して、自動的に送信されます。
• 手動で。このフィールドの値を true に設定します。

例

JavaScript

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

JavaScript（従来版）

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

TypeScript

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

関連情報

• 制限付きの広告を表示する

パブリッシャー様の規制遵守のニーズに対応できるよう、非パーソナライズド広告モードでの配信を有効にします。

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

リクエストが購入トラフィックまたはオーガニック トラフィックのどちらを示しているかを示します。この値は、アド マネージャーのレポートの [トラフィック ソース] ディメンションに入力されます。設定されていない場合、レポートではトラフィック ソースがデフォルトで 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,
});

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

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

具体的には、スロットをクリアすると、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();

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

例

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.

関連情報

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

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

例

JavaScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

JavaScript（従来版）

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

関連情報

• Key-Value ターゲティング

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

関連情報

• 空の広告スロットを閉じる
• レイアウト シフトを最小限に抑える

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

関連情報

• 広告の読み込みと更新を管理する
• SRA のバッチ処理を制御する

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

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

例

JavaScript

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

JavaScript（従来版）

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

TypeScript

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

関連情報

• テスト広告を表示する
• 広告の読み込みと更新を管理する

構成オブジェクトで定義されているように、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,
});

関連情報

• 広告のベスト プラクティス: 「重要な」広告スロットに優先順位を付ける
• 遅延読み込み

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

関連情報

• 広告のベスト プラクティス: シングル リクエスト アーキテクチャを正しく使用する
• SRA のバッチ処理を制御する

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

指定したキーに関連付けられた 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'.

関連情報

• AdSense 属性

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

例

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'].

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

例

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

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

例

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'].

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

ページ上の特定またはすべてのスロットの新しい広告を取得して表示します。非同期レンダリング モードでのみ機能します。

すべてのブラウザで適切に動作するには、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 });

関連情報

• 広告の読み込みと更新を管理する
• 広告スロットを更新する

パブリッシャー広告サービス内のすべての広告スロットに適用される 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");

関連情報

• AdSense 属性

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

例

JavaScript

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

JavaScript（従来版）

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

TypeScript

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

関連情報

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

広告の水平方向の中央揃えを有効または無効にします。中央揃えはデフォルトで無効になっています。従来の 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);

ページ上のすべての広告を 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");

関連情報

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

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

例

JavaScript

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

JavaScript（従来版）

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

TypeScript

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

構成オブジェクトを使用して、単一の 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,
});

関連情報

• プライバシー設定を構成する
• 制限付き広告を表示する

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

例

JavaScript

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

JavaScript（従来版）

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

TypeScript

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

関連情報

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

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

関連情報

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

特定のキーのカスタム ターゲティング パラメータを設定し、パブリッシャー広告サービスのすべての広告スロットに適用します。同じキーに対してこの関数を複数回呼び出すと、古い値が上書きされます。これらのキーは 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-Value ターゲティング

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

関連情報

• VAST 広告タグ URL パラメータ

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

広告主の ID。

キャンペーンの ID です。

クリエイティブの ID。

広告のテンプレート ID。

広告申込情報の ID。

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

リワードに含まれるアイテムの種類（「コイン」など）。

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

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

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

純広告のクリエイティブに対して、SafeFrame でランダムなサブドメインを使用するかどうかを指定します。null を渡して、保存された値を消去します。

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

関連情報

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

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

• events.GameManualInterstitialSlotClosedEvent
• events.GameManualInterstitialSlotReadyEvent
• events.ImpressionViewableEvent
• events.RewardedSlotClosedEvent
• events.RewardedSlotGrantedEvent
• events.RewardedSlotReadyEvent
• events.SlotOnloadEvent
• events.SlotRenderEndedEvent
• events.SlotRequestedEvent
• events.SlotResponseReceived
• events.SlotVisibilityChangedEvent

例

JavaScript

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

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

JavaScript（従来版）

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", function (event) {
  console.log("Slot has been loaded:");
  console.log(event);
});

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

TypeScript

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

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

関連情報

• 広告イベント リスナー

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