В этом справочнике для описания типов используется нотация TypeScript. В следующей таблице представлено краткое объяснение на примере.
Введите выражение | |
---|---|
string | Примитивный строковый тип. |
string[] | Тип массива, значения которого могут быть только строками. |
number | string | Тип объединения, где значение может быть числом или строкой. |
Array<number | string> | Тип массива, где значения представляют собой комплексный тип (объединение). |
[number, string] | Тип кортежа, где значением является массив из двух элементов, который должен содержать число и строку в указанном порядке. |
Slot | Тип объекта, значением которого является экземпляр googletag.Slot . |
() => void | Тип функции без определенных аргументов и возвращаемого значения. |
Чтобы узнать больше о поддерживаемых типах и выражениях типов, обратитесь к TypeScript Handbook .
Введите аннотации
Двоеточие после переменной, имени параметра, имени свойства или сигнатуры функции обозначает аннотацию типа. Аннотации типов описывают типы, которые может принимать или возвращать элемент слева от двоеточия. В следующей таблице показаны примеры аннотаций типов, которые вы можете увидеть в этом справочнике.
Введите аннотацию | |
---|---|
param: string | Указывает, что param принимает или возвращает строковое значение. Этот синтаксис используется для переменных, параметров, свойств и возвращаемых типов. |
param?: number | string | Указывает, что param не является обязательным, но принимает либо число, либо строку, если он указан. Этот синтаксис используется для параметров и свойств. |
...params: Array<() => void> | Указывает, что params — это оставшийся параметр , который принимает функции. Остальные параметры принимают неограниченное количество значений указанного типа. |
Googleтег
Пространства имен | |
---|---|
config | Основной интерфейс конфигурации для настроек на уровне страницы. |
enums | Это пространство имен, которое GPT использует для типов перечислений. |
events | Это пространство имен, которое GPT использует для событий. |
secure Signals | Это пространство имен, которое GPT использует для управления безопасными сигналами. |
Интерфейсы | |
---|---|
Command Array | Массив команд принимает последовательность функций и вызывает их по порядку. |
Companion Ads Service | Сервис сопутствующих объявлений. |
Privacy Settings Config | Объект конфигурации для настроек конфиденциальности. |
Pub Ads Service | Сервис объявлений для издателей. |
Response Information | Объект, представляющий один ответ на объявление. |
Rewarded Payload | Объект, представляющий вознаграждение, связанное с объявлением с вознаграждением . |
Safe Frame Config | Объект конфигурации для контейнеров SafeFrame . |
Service | Базовый класс службы, содержащий методы, общие для всех служб. |
Size Mapping Builder | Построитель объектов спецификации сопоставления размеров. |
Slot | Slot – это объект, представляющий одно рекламное место на странице. |
Введите псевдонимы | |
---|---|
General Size | Допустимая конфигурация размера для слота, которая может иметь один или несколько размеров. |
Multi Size | Список отдельных допустимых размеров. |
Named Size | Именованные размеры, которые может иметь слот. |
Single Size | Единственный допустимый размер для слота. |
Single Size Array | Массив из двух чисел, представляющих [ширину, высоту]. |
Size Mapping | Сопоставление размера области просмотра с размерами объявлений. |
Size Mapping Array | Список сопоставлений размеров. |
Переменные | |
---|---|
api Ready | Флаг, указывающий, что API GPT загружен и готов к вызову. |
cmd | Ссылка на глобальную очередь команд для асинхронного выполнения вызовов, связанных с GPT. |
pubads Ready | Флаг, указывающий, что PubAdsService включен, загружен и полностью работоспособен. |
secure Signal Providers | Ссылка на массив поставщиков защищенных сигналов. |
Функции | |
---|---|
companion Ads | Возвращает ссылку на CompanionAdsService . |
define Out Of Page Slot | Создает внестраничное рекламное место с заданным путем к рекламному блоку. |
define Slot | Создает рекламное место с заданным путем и размером рекламного блока и связывает его с идентификатором элемента div на странице, которая будет содержать объявление. |
destroy Slots | Уничтожает заданные слоты, удаляя все связанные объекты и ссылки на эти слоты из GPT. |
disable Publisher Console | Отключает консоль издателя Google. |
display | Указывает службам слотов отображать слот. |
enable Services | Включает все службы GPT, определенные для рекламных мест на странице. |
get Version | Возвращает текущую версию GPT. |
open Console | Открывает консоль издателя Google. |
pubads | Возвращает ссылку на PubAdsService . |
set Ad Iframe Title | Устанавливает заголовок для всех iframe рекламных контейнеров, созданных PubAdsService , начиная с этого момента. |
set Config | Устанавливает общие параметры конфигурации страницы. |
size Mapping | Создает новый SizeMappingBuilder . |
Введите псевдонимы
ОбщийРазмер
GeneralSize : SingleSize | MultiSize
Допустимая конфигурация размера для слота, которая может иметь один или несколько размеров.
Мультиразмер
MultiSize : SingleSize []
Список одиночных допустимых размеров.
именованный размер
- Liquid : рекламный контейнер занимает 100 % ширины родительского элемента div, а затем изменяет его высоту в соответствии с креативным контентом. Аналогично тому, как ведут себя обычные блочные элементы на странице. Используется для нативной рекламы (см. соответствующую статью ). Обратите внимание, что и
fluid
, и['fluid']
являются приемлемыми формами для объявления размера слота как изменяющегося.
NamedSize : "fluid" | [ "fluid" ]
Именованные размеры, которые может иметь слот. В большинстве случаев размер представляет собой прямоугольник фиксированного размера, но в некоторых случаях нам нужны другие виды спецификаций размера. Допустимыми именованными размерами являются только следующие:
Один размер
SingleSize : SingleSizeArray | NamedSize
Единственный допустимый размер для слота.
SingleSizeArray
SingleSizeArray : [ number , number ]
Массив из двух чисел, представляющих [ширину, высоту].
Сопоставление размеров
SizeMapping : [ SingleSizeArray , GeneralSize ]
Сопоставление размера области просмотра с размерами объявлений. Используется для адаптивных объявлений.
РазмерСопоставлениеМассив
SizeMappingArray : SizeMapping []
Список сопоставлений размеров.
Переменные
Const
APIReady
apiReady : boolean | undefined
Флаг, указывающий, что API GPT загружен и готов к вызову. Это свойство будет просто undefined
, пока API не будет готов.
Обратите внимание, что рекомендуемый способ обработки асинхронности — использовать googletag.cmd для постановки в очередь обратных вызовов, когда GPT будет готов. Эти обратные вызовы не должны проверять googletag.apiReady, поскольку они гарантированно выполняются после настройки API.
Const
команда
- Пример
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()); });
Машинопись
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
cmd : ( ( this : typeof globalThis ) => void ) [] | CommandArray
Ссылка на глобальную очередь команд для асинхронного выполнения вызовов, связанных с GPT.
Переменная googletag.cmd
инициализируется пустым массивом JavaScript с помощью синтаксиса тега GPT на странице, а cmd.push
— это стандартный метод Array.push
, который добавляет элемент в конец массива. Когда GPT JavaScript загружается, он просматривает массив и выполняет все функции по порядку. Затем сценарий заменяет cmd
объектом CommandArray , метод push которого определен для выполнения переданного ему аргумента функции. Этот механизм позволяет GPT сократить воспринимаемую задержку за счет асинхронной выборки JavaScript, позволяя браузеру продолжать обработку страницы.
Const
pubadsГотово
pubadsReady : boolean | undefined
Флаг, указывающий, что PubAdsService включен, загружен и полностью работоспособен. Это свойство будет просто undefined
до тех пор, пока не будет вызвана функция EnableServices и не будет загружен и инициализирован PubAdsService .
SecureSignalProviders
- Пример
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"); }, });
Машинопись
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
secureSignalProviders : SecureSignalProvider [] | SecureSignalProvidersArray | undefined
Ссылка на массив поставщиков защищенных сигналов.
Массив поставщиков безопасных сигналов принимает последовательность функций, генерирующих сигналы, и вызывает их по порядку. Он предназначен для замены стандартного массива, который используется для постановки в очередь функций, генерирующих сигналы, которые будут вызываться после загрузки GPT.
Функции
сопутствующие объявления
companionAds ( ) : CompanionAdsService
Возвращает ссылку на CompanionAdsService .
Возврат | |
---|---|
CompanionAdsService | Служба сопутствующих объявлений. |
определитьOutOfPageSlot
- Пример
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);
Машинопись
// 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);
- См. также
defineOutOfPageSlot ( adUnitPath : string , div ?: string | OutOfPageFormat ) : Slot | null
Создает внестраничное рекламное место с заданным путем к рекламному блоку.
Для пользовательских внестраничных объявлений div
— это идентификатор элемента div, который будет содержать объявление. Более подробную информацию можно найти в статье о внестраничных креативах .
Для внестраничных объявлений, управляемых GPT, div
– это поддерживаемый формат OutOfPageFormat .
Параметры | |
---|---|
adUnitPath : string | Полный путь к рекламному блоку с кодом сети и кодом рекламного блока. |
| Идентификатор div, который будет содержать этот рекламный блок или OutOfPageFormat. |
Возврат | |
---|---|
Slot | null | Вновь созданный слот или null , если слот невозможно создать. |
определить слот
- Пример
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (устаревший)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
Машинопись
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- См. также
defineSlot ( adUnitPath : string , size : GeneralSize , div ?: string ) : Slot | null
Создает рекламное место с заданным путем и размером рекламного блока и связывает его с идентификатором элемента div на странице, которая будет содержать объявление.
Параметры | |
---|---|
adUnitPath : string | Полный путь рекламного блока с кодом сети и кодом объекта. |
size : GeneralSize | Ширина и высота добавляемого слота. Это размер, который используется в запросе объявления, если не указано адаптивное сопоставление размеров или размер области просмотра меньше наименьшего размера, указанного в сопоставлении. |
| Идентификатор div, который будет содержать этот рекламный блок. |
Возврат | |
---|---|
Slot | null | Вновь созданный слот или null , если слот невозможно создать. |
уничтожитьСлоты
- Пример
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();
Машинопись
// 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();
destroySlots ( slots ?: Slot [] ) : boolean
Уничтожает заданные слоты, удаляя все связанные объекты и ссылки на эти слоты из GPT. Этот API не поддерживает слоты возврата и сопутствующие рекламные места.
Вызов этого API для рекламного места очищает объявление и удаляет объект рекламного места из внутреннего состояния, поддерживаемого GPT. Вызов дополнительных функций для объекта слота приведет к неопределенному поведению. Обратите внимание, что браузер может по-прежнему не освобождать память, связанную с этим слотом, если ссылка на него поддерживается страницей издателя. Вызов этого API делает элемент div, связанный с этим слотом, доступным для повторного использования.
В частности, удаление рекламного места удаляет объявление из списка долгосрочных просмотров страниц GPT, поэтому на будущие запросы не будут влиять препятствия или конкурентные исключения, связанные с этим объявлением. Если вы не вызовете эту функцию перед удалением элемента div со страницы, это приведет к неопределенному поведению.
Параметры | |
---|---|
| Массив слотов для уничтожения. Массив не является обязательным; все слоты будут уничтожены, если он не указан. |
Возврат | |
---|---|
boolean | true если слоты были уничтожены, в противном случае — false . |
отключитьPublisherConsole
отображать
- См. также
display ( divOrSlot : string | Element | Slot ) : void
Указывает службам слотов отображать слот. Каждое рекламное место должно отображаться только один раз на странице. Перед отображением все слоты должны быть определены и иметь связанную с ними службу. Вызов отображения не должен происходить до тех пор, пока элемент не появится в DOM. Обычный способ добиться этого — поместить его в блок сценария внутри элемента div, указанного в вызове метода.
Если используется архитектура единого запроса (SRA), все невыбранные рекламные места на момент вызова этого метода будут выбраны одновременно. Чтобы рекламное место не отображалось, необходимо удалить весь элемент div.
Параметры | |
---|---|
divOrSlot : string | Element | Slot | Либо идентификатор элемента div, содержащего рекламное место, либо элемент div, либо объект рекламного места. Если указан элемент div, он должен иметь атрибут «id», который соответствует идентификатору, переданному в defineSlot . |
EnableServices
получить версию
openConsole
- Пример
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();
Машинопись
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- См. также
openConsole ( div ?: string ) : void
Открывает консоль издателя Google.
Параметры | |
---|---|
| Идентификатор div рекламного места. Это значение является необязательным. Если это предусмотрено, консоль издателя попытается открыться с подробной информацией об указанном рекламном месте. |
пабады
pubads ( ) : PubAdsService
Возвращает ссылку на PubAdsService .
Возврат | |
---|---|
PubAdsService | Служба рекламы для издателей. |
setAdIframeTitle
- Пример
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (устаревший)
googletag.setAdIframeTitle("title");
Машинопись
googletag.setAdIframeTitle("title");
setAdIframeTitle ( title : string ) : void
Устанавливает заголовок для всех iframe рекламных контейнеров, созданных PubAdsService , начиная с этого момента.
Параметры | |
---|---|
title : string | Новый заголовок для всех iframe рекламных контейнеров. |
setConfig
setConfig ( config : PageSettingsConfig ) : void
Устанавливает общие параметры конфигурации страницы.
Параметры | |
---|---|
config : PageSettingsConfig |
Сопоставление размеров
sizeMapping ( ) : SizeMappingBuilder
Создает новый SizeMappingBuilder .
Возврат | |
---|---|
SizeMappingBuilder | Новый застройщик. |
googletag.CommandArray
Методы | |
---|---|
push | Выполняет последовательность функций, указанных в аргументах, по порядку. |
Методы
толкать
- Пример
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()); });
Машинопись
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
push ( ... f : ( ( this : typeof globalThis ) => void ) [] ) : number
Выполняет последовательность функций, указанных в аргументах, по порядку.
Параметры | |
---|---|
| Функция JavaScript, которую необходимо выполнить. Привязка времени выполнения всегда будет globalThis . Рассмотрите возможность передачи стрелочной функции, чтобы сохранить значение this включающего лексического контекста. |
Возврат | |
---|---|
number | Количество команд, обработанных на данный момент. Это совместимо с возвращаемым значением Array.push (текущая длина массива). |
googletag.CompanionAdsService
Продлевает срокМетоды | |
---|---|
add Event Listener | Регистрирует прослушиватель, который позволяет вам настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. Унаследовано от |
get Slots | Получите список слотов, связанных с этим сервисом. Унаследовано от |
remove Event Listener | Удаляет ранее зарегистрированный прослушиватель. Унаследовано от |
set Refresh Unfilled Slots | Определяет, будут ли незаполненные места для сопутствующих товаров заполняться автоматически. |
Методы
setRefreshUnfilledSlots
- Пример
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (устаревший)
googletag.companionAds().setRefreshUnfilledSlots(true);
Машинопись
googletag.companionAds().setRefreshUnfilledSlots(true);
setRefreshUnfilledSlots ( value : boolean ) : void
Определяет, будут ли незаполненные места для сопутствующих товаров заполняться автоматически.
Этот метод можно вызывать несколько раз в течение жизни страницы, чтобы включать и отключать обратное заполнение. Будут заполнены только те рекламные места, которые также зарегистрированы в PubAdsService . Из-за ограничений политики этот метод не предназначен для заполнения пустых рекламных мест при показе видео Ad Exchange.
Параметры | |
---|---|
value : boolean | true для автоматического заполнения незаполненных слотов и false для того, чтобы оставить их без изменений. |
googletag.PrivacySettingsConfig
Характеристики | |
---|---|
child Directed Treatment ? | Указывает, следует ли рассматривать страницу как предназначенную для детей . |
limited Ads ? | Позволяет показывать рекламу в режиме ограниченного количества объявлений , что помогает издателям соблюдать нормативные требования. |
non Personalized Ads ? | Позволяет показывать рекламу в режиме неперсонализированной рекламы, что помогает издателям соблюдать нормативные требования. |
restrict Data Processing ? | Позволяет выполнять обслуживание в ограниченном режиме обработки , что помогает издателям соблюдать нормативные требования. |
traffic Source ? | Указывает, представляют ли запросы купленный или органический трафик. |
under Age Of Consent ? | Указывает, следует ли отмечать запросы объявлений как поступающие от пользователей, не достигших возраста согласия . |
- См. также
Характеристики
Optional
childDirectedTreatment
childDirectedTreatment ?: null | boolean
Указывает, следует ли рассматривать страницу как предназначенную для детей . Установите значение null
, чтобы очистить конфигурацию.
Optional
ограничение рекламы
- Автоматически, используя сигнал платформы управления согласием 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, });
Машинопись
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- См. также
limitedAds ?: boolean
Позволяет показывать рекламу в режиме ограниченного количества объявлений , что помогает издателям соблюдать нормативные требования.
Вы можете поручить GPT запрашивать ограниченную рекламу двумя способами:
Обратите внимание: при использовании CMP нет необходимости вручную включать ограниченную рекламу.
Optional
неперсонализированная реклама
nonPersonalizedAds ?: boolean
Позволяет показывать рекламу в режиме неперсонализированной рекламы, что помогает издателям соблюдать нормативные требования.
Optional
ограничение обработки данных
restrictDataProcessing ?: boolean
Позволяет выполнять обслуживание в ограниченном режиме обработки , что помогает издателям соблюдать нормативные требования.
Optional
источник трафика
- Пример
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, });
Машинопись
// 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, });
trafficSource ?: TrafficSource
Указывает, представляют ли запросы купленный или органический трафик. Это значение заполняет параметр «Источник трафика» в отчетах Менеджера рекламы. Если этот параметр не установлен, источник трафика по умолчанию undefined
в отчетах.
Optional
underAgeOfConsent ?: null | boolean
Указывает, следует ли отмечать запросы объявлений как поступающие от пользователей, не достигших возраста согласия . Установите значение null
, чтобы очистить конфигурацию.
googletag.PubAdsService
Продлевает срокМетоды | |
---|---|
add Event Listener | Регистрирует прослушиватель, который позволяет вам настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. Унаследовано от |
clear | Удаляет рекламу из заданных слотов и заменяет их пустым контентом. |
clear Category Exclusions | Удаляет все метки исключения категорий объявлений на уровне страницы. |
clear Targeting | Очищает параметры специального таргетинга для определенного ключа или для всех ключей. |
collapse Empty Divs | Включает свертывание блоков div, чтобы они не занимали места на странице, когда нет рекламного контента для отображения. |
disable Initial Load | Отключает запросы рекламы при загрузке страницы, но позволяет запрашивать рекламу с помощью вызова PubAdsService.refresh . |
display | Создает и отображает рекламное место с заданным путем и размером рекламного блока. |
enable Lazy Load | Включает отложенную загрузку в GPT, как определено объектом конфигурации. |
enable Single Request | Включает режим единого запроса для одновременного получения нескольких объявлений. |
enable Video Ads | Сигнализирует GPT о том, что на странице будет присутствовать видеореклама. |
get | Возвращает значение атрибута AdSense, связанного с данным ключом. |
get Attribute Keys | Возвращает ключи атрибутов, которые были установлены для этой службы. |
get Slots | Получите список слотов, связанных с этим сервисом. Унаследовано от |
get Targeting | Возвращает определенный заданный параметр таргетинга на уровне обслуживания. |
get Targeting Keys | Возвращает список всех установленных ключей таргетинга настраиваемого уровня обслуживания. |
is Initial Load Disabled | Возвращает, были ли первоначальные запросы объявлений успешно отключены предыдущим вызовом PubAdsService.disableInitialLoad . |
refresh | Получает и отображает новые объявления для определенных или всех рекламных мест на странице. |
remove Event Listener | Удаляет ранее зарегистрированный прослушиватель. Унаследовано от |
set | Устанавливает значения атрибутов AdSense, которые применяются ко всем рекламным местам в рамках службы "Реклама издателя". |
set Category Exclusion | Устанавливает исключение категории объявлений на уровне страницы для данного названия ярлыка. |
set Centering | Включает и отключает горизонтальное центрирование объявлений. |
set Force Safe Frame | Определяет, должны ли все объявления на странице принудительно отображаться с использованием контейнера SafeFrame. |
set Location | Передаёт информацию о местоположении с веб-сайтов, чтобы вы могли нацелить позиции на определенные местоположения. |
set Privacy Settings | Позволяет настраивать все параметры конфиденциальности из единого API с помощью объекта конфигурации. |
set Publisher Provided Id | Устанавливает значение идентификатора, предоставленного издателем. |
set Safe Frame Config | Устанавливает настройки уровня страницы для конфигурации SafeFrame. |
set Targeting | Устанавливает параметры пользовательского таргетинга для данного ключа, которые применяются ко всем рекламным местам службы Publisher Ads. |
set Video Content | Устанавливает информацию о видеоконтенте, которая будет отправляться вместе с запросами объявлений для целей таргетинга и исключения контента. |
update Correlator | Изменяет коррелятор, отправляемый с запросами объявлений, фактически запуская новый просмотр страницы. |
Методы
прозрачный
- Пример
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();
Машинопись
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();
clear ( slots ?: Slot [] ) : boolean
Удаляет рекламу из заданных слотов и заменяет ее пустым контентом. Слоты будут помечены как невыбранные.
В частности, очистка слота удаляет объявление из списка долгосрочных просмотров страниц GPT, поэтому на будущие запросы не будут влиять препятствия или конкурентные исключения, связанные с этим объявлением.
Параметры | |
---|---|
| Массив слотов, которые необходимо очистить. Массив не является обязательным; все слоты будут очищены, если он не указан. |
Возврат | |
---|---|
boolean | Возвращает true , если слоты были очищены, в противном случае — false . |
ClearCategoryExclusions
- Пример
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.
Машинопись
// 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.
clearCategoryExclusions ( ) : PubAdsService
Удаляет все метки исключения категорий объявлений на уровне страницы. Это полезно, если вы хотите обновить слот.
Возврат | |
---|---|
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.
Машинопись
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.
- См. также
clearTargeting ( key ?: string ) : PubAdsService
Очищает параметры специального таргетинга для определенного ключа или для всех ключей.
Параметры | |
---|---|
| Ключ параметра таргетинга. Ключ не является обязательным; все параметры таргетинга будут удалены, если они не указаны. |
Возврат | |
---|---|
PubAdsService | Объект службы, для которого был вызван метод. |
свернутьEmptyDivs
collapseEmptyDivs ( collapseBeforeAdFetch ?: boolean ) : boolean
Включает свертывание элементов div рекламных мест, чтобы они не занимали места на странице, когда нет рекламного контента для отображения. Этот режим необходимо установить до включения службы.
Параметры | |
---|---|
| Сворачивать ли рекламные места еще до того, как будет получена реклама. Этот параметр является необязательным; если не указано, в качестве значения по умолчанию будет использоваться false . |
Возврат | |
---|---|
boolean | Возвращает true , если режим свертывания div был включен, и false , если включить режим свертывания невозможно, поскольку метод был вызван после включения службы. |
отключить начальную загрузку
disableInitialLoad ( ) : void
Отключает запросы рекламы при загрузке страницы, но позволяет запрашивать рекламу с помощью вызова PubAdsService.refresh . Это должно быть установлено до включения службы. Необходимо использовать асинхронный режим; в противном случае будет невозможно запросить рекламу с помощью refresh
.
отображать
- Пример
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (устаревший)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
Машинопись
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
display ( adUnitPath : string , size : GeneralSize , div ?: string | Element , clickUrl ?: string ) : void
Создает и отображает рекламное место с заданным путем и размером рекламного блока. Этот метод не работает в режиме единого запроса.
Примечание. При вызове этого метода создается снимок состояния рекламного места и страницы, чтобы обеспечить согласованность при отправке запроса объявления и обработке ответа. Любые изменения, внесенные в состояние слота или страницы после вызова этого метода (включая таргетинг, настройки конфиденциальности, принудительное использование SafeFrame и т. д.), будут применяться только к последующим запросам display()
или refresh()
.
Параметры | |
---|---|
adUnitPath : string | Путь рекламного блока к отображаемому месту. |
size : GeneralSize | Ширина и высота прорези. |
| Либо идентификатор div, содержащего слот, либо сам элемент div. |
| URL-адрес клика для использования в этом слоте. |
включитьLazyLoad
- Пример
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, });
Машинопись
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, });
-
fetchMarginPercent
Минимальное расстояние от текущей области просмотра, на котором должно быть место, прежде чем мы получим объявление в процентах от размера области просмотра. Значение 0 означает «когда рекламное место попадает в область просмотра», 100 означает «когда реклама находится на расстоянии 1 области просмотра» и так далее. -
renderMarginPercent
Минимальное расстояние от текущей области просмотра, на котором должно быть место, прежде чем мы сможем отобразить объявление. Это позволяет предварительно загрузить объявление, но ожидать обработки и загрузки других подресурсов. Значение работает так же, как иfetchMarginPercent
, в процентах от области просмотра. -
mobileScaling
Множитель, применяемый к марже на мобильных устройствах. Это позволяет варьировать прибыль на мобильных устройствах и настольных компьютерах. Например, значение 2,0 умножит все поля на 2 на мобильных устройствах, увеличивая минимальное расстояние, которое может находиться слот перед выборкой и рендерингом.
enableLazyLoad ( config ?: {
fetchMarginPercent ?: number ;
mobileScaling ?: number ;
renderMarginPercent ?: number ;
} ) : void
Включает отложенную загрузку в GPT, как определено объектом конфигурации. Более подробные примеры см. в примере отложенной загрузки .
Примечание. Отложенная выборка в SRA работает только в том случае, если все слоты находятся за пределами выборки.
Параметры | |
---|---|
| Объект конфигурации позволяет настраивать ленивое поведение. Любые пропущенные конфигурации будут использовать настройки Google по умолчанию, которые со временем будут корректироваться. Чтобы отключить определенный параметр, например поле выборки, установите значение -1 . |
включитьSingleRequest
- См. также
enableSingleRequest ( ) : boolean
Включает режим единого запроса для одновременного получения нескольких объявлений. Для этого необходимо, чтобы все рекламные места издателя были определены и добавлены в PubAdsService до включения службы. Режим единого запроса должен быть установлен до включения услуги.
Возврат | |
---|---|
boolean | Возвращает true , если режим единого запроса был включен, и false , если включить режим единого запроса невозможно, поскольку метод был вызван после включения службы. |
включитьВидеообъявления
enableVideoAds ( ) : void
Сигнализирует GPT о том, что на странице будет присутствовать видеореклама. Это включает ограничения конкурентного исключения для медийной и видеорекламы. Если видеоконтент известен, вызовите PubAdsService.setVideoContent , чтобы иметь возможность использовать исключение контента для медийной рекламы.
получать
- Пример
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'.
Машинопись
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- См. также
get ( key : string ) : null | string
Возвращает значение атрибута AdSense, связанного с данным ключом.
Параметры | |
---|---|
key : string | Имя атрибута, который требуется найти. |
Возврат | |
---|---|
null | string | Текущее значение ключа атрибута или значение null , если ключ отсутствует. |
getAttributeKeys
- Пример
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'].
Машинопись
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
getAttributeKeys ( ) : 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).
Машинопись
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
getTargeting ( key : string ) : string []
Возвращает определенный заданный параметр таргетинга на уровне обслуживания.
Параметры | |
---|---|
key : string | Ключ таргетинга, который нужно искать. |
Возврат | |
---|---|
string [] | Значения, связанные с этим ключом, или пустой массив, если такого ключа нет. |
getTargetingKeys
- Пример
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'].
Машинопись
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
getTargetingKeys ( ) : string []
Возвращает список всех установленных ключей таргетинга настраиваемого уровня обслуживания.
Возврат | |
---|---|
string [] | Массив ключей таргетинга. Порядок не определен. |
Исинитиаллоаддисаблед
isInitialLoadDisabled ( ) : boolean
Возвращает, были ли первоначальные запросы объявлений успешно отключены предыдущим вызовом PubAdsService.disableInitialLoad .
Возврат | |
---|---|
boolean | Возвращает true , если предыдущий вызов PubAdsService.disableInitialLoad был успешным, в противном случае — false . |
обновить
- Пример
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 });
Машинопись
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 });
-
changeCorrelator
Указывает, следует ли создавать новый коррелятор для получения рекламы. Наши рекламные серверы кратковременно поддерживают это значение коррелятора (в настоящее время в течение 30 секунд, но могут быть изменены), поэтому запросы с одним и тем же коррелятором, полученные близко друг к другу, будут считаться просмотром одной страницы. По умолчанию новый коррелятор создается для каждого обновления.
Примечание. Этот параметр не влияет на долгосрочный просмотр страниц GPT, который автоматически отражает объявления, находящиеся в данный момент на странице, и не имеет срока действия.
refresh ( slots ?: null | Slot [] , options ?: {
changeCorrelator : boolean ;
} ) : void
Получает и отображает новые объявления для определенных или всех рекламных мест на странице. Работает только в режиме асинхронного рендеринга.
Для правильного поведения во всех браузерах вызову refresh
должен предшествовать вызов для display
рекламного места. Если вызов display
опущен, обновление может вести себя неожиданно. При желании можно использовать метод PubAdsService.disableInitialLoad , чтобы запретить display
рекламы.
Обновление рекламного места удаляет старое объявление из списка долгоживущих просмотров страниц GPT, поэтому на будущие запросы не будут влиять препятствия или конкурентные исключения, связанные с этим объявлением.
Параметры | |
---|---|
| Слоты для обновления. Массив не является обязательным; все слоты будут обновлены, если он не указан. |
| Параметры конфигурации, связанные с этим вызовом обновления. |
набор
- Пример
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (устаревший)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
Машинопись
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- См. также
set ( key : string , value : string ) : PubAdsService
Устанавливает значения атрибутов AdSense, которые применяются ко всем рекламным местам в рамках службы «Реклама издателя».
Вызов этого более одного раза для одного и того же ключа приведет к переопределению ранее установленных значений для этого ключа. Все значения должны быть установлены перед вызовом display
или refresh
.
Параметры | |
---|---|
key : string | Имя атрибута. |
value : string | Значение атрибута. |
Возврат | |
---|---|
PubAdsService | Объект службы, для которого был вызван метод. |
setCategoryExclusion
- Пример
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (устаревший)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
Машинопись
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
setCategoryExclusion ( categoryExclusion : string ) : PubAdsService
Устанавливает исключение категории объявлений на уровне страницы для данного названия ярлыка.
Параметры | |
---|---|
categoryExclusion : string | Добавляемый ярлык исключения категории объявлений. |
Возврат | |
---|---|
PubAdsService | Объект службы, для которого был вызван метод. |
setCentering
- Пример
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (устаревший)
// Make ads centered. googletag.pubads().setCentering(true);
Машинопись
// Make ads centered. googletag.pubads().setCentering(true);
setCentering ( centerAds : boolean ) : void
Включает и отключает горизонтальное центрирование рекламы. Центрирование отключено по умолчанию. В устаревшем gpt_mobile.js центрирование включено по умолчанию.
Этот метод следует вызывать перед вызовом display
или refresh
поскольку центрироваться будут только объявления, запрошенные после вызова этого метода.
Параметры | |
---|---|
centerAds : boolean | true для центрирования объявлений, false — для их выравнивания по левому краю. |
setForceSafeFrame
- Эта настройка вступит в силу только для последующих запросов объявлений, сделанных для соответствующих рекламных мест.
- Параметр уровня слота, если он указан, всегда будет иметь приоритет над параметром уровня страницы.
- Если установлено значение
true
(на уровне рекламного места или страницы), объявление всегда будет отображаться с использованием контейнера SafeFrame, независимо от выбора, сделанного в пользовательском интерфейсе Google Ad Manager. - Однако если установлено значение
false
или не указано, объявление будет отображаться с использованием контейнера SafeFrame в зависимости от типа объявления и выбора, сделанного в пользовательском интерфейсе Google Ad Manager. - Этот 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");
Машинопись
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");
- См. также
setForceSafeFrame ( forceSafeFrame : boolean ) : PubAdsService
Определяет, должны ли все объявления на странице принудительно отображаться с использованием контейнера SafeFrame.
При использовании этого API помните следующее:
Параметры | |
---|---|
forceSafeFrame : boolean | Значение true чтобы все объявления на странице отображались в SafeFrames, и false , чтобы изменить предыдущую настройку на false. Установка значения false если оно не указано ранее, ничего не изменит. |
Возврат | |
---|---|
PubAdsService | Объект службы, для которого была вызвана функция. |
setLocation
- Пример
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (устаревший)
// Postal code: googletag.pubads().setLocation("10001,US");
Машинопись
// Postal code: googletag.pubads().setLocation("10001,US");
setLocation ( address : string ) : PubAdsService
Передаёт информацию о местоположении с веб-сайтов, чтобы вы могли нацелить позиции на определенные местоположения.
Параметры | |
---|---|
address : string | Адрес в свободной форме. |
Возврат | |
---|---|
PubAdsService | Объект службы, для которого был вызван метод. |
setPrivacySettings
- Пример
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, });
Машинопись
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, });
setPrivacySettings ( privacySettings : PrivacySettingsConfig ) : PubAdsService
Позволяет настраивать все параметры конфиденциальности из одного API с помощью объекта конфигурации.
Параметры | |
---|---|
privacySettings : PrivacySettingsConfig | Объект, содержащий конфигурацию настроек конфиденциальности. |
Возврат | |
---|---|
PubAdsService | Объект службы, для которого была вызвана функция. |
setPublisherProvidedId
- Пример
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (устаревший)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
Машинопись
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
setPublisherProvidedId ( ppid : string ) : PubAdsService
Устанавливает значение идентификатора, предоставленного издателем.
Параметры | |
---|---|
ppid : string | Буквенно-цифровой идентификатор, предоставленный издателем. Должно быть от 32 до 150 символов. |
Возврат | |
---|---|
PubAdsService | Объект службы, для которого был вызван метод. |
setSafeFrameConfig
- Пример
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");
Машинопись
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");
- См. также
setSafeFrameConfig ( config : SafeFrameConfig ) : PubAdsService
Устанавливает настройки уровня страницы для конфигурации SafeFrame. Любые нераспознанные ключи в объекте конфигурации будут игнорироваться. Вся конфигурация будет проигнорирована, если для распознанного ключа будет передано недопустимое значение.
Эти настройки уровня страницы будут переопределены настройками уровня слота, если они указаны.
Параметры | |
---|---|
config : SafeFrameConfig | Объект конфигурации. |
Возврат | |
---|---|
PubAdsService | Объект службы, для которого был вызван метод. |
установить таргетинг
- Пример
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"]);
Машинопись
// 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"]);
- См. также
setTargeting ( key : string , value : string | string [] ) : PubAdsService
Устанавливает параметры пользовательского таргетинга для данного ключа, которые применяются ко всем рекламным местам службы Publisher Ads. Вызов этого несколько раз для одного и того же ключа приведет к перезаписи старых значений. Эти ключи определены в вашем аккаунте Google Ad Manager.
Параметры | |
---|---|
key : string | Ключ параметра таргетинга. |
value : string | string [] | Значение параметра таргетинга или массив значений. |
Возврат | |
---|---|
PubAdsService | Объект службы, для которого был вызван метод. |
setVideoContent
setVideoContent ( videoContentId : string , videoCmsId : string ) : void
Устанавливает информацию о видеоконтенте, которая будет отправляться вместе с запросами объявлений для целей таргетинга и исключения контента. Видеореклама будет автоматически включена при вызове этого метода. Для videoContentId
и videoCmsId
используйте значения, предоставленные службе приема контента Google Ad Manager.
Параметры | |
---|---|
videoContentId : string | Идентификатор видеоконтента. |
videoCmsId : string | Идентификатор видео CMS. |
updateCorrelator
- Пример
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.
Машинопись
// 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.
updateCorrelator ( ) : PubAdsService
Изменяет коррелятор, отправляемый с запросами объявлений, фактически запуская новый просмотр страницы. Коррелятор одинаков для всех запросов объявлений, поступающих при одном просмотре страницы, и уникален для всех просмотров страниц. Применяется только к асинхронному режиму.
Примечание. Это не влияет на долгосрочный просмотр страниц GPT, который автоматически отображает фактические объявления на странице и не имеет срока действия.
Возврат | |
---|---|
PubAdsService | Объект службы, для которого была вызвана функция. |
googletag.ResponseInformation
Характеристики | |
---|---|
advertiser Id | Идентификатор рекламодателя. |
campaign Id | Идентификатор кампании. |
creative Id | Идентификатор объявления. |
creative Template Id | Идентификатор шаблона объявления. |
line Item Id | Идентификатор позиции. |
- См. также
Характеристики
идентификатор рекламодателя
advertiserId : null | number
Идентификатор рекламодателя.
идентификатор кампании
campaignId : null | number
Идентификатор кампании.
креативный идентификатор
creativeId : null | number
Идентификатор объявления.
CreativeTemplateId
creativeTemplateId : null | number
Идентификатор шаблона объявления.
идентификатор строки
lineItemId : null | number
Идентификатор позиции.
googletag.RewardedPayload
Характеристики | |
---|---|
amount | Количество предметов, входящих в награду. |
type | Тип предмета, входящего в награду (например, «монета»). |
- См. также
Характеристики
количество
amount : number
Количество предметов, включенных в награду.
тип
type : string
Тип предмета, входящего в награду (например, «монета»).
googletag.SafeFrameConfig
Характеристики | |
---|---|
allow Overlay Expansion ? | Должен ли SafeFrame разрешать расширение рекламного контента за счет наложения содержимого страницы. |
allow Push Expansion ? | Должен ли SafeFrame разрешать расширение рекламного контента за счет перемещения содержимого страницы. |
sandbox ? | Следует ли SafeFrame использовать атрибут песочницы HTML5, чтобы предотвратить навигацию верхнего уровня без взаимодействия с пользователем. |
use Unique Domain ? | Устарело. Следует ли SafeFrame использовать случайные субдомены для креативов с резервированием. |
- См. также
Характеристики
Optional
разрешениеOverlayExpansion
allowOverlayExpansion ?: boolean
Должен ли SafeFrame разрешать расширение рекламного контента за счет наложения содержимого страницы.
Optional
разрешениеPushExpansion
allowPushExpansion ?: boolean
Должен ли SafeFrame разрешать расширение рекламного контента за счет перемещения содержимого страницы.
Optional
песочница
sandbox ?: boolean
Следует ли SafeFrame использовать атрибут песочницы HTML5, чтобы предотвратить навигацию верхнего уровня без взаимодействия с пользователем. Единственное допустимое значение — true
(невозможно принудительно установить false
). Обратите внимание, что атрибут песочницы отключает плагины (например, Flash).
Optional
использованиеUniqueDomain
- См. также
useUniqueDomain ?: null | boolean
Следует ли SafeFrame использовать случайные субдомены для креативов с резервированием. Передайте значение null
, чтобы очистить сохраненное значение.
Примечание: эта функция включена по умолчанию.
googletag.Service
Методы | |
---|---|
add Event Listener | Регистрирует прослушиватель, который позволяет вам настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. |
get Slots | Получите список слотов, связанных с этим сервисом. |
remove Event Listener | Удаляет ранее зарегистрированный прослушиватель. |
Методы
добавитьEventListener
- event.GameManualInterstitialSlotClosedEvent
- event.GameManualInterstitialSlotReadyEvent
- события.ImpressionViewableEvent
- события.RewardedSlotClosedEvent
- события.RewardedSlotGrantedEvent
- события.RewardedSlotReadyEvent
- события.SlotOnloadEvent
- события.SlotRenderEndedEvent
- события.SlotRequestedEvent
- события.SlotResponseReceived
- события.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. } });
Машинопись
// 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. } });
- См. также
addEventListener < K extends keyof EventTypeMap > ( eventType : K , listener : ( ( arg : EventTypeMap [ K ] ) => void ) ) : Service
Регистрирует прослушиватель, который позволяет вам настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. Поддерживаются следующие события:
Параметры | |
---|---|
eventType : K | Строка, представляющая тип события, созданного GPT. Типы событий чувствительны к регистру. |
listener : ( ( arg : EventTypeMap [ K ] ) => void ) | Функция, принимающая один аргумент объекта события. |
Возврат | |
---|---|
Service | Объект сервиса, на котором был вызван метод. |
Getslots
Удалить EventListener
- Пример
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 (Legacy)
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(); });
Машинопись
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(); });
removeEventListener < K extends keyof EventTypeMap > ( eventType : K , listener : ( ( event : EventTypeMap [ K ] ) => void ) ) : void
Удаляет ранее зарегистрированного слушателя.
Параметры | |
---|---|
eventType : K | Строка, представляющая тип события, сгенерированного GPT. Типы событий чувствительны к корпусу. |
listener : ( ( event : EventTypeMap [ K ] ) => void ) | Функция, которая принимает один аргумент объекта события. |
GOOGLEG.SizemappingBuilder
Методы | |
---|---|
add Size | Добавляет отображение из одноразмерного массива (представляющего шлифонный товар) в одно- или многократный массив, представляющий слот. |
build | Создает спецификацию карты размера из сопоставлений, добавленных к этому строителю. |
- См. также
Методы
добавить
- Пример
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (Legacy)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
Машинопись
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
addSize ( viewportSize : SingleSizeArray , slotSize : GeneralSize ) : SizeMappingBuilder
Добавляет отображение из одноразмерного массива (представляющего шлифонный товар) в одно- или многократный массив, представляющий слот.
Параметры | |
---|---|
viewportSize : SingleSizeArray | Размер просмотра для этой записи отображения. |
slotSize : GeneralSize | Размеры слота для этой записи отображения. |
Возврат | |
---|---|
SizeMappingBuilder | Ссылка на этот строитель. |
строить
build ( ) : null | SizeMappingArray
Создает спецификацию карты размера из сопоставлений, добавленных к этому строителю.
Если будут предоставлены какие -либо недействительные отображения, этот метод вернет null
. В противном случае он возвращает спецификацию в правильном формате, чтобы пройти в slot.definesezemapping .
Примечание. Поведение строителя после вызова этого метода не определен.
Возврат | |
---|---|
null | SizeMappingArray | Результат, построенный этим строителем. Может быть нулевым, если были предоставлены неверные отображения размера. |
Googletag.slot
Методы | |
---|---|
add Service | Добавляет сервис в этот слот. |
clear Category Exclusions | Очистка всех метковки AD-категории на уровне слота для этого слота. |
clear Targeting | Очистка конкретных или всех пользовательских параметров нацеливания на уровне слота для этого слота. |
define Size Mapping | Устанавливает множество сопоставлений от минимального размера просмотра до размера слота для этого слота. |
get | Возвращает значение для атрибута AdSense, связанного с данным ключом для этого слота. |
get Ad Unit Path | Возвращает полный путь блока рекламы с помощью сетевого кода и пути AD. |
get Attribute Keys | Возвращает список ключей атрибутов, установленных в этом слоте. |
get Category Exclusions | Возвращает этикетки исключения категории объявлений для этого слота. |
get Response Information | Возвращает информацию о ответе на рекламу. |
get Slot Element Id | Возвращает div слота, предоставленного при определении слота. |
get Targeting | Возвращает конкретный пользовательский параметр таргетинга, установленную на этом слоте. |
get Targeting Keys | Возвращает список всех пользовательских клавиш, установленных на этом слоте. |
set | Устанавливает значение для атрибута AdSense на этом слоте AD. |
set Category Exclusion | Устанавливает на этом слоте метку AD-категории на уровне слота. |
set Click Url | Устанавливает URL Click, на который пользователи будут перенаправлены после нажатия на объявление. |
set Collapse Empty Div | Устанавливает, должен ли лот div быть скрыт, когда в слоте нет рекламы. |
set Config | Устанавливает общие параметры конфигурации для этого слота. |
set Force Safe Frame | Настраивает, следует ли вынужден быть вынуждены отображать рекламу в этом слоте с использованием контейнера SafeFrame. |
set Safe Frame Config | Устанавливает предпочтения на уровне слота для конфигурации SafeFrame. |
set Targeting | Устанавливает пользовательский параметр таргетирования для этого слота. |
update Targeting From Map | Устанавливает пользовательские параметры таргетирования для этого слота, из ключа: карта значений в объекте JSON. |
Методы
Добавить
- Пример
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (Legacy)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
Машинопись
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
addService ( service : Service ) : Slot
Добавляет сервис в этот слот.
Параметры | |
---|---|
service : Service | Услуга, которая будет добавлена. |
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
ClearCategoryExclusions
- Пример
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 (Legacy)
// 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.
Машинопись
// 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.
clearCategoryExclusions ( ) : Slot
Очистка всех метковки AD-категории на уровне слота для этого слота.
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
ClearTargeting
- Пример
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 (Legacy)
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.
Машинопись
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.
- См. также
clearTargeting ( key ?: string ) : Slot
Очистка конкретных или всех пользовательских параметров нацеливания на уровне слота для этого слота.
Параметры | |
---|---|
| Ключ для параметра таргетирования. Ключ не является обязательным; Все параметры таргетирования будут очищены, если он не определен. |
Возврат | |
---|---|
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 (Legacy)
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);
Машинопись
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!);
- См. также
defineSizeMapping ( sizeMapping : SizeMappingArray ) : Slot
Устанавливает множество сопоставлений от минимального размера просмотра до размера слота для этого слота.
Параметры | |
---|---|
sizeMapping : SizeMappingArray | Массив размеров. Вы можете использовать SizemappingBuilder для его создания. Каждое отображение размера представляет собой массив двух элементов: SingleSizeArray и GeneralSize . |
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
получать
- Пример
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 (Legacy)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- См. также
get ( key : string ) : null | string
Возвращает значение для атрибута AdSense, связанного с данным ключом для этого слота. Чтобы увидеть атрибуты уровня обслуживания, унаследованные этим слотом, используйте pubadsservice.get .
Параметры | |
---|---|
key : string | Название атрибута, чтобы найти. |
Возврат | |
---|---|
null | string | Текущее значение для клавиши атрибута или null , если ключ отсутствует. |
getadunitpath
- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (Legacy)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
getAdUnitPath ( ) : string
Возвращает полный путь блока рекламы с помощью сетевого кода и пути AD.
Возврат | |
---|---|
string | Блок Блок. |
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 (Legacy)
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'].
Машинопись
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'].
getAttributeKeys ( ) : string []
Возвращает список ключей атрибутов, установленных в этом слоте. Чтобы увидеть клавиши атрибутов уровня обслуживания, унаследованные этим слотом, используйте pubadsservice.getattributekeys .
Возврат | |
---|---|
string [] | Массив клавиш атрибута. Заказ не определен. |
GetCategoryExclusions
- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (Legacy)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
getCategoryExclusions ( ) : string []
Возвращает этикетки исключения категории объявлений для этого слота.
Возврат | |
---|---|
string [] | Экскурсионные метки AD Category для этого слота или пустой массив, если его не было установлено. |
GetResponseInformation
getResponseInformation ( ) : null | ResponseInformation
Возвращает информацию о ответе на рекламу. Это основано на последнем ответе на рекламу для слота. Если это вызывается, когда слот не имеет рекламы, null
будет возвращен.
Возврат | |
---|---|
null | ResponseInformation | Последняя информация о ответе на рекламу, или null , если слот не имеет объявления. |
GetSlotelementId
- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
JavaScript (Legacy)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
getSlotElementId ( ) : string
Возвращает div
слота, предоставленного при определении слота.
Возврат | |
---|---|
string | Слот div id. |
GetTargeting
- Пример
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 (Legacy)
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).
Машинопись
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).
getTargeting ( key : string ) : string []
Возвращает конкретный пользовательский параметр таргетинга, установленную на этом слоте. Параметры таргетирования на уровне обслуживания не включены.
Параметры | |
---|---|
key : string | Целевой ключ для поиска. |
Возврат | |
---|---|
string [] | Значения, связанные с этим ключом, или пустой массив, если нет такого ключа. |
GetTargetingKeys
- Пример
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 (Legacy)
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'].
Машинопись
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'].
getTargetingKeys ( ) : string []
Возвращает список всех пользовательских клавиш, установленных на этом слоте. Ключи на уровне обслуживания не включены.
Возврат | |
---|---|
string [] | Массив целевых ключей. Заказ не определен. |
набор
- Пример
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 (Legacy)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
Машинопись
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- См. также
set ( key : string , value : string ) : Slot
Устанавливает значение для атрибута AdSense на этом слоте AD. Это будет переопределять любые значения, установленные на уровне службы для этого ключа.
Вызов этот метод более одного раза для одного и того же ключа переопределяет ранее установленные значения для этого ключа. Все значения должны быть установлены перед вызовом display
или refresh
.
Параметры | |
---|---|
key : string | Имя атрибута. |
value : string | Значение атрибута. |
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
setCategoryExclusion
- Пример
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (Legacy)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
Машинопись
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
setCategoryExclusion ( categoryExclusion : string ) : Slot
Устанавливает на этом слоте метку AD-категории на уровне слота.
Параметры | |
---|---|
categoryExclusion : string | Метка исключения категории объявлений, чтобы добавить. |
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
SetClickurl
- Пример
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (Legacy)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
Машинопись
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
setClickUrl ( value : string ) : Slot
Устанавливает URL Click, на который пользователи будут перенаправлены после нажатия на объявление.
Серверы Google Ad Manager по -прежнему записывают щелчок, даже если заменен URL -адрес Click. Любой URL -адрес целевой страницы, связанный с поданной креативной, добавляется к предоставленной стоимости. Последующие вызовы перезаписывают значение. Это работает только для запросов без SRA.
Параметры | |
---|---|
value : string | URL Click для установки. |
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
SetCollapSeeMptyDiv
- Пример
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 (Legacy)
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.
Машинопись
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.
setCollapseEmptyDiv ( collapse : boolean , collapseBeforeAdFetch ?: boolean ) : Slot
Устанавливает, должен ли лот div
быть скрыт, когда в слоте нет рекламы. Это переопределяет настройки уровня службы.
Параметры | |
---|---|
collapse : boolean | Развалить слот, если объявление не возвращается. |
| Развалить слот еще до того, как реклама будет извлечена. Игнорируется, если коллапс true . |
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
setConfig
setConfig ( slotConfig : SlotSettingsConfig ) : void
Устанавливает общие параметры конфигурации для этого слота.
Параметры | |
---|---|
slotConfig : SlotSettingsConfig | Объект конфигурации. |
setForcesafeFrame
- Эта настройка вступит в силу только для последующих запросов на рекламу, сделанных для соответствующих слотов.
- Настройка уровня слота, если указано, всегда будет переопределять настройку уровня страницы.
- Если установить на
true
(на уровне слота или уровне страницы), объявление всегда будет отображаться с использованием контейнера SafeFrame, независимо от выбора, сделанного в пользовательском интерфейсе Google AD Manager. - Однако, если установить на
false
или Left Uncesitification, объявление будет отображаться с использованием контейнера SafeFrame в зависимости от типа творчества и отбора, сделанного в пользовательском интерфейсе Google AD Manager. - Этот API следует использовать с осторожностью, поскольку он может повлиять на поведение креативщиков, которые пытаются вырваться из их iframes или полагаться на то, что они будут отображаться непосредственно на странице издателей.
- Пример
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (Legacy)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
Машинопись
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
setForceSafeFrame ( forceSafeFrame : boolean ) : Slot
Настраивает, следует ли вынужден быть вынуждены отображать рекламу в этом слоте с использованием контейнера SafeFrame.
Пожалуйста, имейте в виду следующие вещи при использовании этого API:
Параметры | |
---|---|
forceSafeFrame : boolean | true , чтобы заставить все объявления в этом слоте быть отображаются в SafeFrames и false , чтобы отказаться от настройки на уровне страницы (если присутствует). Установка этого на false когда не указано на уровне страницы, ничего не изменит. |
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
setSafeFrameConfig
- Пример
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 (Legacy)
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");
Машинопись
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");
setSafeFrameConfig ( config : null | SafeFrameConfig ) : Slot
Устанавливает предпочтения на уровне слота для конфигурации SafeFrame. Любые непризнанные ключи в объекте конфигурации будут игнорироваться. Вся конфигурация будет проигнорирована, если для признанного ключа передается неверное значение.
Эти предпочтения на уровне слота, если указаны, будут переоценить любые предпочтения на уровне страницы.
Параметры | |
---|---|
config : null | SafeFrameConfig | Объект конфигурации. |
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
поселение
- Пример
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 (Legacy)
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"]);
Машинопись
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"]);
- См. также
setTargeting ( key : string , value : string | string [] ) : Slot
Устанавливает пользовательский параметр таргетирования для этого слота. Вызов этот метод несколько раз для одного и того же ключа будет перезаписать старые значения. Значения, установленные здесь, будут перезаписать параметры таргетирования, установленные на уровне службы. Эти ключи определены в вашей учетной записи Google Ad Manager.
Параметры | |
---|---|
key : string | Ключ для параметра таргетирования. |
value : string | string [] | Значение параметра таргетирования или массив значений. |
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
UpdateTargetingFrommap
- В случае перезаписи будет сохранено только последнее значение.
- Если значение является массивом, любое предыдущее значение будет перезаписано, а не объединено.
- Значения, установленные здесь, будут перезаписать параметры таргетирования, установленные на уровне службы.
- Пример
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (Legacy)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
Машинопись
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
updateTargetingFromMap ( map : {
[ adUnitPath : string ] : string | string [] ;
} ) : Slot
Устанавливает пользовательские параметры таргетирования для этого слота, из ключа: карта значений в объекте JSON. Это то же самое, что и вызов слот.setTargeting для всех значений ключей объекта. Эти ключи определены в вашей учетной записи Google Ad Manager.
Примечания:
Параметры | |
---|---|
map : { | Ключ параметров таргетирования: карта значений. |
Возврат | |
---|---|
Slot | Слот -объект, на котором был вызван метод. |
Googletag.config
Интерфейсы | |
---|---|
Ad Expansion Config | Настройки для управления расширением рекламы. |
Component Auction Config | Объект, представляющий аукцион с одним компонентом на аукционе AD на устройстве. |
Interstitial Config | Объект, который определяет поведение единого интерстициального рекламного слота. |
Page Settings Config | Основной интерфейс конфигурации для настройки на уровне страницы. |
Privacy Treatments Config | Настройки для контроля лечения конфиденциальности издателя. |
Publisher Provided Signals Config | Издатель предоставил объект конфигурации Signals (PPS). |
Slot Settings Config | Основной интерфейс конфигурации для настройки уровня слота. |
Taxonomy Data | Объект, содержащий значения для одной таксономии . |
Тип псевдонимов | |
---|---|
Interstitial Trigger | Поддерживаемые интерстициальные триггеры AD. |
Privacy Treatment | Поддерживаемые издатели. |
Taxonomy | Поддерживаемые таксономии для издателя предоставили сигналы (PPS) . |
Тип псевдонимов
Interstitialtrigger
InterstitialTrigger : "unhideWindow" | "navBar"
Поддерживаемые интерстициальные триггеры AD.
Конфиденциальность
PrivacyTreatment : "disablePersonalization"
Поддерживаемые издатели.
Таксономия
Taxonomy : "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
Поддерживаемые таксономии для издателя предоставили сигналы (PPS) .
googletag.config.adexpansionconfig
Характеристики | |
---|---|
enabled ? | Развитие рекламы включено или отключено. |
- Пример
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (Legacy)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
Машинопись
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
Характеристики
Optional
включено
enabled ?: boolean
Развитие рекламы включено или отключено.
Установка этого значения переопределяет по умолчанию, настроенное в Google Ad Manager.
Googletag.config.componentauctionConfig
Характеристики | |
---|---|
auction Config | Объект конфигурации аукциона для этого компонентного аукциона. |
config Key | Ключ конфигурации, связанный с этим компонентным аукционом. |
Характеристики
AuctionConfig
- Пример
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 (Legacy)
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, }, ], });
Машинопись
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, }, ], });
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
.
конфигурация
configKey : string
Ключ конфигурации, связанный с этим компонентным аукционом.
Это значение должно быть непустым и должно быть уникальным. Если два объекта ComponentAuctionConfig
имеют одно и то же значение конфигурации, последнее, которое будет установлено, будет перезаписать предыдущие конфигурации.
googletag.config.InterstitialConfig
Характеристики | |
---|---|
triggers ? | Конфигурация интерстициального триггера для этого интерстициального объявления. |
Характеристики
Optional
триггеры
- Пример
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 (Legacy)
// 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, }, }, });
Машинопись
// 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, }, }, });
triggers ?: Partial < Record < InterstitialTrigger , boolean > >
Конфигурация интерстициального триггера для этого интерстициального объявления.
Установка значения интерстициального триггера для true
включит его, и false
отключит его. Это переоценит значения по умолчанию, настроенные в Google Ad Manager .
googletag.config.pagesettingsconfig
Позволяет установить несколько функций с одним вызовом 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, });
Характеристики | |
---|---|
ad Expansion ? | Настройки для управления расширением рекламы. |
ad Yield ? | Устарело. |
pps ? | Настройки для управления издателем предоставили сигналы (PPS). |
privacy Treatments ? | Настройки для контроля лечения конфиденциальности издателя. |
thread Yield ? | Настройка для управления, должен ли GPT дать поток JS при рендеринге креативщиков. |
Характеристики
Optional
AdexPansion
adExpansion ?: null | AdExpansionConfig
Настройки для управления расширением рекламы.
Optional
Adyield
adYield ?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Optional
PPS
pps ?: null | PublisherProvidedSignalsConfig
Настройки для управления издателем предоставили сигналы (PPS).
Optional
конфиденциальностьПроцедуры
privacyTreatments ?: null | PrivacyTreatmentsConfig
Настройки для контроля лечения конфиденциальности издателя.
Optional
Threadyield
-
null
(по умолчанию): GPT даст поток JS для слотов за пределами просмотра. -
ENABLED_ALL_SLOTS
: GPT даст поток JS для всех слотов независимо от того, находится ли слот в пределах просмотра. -
DISABLED
: GPT не даст поток JS. - Пример
JavaScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
JavaScript (Legacy)
// 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 });
Машинопись
// 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 });
- См. также
threadYield ?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Настройка для управления, должен ли GPT дать поток JS при рендеринге креативщиков.
GPT даст только для браузеров, которые поддерживают API Pradeler.posttask.
Поддерживаемые значения:
Googletag.config.privacyTreatmentsConfig
Характеристики | |
---|---|
treatments | Массив лечения конфиденциальности издателей для включения. |
Характеристики
лечение
- Пример
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (Legacy)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
Машинопись
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
treatments : "disablePersonalization" []
Массив лечения конфиденциальности издателей для включения.
googletag.config.publisherprovidedsignalsconfig
Характеристики | |
---|---|
taxonomies | Объект, содержащий таксономические отображения. |
- Пример
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (Legacy)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
Машинопись
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
Характеристики
таксономии
taxonomies : Partial < Record < Taxonomy , TaxonomyData > >
Объект, содержащий таксономические отображения.
googletag.config.SlotSettingsConfig
Позволяет установить несколько функций с одним вызовом API для одного слота.
Все свойства, перечисленные ниже, являются примерами и не отражают фактические функции, которые используют SetConfig. Для набора функций см. Поля в типе SlotsettingSconfig ниже.
Примеры:
- Модифицируются только функции, указанные в слоте. SetConfig Call.
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, });
Характеристики | |
---|---|
ad Expansion ? | Настройки для управления расширением рекламы. |
component Auction ? | Массив компонентных аукционов, которые должны быть включены в аукцион AD на устройстве. |
interstitial ? | Настройки, которые управляют интерстициальным поведением слота AD. |
Характеристики
Optional
AdexPansion
adExpansion ?: AdExpansionConfig
Настройки для управления расширением рекламы.
Optional
компонентАукцион
componentAuction ?: ComponentAuctionConfig []
Массив компонентных аукционов, которые должны быть включены в аукцион AD на устройстве.
Optional
интерстициальный
interstitial ?: InterstitialConfig
Настройки, которые управляют интерстициальным поведением слота AD.
Googletag.config.taxonomyData
Характеристики | |
---|---|
values | Список ценностей таксономии . |
Характеристики
ценности
values : string []
Список ценностей таксономии .
Googletag.enums
Перечисления | |
---|---|
Out Of Page Format | Форматы вне страда, поддерживаемые GPT. |
Traffic Source | Источники трафика, поддерживаемые GPT. |
Перечисления
OutofPageFormat
- См. также
OutOfPageFormat
Форматы вне страда, поддерживаемые GPT.
Перечисление членов | |
---|---|
BOTTOM_ ANCHOR | Анкер формат, где слот прилипает к нижней части просмотра. |
GAME_ MANUAL_ INTERSTITIAL | Игровое ручное межметичное формат. Примечание. Руководство по игре Interstitial-это формат с ограниченным доступом . |
INTERSTITIAL | Веб -интерстициальный творческий формат. |
LEFT_ SIDE_ RAIL | Формат левого бокового железа. |
REWARDED | Вознагражденный формат. |
RIGHT_ SIDE_ RAIL | Правый железнодорожный формат. |
TOP_ ANCHOR | Анкер формат, где слот прилипает к вершине видоубийта. |
TrafficSource
- См. также
TrafficSource
Источники трафика, поддерживаемые GPT.
Googletag.events
Интерфейсы | |
---|---|
Event | Базовый интерфейс для всех событий GPT. |
Event Type Map | Это псевдо-тип, который отображает имя события на соответствующий тип объекта события для Service.AddeventListener и Service.RemoveEventListener . |
Game Manual Interstitial Slot Closed Event | Это событие запускается, когда пользователь был закрыт в ручном ручном интервале. |
Game Manual Interstitial Slot Ready Event | Это событие запускается, когда игровой ручный интернет -слот готов к тому, чтобы показать пользователю. |
Impression Viewable Event | Это событие запускается, когда впечатление становится просмотренным, согласно критериям активного взгляда . |
Rewarded Slot Closed Event | Это событие запускается, когда пользователь закрыт вознагражденный рекламный слот. |
Rewarded Slot Granted Event | Это событие уволено, когда награда предоставляется за просмотр вознагражденного объявления . |
Rewarded Slot Ready Event | Это событие уволено, когда награжденное объявление готово для отображения. |
Slot Onload Event | Это событие уволено, когда Iframe Creative запускает свое событие нагрузки. |
Slot Render Ended Event | Это событие запускается, когда творческий код вводится в слот. |
Slot Requested Event | Это событие запускается, когда было запрошено объявление о конкретном слоте. |
Slot Response Received | Это событие запускается, когда был получен ответ рекламного объявления для определенного слота. |
Slot Visibility Changed Event | Это событие запускается всякий раз, когда на экране процент площади рекламного слота меняется. |
Googletag.events.event
Характеристики | |
---|---|
service Name | Название сервиса, которая вызвала событие. |
slot | Слот, который вызвал событие. |
- См. также
Характеристики
служебное имя
serviceName : string
Название сервиса, которая вызвала событие.
слот
slot : Slot
Слот, который вызвал событие.
googletag.events.EventTypeMap
Характеристики | |
---|---|
game Manual Interstitial Slot Closed | Псевдоним для событий.gamemanualInterstitialSlotClosCosedEvent . |
game Manual Interstitial Slot Ready | Псевдоним для событий.gamemanualInterstitialSlotEdEvent . |
impression Viewable | Псевдоним для событий . ImpressionViewableEvent. |
rewarded Slot Closed | Псевдоним для событий . Rewardedslotclosevent. |
rewarded Slot Granted | Псевдоним для событий . RewardedSlotgrantedEvent. |
rewarded Slot Ready | Псевдоним для событий . |
slot Onload | Псевдоним для событий.slotonloadevent . |
slot Render Ended | Псевдоним для событий.slotrenderendendevent . |
slot Requested | Псевдоним для событий.slotrequestEvent . |
slot Response Received | Псевдоним для событий . |
slot Visibility Changed | Псевдоним для событий.slotvisibilityChangeDevent . |
Характеристики
GamemanualInterstitialSclotClotclotclotclotclotclot
gameManualInterstitialSlotClosed : GameManualInterstitialSlotClosedEvent
Псевдоним для событий.gamemanualInterstitialSlotClosCosedEvent .
GamemanualInterstialSlotredy
gameManualInterstitialSlotReady : GameManualInterstitialSlotReadyEvent
Псевдоним для событий.gamemanualInterstitialSlotEdEvent .
ImpressionViewable
impressionViewable : ImpressionViewableEvent
Псевдоним для событий . ImpressionViewableEvent.
вознаграждение
rewardedSlotClosed : RewardedSlotClosedEvent
Псевдоним для событий . Rewardedslotclosevent.
вознаграждение
rewardedSlotGranted : RewardedSlotGrantedEvent
Псевдоним для событий . RewardedSlotgrantedEvent.
reatedslotready
rewardedSlotReady : RewardedSlotReadyEvent
Псевдоним для событий .
Слотона
slotOnload : SlotOnloadEvent
Псевдоним для событий.slotonloadevent .
Slotrendered
slotRenderEnded : SlotRenderEndedEvent
Псевдоним для событий.slotrenderendendevent .
Слатроированная
slotRequested : SlotRequestedEvent
Псевдоним для событий.slotrequestEvent .
SlotResponsereceed
slotResponseReceived : SlotResponseReceived
Псевдоним для событий .
SlotvisibilityChanged
slotVisibilityChanged : SlotVisibilityChangedEvent
Псевдоним для событий.slotvisibilityChangeDevent .
googletag.events.gamemanualInterstitialSclotColosEvent
ExtendsПримечание. Руководство по игре Interstitial-это формат с ограниченным доступом .
Характеристики | |
---|---|
service Name | Название сервиса, которая вызвала событие. Унаследован от |
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 (Legacy)
// 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. } });
Машинопись
// 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.gamemanualInterstitialSlotEdEvent
ExtendsПримечание. Руководство по игре Interstitial-это формат с ограниченным доступом .
Характеристики | |
---|---|
service Name | Название сервиса, которая вызвала событие. Унаследован от |
slot | Слот, который вызвал событие. Унаследован от |
Методы | |
---|---|
make Game Manual Interstitial Visible | Отображает игровое ручное интерстициальное объявление пользователю. |
- Пример
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 (Legacy)
// 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. } });
Машинопись
// 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
googletag.events.ImpressionViewableEvent
ExtendsХарактеристики | |
---|---|
service Name | Название сервиса, которая вызвала событие. Унаследован от |
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 (Legacy)
// 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. } });
Машинопись
// 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.rewardedslotcloscoledevent
ExtendsХарактеристики | |
---|---|
service Name | Название сервиса, которая вызвала событие. Унаследован от |
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 (Legacy)
// 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. } });
Машинопись
// 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
ExtendsХарактеристики | |
---|---|
payload | Объект, содержащий информацию о вознаграждении, которая была предоставлена. |
service Name | Название сервиса, которая вызвала событие. Унаследован от |
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 (Legacy)
// 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. } });
Машинопись
// 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
ExtendsХарактеристики | |
---|---|
service Name | Название сервиса, которая вызвала событие. Унаследован от |
slot | Слот, который вызвал событие. Унаследован от |
Методы | |
---|---|
make Rewarded Visible | Отображает вознагражденную рекламу. |
- Пример
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 (Legacy)
// 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. } });
Машинопись
// 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. } });
Методы
MakereAwardedvisible
googletag.events.slotonloadevent
ExtendsSlotOnloadEvent
не будет запущен. Характеристики | |
---|---|
service Name | Название сервиса, которая вызвала событие. Унаследован от |
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 (Legacy)
// 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. } });
Машинопись
// 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. } });
- См. также
GOOGLEG.EVENTS.SlotrenderendendEvent
ExtendsХарактеристики | |
---|---|
advertiser Id | Рекламодатель идентификатор рендерированного объявления. |
campaign Id | Идентификатор кампании рендерированной рекламы. |
company Ids | Идентификаторы компаний, которые ставят предложение на рекламную рекламу. |
creative Id | Творческий идентификатор отображаемого бронирования объявления. |
creative Template Id | Творческий идентификатор шаблона рекламной рекламы. |
is Backfill | Была ли объявление рекламой засыпания. |
is Empty | Было ли было возвращено объявление для слота. |
label Ids | Идентификаторы маркировки рендерированной рекламы. |
line Item Id | Лидийный идентификатор позиции отображаемого бронирования объявления. |
service Name | Название сервиса, которая вызвала событие. Унаследован от |
size | Указывает размер пикселя визуализированного творчества. |
slot | Слот, который вызвал событие. Унаследован от |
slot Content Changed | Было ли изменено содержание слота с помощью рекламы. |
source Agnostic Creative Id | Творческий идентификатор оторваемого резервации или рекламы засыпания. |
source Agnostic Line Item Id | Линейный идентификатор позиции отображаемого бронирования или засыпания. |
yield Group Ids | Идентификаторы групп урожая для рендерированной рекламы засыпания. |
- Пример
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (Legacy)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
Машинопись
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- См. также
Характеристики
рекламодатель
advertiserId : null | number
Рекламодатель идентификатор рендерированного объявления. Значение является null
для пустых слотов, рекламы засыпания и креативщиков, предоставляемых другими услугами, кроме Pubadsservice .
Кампания
campaignId : null | number
Идентификатор кампании рендерированной рекламы. Значение является null
для пустых слотов, рекламы засыпания и креативщиков, предоставляемых другими услугами, кроме Pubadsservice .
Компании
companyIds : null | number []
Идентификаторы компаний, которые ставят предложение на рекламную рекламу. Стоимость является null
для пустых слотов, бронирования и креативщиков, предоставляемых другими услугами, кроме Pubadsservice .
CreativeId
creativeId : null | number
Творческий идентификатор отображаемого бронирования объявления. Значение является null
для пустых слотов, рекламы засыпания и креативщиков, предоставляемых другими услугами, кроме Pubadsservice .
CreativeTemplateId
creativeTemplateId : null | number
Творческий идентификатор шаблона рекламной рекламы. Значение является null
для пустых слотов, рекламы засыпания и креативщиков, предоставляемых другими услугами, кроме Pubadsservice .
isbackfill
isBackfill : boolean
Была ли объявление рекламой засыпания. Значение true
если объявление было рекламой засыпания, false
в противном случае.
isEmpty
isEmpty : boolean
Было ли было возвращено объявление для слота. Значение true
если объявление не было возвращено, в противном случае false
.
метки
labelIds : null | number []
Идентификаторы маркировки рендерированной рекламы. Значение является null
для пустых слотов, рекламы засыпания и креативщиков, предоставляемых другими услугами, кроме Pubadsservice .
LineItemid
lineItemId : null | number
Лидийный идентификатор позиции отображаемого бронирования объявления. Значение является null
для пустых слотов, рекламы засыпания и креативщиков, предоставляемых другими услугами, кроме Pubadsservice .
размер
size : null | string | number []
Указывает размер пикселя визуализированного творчества. Пример: [728, 90]
. Значение является null
для пустых рекламных слотов.
SlotContentChanged
slotContentChanged : boolean
Было ли изменено содержание слота с помощью рекламы. Значение true
если контент был изменен, false
в противном случае.
SourceAgnosticCreativeId
sourceAgnosticCreativeId : null | number
Творческий идентификатор оторваемого резервации или рекламы засыпания. Стоимость является null
, если объявление не является засыпкой для бронирования или строки, или творческий подход оказывается другими услугами, отличными от Pubadsservice .
SourceAgnosticlineItemid
sourceAgnosticLineItemId : null | number
Линейный идентификатор позиции отображаемого бронирования или засыпания. Стоимость является null
, если объявление не является засыпкой для бронирования или строки, или творческий подход оказывается другими услугами, отличными от Pubadsservice .
урожайность
yieldGroupIds : null | number []
Идентификаторы групп урожая для рендерированной рекламы засыпания. Стоимость является null
для пустых слотов, бронирования и креативщиков, предоставляемых другими услугами, кроме Pubadsservice .
Googletag.events.slotrequesteventevent
ExtendsХарактеристики | |
---|---|
service Name | Название сервиса, которая вызвала событие. Унаследован от |
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 (Legacy)
// 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. } });
Машинопись
// 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
ExtendsХарактеристики | |
---|---|
service Name | Название сервиса, которая вызвала событие. Унаследован от |
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 (Legacy)
// 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. } });
Машинопись
// 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.slotvisibilityChangangeDevent
ExtendsХарактеристики | |
---|---|
in View Percentage | Процент зоны объявления, который виден. |
service Name | Название сервиса, которая вызвала событие. Унаследован от |
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 (Legacy)
// 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. } });
Машинопись
// 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
Интерфейсы | |
---|---|
Bidder Signal Provider | Возвращает безопасный сигнал для конкретного участника. |
Publisher Signal Provider | Возвращает безопасный сигнал для конкретного издателя. |
Secure Signal Providers Array | Интерфейс для управления безопасными сигналами. |
Тип псевдонимов | |
---|---|
Secure Signal Provider | Интерфейс для возврата безопасного сигнала для конкретного участника участника или поставщика. |
Тип псевдонимов
SecuresignalProvider
SecureSignalProvider : BidderSignalProvider | PublisherSignalProvider
Интерфейс для возврата безопасного сигнала для конкретного участника участника или поставщика. Один из id
или networkCode
должен быть предоставлен, но не оба.
googletag.secureSignals.BidderSignalProvider
Поставщик защитных сигналов участника торгов состоит из 2 частей:
- Функция коллекционера, которая возвращает
Promise
, которое разрешается защищенным сигналом. -
id
, который идентифицирует участника, связанного с сигналом.
Характеристики | |
---|---|
collector Function | Функция, которая дает Promise , которое разрешается защищенным сигналом. |
id | Уникальный идентификатор для коллекционера, связанного с этим безопасным сигналом, зарегистрированным в Google Ad Manager. |
- Пример
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (Legacy)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
Машинопись
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
Характеристики
Коллекционное функция
collectorFunction : ( ( ) => Promise < string > )
Функция, которая дает Promise
, которое разрешается защищенным сигналом.
идентификатор
id : string
Уникальный идентификатор для коллекционера, связанного с этим безопасным сигналом, зарегистрированным в Google Ad Manager.
googletag.secureSignals.PublisherSignalProvider
Поставщик сигналов издателя состоит из 2 частей:
- Функция коллекционера, которая возвращает
Promise
, которое разрешается защищенным сигналом. -
networkCode
, который идентифицирует издателя, связанный с сигналом.
Характеристики | |
---|---|
collector Function | Функция, которая дает Promise , которое разрешается защищенным сигналом. |
network Code | Сетевой код (как видно в пути AD Unit) для издателя, связанного с этим безопасным сигналом. |
- Пример
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (Legacy)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
Машинопись
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
Характеристики
Коллекционное функция
collectorFunction : ( ( ) => Promise < string > )
Функция, которая дает Promise
, которое разрешается защищенным сигналом.
сетевой код
networkCode : string
Сетевой код (как видно в пути AD Unit) для издателя, связанного с этим безопасным сигналом.
googletag.secureSignals.SecureSignalProvidersArray
Методы | |
---|---|
clear All Cache | Очистит все сигналы для всех коллекционеров из кеша. |
push | Добавляет новый Securesignals.SecureSignalProvider в массив поставщика сигналов и начинает процесс генерации сигналов. |
Методы
clearallcache
clearAllCache ( ) : void
Очистит все сигналы для всех коллекционеров из кеша.
Призыв этого метода может снизить вероятность того, что сигналы будут включены в запросы на рекламу для текущих и потенциально более поздних представлений страниц. Из -за этого его следует вызывать только тогда, когда происходят значимые изменения состояния, такие как события, которые указывают нового пользователя (входите в систему, входите в систему, зарегистрированы и т. Д.).
толкать
push ( provider : SecureSignalProvider ) : void
Добавляет новый Securesignals.SecureSignalProvider в массив поставщика сигналов и начинает процесс генерации сигналов.
Параметры | |
---|---|
provider : SecureSignalProvider | Объект Securesignals.SecureSignalProvider , который будет добавлен в массив. |