Справочные материалы о тегах GPT

В этом справочнике для описания типов используется нотация TypeScript. В таблице ниже приведены примеры.

Введите выражение
string	Примитивный строковый тип.
string[]	Тип массива, в котором значения могут быть только строками.
number | string	Объединенный тип, значением которого может быть число или строка.
Array<number | string>	Тип массива, в котором значения имеют сложный (объединенный) тип.
[number, string]	Тип кортежа, где значение – это массив из двух элементов, который должен содержать число и строку в указанном порядке.
Slot	Тип объекта, значение которого является экземпляром googletag.Slot.
() => void	Тип функции без определенных аргументов и возвращаемого значения.

Подробнее о поддерживаемых типах и выражениях типов можно узнать в руководстве по TypeScript .

Аннотации типов

Двоеточие после переменной, названия параметра, названия свойства или сигнатуры функции обозначает аннотацию типа. Аннотации типов описывают типы, которые элемент слева от двоеточия может принимать или возвращать. В таблице ниже приведены примеры аннотаций типов, которые могут встречаться в этой справке.

Аннотация типа
param: string	Указывает, что param принимает или возвращает строковое значение. Этот синтаксис используется для переменных, параметров, свойств и типов возвращаемых значений.
param?: number | string	Указывает, что параметр param является необязательным, но принимает число или строку, если они указаны. Этот синтаксис используется для параметров и свойств.
...params: Array<() => void>	Указывает, что params – это остаточный параметр , который принимает функции. Остаточные параметры принимают неограниченное количество значений указанного типа.

---

googletag

Глобальное пространство имен, которое тег Google Publisher Tag использует для своего API.

Пространства имен
config	Основной интерфейс для настроек на уровне страницы.
enums	Это пространство имен, которое теги GPT используют для перечисляемых типов.
events	Это пространство имен, которое тег GPT использует для событий.
secureSignals	Это пространство имен, которое тег GPT использует для управления защищенными сигналами.

Интерфейсы
CommandArray	Массив команд принимает последовательность функций и вызывает их по порядку.
CompanionAdsService	Сервис сопутствующих объявлений.
PrivacySettingsConfig	Объект конфигурации для настроек конфиденциальности.
PubAdsService	Сервис объявлений издателя.
RequestHook	Функция обратного вызова, которая вызывается перед каждым запросом объявления, если она зарегистрирована с помощью PubAdsService.registerRequestHook.
ResponseInformation	Объект, представляющий один ответ на запрос объявления.
RewardedPayload	Объект, представляющий вознаграждение, связанное с объявлением с вознаграждением.
Service	Базовый класс сервиса, содержащий методы, общие для всех сервисов.
SizeMappingBuilder	Конструктор для объектов спецификации сопоставления размеров.
Slot	Рекламное место – это объект, представляющий одно рекламное место на странице.

Псевдонимы типов
FluidSize	Строка размера, в которой контейнер объявления занимает 100% ширины родительского элемента div, а затем изменяет свою высоту в соответствии с размером креатива.
GeneralSize	Допустимая конфигурация размера для рекламного места, которая может включать один или несколько размеров.
MultiSize	Список допустимых размеров.
NamedSize	Названия размеров, которые может иметь рекламное место.
SingleSize	Один допустимый размер рекламного места.
SingleSizeArray	Массив из двух чисел, представляющих ширину и высоту.
SizeMapping	Сопоставление размеров области просмотра и размеров объявлений.
SizeMappingArray	Список сопоставлений размеров.

Переменные
apiReady	Пометка, указывающая, что GPT API загружен и готов к вызову.
cmd	Ссылка на глобальную очередь команд для асинхронного выполнения вызовов, связанных с GPT.
pubadsReady	Отметка, показывающая, что сервис PubAdsService включен, загружен и полностью готов к работе.
secureSignalProviders	Ссылка на массив поставщиков защищенных сигналов.

Функции
companionAds	Возвращает ссылку на CompanionAdsService.
defineOutOfPageSlot	Создает рекламное место для внестраничного объявления с заданным путем к рекламному блоку.
defineSlot	Создает рекламное место с заданным путем к рекламному блоку и размером и связывает его с идентификатором элемента div на странице, которая будет содержать объявление.
destroySlots	Удаляет указанные рекламные места, а также все связанные с ними объекты и ссылки из тегов GPT.
disablePublisherConsole	Отключает Google Консоль для издателей.
display	Указывает сервисам рекламных мест отрисовать рекламное место.
enableServices	Включает все сервисы GPT, заданные для рекламных мест на странице.
getConfig	Получает неизменяемую копию общих параметров конфигурации для страницы, заданных с помощью setConfig.
getVersion	Возвращает текущую версию тега GPT.
openConsole	Открывает Google Консоль для издателей.
pubads	Возвращает ссылку на PubAdsService.
setAdIframeTitle	Задает заголовок для всех окон iframe, созданных PubAdsService.
setConfig	Задает общие параметры конфигурации для страницы.
sizeMapping	Создает новый объект SizeMappingBuilder.

Псевдонимы типов

---

FluidSize

FluidSize: "fluid"

Строка размера, в которой контейнер объявления занимает 100% ширины родительского элемента div, а затем изменяет свою высоту в соответствии с размером креатива. Аналогично тому, как ведут себя обычные блочные элементы на странице. Используется для нативных объявлений и баннеров (см. статью по теме).

---

GeneralSize

GeneralSize: SingleSize | MultiSize

Допустимая конфигурация размера для рекламного места, которая может включать один или несколько размеров.

---

MultiSize

MultiSize: SingleSize[]

Список допустимых размеров.

---

NamedSize

NamedSize: FluidSize | [FluidSize]

Названия размеров, которые может иметь рекламное место. В большинстве случаев размер представляет собой прямоугольник фиксированного размера, но в некоторых случаях нам нужны другие виды спецификаций размера. Допустимы только следующие названия размеров:

• Гибкий. Контейнер объявления занимает 100% ширины родительского элемента div, а его высота изменяется в соответствии с размером креатива. Аналогично тому, как ведут себя обычные блочные элементы на странице. Используется для нативных объявлений и баннеров (см. статью по теме). Обратите внимание, что для объявления гибкого размера рекламного места можно использовать как fluid, так и ['fluid'].

---

SingleSize

SingleSize: SingleSizeArray | NamedSize

Один допустимый размер рекламного места.

---

SingleSizeArray

SingleSizeArray: [number, number]

Массив из двух чисел, представляющих ширину и высоту.

---

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

Сопоставление размеров области просмотра и размеров объявлений. Используется для адаптивных объявлений.

---

SizeMappingArray

SizeMappingArray: SizeMapping[]

Список сопоставлений размеров.

Переменные

---

Const apiReady

apiReady: boolean | undefined

Пометка, указывающая, что GPT API загружен и готов к вызову. Пока API не будет готов, это свойство будет иметь значение undefined.

Обратите внимание, что для асинхронной обработки рекомендуется использовать googletag.cmd, чтобы ставить обратные вызовы в очередь до тех пор, пока тег GPT не будет готов. В этих обратных вызовах не нужно проверять googletag.apiReady, поскольку они гарантированно выполняются после настройки API.

---

Const cmd

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

Ссылка на глобальную очередь команд для асинхронного выполнения вызовов, связанных с GPT.

Переменная googletag.cmd инициализируется как пустой массив JavaScript с помощью синтаксиса тега GPT на странице, а cmd.push – это стандартный метод Array.push, который добавляет элемент в конец массива. Когда загружается JavaScript-код тега GPT, он просматривает массив и выполняет все функции по порядку. Затем скрипт заменяет cmd объектом CommandArray, метод push которого определен для выполнения переданного ему аргумента функции. Этот механизм позволяет тегам GPT сократить задержку, получая код JavaScript асинхронно и позволяя браузеру продолжать отрисовку страницы.

Пример

JavaScript

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

TypeScript

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

---

Const pubadsReady

pubadsReady: boolean | undefined

Отметка, показывающая, что сервис PubAdsService включен, загружен и полностью готов к работе. Это свойство будет иметь значение undefined, пока не будет вызван метод enableServices, а сервис PubAdsService не будет загружен и инициализирован.

---

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

TypeScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

Статьи по теме

• Как отправлять защищенные сигналы системам назначения ставок

Функции

---

companionAds

companionAds(): CompanionAdsService

Возвращает ссылку на CompanionAdsService.

Возвраты
CompanionAdsService	Сервис сопутствующих объявлений.

---

defineOutOfPageSlot

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

Создает рекламное место для внестраничного объявления с заданным путем к рекламному блоку.

Для собственных внестраничных объявлений div – это идентификатор элемента div, который будет содержать объявление. Подробную информацию вы найдете в статье о внестраничных креативах.

Для внестраничных объявлений, управляемых с помощью тега 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);

TypeScript

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

Статьи по теме

• Как показывать объявления с вознаграждением
• Как показывать межстраничные объявления на сайте
• Как показывать фиксированные объявления
• Как показывать внестраничные объявления

Параметры
adUnitPath: string	Полный путь к рекламному блоку с кодом сети и кодом рекламного блока.
Optional div: string | OutOfPageFormat	Идентификатор элемента div, который будет содержать этот рекламный блок или OutOfPageFormat.

Возвраты
Slot | null	Новое рекламное место или null, если его не удалось создать.

---

defineSlot

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

Создает рекламное место с заданным путем к рекламному блоку и размером, а также связывает его с идентификатором элемента div на странице, которая будет содержать объявление.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Начало работы с тегами Google Publisher Tag

Параметры
adUnitPath: string	Полный путь к рекламному блоку с кодом сети и кодом блока.
size: GeneralSize	Ширина и высота добавленного рекламного места. Этот размер используется в запросе объявления, если не задано сопоставление размеров для адаптивного дизайна или размер области просмотра меньше минимального размера, указанного в сопоставлении.
Optional div: string	Идентификатор элемента div, который будет содержать этот рекламный блок.

Возвраты
Slot | null	Новое рекламное место или null, если его не удалось создать.

---

destroySlots

destroySlots(slots?: Slot[]): boolean

Удаляет указанные рекламные места, а также все связанные с ними объекты и ссылки из тегов GPT. Этот API не поддерживает рекламные места для возврата показов и сопутствующих креативов.

Вызов этого API для рекламного места удаляет объявление и объект рекламного места из внутреннего состояния, поддерживаемого тегом GPT. Вызов других функций для объекта рекламного места приведет к неопределенному поведению. Обратите внимание, что браузер может не освободить память, связанную с этим рекламным местом, если на странице издателя есть ссылка на него. Вызов этого API делает элемент div, связанный с этим рекламным местом, доступным для повторного использования.

В частности, удаление рекламного места удаляет объявление из долгосрочного просмотра страницы тега GPT, поэтому на будущие запросы не будут влиять блокировки или конкурентные исключения, связанные с этим объявлением. Если не вызвать эту функцию перед удалением тега div рекламного места со страницы, это приведет к неопределенному поведению.

Пример

JavaScript

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

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

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

// This call to destroy all slots.
googletag.destroySlots();

TypeScript

// The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

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

// This call to destroy all slots.
googletag.destroySlots();

Параметры
Optional slots: Slot[]	Массив рекламных мест, которые нужно удалить. Массив указывать необязательно. Если он не задан, будут удалены все рекламные места.

Возвраты
boolean	true, если рекламные места были удалены, и false в противном случае.

---

disablePublisherConsole

disablePublisherConsole(): void

Отключает Google Консоль для издателей.

Статьи по теме

• Google Консоль для издателей

---

display

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

Указывает сервисам рекламных мест отрисовать рекламное место. Каждое рекламное место должно показываться на странице только один раз. Прежде чем показывать интервалы, необходимо определить их и связать с услугой. Вызов показа должен происходить только после того, как элемент появится в DOM. Обычно для этого его помещают в блок скрипта внутри элемента div, указанного в вызове метода.

Если используется режим единого запроса, то при вызове этого метода будут получены все рекламные места, которые не были получены ранее. Чтобы рекламное место не показывалось, необходимо удалить весь тег div.

Статьи по теме

• Начало работы с тегами Google Publisher Tag
• Как показать тестовое объявление
• Управление загрузкой и обновлением объявлений

Параметры
divOrSlot: string | Element | Slot	Идентификатор элемента div, содержащего рекламное место, или сам элемент div, или объект рекламного места. Если используется элемент div, у него должен быть атрибут id, соответствующий идентификатору, переданному в defineSlot.

---

enableServices

enableServices(): void

Включает все сервисы GPT, заданные для рекламных мест на странице.

---

getConfig

getConfig(keys: string | string[]): Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>

Возвращает неизменяемую копию общих настроек страницы, заданных с помощью setConfig.

Этот метод поддерживает не все свойства setConfig(). Поддерживаемые свойства:

• adsenseAttributes
• disableInitialLoad
• targeting

Пример

JavaScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

TypeScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

Параметры
keys: string | string[]	Ключи параметров конфигурации, которые нужно получить.

Возвраты
Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>	Неизменяемая копия настроек страницы.

---

getVersion

getVersion(): string

Возвращает текущую версию тега GPT.

Статьи по теме

• История версий GPT

Возвраты
string	Строка с версией тега GPT, который выполняется в данный момент.

---

openConsole

openConsole(div?: string): void

Открывает Google Консоль для издателей.

Пример

JavaScript

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

// Calling without div ID.
googletag.openConsole();

TypeScript

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

// Calling without div ID.
googletag.openConsole();

Статьи по теме

• Google Консоль для издателей

Параметры
Optional div: string	Идентификатор div рекламного места. Это необязательное значение. Если этот параметр задан, Консоль для издателей попытается открыться с информацией об указанном рекламном месте.

---

pubads

pubads(): PubAdsService

Возвращает ссылку на PubAdsService.

Возвраты
PubAdsService	Сервис Publisher Ads.

---

setAdIframeTitle

setAdIframeTitle(title: string): void

Задает заголовок для всех окон iframe, созданных PubAdsService.

Пример

JavaScript

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");

Параметры
title: string	Новый заголовок для всех контейнеров объявлений iframe.

---

setConfig

setConfig(config: PageSettingsConfig): void

Задает общие параметры конфигурации для страницы.

Параметры
config: PageSettingsConfig

---

sizeMapping

sizeMapping(): SizeMappingBuilder

Создает новый объект SizeMappingBuilder.

Статьи по теме

• Размеры адаптивных объявлений

Возвраты
SizeMappingBuilder	Новый конструктор.

---

googletag.CommandArray

Массив команд принимает последовательность функций и вызывает их по порядку. Он предназначен для замены стандартного массива, который используется для постановки в очередь функций, вызываемых после загрузки тега GPT.

Методы
push	Выполняет последовательность функций, указанных в аргументах.

Методы

---

push

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

Выполняет последовательность функций, указанных в аргументах.

Пример

JavaScript

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

TypeScript

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

Параметры
Rest ...f: ((this: typeof globalThis) => void)[]	Функция JavaScript, которую нужно выполнить. Привязка во время выполнения всегда будет globalThis. Попробуйте передать стрелочную функцию, чтобы сохранить значение this окружающего лексического контекста.

Возвраты
number	Количество обработанных команд. Это совместимо с возвращаемым значением Array.push (текущая длина массива).

---

googletag.CompanionAdsService

Расширяет Service

Сервис сопутствующих объявлений. Этот сервис используется видеообъявлениями для показа сопутствующих объявлений.

Методы
addEventListener	Регистрирует прослушиватель, который позволяет настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. Унаследовано от метода Service.addEventListener
getSlots	Получить список интервалов, связанных с этим сервисом. Унаследовано от метода Service.getSlots
removeEventListener	Удаляет ранее зарегистрированный прослушиватель. Унаследовано от метода Service.removeEventListener
setRefreshUnfilledSlots	Определяет, будут ли автоматически заполняться незаполненные рекламные места для сопутствующих объявлений.

Статьи по теме

• Сопутствующие объявления для видео- и аудиорекламы

Методы

---

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void

Определяет, будут ли рекламные места сопутствующих объявлений, которые не были заполнены, автоматически заполняться объявлениями из других источников.

Этот метод можно вызывать несколько раз в течение жизненного цикла страницы, чтобы включать и отключать заполнение. Заполняться будут только рекламные места, зарегистрированные в PubAdsService. Из-за ограничений, связанных с правилами, этот метод не предназначен для заполнения пустых сопутствующих рекламных мест при показе видеообъявления Ad Exchange.

Пример

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

Параметры
value: boolean	true, чтобы автоматически заполнять незаполненные рекламные места, или false, чтобы оставить их без изменений.

---

googletag.PrivacySettingsConfig

Объект конфигурации для настроек конфиденциальности.

Свойства
childDirectedTreatment?	Указывает, следует ли считать страницу предназначенной для детей.
limitedAds?	Позволяет показывать ограниченную рекламу в режиме, чтобы помочь издателям в соблюдении нормативных требований.
nonPersonalizedAds?	Позволяет показывать неперсонализированную рекламу, чтобы издатели могли соблюдать нормативные требования.
restrictDataProcessing?	Позволяет выполнять показ в режиме ограниченной обработки данных, чтобы издатели могли соблюдать нормативные требования.
tagForAgeTreatment?	Обработка данных с учетом возраста. Указывает, предназначен ли запрос объявления для детей, подростков или возрастная категория не задана.
trafficSource?	Указывает, относится ли запрос к платному или бесплатному трафику.
underAgeOfConsent?	Указывает, нужно ли помечать запросы объявлений как поступающие от пользователей, не достигших минимального возраста.

Статьи по теме

• Как задать настройки конфиденциальности

Свойства

---

Optional childDirectedTreatment

childDirectedTreatment?: boolean

Указывает, следует ли считать страницу предназначенной для детей. Чтобы очистить конфигурацию, установите значение null.

---

Optional limitedAds

limitedAds?: boolean

Позволяет показывать объявления в режиме ограниченного показа, чтобы издатели могли соблюдать нормативные требования.

Вы можете настроить тег GPT так, чтобы он запрашивал объявления для ограниченного показа, двумя способами:

• Автоматически, используя сигнал от платформы для запросов согласия, которая поддерживает спецификацию IAB TCF версии 2.0.
• Вручную, задав для этого поля значение true.

Настраивать ограниченный показ рекламы вручную можно только в том случае, если тег GPT загружается с URL, который относится к ограниченному показу рекламы. Если вы попытаетесь изменить эту настройку, когда тег GPT загружен со стандартного URL, то в Консоли для издателей появится предупреждение.

Обратите внимание, что при использовании CMP включать ограниченный показ рекламы вручную не требуется.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Показ ограниченной рекламы

---

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean

Позволяет показывать неперсонализированную рекламу, чтобы издатели могли соблюдать нормативные требования.

---

Optional restrictDataProcessing

restrictDataProcessing?: boolean

Позволяет выполнять показ в режиме ограниченной обработки данных, чтобы издатели могли соблюдать нормативные требования.

---

Optional tagForAgeTreatment

tagForAgeTreatment?: TagForAgeTreatment

Обработка с учетом возрастных ограничений, указывающая, предназначен ли запрос объявления для детей, подростков или не указано.

Чтобы определить, какие настройки обработки данных о возрасте подходят для вашей пользовательской базы, проконсультируйтесь с юристом. Подробнее об этой настройке…

Устанавливая это свойство, вы подтверждаете, что уведомление является точным и вы уполномочены действовать от имени владельца сайта. Вы понимаете, что злоупотребление этой функцией может привести к удалению вашего аккаунта Google.

Пример

JavaScript

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

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

TypeScript

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

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

---

Optional trafficSource

trafficSource?: TrafficSource

Указывает, относится ли запрос к платному или бесплатному трафику. Это значение используется для заполнения параметра Источник трафика в отчетах Менеджера рекламы. Если источник трафика не задан, в отчетах по умолчанию используется undefined.

Пример

JavaScript

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

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

TypeScript

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

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

---

Optional underAgeOfConsent

underAgeOfConsent?: boolean

Указывает, нужно ли помечать запросы объявлений как поступающие от пользователей, не достигших минимального возраста. Чтобы очистить конфигурацию, установите значение null.

---

googletag.PubAdsService

Расширяет Service

Сервис объявлений издателя. Этот сервис используется для получения и показа объявлений из вашего аккаунта Google Менеджера рекламы.

Методы
addEventListener	Регистрирует прослушиватель, который позволяет настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. Унаследовано от метода Service.addEventListener
clear	Удаляет объявления из указанных рекламных мест и заменяет их пустым контентом.
clearCategoryExclusions	Столбец больше не доступен. Удаляет все ярлыки для исключения категорий объявлений уровня страницы.
clearTargeting	Столбец больше не доступен.  Удаляет параметры таргетинга со специальными настройками для определенного ключа или для всех ключей.
collapseEmptyDivs	Столбец больше не доступен.  Позволяет сворачивать блоки div рекламных мест, чтобы они не занимали место на странице, если в них нет содержания объявления.
disableInitialLoad	Столбец больше не доступен.  Отключает запросы объявлений при загрузке страницы, но позволяет запрашивать объявления с помощью вызова PubAdsService.refresh.
display	Создает и показывает рекламное место с заданным путем к рекламному блоку и размером.
enableLazyLoad	Столбец больше не доступен. Активирует отложенную загрузку в теге GPT, как определено объектом конфигурации.
enableSingleRequest	Столбец больше не доступен.  Включает режим единого запроса, позволяющий получать несколько объявлений одновременно.
enableVideoAds	Столбец больше не доступен.  Сообщает тегу GPT, что на странице будут показываться видеообъявления.
get	Столбец больше не доступен.  Возвращает значение атрибута AdSense, связанного с указанным ключом.
getAttributeKeys	Столбец больше не доступен. Возвращает ключи атрибутов, заданные для этого сервиса.
getSlots	Получить список интервалов, связанных с этим сервисом. Унаследовано от метода Service.getSlots
getTargeting	Столбец больше не доступен.  Возвращает заданный специальный параметр таргетинга на уровне сервиса.
getTargetingKeys	Столбец больше не доступен. Возвращает список всех заданных ключей таргетинга на уровне сервиса.
isInitialLoadDisabled	Столбец больше не доступен. Возвращает информацию о том, были ли успешно отключены первоначальные запросы объявлений предыдущим вызовом PubAdsService.disableInitialLoad.
refresh	Получает и показывает новые объявления для определенных или всех рекламных мест на странице.
registerRequestHook	Регистрирует хук, который будет выполняться параллельно с другими зарегистрированными хуками перед каждым запросом объявления на странице в рамках глобального тайм-аута.
removeEventListener	Удаляет ранее зарегистрированный прослушиватель. Унаследовано от метода Service.removeEventListener
set	Столбец больше не доступен. Задает значения атрибутов AdSense, которые применяются ко всем рекламным местам в сервисе Publisher Ads.
setCategoryExclusion	Столбец больше не доступен. Задает исключение категорий объявлений уровня страницы для указанного названия ярлыка.
setCentering	Столбец больше не доступен. Включает и отключает горизонтальное центрирование объявлений.
setForceSafeFrame	Столбец больше не доступен.  Позволяет настроить принудительный показ всех объявлений на странице в контейнере SafeFrame.
setLocation	Столбец больше не доступен. Передает информацию о местоположении с сайтов, чтобы вы могли настроить геотаргетинг позиций на определенные местоположения.
setPrivacySettings	Позволяет задавать все настройки конфиденциальности в одном API с помощью объекта конфигурации.
setPublisherProvidedId	Задает значение для идентификатора, назначаемого издателем.
setSafeFrameConfig	Столбец больше не доступен.  Задает настройки на уровне страницы для конфигурации SafeFrame.
setTargeting	Столбец больше не доступен. Задает параметры таргетинга со специальными настройками для определенного ключа, которые применяются ко всем рекламным местам рекламных сервисов.
setVideoContent	Столбец больше не доступен. Задает информацию о видеоконтенте, которая будет отправляться вместе с запросами объявлений для таргетинга и исключения контента.
updateCorrelator	Изменяет коррелятор, который отправляется с запросами объявлений, фактически начиная новый просмотр страницы.

Методы

---

clear

clear(slots?: Slot[]): boolean

Удаляет объявления из указанных рекламных мест и заменяет их пустым контентом. Рекламные места будут помечены как неполученные.

В частности, очистка рекламного места удаляет объявление из долгосрочного просмотра страницы тега GPT, поэтому на будущие запросы не будут влиять блокировки или конкурентные исключения, связанные с этим объявлением.

Пример

JavaScript

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

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

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

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

TypeScript

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

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

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

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

Параметры
Optional slots: Slot[]	Массив рекламных мест, которые нужно очистить. Массив необязателен. Если он не указан, будут очищены все рекламные места.

Возвраты
boolean	Возвращает true, если рекламные места были очищены, и false в противном случае.

---

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService

Удаляет все ярлыки для исключения категорий объявлений уровня страницы. Это удобно, если вы хотите обновить рекламное место.

Устарело. Используйте вместо этого PageSettingsConfig.categoryExclusion.

Пример

JavaScript

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

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

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

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

TypeScript

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

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

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

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

Статьи по теме

• Специальные ярлыки для блокировки объявлений

Возвраты
PubAdsService	Объект сервиса, для которого был вызван метод.

---

clearTargeting

clearTargeting(key?: string): PubAdsService

Удаляет параметры таргетинга со специальными настройками для определенного ключа или для всех ключей.

Устарело. Используйте вместо этого PageSettingsConfig.targeting.

Пример

JavaScript

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

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

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

TypeScript

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

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

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

Статьи по теме

• Таргетинг на пары "ключ-значение"

Параметры
Optional key: string	Ключ параметра таргетинга. Ключ указывать необязательно. Если он не задан, будут удалены все параметры таргетинга.

Возвраты
PubAdsService	Объект сервиса, для которого был вызван метод.

---

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

Позволяет сворачивать блоки div рекламных мест, чтобы они не занимали место на странице, когда нет объявлений для показа. Этот режим необходимо задать до включения сервиса.

Устарело. Используйте вместо этого PageSettingsConfig.collapseDiv.

Статьи по теме

• Сворачивание пустых рекламных мест
• Минимизируйте смещение макета

Параметры
Optional collapseBeforeAdFetch: boolean	Нужно ли сворачивать рекламные места до получения объявлений. Это необязательный параметр. Если он не указан, по умолчанию будет использоваться значение false.

Возвраты
boolean	Возвращает true, если режим сворачивания div-контейнера был включен, и false, если включить режим сворачивания невозможно, поскольку метод был вызван после включения сервиса.

---

disableInitialLoad

disableInitialLoad(): void

Отключает запросы объявлений при загрузке страницы, но позволяет запрашивать объявления с помощью вызова PubAdsService.refresh. Это нужно сделать до включения сервиса. Необходимо использовать асинхронный режим, иначе запрашивать объявления с помощью refresh будет невозможно.

Устарело. Используйте вместо этого PageSettingsConfig.disableInitialLoad.

Статьи по теме

• Управление загрузкой и обновлением объявлений
• Управление пакетами в режиме единого запроса

---

display

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

Создает и показывает рекламное место с заданным путем к рекламному блоку и размером.

Этот метод является сокращенным эквивалентом вызова googletag.defineSlot, за которым сразу следует googletag.display.

Поведение этого метода зависит от того, включен ли режим единого запроса:

• Режим единого запроса включен. Все рекламные места, определенные до момента вызова, будут объединены в пакет и запрошены вместе.
• Режим единого запроса отключен (по умолчанию). Запрос будет отправлен только для одного рекламного места.

Примечание. При вызове этого метода создается снимок рекламного места и состояния страницы, чтобы обеспечить согласованность при отправке запроса объявления и обработке ответа. Любые изменения, внесенные в рекламное место или страницу после вызова этого метода (включая таргетинг, настройки конфиденциальности, принудительное использование SafeFrame и т. д.), будут применяться только к последующим запросам display() или refresh().

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Как показать тестовое объявление
• Управление загрузкой и обновлением объявлений

Параметры
adUnitPath: string	Путь к рекламному блоку, который нужно отобразить.
size: GeneralSize	Ширина и высота рекламного места.
Optional div: string | Element	Идентификатор элемента div, содержащего рекламное место, или сам элемент div.
Optional clickUrl: string	URL клика, который будет использоваться в этом рекламном месте.

---

enableLazyLoad

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

Включает отложенную загрузку в теге GPT, как определено объектом конфигурации. Более подробные примеры приведены в статье Отложенная загрузка.

Примечание. Отложенный запрос в режиме единого запроса работает, только если все рекламные места находятся за пределами области запроса.

Устарело. Используйте вместо этого PageSettingsConfig.lazyLoad.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Рекомендации по работе с объявлениями: отдавайте приоритет важным рекламным местам
• Отложенная загрузка

Параметры

Optional config: {   fetchMarginPercent?: number;   mobileScaling?: number;   renderMarginPercent?: number; }

Объект конфигурации позволяет настраивать отложенную загрузку. Для всех пропущенных конфигураций будут использоваться настройки по умолчанию, заданные Google. Со временем они будут корректироваться. Чтобы отключить определенную настройку, например запас времени для получения, задайте значение -1. fetchMarginPercent Минимальное расстояние от текущей области просмотра, на котором должно находиться рекламное место, чтобы мы получили объявление. Выражается в процентах от размера области просмотра. Значение 0 означает, что объявление будет загружено, когда рекламное место появится в области просмотра, 100 – когда объявление будет находиться на расстоянии одной области просмотра от нее и т. д. renderMarginPercent Минимальное расстояние от текущей области просмотра до рекламного места, при котором объявление будет показано. Это позволяет предварительно загружать объявление, но откладывать отрисовку и скачивание других дочерних ресурсов. Значение работает так же, как fetchMarginPercent в процентах от области просмотра. mobileScaling Множитель, применяемый к полям на мобильных устройствах. Это позволяет задавать разные поля для мобильных устройств и компьютеров. Например, значение 2,0 умножит все поля на 2 на мобильных устройствах, увеличив минимальное расстояние, на котором может находиться рекламное место до получения и отрисовки.

---

enableSingleRequest

enableSingleRequest(): boolean

Включает режим единого запроса для одновременного получения нескольких объявлений. Для этого необходимо определить все рекламные места и добавить их в PubAdsService до включения сервиса. Режим единого запроса необходимо настроить до включения сервиса.

Устарело. Используйте вместо этого PageSettingsConfig.singleRequest.

Статьи по теме

• Рекомендации по работе с объявлениями: как правильно использовать режим единого запроса
• Управление пакетами в режиме единого запроса

Возвраты
boolean	Возвращает true, если режим единого запроса включен, и false, если его невозможно включить, поскольку метод был вызван после включения сервиса.

---

enableVideoAds

enableVideoAds(): void

Сообщает тегу GPT, что на странице будут показываться видеообъявления. Это позволяет применять ограничения конкурентных исключений к медийным объявлениям и видеорекламе. Если видеоконтент известен, вызовите PubAdsService.setVideoContent, чтобы использовать исключение контента для медийных объявлений.

Устарело. Вместо этого используйте PageSettingsConfig.videoAds.

---

get

get(key: string): string

Возвращает значение атрибута AdSense, связанного с указанным ключом.

Устарело. Используйте вместо этого googletag.getConfig.

Пример

JavaScript

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

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

TypeScript

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

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

Статьи по теме

• Атрибуты AdSense

Параметры
key: string	Название атрибута, который нужно найти.

Возвраты
string	Текущее значение ключа атрибута или null, если ключ отсутствует.

---

getAttributeKeys

getAttributeKeys(): string[]

Возвращает ключи атрибутов, заданные для этого сервиса.

Устарело. Используйте вместо этого googletag.getConfig.

Пример

JavaScript

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

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

TypeScript

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

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

Возвраты
string[]	Массив ключей атрибутов, заданных для этого сервиса. Порядок не определен.

---

getTargeting

getTargeting(key: string): string[]

Возвращает заданный специальный параметр таргетинга на уровне сервиса.

Устарело. Используйте вместо этого googletag.getConfig.

Пример

JavaScript

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

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

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

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

TypeScript

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

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

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

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

Параметры
key: string	Ключ таргетинга, который нужно найти.

Возвраты
string[]	Значения, связанные с этим ключом, или пустой массив, если такого ключа нет.

---

getTargetingKeys

getTargetingKeys(): string[]

Возвращает список всех заданных ключей таргетинга на уровне сервиса.

Устарело. Используйте вместо этого googletag.getConfig.

Пример

JavaScript

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

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

TypeScript

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

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

Возвраты
string[]	Массив ключей таргетинга. Порядок не определен.

---

isInitialLoadDisabled

isInitialLoadDisabled(): boolean

Возвращает информацию о том, были ли успешно отключены первоначальные запросы объявлений предыдущим вызовом PubAdsService.disableInitialLoad.

Устарело. Используйте вместо этого googletag.getConfig.

Возвраты
boolean	Возвращает true, если предыдущий вызов PubAdsService.disableInitialLoad был успешным, и false в противном случае.

---

refresh

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void

Получает и показывает новые объявления для определенных или всех рекламных мест на странице. Работает только в режиме асинхронной отрисовки.

Чтобы обеспечить корректную работу во всех браузерах, перед вызовом refresh необходимо вызвать display для рекламного места. Если вызов display не выполняется, обновление может работать некорректно. При необходимости можно использовать метод PubAdsService.disableInitialLoad, чтобы запретить display получать объявление.

Обновление рекламного места удаляет старое объявление из долгосрочного просмотра страницы тега GPT, поэтому на будущие запросы не будут влиять блокировки или конкурентные исключения, связанные с этим объявлением.

Пример

JavaScript

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

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

TypeScript

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

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

Статьи по теме

• Управление загрузкой и обновлением объявлений
• Обновление рекламных мест

Параметры
Optional slots: Slot[]	Рекламные места, которые нужно обновить. Массив необязателен. Если он не указан, будут обновлены все рекламные места.
Optional options: {   changeCorrelator: boolean; }	Параметры конфигурации, связанные с этим вызовом обновления. changeCorrelator Указывает, нужно ли генерировать новый коррелятор для получения объявлений. Наши серверы объявлений хранят значение коррелятора в течение короткого времени (в настоящее время – 30 секунд, но это может измениться). Запросы с одинаковым коррелятором, полученные в течение этого времени, считаются относящимися к одному просмотру страницы. По умолчанию при каждом обновлении создается новый коррелятор. Примечание. Эта настройка не влияет на долгосрочные просмотры страниц, которые автоматически отражают объявления, показываемые на странице, и не имеют срока действия.

---

registerRequestHook

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

Experimental Регистрирует хук, который будет выполняться параллельно с другими зарегистрированными хуками перед каждым запросом объявления на странице в рамках глобального тайм-аута.

Пример

JavaScript

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

// Unregister the hook.
unregister();

TypeScript

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

// Unregister the hook.
unregister();

Параметры
hook: RequestHook	Функция, которая принимает объект, содержащий список запрошенных рекламных мест, и возвращает обещание, которое выполняется после завершения всех асинхронных действий.
hookId: string	Идентификатор, который позволяет пометить хук для улучшения диагностики.

Возвраты
(() => void)	Функция, отменяющая регистрацию хука.

---

set

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

Задает значения атрибутов AdSense, которые применяются ко всем рекламным местам в сервисе Publisher Ads.

Если вызвать этот метод несколько раз для одного и того же ключа, то ранее заданные значения будут перезаписаны. Все значения должны быть заданы до вызова display или refresh.

Устарело. Вместо этого используйте PageSettingsConfig.adsenseAttributes.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Атрибуты AdSense

Параметры
key: string	Название атрибута.
value: string	Значение атрибута.

Возвраты
PubAdsService	Объект сервиса, для которого был вызван метод.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService

Задает исключение категорий объявлений уровня страницы для указанного названия ярлыка.

Устарело. Используйте вместо этого PageSettingsConfig.categoryExclusion.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Специальные ярлыки для блокировки объявлений

Параметры
categoryExclusion: string	Ярлык для исключения категории объявлений, который нужно добавить.

Возвраты
PubAdsService	Объект сервиса, для которого был вызван метод.

---

setCentering

setCentering(centerAds: boolean): void

Включает и отключает горизонтальное центрирование объявлений. По умолчанию центрирование отключено. В устаревшем файле gpt_mobile.js центрирование включено по умолчанию.

Этот метод необходимо вызывать до display или refresh, поскольку центрироваться будут только объявления, запрошенные после вызова этого метода.

Устарело. Используйте PageSettingsConfig.centering.

Пример

JavaScript

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

TypeScript

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

Параметры
centerAds: boolean	true – по центру, false – по левому краю.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Определяет, должны ли все объявления на странице показываться в контейнере SafeFrame.

При использовании этого API учитывайте следующее:

• Эта настройка будет действовать только для последующих запросов объявлений, отправленных для соответствующих рекламных мест.
• Настройки на уровне рекламного места всегда переопределяют настройки на уровне страницы.
• Если задать значение true (на уровне рекламного места или страницы), объявление всегда будет показываться в контейнере SafeFrame независимо от настроек в интерфейсе Google Менеджера рекламы.
• Если же задано значение false или параметр не указан, то объявление будет показываться в контейнере SafeFrame в зависимости от типа креатива и настроек, заданных в интерфейсе Google Менеджера рекламы.
• Этот API следует использовать с осторожностью, поскольку он может повлиять на поведение креативов, которые пытаются выйти за пределы своих фреймов iframe или полагаются на то, что они будут отображаться непосредственно на странице издателя.

Устарело. Используйте вместо этого PageSettingsConfig.safeFrame.

Пример

JavaScript

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

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: false,
    },
  })
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

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

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      forceSafeFrame: false,
    },
  })
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Статьи по теме

• Как показывать креативы с помощью SafeFrame

Параметры
forceSafeFrame: boolean	true, чтобы все объявления на странице показывались в контейнерах SafeFrame, и false, чтобы отменить предыдущую настройку. Если вы не задавали значение ранее, то при выборе false ничего не изменится.

Возвраты
PubAdsService	Объект сервиса, для которого был вызван метод.

---

setLocation

setLocation(address: string): PubAdsService

Передает данные о местоположении с сайтов, чтобы вы могли настроить геотаргетинг позиций на определенные местоположения.

Устарело. Используйте вместо этого PageSettingsConfig.location.

Пример

JavaScript

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

TypeScript

// Postal code:
googletag.setConfig({
  location: "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,
});

TypeScript

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

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

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

Статьи по теме

• Как задать настройки конфиденциальности
• Показ ограниченной рекламы

Параметры
privacySettings: PrivacySettingsConfig	Объект, содержащий конфигурацию настроек конфиденциальности.

Возвраты
PubAdsService	Объект сервиса, для которого была вызвана функция.

---

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService

Задает значение для идентификатора, назначаемого издателем.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Идентификаторы, назначаемые издателем

Параметры
ppid: string	Буквенно-цифровой идентификатор, назначаемый издателем. Должно содержать от 22 до 150 символов.

Возвраты
PubAdsService	Объект сервиса, для которого был вызван метод.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

Задает настройки на уровне страницы для конфигурации SafeFrame. Все нераспознанные ключи в объекте конфигурации будут игнорироваться. Если для распознанного ключа передано недопустимое значение, вся конфигурация будет игнорироваться.

Эти настройки на уровне страницы будут переопределены настройками на уровне рекламного места, если они заданы.

Устарело. Используйте вместо этого PageSettingsConfig.safeFrame.

Пример

JavaScript

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

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

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

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Статьи по теме

• Как показывать креативы с помощью SafeFrame

Параметры
config: SafeFrameConfig	Объект конфигурации.

Возвраты
PubAdsService	Объект сервиса, для которого был вызван метод.

---

setTargeting

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

Задает параметры таргетинга со специальными настройками для определенного ключа, которые применяются ко всем рекламным местам сервиса Publisher Ads. Если вызвать этот метод несколько раз для одного ключа, старые значения будут перезаписаны. Эти ключи определяются в аккаунте Google Менеджера рекламы.

Устарело. Используйте вместо этого PageSettingsConfig.targeting.

Пример

JavaScript

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

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

TypeScript

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

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

Статьи по теме

• Таргетинг на пары "ключ-значение"

Параметры
key: string	Ключ параметра таргетинга.
value: string | string[]	Значение или массив значений параметра таргетинга.

Возвраты
PubAdsService	Объект сервиса, для которого был вызван метод.

---

setVideoContent

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

Задает информацию о видеоконтенте, которая будет отправляться вместе с запросами объявлений для таргетинга и исключения контента. При вызове этого метода видеообъявления будут включены автоматически. Для videoContentId и videoCmsId используйте значения, которые передаются в сервис приема контента Google Менеджера рекламы.

Устарело. Используйте PageSettingsConfig.videoAds.

Статьи по теме

• Параметры URL тегов объявлений VAST

Параметры
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.

TypeScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

Возвраты
PubAdsService	Объект сервиса, для которого была вызвана функция.

---

googletag.RequestHook

Функция обратного вызова, которая вызывается перед каждым запросом объявления, если она зарегистрирована с помощью PubAdsService.registerRequestHook.

---

googletag.ResponseInformation

Объект, представляющий один ответ на запрос объявления.

Свойства
advertiserId	Идентификатор рекламодателя.
campaignId	Идентификатор кампании.
creativeId	Идентификатор креатива.
creativeTemplateId	Идентификатор шаблона объявления.
lineItemId	Идентификатор позиции.

Статьи по теме

• Slot.getResponseInformation

Свойства

---

advertiserId

advertiserId: number

Идентификатор рекламодателя.

---

campaignId

campaignId: number

Идентификатор кампании.

---

creativeId

creativeId: number

Идентификатор креатива.

---

creativeTemplateId

creativeTemplateId: number

Идентификатор шаблона объявления.

---

lineItemId

lineItemId: number

Идентификатор позиции.

---

googletag.RewardedPayload

Объект, представляющий вознаграждение, связанное с объявлением с вознаграждением.

Свойства
amount	Количество предметов в награде.
type	Тип предмета, который пользователь получает в качестве вознаграждения (например, "монета").

Статьи по теме

• Как показывать объявления с вознаграждением

Свойства

---

amount

amount: number

Количество предметов в награде.

---

type

type: string

Тип предмета, который пользователь получает в качестве вознаграждения (например, "монета").

---

googletag.Service

Базовый класс сервиса, содержащий методы, общие для всех сервисов.

Методы
addEventListener	Регистрирует прослушиватель, который позволяет настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT.
getSlots	Получить список интервалов, связанных с этим сервисом.
removeEventListener	Удаляет ранее зарегистрированный прослушиватель.

Методы

---

addEventListener

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

Регистрирует прослушиватель, который позволяет настроить и вызвать функцию JavaScript, когда на странице происходит определенное событие GPT. Поддерживаются следующие события:

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

При вызове прослушивателя ему передается объект соответствующего типа события.

Пример

JavaScript

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

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

TypeScript

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

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

Статьи по теме

• Прослушиватели событий объявлений

Параметры
eventType: K	Строка, представляющая тип события, созданного тегом GPT. Типы событий вводятся с учетом регистра.
listener: ((arg: EventTypeMap[K]) => void)	Функция, которая принимает один аргумент объекта события.

Возвраты
Service	Объект сервиса, для которого был вызван метод.

---

getSlots

getSlots(): Slot[]

Получить список интервалов, связанных с этим сервисом.

Возвраты
Slot[]	Интервалы в порядке их добавления в сервис.

---

removeEventListener

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

Удаляет ранее зарегистрированный прослушиватель.

Пример

JavaScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

TypeScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag
    .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")!
    .addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

Параметры
eventType: K	Строка, представляющая тип события, созданного тегом GPT. Типы событий вводятся с учетом регистра.
listener: ((event: EventTypeMap[K]) => void)	Функция, которая принимает один аргумент объекта события.

---

googletag.SizeMappingBuilder

Конструктор для объектов спецификации сопоставления размеров. Этот конструктор поможет вам легко задать размеры.

Методы
addSize	Добавляет сопоставление между массивом с одним размером (представляющим область просмотра) и массивом с одним или несколькими размерами (представляющим рекламное место).
build	Создает спецификацию сопоставления размеров на основе сопоставлений, добавленных в этот конструктор.

Статьи по теме

• Размеры адаптивных объявлений

Методы

---

addSize

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

Добавляет сопоставление между массивом с одним размером (представляющим область просмотра) и массивом с одним или несколькими размерами (представляющим рекламное место).

Пример

JavaScript

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

TypeScript

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

Параметры
viewportSize: SingleSizeArray	Размер области просмотра для этой записи сопоставления.
slotSize: GeneralSize	Размеры рекламного места для этой записи сопоставления.

Возвраты
SizeMappingBuilder	Ссылка на этот конструктор.

---

build

build(): SizeMappingArray

Создает спецификацию сопоставления размеров на основе сопоставлений, добавленных в этот конструктор.

Если были указаны недопустимые сопоставления, этот метод возвращает значение null. В противном случае возвращает спецификацию в правильном формате для передачи в Slot.defineSizeMapping.

Примечание. Поведение конструктора после вызова этого метода не определено.

Возвраты
SizeMappingArray	Результат, созданный этим конструктором. Если указаны недопустимые сопоставления размеров, значение может быть пустым.

---

googletag.Slot

Рекламное место – это объект, представляющий одно рекламное место на странице.

Методы
addService	Добавляет сервис в это рекламное место.
clearCategoryExclusions	Столбец больше не доступен.  Удаляет все ярлыки для исключения категорий объявлений на уровне рекламного места.
clearTargeting	Столбец больше не доступен. Удаляет определенные или все специальные параметры таргетинга на уровне рекламного места.
defineSizeMapping	Задает массив сопоставлений между минимальным размером области просмотра и размером рекламного места.
get	Столбец больше не доступен. Возвращает значение атрибута AdSense, связанного с заданным ключом для этого рекламного места.
getAdUnitPath	Возвращает полный путь к рекламному блоку, включая код сети и путь к рекламному блоку.
getAttributeKeys	Столбец больше не доступен.  Возвращает список ключей атрибутов, заданных для этого рекламного места.
getCategoryExclusions	Столбец больше не доступен. Возвращает ярлыки для исключения категорий объявлений, относящиеся к этому рекламному месту.
getConfig	Получает неизменяемую копию общих параметров конфигурации для рекламного места, заданных с помощью setConfig.
getResponseInformation	Возвращает информацию об ответе на запрос объявления.
getSlotElementId	Возвращает идентификатор рекламного места div, указанный при его определении.
getTargeting	Столбец больше не доступен. Возвращает определенный параметр таргетинга со специальными настройками, заданный для этого рекламного места.
getTargetingKeys	Столбец больше не доступен. Возвращает список всех ключей таргетинга со специальными настройками, заданных для этого рекламного места.
set	Столбец больше не доступен. Задает значение атрибута AdSense для рекламного места.
setCategoryExclusion	Столбец больше не доступен.  Задает ярлык для исключения категорий объявлений на уровне рекламного места.
setClickUrl	Столбец больше не доступен.  Задает URL клика, на который будут перенаправляться пользователи, нажавшие на объявление.
setCollapseEmptyDiv	Столбец больше не доступен. Определяет, нужно ли скрывать рекламное место div, если на нем нет объявления.
setConfig	Задает общие параметры конфигурации для этого рекламного места.
setForceSafeFrame	Столбец больше не доступен.  Позволяет настроить принудительный показ рекламы в этом рекламном месте в контейнере SafeFrame.
setSafeFrameConfig	Столбец больше не доступен.  Задает настройки на уровне рекламного места для конфигурации SafeFrame.
setTargeting	Столбец больше не доступен. Задает параметр таргетинга со специальными настройками для этого рекламного места.
updateTargetingFromMap	Столбец больше не доступен. Задает параметры таргетинга со специальными настройками для этого рекламного места на основе сопоставления ключей и значений в объекте JSON.

Методы

---

addService

addService(service: Service): Slot

Добавляет сервис в рекламное место.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Начало работы с тегами Google Publisher Tag
• Как показать тестовое объявление

Параметры
service: Service	Сервис, который нужно добавить.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

clearCategoryExclusions

clearCategoryExclusions(): Slot

Удаляет все ярлыки для исключения категорий объявлений на уровне рекламного места.

Устарело. Используйте вместо этого SlotSettingsConfig.categoryExclusion.

Пример

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

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

// Make an ad request. Any ad can be returned for the slot.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

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

// Make an ad request. Any ad can be returned for the slot.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

clearTargeting

clearTargeting(key?: string): Slot

Удаляет определенные или все специальные параметры таргетинга на уровне рекламного места.

Устарело. Используйте вместо этого SlotSettingsConfig.targeting.

Пример

JavaScript

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

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

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

TypeScript

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

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

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

Статьи по теме

• Таргетинг на пары "ключ-значение"

Параметры
Optional key: string	Ключ параметра таргетинга. Ключ указывать необязательно. Если он не задан, будут удалены все параметры таргетинга.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Задает массив сопоставлений между минимальным размером области просмотра и размером рекламного места.

Пример

JavaScript

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

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

TypeScript

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

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping!);

Статьи по теме

• Размеры адаптивных объявлений

Параметры
sizeMapping: SizeMappingArray	Массив сопоставлений размеров. Для этого можно использовать SizeMappingBuilder. Каждое сопоставление размеров представляет собой массив из двух элементов: SingleSizeArray и GeneralSize.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

get

get(key: string): string

Возвращает значение атрибута AdSense, связанного с заданным ключом для этого рекламного места. Чтобы посмотреть атрибуты на уровне сервиса, унаследованные этим рекламным местом, используйте PubAdsService.get.

Устарело. Используйте вместо этого googletag.Slot.getConfig.

Пример

JavaScript

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

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

TypeScript

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

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

Статьи по теме

• Атрибуты AdSense

Параметры
key: string	Название атрибута, который нужно найти.

Возвраты
string	Текущее значение ключа атрибута или null, если ключ отсутствует.

---

getAdUnitPath

getAdUnitPath(): string

Возвращает полный путь к рекламному блоку, включая код сети и путь к рекламному блоку.

Пример

JavaScript

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

slot.getAdUnitPath();
// Returns '/1234567/sports'.

TypeScript

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

slot.getAdUnitPath();
// Returns '/1234567/sports'.

Возвраты
string	Путь к рекламному блоку.

---

getAttributeKeys

getAttributeKeys(): string[]

Возвращает список ключей атрибутов, заданных для этого рекламного места. Чтобы посмотреть ключи атрибутов на уровне сервиса, унаследованные этим рекламным местом, используйте PubAdsService.getAttributeKeys.

Устарело. Используйте вместо этого googletag.Slot.getConfig.

Пример

JavaScript

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

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

TypeScript

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

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

Возвраты
string[]	Массив ключей атрибутов. Порядок не определен.

---

getCategoryExclusions

getCategoryExclusions(): string[]

Возвращает ярлыки для исключения категорий объявлений, относящиеся к этому рекламному месту.

Устарело. Используйте вместо этого googletag.Slot.getConfig.

Пример

JavaScript

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

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

TypeScript

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

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

Возвраты
string[]	Ярлыки для исключения категорий объявлений для этого рекламного места или пустой массив, если они не заданы.

---

getConfig

getConfig(keys: string | string[]): Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>

Возвращает неизменяемую копию общих параметров конфигурации для рекламного места, заданных с помощью setConfig.

Этот метод поддерживает не все свойства setConfig(). Поддерживаемые свойства:

• adsenseAttributes
• categoryExclusion
• targeting

Пример

JavaScript

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

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

TypeScript

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

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

Параметры
keys: string | string[]	Ключи параметров конфигурации, которые нужно получить.

Возвраты
Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>	Замороженная копия параметров конфигурации для рекламного места.

---

getResponseInformation

getResponseInformation(): ResponseInformation

Возвращает информацию об ответе на запрос объявления. Это значение основано на последнем ответе на запрос объявления для рекламного места. Если вызвать этот метод, когда в рекламном месте нет объявления, будет возвращено значение null.

Возвраты
ResponseInformation	Последние данные об ответе на запрос объявления или null, если в рекламном месте нет объявления.

---

getSlotElementId

getSlotElementId(): string

Возвращает идентификатор рекламного места div, указанный при его определении.

Пример

JavaScript

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

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

TypeScript

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

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

Возвраты
string	Идентификатор рекламного места div.

---

getTargeting

getTargeting(key: string): string[]

Возвращает определенный параметр таргетинга со специальными настройками, заданный для этого рекламного места. Параметры таргетинга на уровне сервиса не включены.

Устарело. Используйте вместо этого googletag.Slot.getConfig.

Пример

JavaScript

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

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

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

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

TypeScript

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

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

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

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

Параметры
key: string	Ключ таргетинга, который нужно найти.

Возвраты
string[]	Значения, связанные с этим ключом, или пустой массив, если такого ключа нет.

---

getTargetingKeys

getTargetingKeys(): string[]

Возвращает список всех ключей таргетинга со специальными настройками, заданных для этого рекламного места. Ключи таргетинга на уровне сервиса не включаются.

Устарело. Используйте вместо этого googletag.Slot.getConfig.

Пример

JavaScript

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

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

TypeScript

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

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

Возвраты
string[]	Массив ключей таргетинга. Порядок не определен.

---

set

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

Задает значение атрибута AdSense для этого рекламного места. Это переопределит все значения, заданные на уровне сервиса для этого ключа.

Если вызвать этот метод несколько раз для одного и того же ключа, ранее заданные значения для этого ключа будут переопределены. Все значения должны быть заданы до вызова display или refresh.

Устарело. Вместо этого используйте SlotSettingsConfig.adsenseAttributes.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Атрибуты AdSense

Параметры
key: string	Название атрибута.
value: string	Значение атрибута.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot

Устанавливает ярлык для исключения категории объявления на уровне рекламного места в этом рекламном месте.

Устарело. Используйте вместо этого SlotSettingsConfig.categoryExclusion.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Специальные ярлыки для блокировки объявлений

Параметры
categoryExclusion: string	Ярлык для исключения категории объявлений, который нужно добавить.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

setClickUrl

setClickUrl(value: string): Slot

Задает URL клика, на который будут перенаправляться пользователи, нажавшие на объявление.

Серверы Google Менеджера рекламы регистрируют клик, даже если URL клика заменен. К указанному значению добавляется URL целевой страницы, связанный с показанным креативом. Последующие вызовы перезаписывают значение. Это работает только для запросов, не относящихся к архитектуре единого запроса.

Устарело. Используйте вместо этого SlotSettingsConfig.clickUrl.

Пример

JavaScript

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

TypeScript

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

Параметры
value: string	URL клика, который нужно задать.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

setCollapseEmptyDiv

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

Указывает, нужно ли скрывать рекламное место div, если на нем нет объявления. Эта настройка переопределяет настройки на уровне сервиса.

Устарело. Используйте вместо этого SlotSettingsConfig.collapseDiv.

Пример

JavaScript

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

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

TypeScript

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

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

Статьи по теме

• Сворачивание пустых рекламных мест
• Минимизируйте смещение макета

Параметры
collapse: boolean	Сворачивать ли рекламное место, если объявление не возвращено.
Optional collapseBeforeAdFetch: boolean	Сворачивать ли рекламное место до получения объявления. Игнорируется, если для параметра collapse не задано значение true.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

setConfig

setConfig(slotConfig: SlotSettingsConfig): Slot

Задает общие параметры конфигурации для этого рекламного места.

Параметры
slotConfig: SlotSettingsConfig	Объект конфигурации.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Определяет, должны ли объявления в этом рекламном месте показываться в контейнере SafeFrame.

При использовании этого API учитывайте следующее:

• Эта настройка будет действовать только для последующих запросов объявлений, отправленных для соответствующих рекламных мест.
• Настройки на уровне рекламного места всегда переопределяют настройки на уровне страницы.
• Если задать значение true (на уровне рекламного места или страницы), объявление всегда будет показываться в контейнере SafeFrame независимо от настроек в интерфейсе Google Менеджера рекламы.
• Если же задано значение false или параметр не указан, то объявление будет показываться в контейнере SafeFrame в зависимости от типа креатива и настроек, заданных в интерфейсе Google Менеджера рекламы.
• Этот API следует использовать с осторожностью, поскольку он может повлиять на поведение креативов, которые пытаются выйти за пределы своих фреймов iframe или полагаются на то, что они будут отображаться непосредственно на странице издателя.

Устарело. Используйте SlotSettingsConfig.safeFrame.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Как показывать креативы с помощью SafeFrame

Параметры
forceSafeFrame: boolean	true – чтобы все объявления в этом рекламном месте показывались в контейнерах SafeFrame; false – чтобы отказаться от настроек на уровне страницы (если они есть). Если задать значение false, когда на уровне страницы ничего не указано, ничего не изменится.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot

Задает настройки на уровне рекламного места для конфигурации SafeFrame. Все нераспознанные ключи в объекте конфигурации будут игнорироваться. Если для распознанного ключа передано недопустимое значение, вся конфигурация будет игнорироваться.

Если указаны настройки на уровне рекламного места, они переопределят настройки на уровне страницы.

Устарело. Используйте вместо этого SlotSettingsConfig.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");

TypeScript

googletag.pubads().setForceSafeFrame(true);

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

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Статьи по теме

• Как показывать креативы с помощью SafeFrame

Параметры
config: SafeFrameConfig	Объект конфигурации.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

setTargeting

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

Задает параметр таргетинга со специальными настройками для этого рекламного места. Если вызвать этот метод несколько раз для одного ключа, старые значения будут перезаписаны. Значения, заданные здесь, переопределят параметры таргетинга, заданные на уровне сервиса. Эти ключи задаются в аккаунте Google Менеджера рекламы.

Устарело. Вместо этого используйте SlotSettingsConfig.targeting.

Пример

JavaScript

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

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

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

TypeScript

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

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

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

Статьи по теме

• Таргетинг на пары "ключ-значение"

Параметры
key: string	Ключ параметра таргетинга.
value: string | string[]	Значение или массив значений параметра таргетинга.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

updateTargetingFromMap

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

Задает параметры таргетинга со специальными настройками для этого рекламного места на основе сопоставления ключей и значений в объекте JSON. Это аналогично вызову Slot.setTargeting для всех пар "ключ-значение" объекта. Эти ключи задаются в аккаунте Google Менеджера рекламы.

Примечания

• В случае перезаписи будет сохранено только последнее значение.
• Если значение является массивом, то предыдущее значение будет перезаписано, а не объединено.
• Значения, заданные здесь, переопределят параметры таргетинга, заданные на уровне сервиса.

Устарело. Используйте SlotSettingsConfig.targeting.

Пример

JavaScript

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

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

TypeScript

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

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

Параметры
map: {   [adUnitPath: string]: string | string[]; }	Сопоставление ключей и значений параметров таргетинга.

Возвраты
Slot	Объект рекламного места, для которого был вызван метод.

---

googletag.config

Основной интерфейс для настроек на уровне страницы.

Интерфейсы
AdExpansionConfig	Настройки, позволяющие управлять расширением объявлений.
AdSenseAttributesConfig	Настройки, управляющие поведением объявлений AdSense.
AutoRefreshConfig	Настройки автоматического обновления.
ContinueButtonConfig	Настройки, позволяющие задать поведение кнопки "Продолжить".
InterstitialConfig	Объект, определяющий поведение одного рекламного места для межстраничного объявления.
LazyLoadConfig	Настройки, позволяющие управлять использованием отложенной загрузки в тегах GPT.
PageSettingsConfig	Основной интерфейс для настроек на уровне страницы.
PrivacyTreatmentsConfig	Настройки, позволяющие управлять обработкой конфиденциальных данных издателя.
PublisherProvidedSignalsConfig	Объект конфигурации сигналов, предоставленных издателем.
SafeFrameConfig	Настройки, позволяющие управлять SafeFrame в тегах GPT.
SlotSettingsConfig	Основной интерфейс конфигурации для настроек на уровне рекламного места.
TaxonomyData	Объект, содержащий значения для одной таксономии.
VideoAdsConfig	Настройки, связанные с видеорекламой.

Псевдонимы типов
CollapseDivBehavior	Допустимые значения для управления сворачиванием рекламных мест.
InterstitialTrigger	Поддерживаемые триггеры межстраничных объявлений.
PrivacyTreatment	Поддерживаемые варианты защиты конфиденциальности издателем.
Taxonomy	Поддерживаемые таксономии для сигналов, предоставленных издателем.

Псевдонимы типов

---

CollapseDivBehavior

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

Допустимые значения для управления свертыванием рекламных мест.

Статьи по теме

• PageSettingsConfig.collapseDiv
• SlotSettingsConfig.collapseDiv

---

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar" | "inactivity" | "endOfArticle" | "continueReading" | "backward"

Поддерживаемые триггеры межстраничных объявлений.

Примечание. С 15 июня 2026 года триггер backward больше не будет поддерживаться, и его включение не будет иметь никакого эффекта. Дополнительную информацию можно найти в примечаниях к выпуску GPT.

---

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

Поддерживаемые варианты защиты конфиденциальности издателем.

---

Таксономия

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Поддерживаемые классификации для сигналов, предоставленных издателем.

Статьи по теме

• Классификация аудиторий IAB (версия 1.1)
• Классификация контента IAB 2.2

---

googletag.config.AdExpansionConfig

Настройки, позволяющие управлять расширением объявлений.

Свойства
enabled?	Включено ли расширение объявлений.

Пример

JavaScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

TypeScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

Свойства

---

Optional включено

enabled?: boolean

Включено или отключено расширение объявлений.

Если задать это значение, то оно переопределит настройки по умолчанию, заданные в Google Менеджере рекламы.

Статьи по теме

• Расширяемые объявления на компьютерах и планшетах
• Объявления, которые разворачиваются на часть экрана на мобильных сайтах

---

googletag.config.AdSenseAttributesConfig

Настройки, управляющие поведением объявлений AdSense.

Эти атрибуты можно использовать для переопределения настроек на стороне сервера для каждого запроса.

Свойства
adsense_ad_format?	Формат объявления AdSense.
adsense_channel_ids?	Идентификаторы каналов AdSense.
adsense_test_mode?	Включен ли тестовый режим.
document_language?	Язык страницы, на которой показываются объявления.
page_url?	URL страницы, на которой показываются объявления.

Статьи по теме

• PageSettingsConfig.adsenseAttributes
• SlotSettingsConfig.adsenseAttributes

Свойства

---

Optional adsense_ad_format

adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"

Формат объявления AdSense.

---

Optional adsense_channel_ids

adsense_channel_ids?: string

Идентификаторы каналов AdSense.

Допустимые значения – идентификаторы каналов, разделенные знаком "+".

Пример: 271828183+314159265

Статьи по теме

• Как отслеживать эффективность рекламных блоков с помощью клиентских каналов

---

Optional adsense_test_mode

adsense_test_mode?: "on"

Включен ли тестовый режим.

Если задано значение on, объявления помечаются как тестовые и не учитываются в статистике и при расчете оплаты. Для рабочего, не тестового трафика этот параметр не должен быть задан.

---

Optional document_language

document_language?: string

Язык страницы, на которой показываются объявления.

Допустимые значения – коды языков по стандарту ISO 639-1.

Пример: en

Статьи по теме

• Список языковых кодов ISO 639

---

Optional page_url

page_url?: string

URL страницы, на которой показываются объявления.

Допустимые значения – действительные URL.

Пример: http://www.example.com.

---

googletag.config.AutoRefreshConfig

Настройки автоматического обновления.

Свойства
backForwardCache?	Будет ли тег GPT автоматически обновлять рекламное место, которое активно просматривается, когда страница восстанавливается из возвратного кеша.
heavyAds?	Будет ли тег GPT автоматически обновлять рекламное место, если в Chrome сработает вмешательство в работу ресурсоемкой рекламы для iframe объявления.

Свойства

---

Optional backForwardCache

backForwardCache?: boolean

Будет ли тег GPT автоматически обновлять рекламное место, которое активно просматривается, когда страница восстанавливается из возвратного кеша. Значение по умолчанию – true.

Пример

JavaScript

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

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

TypeScript

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

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

Статьи по теме

• Возвратный кеш

---

Optional heavyAds

heavyAds?: boolean

Будет ли тег GPT автоматически обновлять рекламное место, если в Chrome сработает вмешательство в работу ресурсоемкой рекламы для iframe объявления. Значение по умолчанию – true.

Пример

JavaScript

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

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

TypeScript

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

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

Статьи по теме

• Блокировка ресурсоемких объявлений в Chrome

---

googletag.config.ContinueButtonConfig

Настройки, позволяющие задать поведение кнопки "Продолжить".

Свойства
backgroundColor?	Цвет фона кнопки.
font?	Семейство шрифтов для текста кнопки.
fontColor?	Цвет текста кнопки.
freqCapIntervalMinutes?	Интервал ограничения частоты показов в минутах.
targetId?	Идентификатор элемента HTML, в котором будет отображаться кнопка продолжения.

Статьи по теме

• SlotSettingsConfig.continueButton

Свойства

---

Optional backgroundColor

backgroundColor?: string

Цвет фона кнопки.

Примеры: 'blue', '#94B1FF'.

---

Optional font

font?: string

Семейство шрифтов для текста кнопки.

Пример: 'Arial'

---

Optional fontColor

fontColor?: string

Цвет текста кнопки.

Пример: 'white', '#B73B87'.

---

Optional freqCapIntervalMinutes

freqCapIntervalMinutes?: number

Интервал ограничения частоты показов в минутах.

Должен быть целым числом, большим или равным 1.

---

Optional targetId

targetId?: string

Идентификатор элемента HTML, в котором будет отображаться кнопка продолжения.

---

googletag.config.InterstitialConfig

Объект, определяющий поведение одного рекламного места для межстраничного объявления.

Свойства
requireStorageAccess?	Требуется ли согласие на использование хранилища для показа этого межстраничного объявления.
triggers?	Конфигурация триггера для этого межстраничного объявления.

Свойства

---

Optional requireStorageAccess

requireStorageAccess?: boolean

Требуется ли согласие на использование локального хранилища для показа этого межстраничного объявления.

Теги GPT используют локальное хранилище, чтобы применять ограничение частоты показа для межстраничных объявлений. Однако межстраничные объявления могут показываться и пользователям, которые не дали согласие на использование локального хранилища. Если задать для этого свойства значение true, то будет отключен режим работы по умолчанию, и межстраничные объявления будут показываться только пользователям, которые дали согласие на использование локального хранилища.

Пример

JavaScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

TypeScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

Статьи по теме

• Размещение межстраничных объявлений на сайтах

---

Optional триггеров

triggers?: Partial<Record<InterstitialTrigger, boolean>>

Настройка триггера для этого межстраничного объявления.

Чтобы включить триггер, задайте для него значение true, а чтобы отключить – false. Это позволит переопределить значения по умолчанию, заданные в Google Менеджере рекламы.

Пример

JavaScript

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

TypeScript

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

Статьи по теме

• Как показывать межстраничные объявления на сайте

---

googletag.config.LazyLoadConfig

Настройки, позволяющие управлять использованием отложенной загрузки в тегах GPT.

Свойства
fetchMarginPercent?	Минимальное расстояние от текущей области просмотра до рекламного места, при котором запрашивается объявление. Выражается в процентах от размера области просмотра.
mobileScaling?	Множитель, применяемый к полям на мобильных устройствах.
renderMarginPercent?	Минимальное расстояние от текущей области просмотра, на котором должно находиться рекламное место, чтобы мы могли показать объявление. Выражается в процентах от размера области просмотра.

Статьи по теме

• PageSettingsConfig.lazyLoad

Свойства

---

Optional fetchMarginPercent

fetchMarginPercent?: number

Минимальное расстояние от текущей области просмотра до рекламного места, при котором запрашивается объявление. Выражается в процентах от размера области просмотра.

В сочетании с renderMarginPercent эта настройка позволяет предварительно загружать объявление, но откладывать отрисовку и скачивание других дополнительных ресурсов. Поэтому значение этого параметра должно быть больше или равно значению renderMarginPercent.

Значение 0 означает, что объявление загружается, когда рекламное место попадает в область просмотра, 100 – когда рекламное место находится на расстоянии одной области просмотра от объявления и т. д.

---

Optional mobileScaling

mobileScaling?: number

Множитель, применяемый к полям на мобильных устройствах. Этот множитель применяется как к fetchMarginPercent, так и к renderMarginPercent.

Это позволяет задавать разные поля для мобильных устройств и компьютеров, у которых могут различаться размеры области просмотра и скорость прокрутки. Например, если указать значение 2.0, то все поля на мобильных устройствах будут умножены на 2. Это увеличит минимальное расстояние, на котором рекламное место может находиться от области просмотра до получения и отрисовки.

---

Optional renderMarginPercent

renderMarginPercent?: number

Минимальное расстояние от текущей области просмотра, на котором должен находиться рекламный блок, чтобы в нем было показано объявление. Выражается в процентах от размера области просмотра.

Эта настройка используется вместе с fetchMarginPercent и позволяет предварительно получать объявление, но откладывать его показ и скачивание других дополнительных ресурсов. Поэтому это значение всегда должно быть меньше или равно fetchMarginPercent.

Значение 0 означает "когда рекламное место попадает в область просмотра", 100 – "когда объявление находится на расстоянии одной области просмотра" и т. д.

---

googletag.config.PageSettingsConfig

Основной интерфейс для настройки параметров на уровне страницы.

Позволяет задавать несколько функций с помощью одного вызова API.

Все перечисленные ниже свойства являются примерами и не отражают фактические функции, использующие setConfig. Доступные функции перечислены в полях типа PageSettingsConfig ниже.

Примеры:

• Изменяются только функции, указанные в вызове googletag.setConfig.

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

• Все настройки для определенной функции обновляются при каждом вызове googletag.setConfig.

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

• Чтобы сбросить все настройки функции, передайте null.

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

Свойства
adExpansion?	Настройки, позволяющие управлять расширением объявлений.
adsenseAttributes?	Настройка атрибутов AdSense.
adYield?	Поддержка прекращена.
autoRefresh?	Настройка, позволяющая задать параметры автоматического обновления объявлений.
categoryExclusion?	Настройка, позволяющая задать исключения категорий объявлений.
centering?	Настройка, позволяющая управлять горизонтальным центрированием объявлений.
collapseDiv?	Настройка, позволяющая управлять сворачиванием рекламных мест.
disableInitialLoad?	Настройка, позволяющая управлять запросами объявлений.
lazyLoad?	Настройки, позволяющие управлять использованием отложенной загрузки в тегах GPT.
location?	Настройка геотаргетинга позиций на географические местоположения.
pps?	Настройки для управления сигналами, предоставленными издателем.
privacyTreatments?	Настройки, позволяющие управлять обработкой конфиденциальных данных издателя.
requestHookTimeoutMs?	Настройка, которая позволяет задать максимальное время ожидания тегом GPT завершения всех зарегистрированных хуков запросов перед отправкой запроса объявления.
safeFrame?	Настройки, позволяющие управлять использованием SafeFrame в тегах GPT.
singleRequest?	Настройка, позволяющая включить или отключить режим единого запроса.
targeting?	Настройка, позволяющая управлять таргетингом на ключи-значения.
threadYield?	Настройка, которая определяет, должен ли тег GPT уступать поток JS при запросе и отрисовке креативов.
videoAds?	Настройки для управления видеорекламой.

Свойства

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Настройки, позволяющие управлять расширением объявлений.

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Настройка атрибутов AdSense.

Атрибуты AdSense, заданные с помощью этой настройки, будут применяться ко всем рекламным местам на странице. Этот параметр можно вызывать несколько раз, чтобы задать несколько значений атрибутов или перезаписать существующие значения.

Изменения атрибутов AdSense применяются только к запросам объявлений, сделанным после вызова этого метода. Поэтому рекомендуется вызывать этот метод до вызова googletag.display или PubAdsService.refresh.

Пример

JavaScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

TypeScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

---

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Устарело. Используйте threadYield. В ближайшее время он будет удален.

---

Optional autoRefresh

autoRefresh?: AutoRefreshConfig

Настройка, позволяющая задать поведение при автоматическом обновлении объявлений.

Пример

JavaScript

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

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

TypeScript

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

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

---

Optional categoryExclusion

categoryExclusion?: string[]

Настройка исключения категорий объявлений.

Пример

JavaScript

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

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

TypeScript

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

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

Статьи по теме

• Специальные ярлыки для блокировки объявлений

---

Optional центрирование

centering?: boolean

Настройка, позволяющая управлять горизонтальным центрированием объявлений. По умолчанию центрирование отключено.

Изменения в горизонтальном центрировании применяются только к запросам объявлений, сделанным после вызова этого метода. Поэтому рекомендуется вызывать этот метод до вызова googletag.display или PubAdsService.refresh.

Пример

JavaScript

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

// Clear the centering setting.
googletag.setConfig({ centering: null });

TypeScript

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

// Clear the centering setting.
googletag.setConfig({ centering: null });

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Настройка, позволяющая управлять свертыванием рекламных мест.

Свернутое рекламное место не занимает места на странице.

Допустимые значения:

• null (по умолчанию) – рекламное место не будет свернуто.
• DISABLED – рекламное место не будет свернуто независимо от того, возвращено ли объявление.
• BEFORE_FETCH – рекламное место сначала будет свернуто, а затем развернется, когда будет получено объявление.
• ON_NO_FILL – рекламное место будет развернуто, но свернется, если не будет возвращено ни одно объявление.

Пример

JavaScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

TypeScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

Статьи по теме

• Сворачивание пустых рекламных мест
• Минимизируйте смещение макета

---

Optional disableInitialLoad

disableInitialLoad?: boolean

Настройка, позволяющая управлять временем запроса объявлений.

По умолчанию метод googletag.display регистрирует рекламные места и запрашивает для них объявления. Однако иногда эти действия лучше разделить, чтобы точнее контролировать загрузку рекламного контента.

Если включить эту настройку, то при вызове метода display() объявления для зарегистрированных рекламных мест запрашиваться не будут. Вместо этого для отправки запроса объявления необходимо выполнить отдельный вызов PubAdsService.refresh.

Этот метод необходимо вызвать до вызова googletag.enableServices.

Пример

JavaScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

TypeScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

Статьи по теме

• Управление загрузкой и обновлением объявлений
• Управление пакетами в режиме единого запроса

---

Optional lazyLoad

lazyLoad?: LazyLoadConfig

Настройки, позволяющие управлять использованием отложенной загрузки в тегах GPT.

Отложенная загрузка – это метод, позволяющий задерживать запрос и отрисовку объявлений до тех пор, пока они не окажутся в области просмотра пользователя. Более подробный пример приведен в разделе Отложенная загрузка.

Примечание. Если включена singleRequest, отложенный запрос работает, только когда все рекламные места находятся за пределами области запроса.

Для всех настроек отложенной загрузки, которые не были заданы при вызове setConfig(), будут использоваться значения по умолчанию, установленные Google. Эти настройки по умолчанию могут со временем меняться. Чтобы отключить определенный параметр, задайте для него значение null.

Пример

JavaScript

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

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

TypeScript

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

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

Статьи по теме

• Рекомендации по работе с объявлениями: отдавайте приоритет важным рекламным местам
• Отложенная загрузка

---

Optional местоположение

location?: string

Настройка геотаргетинга позиций на географические местоположения.

Пример

JavaScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

TypeScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

Статьи по теме

• Как настраивать таргетинг позиций на различные географические местоположения

---

Optional pps

pps?: PublisherProvidedSignalsConfig

Настройки для управления сигналами, предоставленными издателем.

---

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig

Настройки, позволяющие управлять обработкой конфиденциальных данных издателя.

---

Optional Experimental requestHookTimeoutMs

requestHookTimeoutMs?: number | "auto"

Настройка, позволяющая задать максимальное время, в течение которого тег GPT будет ожидать завершения всех зарегистрированных хуков запроса, прежде чем перейти к запросу объявления.

Все зарегистрированные хуки запроса выполняются параллельно. Это время ожидания определяет верхний предел времени, в течение которого процесс запроса объявления будет приостановлен в ожидании завершения параллельных выполнений.

Допустимые значения:

• Положительное число в миллисекундах: настраиваемый период ожидания.
• 'auto' – тег GPT использует оптимизированное Google время ожидания.
• null – отключение тайм-аутов (GPT будет бесконечно ждать завершения хуков).

Пример

JavaScript

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

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

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

TypeScript

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

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

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

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Настройки, позволяющие управлять использованием SafeFrame в тегах GPT.

Значения, заданные с помощью этой настройки, будут применяться ко всем рекламным местам на странице. Для отдельных рекламных мест эти значения можно переопределить с помощью SlotSettingsConfig.safeFrame.

Пример

JavaScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

TypeScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

---

Optional singleRequest

singleRequest?: boolean

Настройка, позволяющая включить или отключить режим единого запроса.

Если этот режим включен, все рекламные места, заданные до вызова googletag.display или PubAdsService.refresh, будут объединены в один запрос объявления. Это не только повышает эффективность, но и позволяет обеспечить показ связок и конкурентных исключений.

Если режим единого запроса отключен, то для каждого рекламного места отправляется отдельный запрос. Это режим работы по умолчанию для GPT.

Этот метод необходимо вызвать до вызова googletag.enableServices.

Пример

JavaScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

TypeScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

Статьи по теме

• О связках
• Рекомендации по работе с объявлениями: как правильно использовать режим единого запроса
• Управление пакетами в режиме единого запроса

---

Optional таргетинг

targeting?: Record<string, string | string[]>

Настройка, позволяющая управлять таргетингом на пары "ключ-значение".

Таргетинг, заданный с помощью этой настройки, будет применяться ко всем рекламным местам на странице. Эту настройку можно вызывать несколько раз, чтобы задать несколько пар "ключ-значение" для таргетинга или перезаписать существующие значения. Ключи таргетинга задаются в аккаунте Google Менеджера рекламы.

Пример

JavaScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

TypeScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

Статьи по теме

• Таргетинг на пары "ключ-значение"

---

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Настройка, которая определяет, должен ли тег GPT уступать поток JS при запросе и отрисовке креативов.

Тег GPT будет уступать поток только в браузерах, поддерживающих API Scheduler.postTask или Scheduler.yield.

Допустимые значения:

• null (по умолчанию): тег GPT будет уступать поток JS рекламным местам за пределами области просмотра.
• ENABLED_ALL_SLOTS – тег GPT будет уступать поток JS для всех рекламных мест независимо от того, находятся ли они в области просмотра.
• DISABLED – тег GPT не будет уступать поток JS.

Пример

JavaScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

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

TypeScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

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

Статьи по теме

• Планировщик

---

Optional videoAds

videoAds?: VideoAdsConfig

Настройки для управления видеорекламой.

Пример

JavaScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

TypeScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

Статьи по теме

• Прием видеоконтента

---

googletag.config.PrivacyTreatmentsConfig

Настройки, позволяющие управлять обработкой конфиденциальных данных издателя.

Свойства
treatments	Массив вариантов защиты конфиденциальности издателем, которые нужно включить.

Свойства

---

treatments

treatments: "disablePersonalization"[]

Массив вариантов защиты конфиденциальности издателем, которые нужно включить.

Пример

JavaScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

TypeScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

---

googletag.config.PublisherProvidedSignalsConfig

Объект конфигурации сигналов, предоставленных издателем.

Свойства
taxonomies	Объект, содержащий сопоставления классификации, или значение null, чтобы очистить конфигурацию.

Пример

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

TypeScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

Статьи по теме

• Общие сведения о сигналах, предоставленных издателем (бета)
• Классификация аудиторий IAB (версия 1.1)
• Классификация контента IAB 2.2

Свойства

---

таксономии

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

Объект, содержащий сопоставления классификации, или значение null, чтобы очистить конфигурацию.

---

googletag.config.SafeFrameConfig

Настройки, позволяющие управлять SafeFrame в тегах GPT.

Свойства
allowOverlayExpansion?	Должен ли контейнер SafeFrame разрешать расширение содержания объявления за счет перекрытия контента страницы.
allowPushExpansion?	Должен ли контейнер SafeFrame позволять содержанию объявления расширяться, сдвигая контент страницы.
forceSafeFrame?	Нужно ли принудительно показывать объявления в контейнере SafeFrame.
sandbox?	Должен ли контейнер SafeFrame использовать атрибут HTML5 sandbox, чтобы предотвращать навигацию верхнего уровня без взаимодействия с пользователем.
useUniqueDomain?	Столбец больше не доступен. Должны ли в SafeFrame использоваться случайные субдомены для креативов с резервированием.

Статьи по теме

• PageSettingsConfig.safeFrame
• SlotSettingsConfig.safeFrame

Свойства

---

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean

Должен ли контейнер SafeFrame разрешать расширение содержания объявления за счет перекрытия контента страницы.

---

Optional allowPushExpansion

allowPushExpansion?: boolean

Должен ли контейнер SafeFrame позволять содержанию объявления расширяться, сдвигая контент страницы.

---

Optional forceSafeFrame

forceSafeFrame?: boolean

Нужно ли принудительно показывать объявления в контейнере SafeFrame.

---

Optional sandbox

sandbox?: boolean

Должен ли контейнер SafeFrame использовать атрибут HTML5 sandbox, чтобы предотвращать навигацию верхнего уровня без взаимодействия с пользователем. Единственное допустимое значение – true (нельзя принудительно задать значение false). Обратите внимание, что атрибут sandbox отключает плагины (например, Flash).

---

Optional useUniqueDomain

useUniqueDomain?: boolean

Должны ли в SafeFrame использоваться случайные субдомены для креативов для позиций с резервированием. Чтобы удалить сохраненное значение, передайте null.

Примечание. Эта функция включена по умолчанию.

Устарело. Отключить эту функцию больше нельзя. Значение useUniqueDomain ни на что не влияет.

Статьи по теме

• Как показывать креативы с помощью SafeFrame

---

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?	Настройки расширения объявлений.
adsenseAttributes?	Настройка атрибутов AdSense.
categoryExclusion?	Настройка, позволяющая задать исключения категорий объявлений.
clickUrl?	Настройка URL, на который будут перенаправляться пользователи, нажавшие на объявление.
collapseDiv?	Настройка, позволяющая задать поведение рекламного места при сворачивании.
continueButton?	Настройки кнопки продолжения для объявлений во время паузы.
interstitial?	Настройки, определяющие поведение рекламного места для межстраничных объявлений.
safeFrame?	Настройки, позволяющие использовать SafeFrame в GPT.
targeting?	Настройка таргетинга на пары "ключ-значение".

Свойства

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Настройки для расширения объявлений.

Статьи по теме

• Расширение объявлений

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Настройка атрибутов AdSense.

Атрибуты AdSense, заданные с помощью этой настройки, будут применяться только к рекламному месту. Этот параметр можно вызывать несколько раз, чтобы задать несколько значений атрибутов или перезаписать существующие значения.

Изменения атрибутов AdSense применяются только к запросам объявлений, сделанным после вызова этого метода. Поэтому рекомендуется вызывать этот метод до вызова googletag.display или PubAdsService.refresh.

Пример

JavaScript

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

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

TypeScript

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

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

---

Optional categoryExclusion

categoryExclusion?: string[]

Настройка исключения категорий объявлений.

Пример

JavaScript

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

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

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

TypeScript

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

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

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

Статьи по теме

• Специальные ярлыки для блокировки объявлений

---

Optional clickUrl

clickUrl?: string

Настройка, позволяющая задать URL, на который будут перенаправляться пользователи, нажавшие на объявление.

Серверы Google Менеджера рекламы регистрируют клик, даже если URL клика заменен. К указанному значению добавляется URL целевой страницы, связанный с показанным креативом. Если вы зададите это значение несколько раз, то предыдущие значения будут перезаписаны. null – значение будет удалено.

Примечание. Эта настройка применяется только к запросам, не относящимся к архитектуре единого запроса.

Пример

JavaScript

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

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

TypeScript

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

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Настройка, позволяющая задать поведение рекламного места при сворачивании.

Свернутое рекламное место не занимает места на странице.

Поддерживаемые значения:

• null (по умолчанию) – рекламное место не будет свернуто.
• DISABLED – рекламное место не будет свернуто независимо от того, возвращено ли объявление.
• BEFORE_FETCH – рекламное место сначала будет свернуто, а затем развернется, когда будет получено объявление.
• ON_NO_FILL – рекламное место будет развернуто, но свернется, если не будет возвращено ни одно объявление.

Пример

JavaScript

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

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

TypeScript

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

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

Статьи по теме

• Сворачивание пустых рекламных мест
• Минимизируйте смещение макета

---

Optional continueButton

continueButton?: ContinueButtonConfig

Настройки кнопки продолжения для объявлений во время паузы.

Они позволяют задать внешний вид и поведение кнопки продолжения чтения и кнопки выхода, которые используются в объявлениях во время паузы.

Если при вызове setConfig() не задать настройки кнопки продолжения, будут использоваться значения по умолчанию, установленные Google.

Чтобы отключить или сбросить все настройки кнопки продолжения, передайте null.

Пример

JavaScript

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

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

TypeScript

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

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

---

Optional Межстраничное объявление

interstitial?: InterstitialConfig

Настройки, определяющие поведение рекламного места для межстраничных объявлений.

Статьи по теме

• Размещение межстраничных объявлений на сайтах

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Настройки, позволяющие использовать SafeFrame в GPT.

Значения, заданные с помощью этой настройки, будут применяться только к рекламному месту и переопределять значения, заданные с помощью PageSettingsConfig.safeFrame.

Пример

JavaScript

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

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

TypeScript

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

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

---

Optional таргетинг

targeting?: Record<string, string | string[]>

Настройка таргетинга по парам "ключ-значение".

Таргетинг, заданный с помощью этой настройки, будет применяться только к рекламному месту. Эту настройку можно вызывать несколько раз, чтобы задать несколько пар "ключ-значение" для таргетинга или перезаписать существующие значения. Ключи таргетинга задаются в аккаунте Google Менеджера рекламы.

Пример

JavaScript

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

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

TypeScript

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

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

Статьи по теме

• Таргетинг на пары "ключ-значение"

---

googletag.config.TaxonomyData

Объект, содержащий значения для одной таксономии.

Свойства
values	Список значений Taxonomy.

Свойства

---

values

values: readonly string[]

Список значений Taxonomy.

---

googletag.config.VideoAdsConfig

Настройки, связанные с видеорекламой.

Свойства
enableVideoAds	Будут ли на странице показываться видеообъявления.
videoCmsId?	Идентификатор источника видеоконтента.
videoContentId?	Идентификатор видеоконтента.

Статьи по теме

• PageSettingsConfig.videoAds

Свойства

---

enableVideoAds

enableVideoAds: boolean

Указывает, будут ли на странице показываться видеообъявления.

Если задано значение true, то для медийных и видеообъявлений будут действовать ограничения на исключение контента.

Если видеоконтент известен, задайте для параметров videoContentId и videoCmsId значения, которые передаются в сервис приема контента Google Менеджера рекламы, чтобы использовать исключение контента для медийных объявлений.

---

Optional videoCmsId

videoCmsId?: string

Идентификатор источника видеоконтента.

Это уникальное значение, которое присваивается сервисом приема контента Google Менеджера рекламы для идентификации источника видеоконтента, указанного в параметре videoContentId.

Статьи по теме

• cmsid (идентификатор источника контента)

---

Optional videoContentId

videoContentId?: string

Идентификатор видеоконтента.

Это уникальное значение, которое идентифицирует определенное видео из источника контента, указанного в параметре videoCmsId. Это значение назначается системой управления контентом (CMS), в которой размещен ваш видеоконтент.

Статьи по теме

• vid (идентификатор видео)

---

googletag.enums

Это пространство имен, которое теги GPT используют для перечисляемых типов.

Перечисления
OutOfPageFormat	Форматы внестраничных объявлений, поддерживаемые тегом GPT.
TagForAgeTreatment	Настройки учета возраста, поддерживаемые тегом GPT.
TrafficSource	Источники трафика, поддерживаемые тегом GPT.

Перечисления

---

OutOfPageFormat

OutOfPageFormat

Форматы внестраничных объявлений, поддерживаемые тегами GPT.

Статьи по теме

• defineOutOfPageSlot

Элементы перечисления
AD_INTENTS	Формат рекламных намерений.
BOTTOM_ANCHOR	Формат фиксированного объявления, при котором рекламное место закреплено в нижней части области просмотра.
GAME_MANUAL_INTERSTITIAL	Межстраничное объявление в руководстве к игре. Примечание. Межстраничное объявление в руководстве к игре – это формат с ограниченным доступом.
INTERSTITIAL	Формат межстраничного объявления на сайте.
LEFT_SIDE_RAIL	Формат бокового объявления слева.
REWARDED	Формат объявлений с вознаграждением.
RIGHT_SIDE_RAIL	Формат бокового объявления справа.
TOP_ANCHOR	Фиксированный формат, при котором рекламное место закреплено в верхней части области просмотра.

---

TagForAgeTreatment

TagForAgeTreatment

Настройки учета возраста, поддерживаемые тегом GPT.

Статьи по теме

• PrivacySettingsConfig.tagForAgeTreatment

Элементы перечисления
CHILD	Означает, что запросы объявлений должны обрабатываться с учетом возрастных ограничений для детей.
TEEN	Означает, что запросы объявлений должны обрабатываться с учетом возрастных ограничений для подростков.
UNSPECIFIED	Значение по умолчанию. Указывает, что к запросу объявления не применяется сигнал обработки данных с учетом возрастных ограничений.

---

TrafficSource

TrafficSource

Источники трафика, поддерживаемые тегом GPT.

Статьи по теме

• PrivacySettingsConfig.trafficSource

Элементы перечисления
ORGANIC	Прямой ввод URL, поиск по сайту или скачивание приложения.
PURCHASED	Трафик, поступивший от ресурсов, не принадлежащих организации, или предусматривающий вознаграждения за выполнение нужных действий.

---

googletag.events

Это пространство имен, которое тег GPT использует для событий. Ваш код может реагировать на эти события с помощью Service.addEventListener.

Интерфейсы
Event	Базовый интерфейс для всех событий GPT.
EventTypeMap	Это псевдотип, который сопоставляет название события с соответствующим типом объекта события для Service.addEventListener и Service.removeEventListener.
GameManualInterstitialSlotClosedEvent	Это событие активируется, когда пользователь закрывает рекламное место для межстраничного объявления в игре.
GameManualInterstitialSlotReadyEvent	Это событие активируется, когда рекламное место готово к показу.
ImpressionViewableEvent	Это событие активируется, когда показ становится видимым в соответствии с критериями Active View.
RewardedSlotClosedEvent	Это событие активируется, когда пользователь закрывает рекламное место для объявления с вознаграждением.
RewardedSlotGrantedEvent	Это событие активируется, когда пользователь получает вознаграждение за просмотр объявления с вознаграждением.
RewardedSlotReadyEvent	Это событие активируется, когда объявление с вознаграждением готово к показу.
RewardedSlotVideoCompletedEvent	Это событие активируется, когда завершается показ видеорекламы с вознаграждением.
SlotOnloadEvent	Это событие активируется, когда iframe креатива активирует событие загрузки.
SlotRenderEndedEvent	Это событие активируется, когда код креатива вставляется в рекламное место.
SlotRequestedEvent	Это событие активируется, когда для определенного рекламного места запрашивается объявление.
SlotResponseReceived	Это событие активируется, когда для определенного рекламного места получен ответ на запрос объявления.
SlotVisibilityChangedEvent	Это событие активируется, когда меняется процент площади рекламного места, видимой на экране.

---

googletag.events.Event

Базовый интерфейс для всех событий GPT. Все перечисленные ниже события GPT будут иметь следующие поля:

Свойства
serviceName	Название сервиса, который активировал событие.
slot	Рекламное место, которое активировало событие.

Статьи по теме

• Прослушиватели событий объявлений

Свойства

---

serviceName

serviceName: string

Название сервиса, который активировал событие.

---

slot

slot: Slot

Рекламное место, которое активировало событие.

---

googletag.events.EventTypeMap

Это псевдотип, который сопоставляет название события с соответствующим типом объекта события для Service.addEventListener и Service.removeEventListener. Она приведена только для справки и обеспечения типобезопасности.

Свойства
gameManualInterstitialSlotClosed	Псевдоним для events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady	Псевдоним для events.GameManualInterstitialSlotReadyEvent.
impressionViewable	Псевдоним для events.ImpressionViewableEvent.
rewardedSlotClosed	Псевдоним для events.RewardedSlotClosedEvent.
rewardedSlotGranted	Псевдоним для events.RewardedSlotGrantedEvent.
rewardedSlotReady	Псевдоним для events.RewardedSlotReadyEvent.
rewardedSlotVideoCompleted	Псевдоним для events.RewardedSlotVideoCompletedEvent.
slotOnload	Псевдоним для events.SlotOnloadEvent.
slotRenderEnded	Псевдоним для events.SlotRenderEndedEvent.
slotRequested	Псевдоним для events.SlotRequestedEvent.
slotResponseReceived	Псевдоним для events.SlotResponseReceived.
slotVisibilityChanged	Псевдоним для events.SlotVisibilityChangedEvent.

Свойства

---

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

Псевдоним для events.GameManualInterstitialSlotClosedEvent.

---

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

Псевдоним для events.GameManualInterstitialSlotReadyEvent.

---

impressionViewable

impressionViewable: ImpressionViewableEvent

Псевдоним для events.ImpressionViewableEvent.

---

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent

Псевдоним для events.RewardedSlotClosedEvent.

---

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent

Псевдоним для events.RewardedSlotGrantedEvent.

---

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent

Псевдоним для events.RewardedSlotReadyEvent.

---

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent

Псевдоним для events.RewardedSlotVideoCompletedEvent.

---

slotOnload

slotOnload: SlotOnloadEvent

Псевдоним для events.SlotOnloadEvent.

---

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent

Псевдоним для events.SlotRenderEndedEvent.

---

slotRequested

slotRequested: SlotRequestedEvent

Псевдоним для events.SlotRequestedEvent.

---

slotResponseReceived

slotResponseReceived: SlotResponseReceived

Псевдоним для events.SlotResponseReceived.

---

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent

Псевдоним для events.SlotVisibilityChangedEvent.

---

googletag.events.GameManualInterstitialSlotClosedEvent

Расширяет Event

Это событие активируется, когда пользователь закрывает рекламное место для межстраничного объявления в руководстве к игре.

Примечание. Межстраничные объявления в руководстве к игре – это формат с ограниченным доступом.

Свойства
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Пример

JavaScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

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

TypeScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

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

Статьи по теме

• Прослушиватели событий объявлений
• Как настроить показ созданных вручную межстраничных объявлений для игр H5

---

googletag.events.GameManualInterstitialSlotReadyEvent

Расширяет Event

Это событие активируется, когда рекламное место готово к показу.

Примечание. Межстраничные объявления в играх, созданные вручную, – это формат с ограниченным доступом.

Свойства
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Методы
makeGameManualInterstitialVisible	Показывает пользователю созданное вручную межстраничное объявление для игр.

Пример

JavaScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

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

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

TypeScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

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

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

Статьи по теме

• Прослушиватели событий объявлений
• Как настроить показ созданных вручную межстраничных объявлений для игр H5

Методы

---

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): boolean

Показывает пользователю созданное вручную межстраничное объявление для игр. Возвращает значение, указывающее, было ли объявление показано.

Возвраты
boolean

---

googletag.events.ImpressionViewableEvent

Расширяет Event

Это событие активируется, когда показ становится видимым в соответствии с критериями Active View.

Свойства
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Пример

JavaScript

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

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

TypeScript

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

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

Статьи по теме

• Прослушиватели событий объявлений

---

googletag.events.RewardedSlotClosedEvent

Расширяет Event

Это событие активируется, когда пользователь закрывает рекламное место для объявления с вознаграждением. Он может сработать как до, так и после предоставления вознаграждения. Чтобы определить, было ли предоставлено вознаграждение, используйте events.RewardedSlotGrantedEvent.

Свойства
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Пример

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

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

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

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

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

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

Статьи по теме

• Прослушиватели событий объявлений
• Как показывать объявления с вознаграждением

---

googletag.events.RewardedSlotGrantedEvent

Расширяет Event

Это событие активируется, когда пользователь получает вознаграждение за просмотр объявления с вознаграждением. Если объявление закрыто до того, как выполнены условия для получения вознаграждения, это событие не активируется.

Свойства
payload	Объект, содержащий информацию о предоставленном вознаграждении.
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Пример

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

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

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

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

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

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

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

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

Статьи по теме

• Прослушиватели событий объявлений
• Как показывать объявления с вознаграждением

Свойства

---

payload

payload: RewardedPayload

Объект, содержащий информацию о предоставленном вознаграждении.

---

googletag.events.RewardedSlotReadyEvent

Расширяет Event

Это событие активируется, когда объявление с вознаграждением готово к показу. Издатель должен предоставить пользователю возможность посмотреть объявление, прежде чем оно будет показано.

Свойства
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Методы
makeRewardedVisible	Показывает объявление с вознаграждением.

Пример

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

Статьи по теме

• Прослушиватели событий объявлений
• Как показывать объявления с вознаграждением

Методы

---

makeRewardedVisible

makeRewardedVisible(): boolean

Показывает объявление с вознаграждением. Этот метод не следует вызывать, пока пользователь не согласится на просмотр объявления.

Возвраты
boolean	Информация о том, было ли объявление с вознаграждением показано.

---

googletag.events.RewardedSlotVideoCompletedEvent

Расширяет Event

Это событие активируется, когда завершается показ видеорекламы с вознаграждением.

Свойства
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Пример

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

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

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

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

Статьи по теме

• Прослушиватели событий объявлений
• Как показывать объявления с вознаграждением

---

googletag.events.SlotOnloadEvent

Расширяет Event

Это событие активируется, когда iframe креатива активирует событие загрузки. При синхронной обработке мультимедийных объявлений не используется iframe, поэтому событие SlotOnloadEvent не регистрируется.

Свойства
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Пример

JavaScript

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

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

TypeScript

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

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

Статьи по теме

• Прослушиватели событий объявлений

---

googletag.events.SlotRenderEndedEvent

Расширяет Event

Это событие активируется, когда код креатива вставляется в рекламное место. Это событие происходит до получения ресурсов креатива, поэтому креатив может быть ещё не виден. Если вам нужно знать, когда завершилась загрузка всех ресурсов креатива для рекламного места, используйте событие events.SlotOnloadEvent.

Свойства
advertiserId	Идентификатор рекламодателя, объявление которого было показано.
campaignId	Идентификатор кампании, к которой относится показанное объявление.
companyIds	Идентификаторы компаний, которые назначили ставку за показанное объявление для заполнения.
creativeId	Идентификатор креатива для показанного объявления с резервированием.
creativeTemplateId	Идентификатор шаблона креатива для показанного объявления с резервированием.
isBackfill	Было ли объявление показано в рамках заполнения.
isEmpty	Было ли возвращено объявление для рекламного места.
labelIds	Поддержка прекращена.
lineItemId	Идентификатор позиции показанного объявления с резервированием.
responseIdentifier	Идентификатор ответа – это уникальный идентификатор ответа на запрос объявления.
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
size	Размер отрисованного креатива в пикселях.
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.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("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

TypeScript

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

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

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

Статьи по теме

• Прослушиватели событий объявлений

Свойства

---

advertiserId

advertiserId: number

Идентификатор рекламодателя, объявление которого было показано. Для пустых рекламных мест, объявлений, предназначенных для заполнения, и креативов, которые обрабатываются не сервисом PubAdsService, значение равно null.

---

campaignId

campaignId: number

Идентификатор кампании, к которой относится показанное объявление. Для пустых рекламных мест, объявлений, предназначенных для заполнения, и креативов, которые обрабатываются не сервисом PubAdsService, значение равно null.

---

companyIds

companyIds: number[]

Идентификаторы компаний, которые назначили ставку за показанное объявление для заполнения. Для пустых рекламных мест, объявлений с резервированием и креативов, отрисованных не с помощью PubAdsService, значение равно null.

---

creativeId

creativeId: number

Идентификатор креатива для показанного объявления с резервированием. Для пустых рекламных мест, объявлений, предназначенных для заполнения, и креативов, которые обрабатываются не сервисом PubAdsService, значение равно null.

---

creativeTemplateId

creativeTemplateId: number

Идентификатор шаблона креатива для показанного объявления с резервированием. Для пустых рекламных мест, объявлений, предназначенных для заполнения, и креативов, которые обрабатываются не сервисом PubAdsService, значение равно null.

---

isBackfill

isBackfill: boolean

Было ли объявление показано в рамках заполнения. Значение true, если объявление было заполнением, и false в противном случае.

---

isEmpty

isEmpty: boolean

Было ли возвращено объявление для рекламного места. Если объявление не было возвращено, значение равно true, в противном случае – false.

---

labelIds

labelIds: number[]

Устарело. Это поле больше не заполняется.

---

lineItemId

lineItemId: number

Идентификатор позиции показанного объявления с резервированием. Для пустых рекламных мест, объявлений, предназначенных для заполнения, и креативов, которые обрабатываются не сервисом PubAdsService, значение равно null.

---

responseIdentifier

responseIdentifier: string

Идентификатор ответа – это уникальный идентификатор ответа на запрос объявления. С помощью этого значения можно найти и заблокировать объявление в Центре проверки объявлений.

---

size

size: string | number[]

Размер отрисованного креатива в пикселях. Пример: [728, 90]. Для пустых рекламных мест значение равно null.

---

slotContentChanged

slotContentChanged: boolean

Было ли изменено содержимое рекламного места при показе объявления. Значение true, если контент был изменен, и false в противном случае.

---

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number

Идентификатор креатива, который относится к показанному резервируемому объявлению или объявлению для заполнения. Значение null используется, если объявление не является резервированием или заполнением позиции, а также если креатив отрисовывается не сервисом PubAdsService.

---

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number

Идентификатор позиции, к которой относится показанное объявление (резервирование или заполнение). Значение null используется, если объявление не является резервированием или заполнением позиции, а также если креатив отрисовывается не сервисом PubAdsService.

---

yieldGroupIds

yieldGroupIds: number[]

Идентификаторы групп доходности для показанного объявления, заполняющего резерв. Для пустых рекламных мест, объявлений с резервированием и креативов, отрисованных не с помощью PubAdsService, значение равно null.

---

googletag.events.SlotRequestedEvent

Расширяет Event

Это событие активируется, когда для определенного рекламного места запрашивается объявление.

Свойства
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Пример

JavaScript

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

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

TypeScript

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

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

Статьи по теме

• Прослушиватели событий объявлений

---

googletag.events.SlotResponseReceived

Расширяет Event

Это событие активируется, когда для определенного рекламного места получен ответ на запрос объявления.

Свойства
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Пример

JavaScript

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

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

TypeScript

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

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

Статьи по теме

• Прослушиватели событий объявлений

---

googletag.events.SlotVisibilityChangedEvent

Расширяет Event

Это событие активируется, когда меняется процент площади рекламного места, видимой на экране. Событие регулируется и не будет срабатывать чаще, чем раз в 200 мс.

Свойства
inViewPercentage	Процент видимой области объявления.
serviceName	Название сервиса, который активировал событие. Унаследовано от ресурса Event.serviceName
slot	Рекламное место, которое активировало событие. Унаследовано от ресурса Event.slot

Пример

JavaScript

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

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

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

TypeScript

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

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

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

Статьи по теме

• Прослушиватели событий объявлений

Свойства

---

inViewPercentage

inViewPercentage: number

Процент видимой области объявления. Значение должно быть числом от 0 до 100.

---

googletag.secureSignals

Это пространство имен, которое тег GPT использует для управления защищенными сигналами.

Интерфейсы
BidderSignalProvider	Возвращает защищенный сигнал для определенной системы назначения ставок.
PublisherSignalProvider	Возвращает защищенный сигнал для определенного издателя.
SecureSignalProvidersArray	Интерфейс для управления защищенными сигналами.

Псевдонимы типов
SecureSignalProvider	Интерфейс для возврата защищенного сигнала для определенной системы назначения ставок или поставщика.

Псевдонимы типов

---

SecureSignalProvider

SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider

Интерфейс для возврата защищенного сигнала для определенной системы назначения ставок или поставщика. Необходимо указать значение id или networkCode, но не оба.

---

googletag.secureSignals.BidderSignalProvider

Возвращает защищенный сигнал для определенной системы назначения ставок.

Поставщик защищенных сигналов для системы назначения ставок состоит из двух частей:

1. Функция сборщика, которая возвращает Promise, преобразуемый в защищенный сигнал.
2. id, который идентифицирует систему назначения ставок, связанную с сигналом.

Чтобы вернуть защищенный сигнал для издателя, используйте secureSignals.PublisherSignalProvider.

Свойства
collectorFunction	Функция, которая возвращает Promise, преобразуемый в защищенный сигнал.
id	Уникальный идентификатор сборщика, связанного с этим защищенным сигналом, зарегистрированный в Google Менеджере рекламы.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Как отправлять защищенные сигналы системам назначения ставок

Свойства

---

collectorFunction

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

Функция, которая возвращает Promise, преобразуемый в защищенный сигнал.

---

id

id: string

Уникальный идентификатор сборщика, связанного с этим защищенным сигналом, зарегистрированный в Google Менеджере рекламы.

---

googletag.secureSignals.PublisherSignalProvider

Возвращает защищенный сигнал для определенного издателя.

Поставщик сигналов издателя состоит из двух частей:

1. Функция сборщика, которая возвращает Promise, преобразуемый в защищенный сигнал.
2. networkCode, который идентифицирует издателя, связанного с сигналом.

Чтобы вернуть защищенный сигнал для системы назначения ставок, используйте secureSignals.BidderSignalProvider.

Свойства
collectorFunction	Функция, которая возвращает Promise, преобразуемый в защищенный сигнал.
networkCode	Код сети (как в пути к рекламному блоку) для издателя, связанного с этим защищенным сигналом.

Пример

JavaScript

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

TypeScript

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

Статьи по теме

• Как отправлять защищенные сигналы системам назначения ставок

Свойства

---

collectorFunction

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

Функция, которая возвращает Promise, преобразуемый в защищенный сигнал.

---

networkCode

networkCode: string

Код сети (как в пути к рекламному блоку) для издателя, связанного с этим защищенным сигналом.

---

googletag.secureSignals.SecureSignalProvidersArray

Интерфейс для управления защищенными сигналами.

Методы
clearAllCache	Удаляет из кеша все сигналы для всех сборщиков.
push	Добавляет новый объект secureSignals.SecureSignalProvider в массив поставщиков сигналов и запускает процесс создания сигналов.

Методы

---

clearAllCache

clearAllCache(): void

Удаляет из кеша все сигналы для всех сборщиков.

Если вызвать этот метод, снизится вероятность того, что сигналы будут добавляться в запросы объявлений при текущих и будущих просмотрах страниц. Поэтому такой вызов следует совершать только при значительных изменениях статуса, например при событиях, указывающих на появление нового пользователя (вход в систему, выход из нее, регистрация и т. д.).

---

push

push(provider: SecureSignalProvider): void

Добавляет новый объект secureSignals.SecureSignalProvider в массив поставщиков сигналов и запускает процесс создания сигналов.

Параметры
provider: SecureSignalProvider	Объект secureSignals.SecureSignalProvider, который нужно добавить в массив.