Класс: ImaSdkSettings

Google. Има . ImaSdkSettings

общедоступный статический класс

Этот класс содержит настройки всего пакета SDK.

Перечисления

CompanionBackfillMode

постоянный статический

нить

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

Если значение равно ALWAYS , заполнение сопутствующего объявления будет выполняться во всех ситуациях, даже если не будет возвращено основное объявление.

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

Значение по умолчанию — ALWAYS .

Обратите внимание, что для заполнения сопутствующих объявлений на стороне клиента необходимо правильно пометить сопутствующие объявления с помощью тега Google Publisher Tag (GPT). Чтобы включить заполнение, необходимо внести следующие изменения в стандартную настройку GPT:

...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();

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

googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Ценить
ВСЕГДА
ON_MASTER_AD

VpaidMode

постоянный статический

число

Набор констант для включения функций VPAID.

Ценить
НЕПОЛНОЦЕННЫЙ	Объявления VPAID не будут воспроизводиться, и будет возвращена ошибка.
ВКЛЮЧЕНО	Объявления VPAID включаются с помощью междоменного iframe. Объявление VPAID не может получить доступ к сайту. Объявления VPAID, зависящие от дружественного доступа к iframe, могут вызывать ошибки. Это значение по умолчанию.
НЕНАДЕЖНЫЙ	Объявления VPAID включаются с использованием дружественного iframe. Это позволяет объявлению получить доступ к сайту через JavaScript.

Характеристики

CompanionBackfillMode

постоянный статический

нить

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

Если значение равно ALWAYS , заполнение сопутствующего объявления будет выполняться во всех ситуациях, даже если не будет возвращено основное объявление.

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

Значение по умолчанию — ALWAYS .

Обратите внимание, что для заполнения сопутствующих объявлений на стороне клиента необходимо правильно пометить сопутствующие объявления с помощью тега Google Publisher Tag (GPT). Чтобы включить заполнение, необходимо внести следующие изменения в стандартную настройку GPT:

...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();

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

googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Ценить
ВСЕГДА
ON_MASTER_AD

VpaidMode

постоянный статический

число

Набор констант для включения функций VPAID.

Ценить
НЕПОЛНОЦЕННЫЙ	Объявления VPAID не будут воспроизводиться, и будет возвращена ошибка.
ВКЛЮЧЕНО	Объявления VPAID включаются с помощью междоменного iframe. Объявление VPAID не может получить доступ к сайту. Объявления VPAID, зависящие от дружественного доступа к iframe, могут вызывать ошибки. Это значение по умолчанию.
НЕНАДЕЖНЫЙ	Объявления VPAID включаются с использованием дружественного iframe. Это позволяет объявлению получить доступ к сайту через JavaScript.

Методы

getCompanionBackfill

getCompanionBackfill() возвращает CompanionBackfillMode

Возвращает текущий режим заполнения сопутствующих объявлений.

Возвращает

non-null CompanionBackfillMode Текущее значение.

getDisableCustomPlaybackForIOS10Plus

getDisableCustomPlaybackForIOS10Plus() возвращает логическое значение

Получает, следует ли отключить пользовательское воспроизведение в браузерах iOS 10+. Значение по умолчанию неверно.

Возвращает

boolean

getFeatureFlags

getFeatureFlags() возвращает объект с любыми свойствами типа

Возвращает объект с ключами в качестве флагов функций и значениями в качестве их текущего состояния.

Возвращает

non-null Object with any type properties

getLocale

getLocale() возвращает строку

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

Возвращает

string Локаль, предоставленная издателем.

getNumRedirects

getNumRedirects() возвращает число

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

Возвращает

number максимальное количество редиректов.

получить тип игрока

getPlayerType() возвращает строку

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

Возвращает

string Тип игрока-партнера.

получитьPlayerVersion

getPlayerVersion() возвращает строку

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

Возвращает

string Версия игрока-партнера.

получитьPpid

getPpid() возвращает (null или строку)

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

Возвращает

(null or string) идентификатор, предоставленный издателем.

isCookiesEnabled

isCookiesEnabled() возвращает логическое значение

Возвращает

boolean Разрешает ли издатель использование файлов cookie.

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) возвращает недействительным

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

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

Возвращает

void

setCompanionBackfill

setCompanionBackfill (режим) возвращает пустоту

Устанавливает режим обратной засыпки сопутствующих товаров. См. различные режимы, доступные в ImaSdkSettings.CompanionBackfillMode.

Режим по умолчанию — ImaSdkSettings.CompanionBackfillMode.ALWAYS.

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

Возвращает

void

setCookiesEnabled

setCookiesEnabled(cookiesEnabled) возвращает недействительным

Должен ли SDK хранить файл cookie Google Ad Manager (файл cookie GFP) в домене издателя в качестве собственного файла cookie. Это обеспечивает сохранение данных при нескольких посещениях одного и того же домена без использования сторонних файлов cookie. По умолчанию истинно.

Этот параметр не повлияет на другие файлы cookie, которые могут быть установлены другими сторонами или для других целей. Согласие пользователя и отказ от него также могут отключить использование сторонних файлов cookie. Они будут получены при использовании издателем поставщика управления согласием, совместимого с IAB, если он находится в том же фрейме.

Параметр
cookiesEnabled	логический

Возвращает

void

setDisableCustomPlaybackForIOS10Plus

setDisableCustomPlaybackForIOS10Plus (отключить) возвращает недействительным

Устанавливает, следует ли отключать пользовательское воспроизведение в браузерах iOS 10+. Если true, реклама будет воспроизводиться встроенной, если видеоконтент является встроенным. Это включает рекламу TrueView с возможностью пропуска. Однако реклама останется встроенной и не будет поддерживать родной полноэкранный режим iOS. При значении false реклама будет воспроизводиться в том же проигрывателе, что и ваш контент. Значение, установленное здесь при создании AdDisplayContainer, используется в течение всего срока службы контейнера. Значение по умолчанию неверно.

Параметр
запрещать	логический Следует ли отключать пользовательское воспроизведение.

Возвращает

void

setFeatureFlags

setFeatureFlags(featureFlags) возвращает недействительным

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

Параметр
функцияФлаги	Объект со свойствами любого типа Значение не должно быть нулевым.

Возвращает

void

setLocale

setLocale (локаль) возвращает пустоту

Задает языковой стандарт, предоставленный издателем. Должен вызываться перед созданием AdsLoader или AdDisplayContainer. Языковой стандарт определяет язык, на котором будут отображаться элементы пользовательского интерфейса. Поддерживаемые коды можно найти в разделе Локализация для языка и локали .

Параметр
место действия	нить Языковой стандарт, предоставленный издателем.

Возвращает

void

setNumRedirects

setNumRedirects(numRedirects) возвращает недействительным

Указывает максимальное количество перенаправлений, после которого последующие перенаправления будут отклонены, а загрузка рекламы прервана. Количество перенаправлений напрямую влияет на задержку и, следовательно, на взаимодействие с пользователем. Это относится ко всем объявлениям-оболочкам VAST.

Параметр
число перенаправлений	число максимальное количество редиректов.

Возвращает

void

setPlayerType

setPlayerType(playerType) возвращает пустоту

Устанавливает тип игрока, предоставленный партнером. Этот параметр следует использовать для указания имени проигрывателя, интегрируемого с SDK. Тип игрока, содержащий более 20 символов, будет обрезан. Указанный тип проигрывателя должен быть коротким и уникальным. Это необязательный параметр, используемый для повышения удобства использования SDK путем отслеживания типов игроков.

Пример:

settings.setPlayerType('google/gmf-player');

Параметр
playerType	нить Тип игрока-партнера.

Возвращает

void

setPlayerVersion

setPlayerVersion(playerVersion) возвращает пустоту

Устанавливает версию проигрывателя, предоставленную партнером. Этот параметр следует использовать для указания версии партнерского проигрывателя, интегрированного с SDK. Версии игроков, содержащие более 20 символов, будут обрезаны. Это необязательный параметр, используемый для повышения удобства использования SDK путем отслеживания версии проигрывателя.

Пример:

settings.setPlayerVersion('1.0.0');

Параметр
playerVersion	нить Версия партнерского игрока.

Возвращает

void

setPpid

setPpid(ppid) возвращает пустоту

Устанавливает предоставленный издателем идентификатор.

Параметр
ppid	нить издатель предоставил идентификатор.

Возвращает

void

setSessionId

setSessionId (sessionId) возвращает недействительным

Идентификатор сеанса — это временный случайный идентификатор. Он используется исключительно для ограничения частоты показов. Идентификатор сеанса должен быть UUID.

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

Возвращает

void

setVpaidAllowed

setVpaidAllowed(allowVpaid) возвращает пустоту

Устарело. Используйте setVpaidMode. Определяет, разрешены ли креативы VPAID.

Параметр
разрешить Vpaid	логический Разрешить ли креативы VPAID.

Возвращает

void

setVpaidMode

setVpaidMode(vpaidMode) возвращает недействительным

Устанавливает режим воспроизведения VPAID.

Параметр
vpaidMode	VpaidMode Устанавливает, как будут воспроизводиться объявления VPAID. По умолчанию используется безопасный режим. Значение не должно быть нулевым.

Возвращает

void