В этом справочнике для описания типов используется нотация 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 — это оставшийся параметр , который принимает функции. Остальные параметры принимают неограниченное количество значений указанного типа. |
Определения типов
Типы | |
---|---|
| SingleSize | MultiSize |
Допустимая конфигурация размера для слота, которая может иметь один или несколько размеров. | |
| SingleSize [] |
Список отдельных допустимых размеров. | |
| "fluid" | ["fluid"] |
Именованные размеры, которые может иметь слот. В большинстве случаев размер представляет собой прямоугольник фиксированного размера, но в некоторых случаях нам нужны другие виды спецификаций размера. Допустимыми именованными размерами являются только следующие:
| |
| SingleSizeArray | NamedSize |
Единственный допустимый размер для слота. | |
| [number, number] |
Массив из двух чисел, представляющих [ширину, высоту]. | |
| [ SingleSizeArray , GeneralSize ] |
Сопоставление размера области просмотра с размерами объявлений. Используется для адаптивных объявлений. | |
| SizeMapping [] |
Список сопоставлений размеров. | |
| "unhideWindow" | "navBar" |
Поддерживаемые триггеры межстраничной рекламы. | |
| "disablePersonalization" |
Поддерживаемые меры конфиденциальности издателей. | |
| "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2" |
Поддерживаемые таксономии для сигналов, предоставленных издателем (PPS) . | |
| BidderSignalProvider | PublisherSignalProvider |
Интерфейс для возврата защищенного сигнала для конкретного участника торгов или поставщика. Необходимо указать один из |
Типы перечислений
Перечисления | |
---|---|
googletag . enums . OutOfPageFormat | Внестраничные форматы, поддерживаемые GPT. |
googletag . enums . TrafficSource | Источники трафика, поддерживаемые GPT. |
googletag . enums . OutOfPageFormat
Внестраничные форматы, поддерживаемые GPT.
- См. также
googletag . enums . TrafficSource
Источники трафика, поддерживаемые GPT.
- См. также
googletag
Глобальное пространство имен, которое тег издателя Google использует для своего API.
Сводка переменных | |
---|---|
apiReady | Флаг, указывающий, что API GPT загружен и готов к вызову. |
cmd | Ссылка на глобальную очередь команд для асинхронного выполнения вызовов, связанных с GPT. |
pubadsReady | Флаг, указывающий, что PubAdsService включен, загружен и полностью работоспособен. |
secureSignalProviders | Ссылка на массив поставщиков защищенных сигналов. |
Краткое описание функций | |
---|---|
companionAds | Возвращает ссылку на CompanionAdsService . |
defineOutOfPageSlot | Создает внестраничное рекламное место с заданным путем к рекламному блоку. |
defineSlot | Создает рекламное место с заданным путем и размером рекламного блока и связывает его с идентификатором элемента div на странице, которая будет содержать объявление. |
destroySlots | Уничтожает заданные слоты, удаляя все связанные объекты и ссылки на эти слоты из GPT. |
disablePublisherConsole | Отключает консоль издателя Google. |
display | Указывает службам слотов отображать слот. |
enableServices | Включает все службы GPT, определенные для рекламных мест на странице. |
getVersion | Возвращает текущую версию GPT. |
openConsole | Открывает консоль издателя Google. |
pubads | Возвращает ссылку на PubAdsService . |
setAdIframeTitle | Устанавливает заголовок для всех iframe рекламных контейнеров, созданных PubAdsService , начиная с этого момента. |
setConfig | Устанавливает общие параметры конфигурации страницы. |
sizeMapping | Создает новый SizeMappingBuilder . |
googletag . apiReady
apiReady: boolean | undefined
Флаг, указывающий, что API GPT загружен и готов к вызову. Это свойство будет просто
undefined
, пока API не будет готов.
Обратите внимание, что рекомендуемый способ обработки асинхронности — использовать googletag.cmd для постановки обратных вызовов в очередь, когда GPT будет готов. Эти обратные вызовы не должны проверять googletag.apiReady, поскольку они гарантированно выполняются после настройки API.- Пример
JavaScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
JavaScript (устаревший)
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
Машинопись
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
googletag . cmd
cmd: Array<(this: typeof globalThis) => void> | CommandArray
Ссылка на глобальную очередь команд для асинхронного выполнения вызовов, связанных с GPT.
Переменнаяgoogletag.cmd
инициализируется пустым массивом JavaScript с помощью синтаксиса тега GPT на странице, аcmd.push
— это стандартный методArray.push
, который добавляет элемент в конец массива. Когда GPT JavaScript загружается, он просматривает массив и выполняет все функции по порядку. Затем сценарий заменяетcmd
объектомCommandArray
, метод push которого определен для выполнения переданного ему аргумента функции. Этот механизм позволяет GPT сократить воспринимаемую задержку за счет асинхронной выборки JavaScript, позволяя браузеру продолжать обработку страницы.- Пример
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (устаревший)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
Машинопись
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
googletag . pubadsReady
pubadsReady: boolean | undefined
Флаг, указывающий, что
PubAdsService
включен, загружен и полностью работоспособен. Это свойство будет простоundefined
до тех пор, пока не будет вызванаenableServices
и не будет загружен и инициализированPubAdsService
.
googletag . secureSignalProviders
secureSignalProviders: SecureSignalProvider [] | SecureSignalProvidersArray | undefined
Ссылка на массив поставщиков защищенных сигналов.
Массив поставщиков безопасных сигналов принимает последовательность функций, генерирующих сигналы, и вызывает их по порядку. Он предназначен для замены стандартного массива, который используется для постановки в очередь функций, генерирующих сигналы, которые будут вызываться после загрузки GPT.- Пример
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (устаревший)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
Машинопись
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
- См. также
googletag . companionAds
companionAds(): CompanionAdsService
Возвращает ссылку на
CompanionAdsService
.Возврат CompanionAdsService
Служба сопутствующих объявлений.
googletag . defineOutOfPageSlot
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat ): Slot | null
Создает внестраничное рекламное место с заданным путем к рекламному блоку.
Для пользовательских внестраничных объявленийdiv
— это идентификатор элемента div, который будет содержать объявление. Более подробную информацию можно найти в статье о внестраничных креативах .
Для внестраничных объявлений, управляемых GPT,div
– это поддерживаемый формат OutOfPageFormat .- Пример
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (устаревший)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
Машинопись
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- См. также
Параметры adUnitPath: string
Полный путь к рекламному блоку с кодом сети и кодом рекламного блока.div?: string | OutOfPageFormat
Идентификатор div, который будет содержать этот рекламный блок или OutOfPageFormat.Возврат Slot | null
Вновь созданный слот илиnull
если слот невозможно создать.
googletag . defineSlot
defineSlot(adUnitPath: string, size: GeneralSize , div?: string): Slot | null
Создает рекламное место с заданным путем и размером рекламного блока и связывает его с идентификатором элемента div на странице, которая будет содержать объявление.
- Пример
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");
- См. также
Параметры adUnitPath: string
Полный путь рекламного блока с кодом сети и кодом объекта.size: GeneralSize
Ширина и высота добавляемого слота. Это размер, который используется в запросе объявления, если не указано адаптивное сопоставление размеров или размер области просмотра меньше наименьшего размера, указанного в сопоставлении.div?: string
Идентификатор div, который будет содержать этот рекламный блок.Возврат Slot | null
Вновь созданный слот илиnull
если слот невозможно создать.
googletag . destroySlots
destroySlots(slots?: Slot []): boolean
Уничтожает заданные слоты, удаляя все связанные объекты и ссылки на эти слоты из GPT. Этот API не поддерживает слоты возврата и сопутствующие рекламные места.
Вызов этого API для рекламного места очищает объявление и удаляет объект рекламного места из внутреннего состояния, поддерживаемого GPT. Вызов дополнительных функций для объекта слота приведет к неопределенному поведению. Обратите внимание, что браузер может по-прежнему не освобождать память, связанную с этим слотом, если ссылка на него поддерживается страницей издателя. Вызов этого API делает элемент div, связанный с этим слотом, доступным для повторного использования.
В частности, удаление рекламного места удаляет объявление из списка долгосрочных просмотров страниц GPT, поэтому на будущие запросы не будут влиять препятствия или конкурентные исключения, связанные с этим объявлением. Если вы не вызовете эту функцию перед удалением элемента div со страницы, это приведет к неопределенному поведению.- Пример
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript (устаревший)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
Машинопись
// 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();
Параметры slots?: Slot []
Массив слотов для уничтожения. Массив не является обязательным; все слоты будут уничтожены, если он не указан.Возврат boolean
true
, если слоты были уничтожены, в противном случаеfalse
.
googletag . disablePublisherConsole
disablePublisherConsole(): void
Отключает консоль издателя Google.
- См. также
googletag . display
display(divOrSlot: string | Element | Slot ): void
Указывает службам слотов отображать слот. Каждое рекламное место должно отображаться только один раз на странице. Перед отображением все слоты должны быть определены и иметь связанную с ними службу. Вызов отображения не должен происходить до тех пор, пока элемент не появится в DOM. Обычный способ добиться этого — поместить его в блок сценария внутри элемента div, указанного в вызове метода.
Если используется архитектура единого запроса (SRA), все невыбранные рекламные места на момент вызова этого метода будут выбраны одновременно. Чтобы рекламное место не отображалось, необходимо удалить весь элемент div.- Пример
JavaScript
googletag.cmd.push(() => { googletag.display("div-1"); });
JavaScript (устаревший)
googletag.cmd.push(function () { googletag.display("div-1"); });
Машинопись
googletag.cmd.push(() => { googletag.display("div-1"); });
- См. также
Параметры divOrSlot: string | Element | Slot
Либо идентификатор элемента div, содержащего рекламное место, либо элемент div, либо объект рекламного места. Если указан элемент div, он должен иметь атрибут «id», который соответствует идентификатору, переданному вdefineSlot
.
googletag . enableServices
enableServices(): void
Включает все службы GPT, определенные для рекламных мест на странице.
googletag . getVersion
getVersion(): string
Возвращает текущую версию GPT.
- См. также
Возврат string
Текущая исполняемая строка версии GPT.
googletag . openConsole
openConsole(div?: string): void
Открывает консоль издателя Google.
- Пример
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (устаревший)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
Машинопись
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- См. также
Параметры div?: string
Идентификатор div рекламного места. Это значение является необязательным. Если это предусмотрено, консоль издателя попытается открыться с подробной информацией об указанном рекламном месте.
googletag . pubads
pubads(): PubAdsService
Возвращает ссылку на
PubAdsService
.Возврат PubAdsService
Служба рекламы для издателей.
googletag . setAdIframeTitle
setAdIframeTitle(title: string): void
Устанавливает заголовок для всех iframe рекламных контейнеров, созданных
PubAdsService
, начиная с этого момента.- Пример
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (устаревший)
googletag.setAdIframeTitle("title");
Машинопись
googletag.setAdIframeTitle("title");
Параметры title: string
Новый заголовок для всех iframe рекламных контейнеров.
googletag . setConfig
setConfig(config: PageSettingsConfig ): void
Устанавливает общие параметры конфигурации страницы.
Параметры config: PageSettingsConfig
googletag . sizeMapping
sizeMapping(): SizeMappingBuilder
Создает новый
SizeMappingBuilder
.Возврат SizeMappingBuilder
Новый застройщик.
googletag . CommandArray
Массив команд принимает последовательность функций и вызывает их по порядку. Он предназначен для замены стандартного массива, который используется для постановки в очередь функций, которые будут вызываться после загрузки GPT.
Краткое описание метода | |
---|---|
push | Выполняет последовательность функций, указанных в аргументах, по порядку. |
push
push(...f: Array<(this: typeof globalThis) => void>): number
Выполняет последовательность функций, указанных в аргументах, по порядку.
- Пример
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (устаревший)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
Машинопись
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
Параметры ...f: Array<(this: typeof globalThis) => void>
Функция JavaScript, которую необходимо выполнить. Привязка времени выполнения всегда будетglobalThis
. Рассмотрите возможность передачи стрелочной функции, чтобы сохранить значениеthis
включающего лексического контекста.Возврат number
Количество команд, обработанных на данный момент. Это совместимо с возвращаемым значениемArray.push
(текущая длина массива).
googletag . CompanionAdsService
Продлевает срок Сервис сопутствующих объявлений. Эта услуга используется видеорекламой для показа сопутствующих объявлений.
Краткое описание метода | |
---|---|
addEventListener | Регистрирует прослушиватель, который позволяет вам настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. Унаследовано от |
getSlots | Получите список слотов, связанных с этим сервисом. Унаследовано от |
removeEventListener | Удаляет ранее зарегистрированный прослушиватель. Унаследовано от |
setRefreshUnfilledSlots | Определяет, будут ли незаполненные места для сопутствующих товаров заполняться автоматически. |
setRefreshUnfilledSlots
setRefreshUnfilledSlots(value: boolean): void
Определяет, будут ли незаполненные места для сопутствующих товаров заполняться автоматически.
Этот метод можно вызывать несколько раз в течение жизни страницы, чтобы включать и отключать обратное заполнение. Будут заполнены только те рекламные места, которые также зарегистрированы вPubAdsService
. Из-за ограничений политики этот метод не предназначен для заполнения пустых рекламных мест при показе видео Ad Exchange.- Пример
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (устаревший)
googletag.companionAds().setRefreshUnfilledSlots(true);
Машинопись
googletag.companionAds().setRefreshUnfilledSlots(true);
Параметры value: boolean
true
для автоматического заполнения незаполненных слотов иfalse
для того, чтобы оставить их без изменений.
googletag . PrivacySettingsConfig
Объект конфигурации для настроек конфиденциальности.
Сводная информация о недвижимости | |
---|---|
childDirectedTreatment | Указывает, следует ли рассматривать страницу как предназначенную для детей . |
limitedAds | Позволяет показывать рекламу в режиме ограниченного количества объявлений , что помогает издателям соблюдать нормативные требования. |
nonPersonalizedAds | Позволяет показывать рекламу в режиме неперсонализированной рекламы, что помогает издателям соблюдать нормативные требования. |
restrictDataProcessing | Позволяет выполнять обслуживание в ограниченном режиме обработки, что помогает издателям соблюдать нормативные требования. |
trafficSource | Указывает, представляют ли запросы купленный или органический трафик. |
underAgeOfConsent | Указывает, следует ли отмечать запросы объявлений как поступающие от пользователей , не достигших возраста согласия . |
- См. также
childDirectedTreatment
childDirectedTreatment: null | boolean
Указывает, следует ли рассматривать страницу как предназначенную для детей . Установите значение
null
, чтобы очистить конфигурацию.
limitedAds
limitedAds: boolean
Позволяет показывать рекламу в режиме ограниченного количества объявлений , что помогает издателям соблюдать нормативные требования.
Вы можете поручить GPT запрашивать ограниченную рекламу двумя способами:- Автоматически, используя сигнал платформы управления согласием IAB TCF v2.0 .
- Вручную, установив для этого поля значение
true
.
Обратите внимание: при использовании CMP нет необходимости вручную включать ограниченную рекламу.- Пример
JavaScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
JavaScript (устаревший)
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
Машинопись
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- См. также
nonPersonalizedAds
nonPersonalizedAds: boolean
Позволяет показывать рекламу в режиме неперсонализированной рекламы, что помогает издателям соблюдать нормативные требования.
restrictDataProcessing
restrictDataProcessing: boolean
Позволяет выполнять обслуживание в ограниченном режиме обработки, что помогает издателям соблюдать нормативные требования.
trafficSource
trafficSource: TrafficSource
Указывает, представляют ли запросы купленный или органический трафик. Это значение заполняет параметр «Источник трафика» в отчетах Менеджера рекламы. Если этот параметр не установлен, источник трафика по умолчанию
undefined
в отчетах.- Пример
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (устаревший)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
Машинопись
// 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, });
underAgeOfConsent
underAgeOfConsent: null | boolean
Указывает, следует ли отмечать запросы объявлений как поступающие от пользователей , не достигших возраста согласия . Установите значение
null
, чтобы очистить конфигурацию.
googletag . PubAdsService
Продлевает срок Сервис объявлений для издателей. Эта служба используется для получения и показа рекламы из вашего аккаунта Google Ad Manager.
Краткое описание метода | |
---|---|
addEventListener | Регистрирует прослушиватель, который позволяет вам настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. Унаследовано от |
clear | Удаляет рекламу из заданных слотов и заменяет ее пустым контентом. |
clearCategoryExclusions | Удаляет все метки исключения категорий объявлений на уровне страницы. |
clearTargeting | Очищает параметры специального таргетинга для определенного ключа или для всех ключей. |
collapseEmptyDivs | Включает свертывание блоков div, чтобы они не занимали места на странице, когда нет рекламного контента для отображения. |
disableInitialLoad | Отключает запросы рекламы при загрузке страницы, но позволяет запрашивать рекламу с помощью вызова PubAdsService.refresh . |
display | Создает и отображает рекламное место с заданным путем и размером рекламного блока. |
enableLazyLoad | Включает отложенную загрузку в GPT, как определено объектом конфигурации. |
enableSingleRequest | Включает режим единого запроса для одновременного получения нескольких объявлений. |
enableVideoAds | Сигнализирует GPT о том, что на странице будет присутствовать видеореклама. |
get | Возвращает значение атрибута AdSense, связанного с данным ключом. |
getAttributeKeys | Возвращает ключи атрибутов, которые были установлены для этой службы. |
getSlots | Получите список слотов, связанных с этим сервисом. Унаследовано от |
getTargeting | Возвращает определенный заданный параметр таргетинга на уровне обслуживания. |
getTargetingKeys | Возвращает список всех установленных ключей таргетинга настраиваемого уровня обслуживания. |
isInitialLoadDisabled | Возвращает, были ли первоначальные запросы объявлений успешно отключены предыдущим вызовом PubAdsService.disableInitialLoad . |
refresh | Получает и отображает новые объявления для определенных или всех рекламных мест на странице. |
removeEventListener | Удаляет ранее зарегистрированный прослушиватель. Унаследовано от |
set | Устанавливает значения атрибутов AdSense, которые применяются ко всем рекламным местам в рамках службы «Реклама издателя». |
setCategoryExclusion | Устанавливает исключение категории объявлений на уровне страницы для данного названия ярлыка. |
setCentering | Включает и отключает горизонтальное центрирование объявлений. |
setForceSafeFrame | Определяет, должны ли все объявления на странице принудительно отображаться с использованием контейнера SafeFrame. |
setLocation | Передаёт информацию о местоположении с веб-сайтов, чтобы вы могли нацелить позиции на определенные местоположения. |
setPrivacySettings | Позволяет настраивать все параметры конфиденциальности из одного API с помощью объекта конфигурации. |
setPublisherProvidedId | Устанавливает значение идентификатора, предоставленного издателем. |
setSafeFrameConfig | Устанавливает настройки уровня страницы для конфигурации SafeFrame. |
setTargeting | Устанавливает параметры пользовательского таргетинга для данного ключа, которые применяются ко всем рекламным местам службы Publisher Ads. |
setVideoContent | Устанавливает информацию о видеоконтенте, которая будет отправляться вместе с запросами объявлений для целей таргетинга и исключения контента. |
updateCorrelator | Изменяет коррелятор, отправляемый с запросами объявлений, фактически запуская новый просмотр страницы. |
clear
clear(slots?: Slot []): boolean
Удаляет рекламу из заданных слотов и заменяет ее пустым контентом. Слоты будут помечены как невыбранные.
В частности, очистка слота удаляет объявление из списка долгосрочных просмотров страниц GPT, поэтому на будущие запросы не будут влиять препятствия или конкурентные исключения, связанные с этим объявлением.- Пример
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript (устаревший)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
Машинопись
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();
Параметры slots?: Slot []
Массив слотов, которые необходимо очистить. Массив не является обязательным; все слоты будут очищены, если он не указан.Возврат boolean
Возвращаетtrue
, если слоты были очищены,false
в противном случае.
clearCategoryExclusions
clearCategoryExclusions(): PubAdsService
Удаляет все метки исключения категорий объявлений на уровне страницы. Это полезно, если вы хотите обновить слот.
- Пример
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (устаревший)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
Машинопись
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
- См. также
Возврат PubAdsService
Объект службы, для которого был вызван метод.
clearTargeting
clearTargeting(key?: string): PubAdsService
Очищает параметры специального таргетинга для определенного ключа или для всех ключей.
- Пример
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript (устаревший)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
Машинопись
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- См. также
Параметры key?: string
Ключ параметра таргетинга. Ключ не является обязательным; все параметры таргетинга будут удалены, если они не указаны.Возврат PubAdsService
Объект службы, для которого был вызван метод.
collapseEmptyDivs
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
Включает свертывание блоков div, чтобы они не занимали места на странице, когда нет рекламного контента для отображения. Этот режим необходимо установить до включения службы.
Параметры collapseBeforeAdFetch?: boolean
Сворачивать ли рекламные места еще до того, как будет получена реклама. Этот параметр является необязательным; если не указано, в качестве значения по умолчанию будет использоватьсяfalse
.Возврат boolean
Возвращаетtrue
, если режим свертывания div был включен, иfalse
, если включить режим свертывания невозможно, поскольку метод был вызван после включения службы.
disableInitialLoad
disableInitialLoad(): void
Отключает запросы рекламы при загрузке страницы, но позволяет запрашивать рекламу с помощью вызова
PubAdsService.refresh
. Это должно быть установлено до включения службы. Необходимо использовать асинхронный режим; в противном случае будет невозможно запросить рекламу с помощьюrefresh
.
display
display(adUnitPath: string, size: GeneralSize , div?: string | Element, clickUrl?: string): void
Создает и отображает рекламное место с заданным путем и размером рекламного блока. Этот метод не работает в режиме единого запроса.
Примечание. При вызове этого метода создается снимок состояния рекламного места и страницы, чтобы обеспечить согласованность при отправке запроса объявления и обработке ответа. Любые изменения, внесенные в состояние слота или страницы после вызова этого метода (включая таргетинг, настройки конфиденциальности, принудительное использование SafeFrame и т. д.), будут применяться только к последующим запросамdisplay()
илиrefresh()
.- Пример
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (устаревший)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
Машинопись
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
- См. также
Параметры adUnitPath: string
Путь рекламного блока к отображаемому месту.size: GeneralSize
Ширина и высота прорези.div?: string | Element
Либо идентификатор div, содержащего слот, либо сам элемент div.clickUrl?: string
URL-адрес клика для использования в этом слоте.
enableLazyLoad
enableLazyLoad(config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }): void
Включает отложенную загрузку в GPT, как определено объектом конфигурации. Более подробные примеры см. в примере отложенной загрузки .
Примечание. Отложенная выборка в SRA работает только в том случае, если все слоты находятся за пределами выборки.- Пример
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (устаревший)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
Машинопись
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, });
- См. также
Параметры config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
Объект конфигурации позволяет настраивать ленивое поведение. Любые пропущенные конфигурации будут использовать настройки Google по умолчанию, которые со временем будут корректироваться. Чтобы отключить определенный параметр, например поле выборки, установите значение-1
.-
fetchMarginPercent
Минимальное расстояние от текущей области просмотра, на котором должно быть место, прежде чем мы получим объявление в процентах от размера области просмотра. Значение 0 означает «когда рекламное место попадает в область просмотра», 100 означает «когда реклама находится на расстоянии 1 области просмотра» и так далее. -
renderMarginPercent
Минимальное расстояние от текущей области просмотра, на котором должно быть место, прежде чем мы сможем отобразить объявление. Это позволяет предварительно загрузить объявление, но ожидать обработки и загрузки других подресурсов. Значение работает так же, как иfetchMarginPercent
в процентах от области просмотра. -
mobileScaling
Множитель, применяемый к марже на мобильных устройствах. Это позволяет варьировать прибыль на мобильных устройствах и настольных компьютерах. Например, значение 2,0 умножит все поля на 2 на мобильных устройствах, увеличивая минимальное расстояние, которое может находиться слот перед выборкой и рендерингом.
-
enableSingleRequest
enableSingleRequest(): boolean
Включает режим единого запроса для одновременного получения нескольких объявлений. Для этого необходимо, чтобы все рекламные места издателя были определены и добавлены в PubAdsService до включения службы. Режим единого запроса должен быть установлен до включения услуги.
Возврат boolean
Возвращаетtrue
, если режим единого запроса был включен, иfalse
, если включить режим единого запроса невозможно, поскольку метод был вызван после включения службы.
enableVideoAds
enableVideoAds(): void
Сигнализирует GPT о том, что на странице будет присутствовать видеореклама. Это включает ограничения конкурентного исключения для медийной и видеорекламы. Если видеоконтент известен, вызовите
PubAdsService.setVideoContent
, чтобы иметь возможность использовать исключение контента для медийной рекламы.
get
get(key: string): null | string
Возвращает значение атрибута AdSense, связанного с данным ключом.
- Пример
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (устаревший)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
Машинопись
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- См. также
Параметры key: string
Имя атрибута, который требуется найти.Возврат null | string
Текущее значение ключа атрибута илиnull
, если ключ отсутствует.
getAttributeKeys
getAttributeKeys(): string[]
Возвращает ключи атрибутов, которые были установлены для этой службы.
- Пример
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (устаревший)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
Машинопись
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
Возврат string[]
Массив ключей атрибутов, установленных в этом сервисе. Порядок не определен.
getTargeting
getTargeting(key: string): string[]
Возвращает определенный заданный параметр таргетинга на уровне обслуживания.
- Пример
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript (устаревший)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
Машинопись
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
Параметры key: string
Ключ таргетинга, который нужно искать.Возврат string[]
Значения, связанные с этим ключом, или пустой массив, если такого ключа нет.
getTargetingKeys
getTargetingKeys(): string[]
Возвращает список всех установленных ключей таргетинга настраиваемого уровня обслуживания.
- Пример
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
JavaScript (устаревший)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
Машинопись
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
Возврат string[]
Массив ключей таргетинга. Порядок не определен.
isInitialLoadDisabled
isInitialLoadDisabled(): boolean
Возвращает, были ли первоначальные запросы объявлений успешно отключены предыдущим вызовом
PubAdsService.disableInitialLoad
.Возврат boolean
Возвращаетtrue
, если предыдущий вызовPubAdsService.disableInitialLoad
был успешным, в противном случае —false
.
refresh
refresh(slots?: null | Slot [], options?: { changeCorrelator: boolean }): void
Получает и отображает новые объявления для определенных или всех рекламных мест на странице. Работает только в режиме асинхронного рендеринга.
Для правильного поведения во всех браузерах вызовуrefresh
должен предшествовать вызов дляdisplay
рекламного места. Если вызовdisplay
опущен, обновление может вести себя неожиданно. При желании можно использовать методPubAdsService.disableInitialLoad
, чтобы запретитьdisplay
рекламы.
Обновление рекламного места удаляет старое объявление из списка долгоживущих просмотров страниц GPT, поэтому на будущие запросы не будут влиять препятствия или конкурентные исключения, связанные с этим объявлением.- Пример
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (устаревший)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
Машинопись
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 });
- См. также
Параметры slots?: null | Slot []
Слоты для обновления. Массив не является обязательным; все слоты будут обновлены, если он не указан.options?: { changeCorrelator: boolean }
Параметры конфигурации, связанные с этим вызовом обновления.-
changeCorrelator
Указывает, следует ли создавать новый коррелятор для получения рекламы. Наши рекламные серверы кратковременно поддерживают это значение коррелятора (в настоящее время в течение 30 секунд, но могут быть изменены), поэтому запросы с одним и тем же коррелятором, полученные близко друг к другу, будут считаться просмотром одной страницы. По умолчанию новый коррелятор создается для каждого обновления.
Примечание. Этот параметр не влияет на долгосрочный просмотр страниц GPT, который автоматически отражает объявления, находящиеся на странице в данный момент, и не имеет срока действия.
-
set
set(key: string, value: string): PubAdsService
Устанавливает значения атрибутов AdSense, которые применяются ко всем рекламным местам в рамках службы «Реклама издателя».
Вызов этого более одного раза для одного и того же ключа приведет к переопределению ранее установленных значений для этого ключа. Все значения должны быть установлены перед вызовомdisplay
илиrefresh
.- Пример
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (устаревший)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
Машинопись
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- См. также
Параметры key: string
Имя атрибута.value: string
Значение атрибута.Возврат PubAdsService
Объект службы, для которого был вызван метод.
setCategoryExclusion
setCategoryExclusion(categoryExclusion: string): PubAdsService
Устанавливает исключение категории объявлений на уровне страницы для данного названия ярлыка.
- Пример
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (устаревший)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
Машинопись
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- См. также
Параметры categoryExclusion: string
Добавляемый ярлык исключения категории объявлений.Возврат PubAdsService
Объект службы, для которого был вызван метод.
setCentering
setCentering(centerAds: boolean): void
Включает и отключает горизонтальное центрирование объявлений. Центрирование отключено по умолчанию. В устаревшем gpt_mobile.js центрирование включено по умолчанию.
Этот метод следует вызывать перед вызовомdisplay
илиrefresh
поскольку центрироваться будут только объявления, запрошенные после вызова этого метода.- Пример
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (устаревший)
// Make ads centered. googletag.pubads().setCentering(true);
Машинопись
// Make ads centered. googletag.pubads().setCentering(true);
Параметры centerAds: boolean
true
для центрирования объявлений,false
для их выравнивания по левому краю.
setForceSafeFrame
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
Определяет, должны ли все объявления на странице принудительно отображаться с использованием контейнера SafeFrame.
При использовании этого API помните следующее:- Эта настройка вступит в силу только для последующих запросов объявлений, сделанных для соответствующих рекламных мест.
- Параметр уровня слота, если он указан, всегда будет иметь приоритет над параметром уровня страницы.
- Если установлено значение
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");
- См. также
Параметры forceSafeFrame: boolean
Значениеtrue
, чтобы все объявления на странице отображались в SafeFrames, иfalse
, чтобы изменить предыдущую настройку на false. Установка значенияfalse
, если оно не указано ранее, ничего не изменит.Возврат PubAdsService
Объект службы, для которого была вызвана функция.
setLocation
setLocation(address: string): PubAdsService
Передаёт информацию о местоположении с веб-сайтов, чтобы вы могли нацелить позиции на определенные местоположения.
- Пример
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (устаревший)
// Postal code: googletag.pubads().setLocation("10001,US");
Машинопись
// Postal code: googletag.pubads().setLocation("10001,US");
Параметры address: string
Адрес в свободной форме.Возврат PubAdsService
Объект службы, для которого был вызван метод.
setPrivacySettings
setPrivacySettings(privacySettings: PrivacySettingsConfig ): PubAdsService
Позволяет настраивать все параметры конфиденциальности из одного API с помощью объекта конфигурации.
- Пример
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript (устаревший)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
Машинопись
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- См. также
Параметры privacySettings: PrivacySettingsConfig
Объект, содержащий конфигурацию настроек конфиденциальности.Возврат PubAdsService
Объект службы, для которого была вызвана функция.
setPublisherProvidedId
setPublisherProvidedId(ppid: string): PubAdsService
Устанавливает значение идентификатора, предоставленного издателем.
- Пример
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (устаревший)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
Машинопись
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- См. также
Параметры ppid: string
Буквенно-цифровой идентификатор, предоставленный издателем. Должно быть от 32 до 150 символов.Возврат PubAdsService
Объект службы, для которого был вызван метод.
setSafeFrameConfig
setSafeFrameConfig(config: SafeFrameConfig ): PubAdsService
Устанавливает настройки уровня страницы для конфигурации SafeFrame. Любые нераспознанные ключи в объекте конфигурации будут игнорироваться. Вся конфигурация будет проигнорирована, если для распознанного ключа будет передано недопустимое значение.
Эти настройки на уровне страницы будут переопределяться настройками на уровне рекламного места, если они указаны.- Пример
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (устаревший)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
Машинопись
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- См. также
Параметры config: SafeFrameConfig
Объект конфигурации.Возврат PubAdsService
Объект службы, для которого был вызван метод.
setTargeting
setTargeting(key: string, value: string | string[]): PubAdsService
Устанавливает параметры пользовательского таргетинга для данного ключа, которые применяются ко всем рекламным местам службы Publisher Ads. Вызов этого несколько раз для одного и того же ключа приведет к перезаписи старых значений. Эти ключи определены в вашем аккаунте Google Ad Manager.
- Пример
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"]);
- См. также
Параметры key: string
Ключ параметра таргетинга.value: string | string[]
Значение параметра таргетинга или массив значений.Возврат PubAdsService
Объект службы, для которого был вызван метод.
setVideoContent
setVideoContent(videoContentId: string, videoCmsId: string): void
Устанавливает информацию о видеоконтенте, которая будет отправляться вместе с запросами объявлений для целей таргетинга и исключения контента. Видеореклама будет автоматически включена при вызове этого метода. Для
videoContentId
иvideoCmsId
используйте значения, предоставленные службе приема контента Google Ad Manager.Параметры videoContentId: string
Идентификатор видеоконтента.videoCmsId: string
Идентификатор видео CMS.
updateCorrelator
updateCorrelator(): PubAdsService
Изменяет коррелятор, отправляемый с запросами объявлений, фактически запуская новый просмотр страницы. Коррелятор одинаков для всех запросов объявлений, поступающих при одном просмотре страницы, и уникален для всех просмотров страниц. Применяется только к асинхронному режиму.
Примечание. Это не влияет на долгосрочный просмотр страниц GPT, который автоматически отображает фактические объявления на странице и не имеет срока действия.- Пример
JavaScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
JavaScript (устаревший)
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
Машинопись
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
Возврат PubAdsService
Объект службы, для которого была вызвана функция.
googletag . ResponseInformation
Объект, представляющий один ответ на объявление.
Сводная информация о недвижимости | |
---|---|
advertiserId | Идентификатор рекламодателя. |
campaignId | Идентификатор кампании. |
creativeId | Идентификатор объявления. |
creativeTemplateId | Идентификатор шаблона объявления. |
lineItemId | Идентификатор позиции. |
- См. также
advertiserId
advertiserId: null | number
Идентификатор рекламодателя.
campaignId
campaignId: null | number
Идентификатор кампании.
creativeId
creativeId: null | number
Идентификатор объявления.
creativeTemplateId
creativeTemplateId: null | number
Идентификатор шаблона объявления.
lineItemId
lineItemId: null | number
Идентификатор позиции.
googletag . RewardedPayload
Объект, представляющий вознаграждение, связанное с объявлением с вознаграждением.
Сводная информация о недвижимости | |
---|---|
amount | Количество предметов, входящих в награду. |
type | Тип предмета, входящего в награду (например, «монета»). |
- См. также
amount
amount: number
Количество предметов, входящих в награду.
type
type: string
Тип предмета, входящего в награду (например, «монета»).
googletag . SafeFrameConfig
Объект конфигурации для контейнеров SafeFrame .
Сводная информация о недвижимости | |
---|---|
allowOverlayExpansion | Должен ли SafeFrame разрешать расширение рекламного контента за счет наложения содержимого страницы. |
allowPushExpansion | Должен ли SafeFrame разрешать расширение рекламного контента за счет перемещения содержимого страницы. |
sandbox | Следует ли SafeFrame использовать атрибут песочницы HTML5, чтобы предотвратить навигацию верхнего уровня без взаимодействия с пользователем. |
useUniqueDomain | Устарело. Следует ли SafeFrame использовать случайные субдомены для креативов с резервированием. |
- См. также
allowOverlayExpansion
allowOverlayExpansion: boolean
Должен ли SafeFrame разрешать расширение рекламного контента за счет наложения содержимого страницы.
allowPushExpansion
allowPushExpansion: boolean
Должен ли SafeFrame разрешать расширение рекламного контента за счет перемещения содержимого страницы.
sandbox
sandbox: boolean
Следует ли SafeFrame использовать атрибут песочницы HTML5, чтобы предотвратить навигацию верхнего уровня без взаимодействия с пользователем. Единственное допустимое значение —
true
(невозможно принудительно установить значениеfalse
). Обратите внимание, что атрибут песочницы отключает плагины (например, Flash).
useUniqueDomain
useUniqueDomain: null | boolean
Следует ли SafeFrame использовать случайные субдомены для креативов с резервированием. Передайте
null
, чтобы очистить сохраненное значение.
Примечание: эта функция включена по умолчанию.- См. также
googletag . Service
Базовый класс службы, содержащий методы, общие для всех служб.
Краткое описание метода | |
---|---|
addEventListener | Регистрирует прослушиватель, который позволяет вам настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. |
getSlots | Получите список слотов, связанных с этим сервисом. |
removeEventListener | Удаляет ранее зарегистрированный прослушиватель. |
addEventListener
addEventListener<K extends keyof EventTypeMap >(eventType: K, listener: (arg: EventTypeMap [K]) => void): Service
Регистрирует прослушиватель, который позволяет вам настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. Поддерживаются следующие события:
Объект соответствующего типа события передается прослушивателю при его вызове.- Пример
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. } });
- См. также
Параметры eventType: K
Строка, представляющая тип события, созданного GPT. Типы событий чувствительны к регистру.listener: (arg: EventTypeMap [K]) => void
Функция, принимающая один аргумент объекта события.Возврат Service
Объект службы, для которого был вызван метод.
getSlots
removeEventListener
removeEventListener<K extends keyof EventTypeMap >(eventType: K, listener: (event: EventTypeMap [K]) => void): void
Удаляет ранее зарегистрированный прослушиватель.
- Пример
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (устаревший)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
Машинопись
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
Параметры eventType: K
Строка, представляющая тип события, созданного GPT. Типы событий чувствительны к регистру.listener: (event: EventTypeMap [K]) => void
Функция, принимающая один аргумент объекта события.
googletag . SizeMappingBuilder
Построитель объектов спецификации сопоставления размеров. Этот конструктор предназначен для облегчения создания спецификаций размеров.
Краткое описание метода | |
---|---|
addSize | Добавляет сопоставление массива одного размера (представляющего область просмотра) с массивом одного или нескольких размеров, представляющим слот. |
build | Создает спецификацию карты размеров на основе сопоставлений, добавленных в этот построитель. |
addSize
addSize(viewportSize: SingleSizeArray , slotSize: GeneralSize ): SizeMappingBuilder
Добавляет сопоставление массива одного размера (представляющего область просмотра) с массивом одного или нескольких размеров, представляющим слот.
- Пример
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (устаревший)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 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]
Параметры viewportSize: SingleSizeArray
Размер области просмотра для этой записи сопоставления.slotSize: GeneralSize
Размеры слота для этой записи сопоставления.Возврат SizeMappingBuilder
Ссылка на этого застройщика.
build
build(): null | SizeMappingArray
Создает спецификацию карты размеров на основе сопоставлений, добавленных в этот построитель.
Если были предоставлены какие-либо недопустимые сопоставления, этот метод вернетnull
. В противном случае он возвращает спецификацию в правильном формате для передачи вSlot.defineSizeMapping
.
Примечание: поведение строителя после вызова этого метода не определено.Возврат null | SizeMappingArray
Результат, построенный этим строителем. Может иметь значение null, если были предоставлены недопустимые сопоставления размеров.
googletag . Slot
Slot – это объект, представляющий одно рекламное место на странице.
Краткое описание метода | |
---|---|
addService | Добавляет Service в этот слот. |
clearCategoryExclusions | Удаляет все метки исключения категорий объявлений на уровне рекламного места для этого рекламного места. |
clearTargeting | Удаляет определенные или все специальные параметры таргетинга на уровне рекламного места для этого рекламного места. |
defineSizeMapping | Устанавливает массив сопоставлений от минимального размера области просмотра до размера слота для этого слота. |
get | Возвращает значение атрибута AdSense, связанного с данным ключом для этого рекламного места. |
getAdUnitPath | Возвращает полный путь к рекламному блоку, включая код сети и путь к рекламному блоку. |
getAttributeKeys | Возвращает список ключей атрибутов, установленных в этом слоте. |
getCategoryExclusions | Возвращает метки исключения категорий объявлений для этого рекламного места. |
getResponseInformation | Возвращает информацию об ответе на объявление. |
getSlotElementId | Возвращает идентификатор элемента div слота, указанный при определении слота. |
getTargeting | Возвращает определенный параметр специального таргетинга, установленный в этом слоте. |
getTargetingKeys | Возвращает список всех ключей пользовательского таргетинга, установленных в этом слоте. |
set | Устанавливает значение атрибута AdSense для этого рекламного места. |
setCategoryExclusion | Устанавливает для этого места метку исключения категории объявлений на уровне рекламного места. |
setClickUrl | Устанавливает URL-адрес клика, на который будут перенаправлены пользователи после нажатия на объявление. |
setCollapseEmptyDiv | Определяет, следует ли скрывать элемент div рекламного места, если в нем нет рекламы. |
setConfig | Устанавливает общие параметры конфигурации для этого слота. |
setForceSafeFrame | Определяет, должны ли объявления в этом слоте принудительно отображаться с использованием контейнера SafeFrame. |
setSafeFrameConfig | Устанавливает настройки уровня слота для конфигурации SafeFrame. |
setTargeting | Устанавливает специальный параметр таргетинга для этого рекламного места. |
updateTargetingFromMap | Устанавливает параметры специального таргетинга для этого слота на основе сопоставления «ключ:значение» в объекте JSON. |
addService
Добавляет
Service
в этот слот.- Пример
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (устаревший)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
Машинопись
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- См. также
Параметры service: Service
Сервис, который необходимо добавить.Возврат Slot
Объект слота, для которого был вызван метод.
clearCategoryExclusions
clearCategoryExclusions(): Slot
Удаляет все метки исключения категорий объявлений на уровне рекламного места для этого рекламного места.
- Пример
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript (устаревший)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
Машинопись
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
Возврат Slot
Объект слота, для которого был вызван метод.
clearTargeting
clearTargeting(key?: string): Slot
Удаляет определенные или все специальные параметры таргетинга на уровне рекламного места для этого рекламного места.
- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (устаревший)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
Машинопись
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.
- См. также
Параметры key?: string
Ключ параметра таргетинга. Ключ не является обязательным; все параметры таргетинга будут удалены, если они не указаны.Возврат Slot
Объект слота, для которого был вызван метод.
defineSizeMapping
defineSizeMapping(sizeMapping: SizeMappingArray ): Slot
Устанавливает массив сопоставлений от минимального размера области просмотра до размера слота для этого слота.
- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
JavaScript (устаревший)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping!);
- См. также
Параметры sizeMapping: SizeMappingArray
Массив сопоставлений размеров. Для его создания вы можете использоватьSizeMappingBuilder
. Каждое сопоставление размеров представляет собой массив из двух элементов:SingleSizeArray
иGeneralSize
.Возврат Slot
Объект слота, для которого был вызван метод.
get
get(key: string): null | string
Возвращает значение атрибута AdSense, связанного с данным ключом для этого рекламного места. Чтобы просмотреть атрибуты уровня обслуживания, унаследованные этим слотом, используйте
PubAdsService.get
.- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (устаревший)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- См. также
Параметры key: string
Имя атрибута, который требуется найти.Возврат null | string
Текущее значение ключа атрибута илиnull
, если ключ отсутствует.
getAdUnitPath
getAdUnitPath(): string
Возвращает полный путь к рекламному блоку, включая код сети и путь к рекламному блоку.
- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (устаревший)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
Возврат string
Путь к рекламному блоку.
getAttributeKeys
getAttributeKeys(): string[]
Возвращает список ключей атрибутов, установленных в этом слоте. Чтобы просмотреть ключи атрибутов уровня обслуживания, унаследованные этим слотом, используйте
PubAdsService.getAttributeKeys
.- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (устаревший)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
Возврат string[]
Массив ключей атрибутов. Порядок не определен.
getCategoryExclusions
getCategoryExclusions(): string[]
Возвращает метки исключения категорий объявлений для этого рекламного места.
- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (устаревший)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
Возврат string[]
Ярлыки исключения категорий объявлений для этого места или пустой массив, если они не заданы.
getResponseInformation
getResponseInformation(): null | ResponseInformation
Возвращает информацию об ответе на объявление. Это основано на последнем ответе на объявление для данного рекламного места. Если это вызывается, когда в рекламном месте нет рекламы, будет возвращено
null
.Возврат null | ResponseInformation
Самая последняя информация об ответах на рекламу илиnull
, если в рекламном месте нет рекламы.
getSlotElementId
getSlotElementId(): string
Возвращает идентификатор элемента
div
слота, указанный при определении слота.- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
JavaScript (устаревший)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
Возврат string
Идентификаторdiv
слота.
getTargeting
getTargeting(key: string): string[]
Возвращает определенный параметр специального таргетинга, установленный в этом слоте. Параметры таргетинга на уровне обслуживания не включены.
- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript (устаревший)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
Параметры key: string
Ключ таргетинга, который нужно искать.Возврат string[]
Значения, связанные с этим ключом, или пустой массив, если такого ключа нет.
getTargetingKeys
getTargetingKeys(): string[]
Возвращает список всех ключей пользовательского таргетинга, установленных в этом слоте. Ключи таргетинга на уровне обслуживания не включены.
- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript (устаревший)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
Возврат string[]
Массив ключей таргетинга. Порядок не определен.
set
set(key: string, value: string): Slot
Устанавливает значение атрибута AdSense для этого рекламного места. Это переопределит любые значения, установленные на уровне обслуживания для этого ключа.
Вызов этого метода более одного раза для одного и того же ключа приведет к переопределению ранее установленных значений для этого ключа. Все значения должны быть установлены перед вызовомdisplay
илиrefresh
.- Пример
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript (устаревший)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
Машинопись
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- См. также
Параметры key: string
Имя атрибута.value: string
Значение атрибута.Возврат Slot
Объект слота, для которого был вызван метод.
setCategoryExclusion
setCategoryExclusion(categoryExclusion: string): Slot
Устанавливает для этого места метку исключения категории объявлений на уровне рекламного места.
- Пример
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (устаревший)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
Машинопись
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
- См. также
Параметры categoryExclusion: string
Добавляемый ярлык исключения категории объявлений.Возврат Slot
Объект слота, для которого был вызван метод.
setClickUrl
setClickUrl(value: string): Slot
Устанавливает URL-адрес клика, на который будут перенаправлены пользователи после нажатия на объявление.
Серверы Google Ad Manager по-прежнему регистрируют клик, даже если URL клика заменен. Любой URL целевой страницы, связанный с отображаемым креативом, добавляется к указанному значению. Последующие вызовы перезаписывают значение. Это работает только для запросов без SRA.- Пример
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (устаревший)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
Машинопись
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
Параметры value: string
URL-адрес клика, который нужно установить.Возврат Slot
Объект слота, для которого был вызван метод.
setCollapseEmptyDiv
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
Определяет, следует ли скрывать элемент
div
рекламного места, если в нем нет рекламы. Это переопределяет настройки уровня обслуживания.- Пример
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (устаревший)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
Машинопись
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- См. также
Параметры collapse: boolean
Свернуть ли рекламное место, если реклама не возвращается.collapseBeforeAdFetch?: boolean
Следует ли свернуть рекламное место еще до того, как будет получено объявление. Игнорируется, если коллапс неtrue
.Возврат Slot
Объект слота, для которого был вызван метод.
setConfig
setConfig(slotConfig: SlotSettingsConfig ): void
Устанавливает общие параметры конфигурации для этого слота.
Параметры slotConfig: SlotSettingsConfig
Объект конфигурации.
setForceSafeFrame
setForceSafeFrame(forceSafeFrame: boolean): Slot
Определяет, должны ли объявления в этом слоте принудительно отображаться с использованием контейнера SafeFrame.
При использовании этого API помните следующее:- Эта настройка вступит в силу только для последующих запросов объявлений, сделанных для соответствующих рекламных мест.
- Параметр уровня слота, если он указан, всегда будет иметь приоритет над параметром уровня страницы.
- Если установлено значение
true
(на уровне рекламного места или страницы), объявление всегда будет отображаться с использованием контейнера SafeFrame независимо от выбора, сделанного в пользовательском интерфейсе Google Ad Manager. - Однако, если установлено значение
false
или не указано, объявление будет отображаться с использованием контейнера SafeFrame в зависимости от типа объявления и выбора, сделанного в пользовательском интерфейсе Google Ad Manager. - Этот API следует использовать с осторожностью, поскольку он может повлиять на поведение креативов, которые пытаются выйти за пределы своих iFrame или полагаются на их отображение непосредственно на странице издателя.
- Пример
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (устаревший)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
Машинопись
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
- См. также
Параметры forceSafeFrame: boolean
Значениеtrue
, чтобы все объявления в этом слоте отображались в SafeFrames, иfalse
, чтобы отказаться от настройки на уровне страницы (если она имеется). Установка значенияfalse
, если оно не указано на уровне страницы, ничего не изменит.Возврат Slot
Объект слота, для которого был вызван метод.
setSafeFrameConfig
setSafeFrameConfig(config: null | SafeFrameConfig ): Slot
Устанавливает настройки уровня слота для конфигурации SafeFrame. Любые нераспознанные ключи в объекте конфигурации будут игнорироваться. Вся конфигурация будет проигнорирована, если для распознанного ключа будет передано недопустимое значение.
Эти настройки на уровне рекламного места, если они указаны, переопределяют любые настройки на уровне страницы.- Пример
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (устаревший)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
Машинопись
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- См. также
Параметры config: null | SafeFrameConfig
Объект конфигурации.Возврат Slot
Объект слота, для которого был вызван метод.
setTargeting
setTargeting(key: string, value: string | string[]): Slot
Устанавливает специальный параметр таргетинга для этого рекламного места. Вызов этого метода несколько раз для одного и того же ключа приведет к перезаписи старых значений. Установленные здесь значения перезапишут параметры таргетинга, установленные на уровне обслуживания. Эти ключи определены в вашем аккаунте Google Ad Manager.
- Пример
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (устаревший)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
Машинопись
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- См. также
Параметры key: string
Ключ параметра таргетинга.value: string | string[]
Значение параметра таргетинга или массив значений.Возврат Slot
Объект слота, для которого был вызван метод.
updateTargetingFromMap
updateTargetingFromMap(map: { [adUnitPath: string]: string | string[] }): Slot
Устанавливает параметры специального таргетинга для этого слота на основе сопоставления «ключ:значение» в объекте JSON. Это то же самое, что вызвать
Slot.setTargeting
для всех ключевых значений объекта. Эти ключи определены в вашем аккаунте Google Ad Manager.
Примечания:- В случае перезаписи сохранится только последнее значение.
- Если значение представляет собой массив, любое предыдущее значение будет перезаписано, а не объединено.
- Установленные здесь значения перезапишут параметры таргетинга, установленные на уровне обслуживания.
- Пример
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (устаревший)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
Машинопись
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
Параметры map: { [adUnitPath: string]: string | string[] }
Ключ параметра таргетинга: карта значений.Возврат Slot
Объект слота, для которого был вызван метод.
googletag . config . AdExpansionConfig
Настройки для управления расширением рекламы.
Сводная информация о недвижимости | |
---|---|
enabled | Включено или отключено расширение объявления. |
- Пример
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (устаревший)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
Машинопись
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
enabled
enabled: boolean
Включено или отключено расширение объявления.
Установка этого значения отменяет значение по умолчанию, настроенное в Google Ad Manager.
googletag . config . ComponentAuctionConfig
Объект, представляющий однокомпонентный аукцион в аукционе рекламы на устройстве.
Сводная информация о недвижимости | |
---|---|
auctionConfig | Объект конфигурации аукциона для этого аукциона компонентов. |
configKey | Ключ конфигурации, связанный с этим аукционом компонентов. |
auctionConfig
auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: { [buyer: string]: number }, perBuyerGroupLimits: { [buyer: string]: number }, perBuyerSignals: { [buyer: string]: unknown }, perBuyerTimeouts: { [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }
Объект конфигурации аукциона для этого аукциона компонентов.
Если для этого значения установлено значениеnull
, любая существующая конфигурация для указанногоconfigKey
будет удалена.- Пример
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript (устаревший)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
Машинопись
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
- См. также
configKey
configKey: string
Ключ конфигурации, связанный с этим аукционом компонентов.
Это значение должно быть непустым и уникальным. Если два объектаComponentAuctionConfig
имеют одно и то же значение configKey, последнее установленное значение перезапишет предыдущие конфигурации.
googletag . config . InterstitialConfig
Объект, определяющий поведение одного межстраничного рекламного места.
Сводная информация о недвижимости | |
---|---|
triggers | Конфигурация межстраничного триггера для этого межстраничного объявления. |
triggers
triggers: Partial<Record< InterstitialTrigger , boolean>>
Конфигурация межстраничного триггера для этого межстраничного объявления.
Если для межстраничного триггера задано значениеtrue
он будет включен, аfalse
— отключено. Это переопределит значения по умолчанию , настроенные в Google Ad Manager .- Пример
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (устаревший)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
Машинопись
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- См. также
googletag . config . PageSettingsConfig
Основной интерфейс конфигурации для настроек на уровне страницы.
Позволяет устанавливать несколько функций с помощью одного вызова API.
Все свойства, перечисленные ниже, являются примерами и не отражают фактические функции, использующие setConfig. Набор функций см. в полях типа PageSettingsConfig ниже.
Примеры:
- Изменяются только функции, указанные в вызове
setConfig
.// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- Все настройки для данной функции обновляются при каждом вызове
setConfig
.// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- Все настройки функции можно очистить, передав
null
.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
Сводная информация о недвижимости | |
---|---|
adExpansion | Настройки для управления расширением рекламы. |
adYield | Настройка, определяющая, должен ли GPT передавать поток JS при отображении объявлений. |
pps | Настройки для управления сигналами, предоставляемыми издателем (PPS). |
privacyTreatments | Настройки для управления режимом конфиденциальности издателей. |
adExpansion
adExpansion: null | AdExpansionConfig
Настройки для управления расширением рекламы.
adYield
adYield: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Настройка, определяющая, должен ли GPT передавать поток JS при отображении объявлений.
GPT будет работать только для браузеров, поддерживающих API Scheduler.postTask.
Поддерживаемые значения:-
null
(по умолчанию): GPT создаст поток JS для слотов за пределами области просмотра. -
ENABLED_ALL_SLOTS
: GPT предоставит поток JS для всех слотов независимо от того, находится ли слот в области просмотра. -
DISABLED
: GPT не будет передавать поток JS.
-
- Пример
JavaScript
// Disable yielding. googletag.setConfig({ adYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ adYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ adYield: null });
JavaScript (устаревший)
// Disable yielding. googletag.setConfig({ adYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ adYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ adYield: null });
Машинопись
// Disable yielding. googletag.setConfig({ adYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ adYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ adYield: null });
- См. также
pps
pps: null | PublisherProvidedSignalsConfig
Настройки для управления сигналами, предоставляемыми издателем (PPS).
privacyTreatments
privacyTreatments: null | PrivacyTreatmentsConfig
Настройки для управления режимом конфиденциальности издателей.
googletag . config . PrivacyTreatmentsConfig
Настройки для управления режимом конфиденциальности издателей.
Сводная информация о недвижимости | |
---|---|
treatments | Множество средств обеспечения конфиденциальности издателей, которые можно включить. |
treatments
treatments: "disablePersonalization"[]
Множество средств обеспечения конфиденциальности издателей, которые можно включить.
- Пример
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (устаревший)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
Машинопись
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
googletag . config . PublisherProvidedSignalsConfig
Объект конфигурации сигналов (PPS), предоставленный издателем.
Сводная информация о недвижимости | |
---|---|
taxonomies | Объект, содержащий сопоставления таксономии . |
- Пример
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (устаревший)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 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
taxonomies: Partial<Record< Taxonomy , TaxonomyData >>
Объект, содержащий сопоставления таксономии .
googletag . config . SlotSettingsConfig
Основной интерфейс конфигурации для настроек на уровне слота.
Позволяет настроить несколько функций с помощью одного вызова API для одного слота.
Все свойства, перечисленные ниже, являются примерами и не отражают фактические функции, использующие setConfig. Набор функций см. в полях типа SlotSettingsConfig ниже.
Примеры:
- Изменяются только функции, указанные в вызове
Slot.setConfig
.const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- Все настройки данной функции обновляются при каждом вызове
Slot.setConfig
.// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
- Все настройки функции можно очистить, передав
null
.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
Сводная информация о недвижимости | |
---|---|
adExpansion | Настройки для управления расширением рекламы. |
componentAuction | Массив аукционов компонентов, которые будут включены в аукцион рекламы на устройстве. |
interstitial | Настройки, управляющие поведением межстраничных рекламных мест. |
adExpansion
adExpansion: AdExpansionConfig
Настройки для управления расширением рекламы.
componentAuction
componentAuction: ComponentAuctionConfig []
Массив аукционов компонентов, которые будут включены в аукцион рекламы на устройстве.
interstitial
interstitial: InterstitialConfig
Настройки, управляющие поведением межстраничных рекламных мест.
googletag . config . TaxonomyData
Объект, содержащий значения для одной Taxonomy .
Сводная информация о недвижимости | |
---|---|
values | Список значений таксономии . |
values
values: string[]
Список значений таксономии .
googletag . events . Event
Базовый интерфейс для всех событий GPT. Все события GPT, указанные ниже, будут иметь следующие поля.
Сводная информация о недвижимости | |
---|---|
serviceName | Имя службы, вызвавшей событие. |
slot | Слот, вызвавший событие. |
- См. также
serviceName
serviceName: string
Имя службы, вызвавшей событие.
slot
slot: Slot
Слот, вызвавший событие.
googletag . events . EventTypeMap
Это псевдотип, который сопоставляет имя события с соответствующим типом объекта события для Service.addEventListener
и Service.removeEventListener
. Он документирован только для справки и в целях безопасности типа.
Сводная информация о недвижимости | |
---|---|
impressionViewable | Псевдоним для events.ImpressionViewableEvent . |
rewardedSlotClosed | Псевдоним для events.RewardedSlotClosedEvent . |
rewardedSlotGranted | Псевдоним для events.RewardedSlotGrantedEvent . |
rewardedSlotReady | Псевдоним для events.RewardedSlotReadyEvent . |
slotOnload | Псевдоним для events.SlotOnloadEvent . |
slotRenderEnded | Псевдоним для events.SlotRenderEndedEvent . |
slotRequested | Псевдоним для events.SlotRequestedEvent . |
slotResponseReceived | Псевдоним для events.SlotResponseReceived . |
slotVisibilityChanged | Псевдоним для events.SlotVisibilityChangedEvent . |
impressionViewable
impressionViewable: ImpressionViewableEvent
Псевдоним для
events.ImpressionViewableEvent
.
rewardedSlotClosed
rewardedSlotClosed: RewardedSlotClosedEvent
Псевдоним для
events.RewardedSlotClosedEvent
.
rewardedSlotGranted
rewardedSlotGranted: RewardedSlotGrantedEvent
Псевдоним для
events.RewardedSlotGrantedEvent
.
rewardedSlotReady
rewardedSlotReady: RewardedSlotReadyEvent
Псевдоним для
events.RewardedSlotReadyEvent
.
slotOnload
slotOnload: SlotOnloadEvent
Псевдоним для
events.SlotOnloadEvent
.
slotRenderEnded
slotRenderEnded: SlotRenderEndedEvent
Псевдоним для
events.SlotRenderEndedEvent
.
slotRequested
slotRequested: SlotRequestedEvent
Псевдоним для
events.SlotRequestedEvent
.
slotResponseReceived
slotResponseReceived: SlotResponseReceived
Псевдоним для
events.SlotResponseReceived
.
slotVisibilityChanged
slotVisibilityChanged: SlotVisibilityChangedEvent
Псевдоним для
events.SlotVisibilityChangedEvent
.
googletag . events . ImpressionViewableEvent
Расширяет Это событие генерируется, когда показ становится доступным для просмотра в соответствии с критериями Active View .
Сводная информация о недвижимости | |
---|---|
serviceName | Имя службы, вызвавшей событие. Унаследовано от |
slot | Слот, вызвавший событие. Унаследовано от |
- Пример
JavaScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (устаревший)
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
Машинопись
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
- См. также
googletag . events . RewardedSlotClosedEvent
Расширяет Это событие генерируется, когда пользователь закрывает рекламное место с вознаграждением. Он может сработать как до, так и после получения награды. Чтобы определить, было ли предоставлено вознаграждение, используйте вместо этого events.RewardedSlotGrantedEvent
.
Сводная информация о недвижимости | |
---|---|
serviceName | Имя службы, вызвавшей событие. Унаследовано от |
slot | Слот, вызвавший событие. Унаследовано от |
- Пример
JavaScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (устаревший)
// This listener is called when the user closes a rewarded ad slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
Машинопись
// 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
Расширяет Это событие генерируется, когда за просмотр объявления с вознаграждением предоставляется вознаграждение. Если объявление будет закрыто до того, как будут выполнены критерии предоставления вознаграждения, это событие не сработает.
Сводная информация о недвижимости | |
---|---|
payload | Объект, содержащий информацию о предоставленной награде. |
serviceName | Имя службы, вызвавшей событие. Унаследовано от |
slot | Слот, вызвавший событие. Унаследовано от |
- Пример
JavaScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (устаревший)
// This listener is called whenever a reward is granted for a // rewarded ad. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", function (event) { var _a, _b; var slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type); console.log( "Reward amount:", (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount ); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
Машинопись
// 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
payload: null | RewardedPayload
Объект, содержащий информацию о предоставленной награде.
googletag . events . RewardedSlotReadyEvent
Расширяет Это событие вызывается, когда рекламное объявление с вознаграждением готово к отображению. Издатель несет ответственность за предоставление пользователю возможности просмотреть рекламу перед ее показом.
Сводная информация о недвижимости | |
---|---|
serviceName | Имя службы, вызвавшей событие. Унаследовано от |
slot | Слот, вызвавший событие. Унаследовано от |
Краткое описание метода | |
---|---|
makeRewardedVisible | Отображает вознагражденное объявление. |
- Пример
JavaScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (устаревший)
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
Машинопись
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
- См. также
makeRewardedVisible
makeRewardedVisible(): void
Отображает вознагражденное объявление. Этот метод не следует вызывать до тех пор, пока пользователь не согласится просмотреть объявление.
googletag . events . SlotOnloadEvent
Расширяет Это событие генерируется, когда iframe креатива запускает событие загрузки. При рендеринге мультимедийных объявлений в режиме синхронизированного рендеринга iframe не используется, поэтому SlotOnloadEvent
не запускается.
Сводная информация о недвижимости | |
---|---|
serviceName | Имя службы, вызвавшей событие. Унаследовано от |
slot | Слот, вызвавший событие. Унаследовано от |
- Пример
JavaScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (устаревший)
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
Машинопись
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
- См. также
googletag . events . SlotRenderEndedEvent
Расширяет Это событие генерируется, когда код объявления вводится в слот. Это событие произойдет до того, как будут получены ресурсы креатива, поэтому креатив может быть еще не виден. Если вам нужно знать, когда все творческие ресурсы для слота завершили загрузку, вместо этого рассмотрите events.SlotOnloadEvent
.
Сводная информация о недвижимости | |
---|---|
advertiserId | Идентификатор рекламодателя отображаемого объявления. |
campaignId | Идентификатор кампании отображаемого объявления. |
companyIds | Идентификаторы компаний, которые сделали ставку на созданное объявление для заполнения. |
creativeId | Идентификатор объявления отображаемого объявления с резервированием. |
creativeTemplateId | Идентификатор шаблона объявления для отображаемого объявления с резервированием. |
isBackfill | Было ли объявление резервным объявлением. |
isEmpty | Была ли возвращена реклама для рекламного места. |
labelIds | Идентификаторы меток отображаемого объявления. |
lineItemId | Идентификатор позиции отображаемого объявления с резервированием. |
serviceName | Имя службы, вызвавшей событие. Унаследовано от |
size | Указывает размер отображаемого объявления в пикселях. |
slot | Слот, вызвавший событие. Унаследовано от |
slotContentChanged | Было ли изменено содержимое рекламного места вместе с отображаемым объявлением. |
sourceAgnosticCreativeId | Идентификатор объявления отображаемого объявления с резервированием или заполнением. |
sourceAgnosticLineItemId | Идентификатор позиции отображаемого объявления с резервированием или заполнением. |
yieldGroupIds | Идентификаторы групп доходности для отображаемого объявления-заполнителя. |
- Пример
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 (устаревший)
// 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
advertiserId: null | number
Идентификатор рекламодателя отображаемого объявления. Значение равно
null
для пустых мест, объявлений с заполнением и объявлений, отображаемых службами, отличными отPubAdsService
.
campaignId
campaignId: null | number
Идентификатор кампании отображаемого объявления. Значение равно
null
для пустых рекламных мест, объявлений для заполнения и объявлений, отображаемых службами, отличными отPubAdsService
.
companyIds
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
labelIds: null | number[]
Идентификаторы меток отображаемого объявления. Значение равно
null
для пустых мест, объявлений с заполнением и объявлений, отображаемых службами, отличными отPubAdsService
.
lineItemId
lineItemId: null | number
Идентификатор позиции отображаемого объявления с резервированием. Значение равно
null
для пустых мест, объявлений с заполнением и объявлений, отображаемых службами, отличными отPubAdsService
.
size
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
yieldGroupIds: null | number[]
Идентификаторы групп доходности для отображаемого объявления-заполнителя. Значение равно
null
для пустых мест, объявлений с резервированием и объявлений, отображаемых службами, отличными отPubAdsService
.
googletag . events . SlotRequestedEvent
Расширяет Это событие вызывается, когда объявление запрошено для определенного рекламного места.
Сводная информация о недвижимости | |
---|---|
serviceName | Имя службы, вызвавшей событие. Унаследовано от |
slot | Слот, вызвавший событие. Унаследовано от |
- Пример
JavaScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (устаревший)
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
Машинопись
// 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
Расширяет Это событие генерируется, когда получен ответ на объявление для определенного рекламного места.
Сводная информация о недвижимости | |
---|---|
serviceName | Имя службы, вызвавшей событие. Унаследовано от |
slot | Слот, вызвавший событие. Унаследовано от |
- Пример
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (устаревший)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
Машинопись
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
- См. также
googletag . events . SlotVisibilityChangedEvent
Расширяет Это событие вызывается всякий раз, когда изменяется процент площади рекламного места на экране. Событие регулируется и не будет срабатывать чаще, чем раз в 200 мс.
Сводная информация о недвижимости | |
---|---|
inViewPercentage | Процент видимой площади объявления. |
serviceName | Имя службы, вызвавшей событие. Унаследовано от |
slot | Слот, вызвавший событие. Унаследовано от |
- Пример
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (устаревший)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
Машинопись
// 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 . BidderSignalProvider
Возвращает безопасный сигнал для конкретного участника торгов.
Поставщик безопасных сигналов для участников торгов состоит из двух частей:
- Функция-сборщик, которая возвращает
Promise
, которое преобразуется в безопасный сигнал. -
id
, идентифицирующий участника торгов, связанного с сигналом.
secureSignals.PublisherSignalProvider
. Сводная информация о недвижимости | |
---|---|
collectorFunction | . |
id | Уникальный идентификатор сборщика, связанный с этим безопасным сигналом и зарегистрированный в Google Ad Manager. |
- Пример
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (устаревший)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
Машинопись
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- См. также
collectorFunction
collectorFunction: () => Promise<string>
id
id: string
Уникальный идентификатор сборщика, связанный с этим безопасным сигналом и зарегистрированный в Google Ad Manager.
googletag . secureSignals . PublisherSignalProvider
Возвращает безопасный сигнал для конкретного издателя.
Поставщик сигналов издателя состоит из двух частей:
- Функция-сборщик, которая возвращает
Promise
, которое преобразуется в безопасный сигнал. -
networkCode
, который идентифицирует издателя, связанного с сигналом.
secureSignals.BidderSignalProvider
. Сводная информация о недвижимости | |
---|---|
collectorFunction | . |
networkCode | Сетевой код (как видно на пути к рекламному блоку) издателя, связанного с этим безопасным сигналом. |
- Пример
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (устаревший)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
Машинопись
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- См. также
collectorFunction
collectorFunction: () => Promise<string>
networkCode
networkCode: string
Сетевой код (как видно на пути к рекламному блоку) издателя, связанного с этим безопасным сигналом.
googletag . secureSignals . SecureSignalProvidersArray
Интерфейс для управления защищенными сигналами.
Краткое описание метода | |
---|---|
clearAllCache | Очищает из кэша все сигналы для всех коллекторов. |
push | Добавляет новый secureSignals.SecureSignalProvider в массив поставщиков сигналов и начинает процесс генерации сигналов. |
clearAllCache
clearAllCache(): void
Очищает из кэша все сигналы для всех коллекторов.
Вызов этого метода может снизить вероятность включения сигналов в запросы объявлений для текущих и, возможно, последующих просмотров страниц. В связи с этим его следует вызывать только тогда, когда происходят значимые изменения состояния, например, события, указывающие на нового пользователя (вход в систему, выход из системы, регистрация и т. д.).
push
push(provider: SecureSignalProvider ): void
Добавляет новый
secureSignals.SecureSignalProvider
в массив поставщиков сигналов и начинает процесс генерации сигналов.Параметры provider: SecureSignalProvider
ОбъектsecureSignals.SecureSignalProvider
, который необходимо добавить в массив.