InterstitialAdPreloader

Kotlin | Java

public final class InterstitialAdPreloader

---

Предзагрузчик для межстраничной рекламы.

Краткое содержание

Общедоступные методы
static boolean	destroy ( String preloadId) Останавливает предварительную загрузку для заданного preloadId и удаляет все связанные с ней предварительно загруженные рекламные объявления.
static void	destroyAll () Останавливает предварительную загрузку и удаляет предварительно загруженные рекламные объявления для всех конфигураций предварительной загрузки.
static @ Nullable PreloadConfiguration	getConfiguration ( String preloadId) Возвращает параметр PreloadConfiguration для межстраничной рекламы, связанный с этим preloadId , или null, если он отсутствует.
static Map < String , PreloadConfiguration >	getConfigurations () Возвращает карту всех конфигураций PreloadConfiguration межстраничной рекламы, ключом к которым является соответствующий идентификатор предварительной загрузки.
static int	getNumAdsAvailable ( String preloadId) Возвращает количество доступных рекламных объявлений для заданного идентификатора предварительной загрузки.
static boolean	isAdAvailable ( String preloadId) Определяет, доступна ли хотя бы одна реклама для заданного preloadId .
static @ Nullable InterstitialAd	pollAd ( String preloadId) Возвращает предварительно загруженное объявление из start или start и удаляет его из кэша.
static boolean	start ( String preloadId, PreloadConfiguration preloadConfiguration) Запускает предварительную загрузку рекламы для заданных preloadId и PreloadConfiguration .
static boolean	start ( String preloadId, PreloadConfiguration preloadConfiguration, PreloadCallbackV2 preloadCallback ) Запускает предварительную загрузку рекламы для заданных preloadId , PreloadConfiguration и PreloadCallbackV2 .

Общедоступные методы

разрушать

public static boolean destroy(String preloadId)

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

Параметры
String preloadId	Идентификатор предварительной загрузки конфигурации, подлежащей удалению.

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

уничтожитьВсе

public static void destroyAll()

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

получить конфигурацию

public static @Nullable PreloadConfiguration getConfiguration(String preloadId)

Возвращает параметр PreloadConfiguration для межстраничной рекламы, связанный с этим preloadId , или null, если он отсутствует.

Параметры
String preloadId	Идентификатор предварительной загрузки, связанный с этой конфигурацией.

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

getConfigurations

public static Map<String, PreloadConfiguration> getConfigurations()

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

Возвраты
Map < String , PreloadConfiguration >	Настройки межстраничной рекламы или пустая карта, если прелоадеры отсутствуют.

getNumAdsAvailable

public static int getNumAdsAvailable(String preloadId)

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

Параметры
String preloadId	Идентификатор предварительной загрузки для проверки доступности.

Возвраты
int	Количество доступных рекламных объявлений для данного идентификатора предварительной загрузки.

isAdAvailable

public static boolean isAdAvailable(String preloadId)

Определяет, доступна ли хотя бы одна реклама для заданного preloadId .

Параметры
String preloadId	Идентификатор предварительной загрузки для проверки доступности.

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

pollAd

public static @Nullable InterstitialAd pollAd(String preloadId)

Возвращает предварительно загруженное объявление из start или start и удаляет его из кэша.

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

Параметры
String preloadId	Идентификатор предварительной загрузки объявления.

Возвраты
@ Nullable InterstitialAd	Межстраничная реклама для указанного идентификатора предварительной загрузки или null , если реклама недоступна.

начинать

public static boolean start(String preloadId, PreloadConfiguration preloadConfiguration)

Запускает предварительную загрузку рекламы для заданных preloadId и PreloadConfiguration .

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

Если процесс PreloadConfiguration уже был запущен с preloadId , этот метод становится пустым и возвращает false .

Параметры
String preloadId	Строковый идентификатор для этой PreloadConfiguration . Используйте этот идентификатор при вызове pollAd , чтобы получить объявление для этой конфигурации.
PreloadConfiguration preloadConfiguration	Настройки для предварительной загрузки рекламы.

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

начинать

public static boolean start(
    String preloadId,
    PreloadConfiguration preloadConfiguration,
    PreloadCallbackV2 preloadCallback
)

Запускает предварительную загрузку рекламы для заданных preloadId , PreloadConfiguration и PreloadCallbackV2 .

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

Для каждого запроса рекламы SDK запускает либо обратный вызов onAdPreloaded при успешной предварительной загрузке, либо обратный вызов onAdFailedToPreload если предварительная загрузка не удалась. SDK автоматически повторяет неудачные запросы.

Если PreloadConfiguration с заданным preloadId уже запущен, этот метод ничего не делает и возвращает false . становится пустым действием и возвращает false .

Параметры
String preloadId	Строка, однозначно идентифицирующая данную PreloadConfiguration . Используйте этот идентификатор при вызове pollAd для получения предварительно загруженной рекламы для данной конфигурации.
PreloadConfiguration preloadConfiguration	Настройки, определяющие способ предварительной загрузки рекламы.
PreloadCallbackV2 preloadCallback	Функция обратного вызова, которая будет вызываться при изменении доступности рекламы для заданной PreloadConfiguration ).

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