Google Mobile Ads React Native API

Модуль @google/mobile-ads содержит основные интерфейсы, классы и функции верхнего уровня TypeScript для интеграции Google Mobile Ads в приложения React Native.

Обзор

Псевдонимы типов
AdapterState
Возможные состояния инициализации адаптера медиации.
AdChoicesPlacement
Позиции значка "Выбор рекламы" в просмотре объявления.
AdFormat
Формат запрашиваемого объявления.
AdInspectorError
Информация об ошибке, из-за которой не удалось запустить инспектор объявлений.
AdInspectorErrorCode
Ошибки, влияющие на открытие или работу инспектора объявлений.
AdOrientation
Варианты ориентации для встроенных адаптивных баннеров и больших фиксированных адаптивных баннеров.
AdSize
Размеры объявления.
AgeRestrictedTreatment
Определяет варианты обработки запросов объявлений с учетом возрастных ограничений.
ConsentStatus
Значения статуса согласия.
DebugGeography
Отладочные значения для тестирования геоданных.
FormErrorCode
Коды ошибок, связанных с операциями в форме User Messaging Platform (UMP).
FullScreenContentErrorCode
LoadAdErrorCode
Представляет коды ошибок, связанных с неудачной загрузкой объявлений.
MaxAdContentRating
Определяет максимальные возрастные ограничения для рекламного контента в приложении, классифицируя типы объявлений, которые могут показываться.
NativeAdAssetNames
Названия, используемые для идентификации стандартных объектов нативных объявлений.
NativeAdType
Определяет формат загруженного нативного объявления.
NativeMediaAspectRatio
Настройки соотношения сторон для медиаконтента в возвращаемых нативных объявлениях.
OnAdInspectorClosedListener
Определение интерфейса для обратного вызова, который вызывается при закрытии интерфейса инспектора объявлений.
PrecisionType
Точность указанной стоимости объявления.
PrivacyOptionsRequirementStatus
Статус требования к параметрам конфиденциальности.
PublisherPrivacyPersonalizationState
Указывает на статус персонализации, заданный издателем в Publisher Privacy Treatment API.
ResizeMode
Варианты настройки режима изменения размера графического контента в NativeAdMediaView.
ResolvedAdSize
Окончательный размер объявления после его загрузки.
SwipeGestureDirection
Инструкции по настройке специальных жестов.
Переменные
AdSize
Стандартные размеры объявлений и вспомогательные методы для создания адаптивных и специальных размеров.
Функции
canRequestAds
Проверяет, позволяет ли текущий статус согласия запрашивать объявления.
getConsentStatus
Получает текущий статус согласия пользователя.
getInitializationStatus
Получает статус инициализации SDK.
getPrivacyOptionsRequirementStatus
Проверяет, требуется ли для вашего приложения точка входа для настроек конфиденциальности.
getRequestConfiguration
Получает глобальную конфигурацию запроса.
initialize
Инициализирует Google Mobile Ads SDK.
isConsentFormAvailable
Проверяет, доступна ли форма согласия.
loadAndShowConsentFormIfRequired
Загружает форму согласия и показывает ее пользователю, если этого требует текущий статус согласия (например, статус REQUIRED).
openAdInspector
Открывает оверлей инспектора объявлений Google Mobile Ads SDK.
openDebugMenu
Открывает меню отладки.
parseLoadAdError
Выполняет синтаксический анализ ошибки, возникшей при загрузке объявлений, и преобразует ее в объект LoadAdError.
requestConsentInfoUpdate
Запрашивает обновление информации о согласии.
reset
Удаляет все статусы согласия из постоянного хранилища.
setPublisherFirstPartyIdEnabled
Включает или отключает собственный идентификатор издателя.
setRequestConfiguration
Задает глобальную конфигурацию запроса для соблюдения нормативных требований и таргетинга.
setUserControlledAppVolume
Устанавливает громкость звука в приложении, управляемом пользователем.
setUserMutedApp
Указывает, отключен ли звук в приложении.
showPrivacyOptionsForm
Показывает форму параметров конфиденциальности.

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

AdapterState

AdapterState: typeof AdapterState[keyof typeof AdapterState]
Возможные состояния инициализации адаптера медиации.
Свойства
NOT_READY
Указывает, что адаптер медиации ещё не инициализирован или не удалось инициализировать.
READY
Указывает, что адаптер медиации успешно инициализирован и готов к показу объявлений.

AdChoicesPlacement

AdChoicesPlacement: typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
Позиции значка "Выбор рекламы" в просмотре объявления.
Свойства
BOTTOM_LEFT
Нижний левый угол объявления.
BOTTOM_RIGHT
Правый нижний угол объявления.
TOP_LEFT
Левый верхний угол объявления.
TOP_RIGHT
Правый верхний угол объявления.

AdFormat

AdFormat: typeof AdFormat[keyof typeof AdFormat]
Формат запрашиваемого объявления.
Свойства
APP_OPEN
Формат объявлений при запуске приложения.
BANNER
Формат баннера.
INTERSTITIAL
Формат межстраничного объявления.
NATIVE
Формат нативного объявления.
REWARDED
Формат объявлений с вознаграждением.
REWARDED_INTERSTITIAL
Межстраничное объявление с вознаграждением.

AdInspectorError

AdInspectorError: BaseError<AdInspectorErrorCode>
Информация об ошибке, из-за которой не удалось запустить инспектор объявлений.

AdInspectorErrorCode

AdInspectorErrorCode: typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
Ошибки, влияющие на открытие или работу инспектора объявлений.
Свойства
ALREADY_OPEN
Инспектор объявлений не может быть открыт, так как он уже открыт.
FAILED_TO_LOAD
Не удалось загрузить инспектор объявлений.
INTERNAL_ERROR
В инспекторе объявлений произошла внутренняя ошибка.
NOT_IN_TEST_MODE
Не удалось открыть инспектор объявлений, так как устройство не находится в тестовом режиме.

AdOrientation

AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
Варианты ориентации для встроенных адаптивных баннеров и крупных фиксированных адаптивных баннеров.
Свойства
CURRENT
LANDSCAPE
PORTRAIT

AdSize

Представляет размеры объявления.

Может быть одним из предопределенных размеров (например, AdSize.LARGE_BANNER) или адаптивным размером.

AgeRestrictedTreatment

AgeRestrictedTreatment: typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
Определяет варианты обработки запросов объявлений с учетом возрастных ограничений.
Свойства
CHILD
Означает, что запросы объявлений должны обрабатываться с учетом возрастных ограничений для детей.
TEEN
Означает, что запросы объявлений должны обрабатываться с учетом возрастных ограничений для подростков.
UNSPECIFIED
Указывает, что к запросу объявления не применяется сигнал об обработке с учетом возрастных ограничений.

ConsentStatus

ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
Значения статуса согласия.
Свойства
NOT_REQUIRED
Согласие не требуется.
OBTAINED
Получено согласие пользователя, персонализированная или неперсонализированная реклама. undefined.
REQUIRED
Требуется согласие пользователя, но оно ещё не получено.
UNKNOWN
Статус согласия неизвестен.

DebugGeography

DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
Отладочные значения для тестирования геоданных.
Свойства
DISABLED
Отладка географии отключена для отладочных устройств.
EEA
Для отладочных устройств в качестве региона будет указана ЕЭЗ.
OTHER
Географическое положение отображается как регион, в котором не действуют нормативные требования для отладочного устройства.
REGULATED_US_STATE
Для отладочных устройств в качестве местоположения указывается штат США, где действуют требования к согласию.

FormErrorCode

FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
Коды ошибок, связанных с операциями с формами User Messaging Platform (UMP).
Свойства
ALREADY_USED
Форма согласия уже использовалась.
INTERNAL_ERROR
В SDK произошла внутренняя ошибка.
INVALID_OPERATION
Операция была недопустимой.
NETWORK_ERROR
Операция с формой не выполнена из-за проблем с подключением к сети.
TIMEOUT
Время ожидания операции с формой истекло.
UNAVAILABLE
Форма согласия недоступна.
UNKNOWN
Код ошибки не удалось сопоставить с известным кодом ошибки.

FullScreenContentErrorCode

FullScreenContentErrorCode: typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
Свойства
AD_ALREADY_USED
Объявление уже было показано.
AD_NOT_READY
Объявление не готово к показу.
AD_TOO_LARGE
Объявление слишком большое для сцены (только для iOS).
APP_NOT_FOREGROUND
Приложение не открыто.
INTERNAL_ERROR
Произошла внутренняя ошибка, например исключение при подготовке к показу содержания объявления.
MEDIATION_ERROR
Адаптеру медиации не удалось показать объявление. Причину можно узнать из поля FullScreenContentError.mediationAdError.
UNKNOWN
Код ошибки не удалось сопоставить с известным кодом ошибки.

LoadAdErrorCode

LoadAdErrorCode: typeof LoadAdErrorCode[keyof typeof LoadAdErrorCode]
Представляет коды ошибок, связанных с неудачной загрузкой объявлений.
Свойства
AD_ALREADY_USED
Ответ на запрос объявления уже использовался для загрузки объявления.
APP_ID_MISSING
Запрос объявления не был выполнен, так как отсутствует идентификатор приложения.
CANCELLED
Запрос объявления был отменен (только для Android).
INTERNAL_ERROR
В SDK произошла внутренняя ошибка.
INVALID_REQUEST
Недействительный запрос объявления. Например, указан неверный идентификатор рекламного блока.
INVALID_RESPONSE
Недопустимый межсерверный ответ на запрос объявления. Например, в ответе на запрос объявления нет идентификатора запроса.
MEDIATION_ERROR
Не удалось найти адаптер медиации или выполнить запрос объявления.
NETWORK_ERROR
Запрос объявления не был выполнен из-за проблем с подключением к сети.
NO_FILL
Запрос объявления выполнен успешно, но из-за отсутствия рекламного инвентаря передалось пустое значение.
TIMEOUT
Время ожидания запроса объявления истекло.
UNKNOWN
Код ошибки не удалось сопоставить с известным кодом ошибки.

MaxAdContentRating

MaxAdContentRating: typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
Определяет максимальный рейтинг рекламного контента для приложения, классифицируя типы объявлений, которые могут показываться.
Свойства
G
Контент, подходящий для любой аудитории, в том числе для детей.
MA
Контент только для взрослых
PG
Контент, с которым несовершеннолетние могут знакомиться с разрешения родителей
T
Контент для подростков и взрослых
UNSPECIFIED
Возрастное ограничение не указано.

NativeAdAssetNames

NativeAdAssetNames: typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
Названия, используемые для идентификации стандартных объектов нативных объявлений.
Свойства
ADCHOICES_CONTAINER_VIEW
Контейнер для оверлея "Выбор рекламы".
ADVERTISER
Название рекламодателя.
BODY
Основной текст объявления.
CALL_TO_ACTION
Текст призыва к действию в объявлении (например, "Установить" или "Подробнее").
HEADLINE
Заголовок объявления.
ICON
Изображение значка для объявления.
MEDIA_CONTENT
Основной медиаконтент объявления (изображение или видео).
PRICE
Цена рекламируемого приложения или товара.
STAR_RATING
Оценка рекламируемого приложения или товара.
STORE
Название магазина.

NativeAdType

NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
Определяет формат загруженного нативного объявления.
Свойства
BANNER
Баннер.
CUSTOM_NATIVE
Специальное нативное объявление.
NATIVE
Нативное объявление.

NativeMediaAspectRatio

NativeMediaAspectRatio: typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
Настройки соотношения сторон для медиаконтента в возвращаемых нативных объявлениях.
Свойства
ANY
Нет предпочтений в отношении соотношения сторон медиаконтента нативного объявления.
LANDSCAPE
Запросите медиаобъект нативного объявления с горизонтальной ориентацией.
PORTRAIT
Запросите вертикальное соотношение сторон для возвращаемого медиаконтента нативного объявления.
SQUARE
Запросите квадратное соотношение сторон для возвращаемого медиаконтента нативного объявления.
UNKNOWN
Соотношение сторон неизвестно.

OnAdInspectorClosedListener

OnAdInspectorClosedListener: ((error?) => void)
Определение интерфейса для обратного вызова, который вызывается при закрытии интерфейса инспектора объявлений.

PrecisionType

PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
Точность указанной стоимости объявления.
Свойства
ESTIMATED
Доход от объявления рассчитывается на основе агрегированных данных.
PRECISE
Точная стоимость показа объявления.
PUBLISHER_PROVIDED
Стоимость объявления, указанная издателем, например цена за тысячу показов, заданная вручную в группе медиации.
UNKNOWN
Стоимость объявления с неизвестной точностью.

PrivacyOptionsRequirementStatus

PrivacyOptionsRequirementStatus: typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
Статус требования к параметрам конфиденциальности.
Свойства
NOT_REQUIRED
Точка входа для параметров конфиденциальности не требуется.
REQUIRED
Точка входа для параметров конфиденциальности обязательна.
UNKNOWN
Статус требования к параметрам конфиденциальности неизвестен.

PublisherPrivacyPersonalizationState

PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
Указывает на статус персонализации, заданный издателем.
Свойства
DEFAULT
Указывает, что запрос объявления должен обрабатываться с учетом настроек конфиденциальности издателя по умолчанию.
DISABLED
Указывает, что запрос объявления должен получить неперсонализированную обработку конфиденциальности издателя.
ENABLED
Указывает, что запрос объявления должен обрабатываться с учетом настроек конфиденциальности издателя.

ResizeMode

ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
Варианты настройки режима изменения размера графического контента в NativeAdMediaView.
Свойства
CONTAIN
Масштабируется равномерно, чтобы поместиться в представлении.

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

Высота и ширина изображения масштабируются вместе, чтобы каждое измерение было равно или больше соответствующего измерения области просмотра. Изображение обрезается, чтобы соответствовать размеру экрана, без искажения соотношения сторон.
STRETCH
Ширина и высота масштабируются независимо друг от друга, чтобы заполнить представление.

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

ResolvedAdSize

ResolvedAdSize: FixedAdSize | FluidAdSize
Окончательное состояние размера объявления после его загрузки.

Для большинства объявлений это FixedAdSize с точными размерами width и height. Для баннеров с динамическим размером это значение преобразуется в FluidAdSize, где размеры управляются иерархией View.

SwipeGestureDirection

SwipeGestureDirection: typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
Инструкции по настройке специальных жестов.
Свойства
DOWN
проведите по экрану вниз;
LEFT
Проведите по экрану влево.
RIGHT
Проведите по экрану вправо.
UP
Пролистните вверх.

Переменные

AdSize

AdSize: {
  BANNER: FixedAdSize;
  custom: ((width, height) => FixedAdSize);
  FLUID: FluidAdSize;
  FULL_BANNER: FixedAdSize;
  getCurrentOrientationInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  getInlineAdaptiveBannerAdSize: ((width, maxHeight) => InlineAdaptiveAdSize);
  getLandscapeInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  getLargeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getLargeLandscapeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getLargePortraitAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getPortraitInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  LARGE_BANNER: FixedAdSize;
  LEADERBOARD: FixedAdSize;
  MEDIUM_RECTANGLE: FixedAdSize;
}
Стандартные размеры объявлений и вспомогательные методы для создания адаптивных и специальных размеров.

Функции

canRequestAds

canRequestAds(): boolean
Проверяет, позволяет ли текущий статус согласия запрашивать объявления.
Возвраты
boolean true, если вы можете запрашивать объявления; false в противном случае.

getConsentStatus

getConsentStatus(): ConsentStatus
Получает текущий статус согласия пользователя.
Возвраты
ConsentStatus Текущий статус согласия.

getInitializationStatus

getInitializationStatus(): InitializationStatus
Получает статус инициализации SDK.

Используйте этот метод, чтобы проверить, завершена ли инициализация SDK, и посмотреть статус отдельных адаптеров медиации.
Возвраты
InitializationStatus Текущий статус инициализации.

getPrivacyOptionsRequirementStatus

getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
Проверяет, требуется ли для вашего приложения точка входа для параметров конфиденциальности.

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

getRequestConfiguration

getRequestConfiguration(): RequestConfiguration
Получает глобальную конфигурацию запроса.

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

initialize

initialize(config, onInitializationComplete?): void
Инициализирует Google Mobile Ads SDK.

Вызовите этот метод, прежде чем загружать объявление и взаимодействовать с остальными компонентами Google Mobile Ads SDK.
Параметры
config: InitializationConfig Параметры инициализации SDK.
Optional onInitializationComplete: ((status) => void) Функция обратного вызова, которая будет выполнена после завершения инициализации SDK.

isConsentFormAvailable

isConsentFormAvailable(): boolean
Проверяет, доступна ли форма согласия.
Возвраты
boolean true, если доступна форма согласия; false в противном случае.

loadAndShowConsentFormIfRequired

loadAndShowConsentFormIfRequired(onDismissed?): void
Загружает форму согласия и показывает ее пользователю, если этого требует текущий статус согласия (например, статус REQUIRED).
Параметры
Optional onDismissed: ((error?) => void) Функция обратного вызова, которая вызывается, когда форма закрывается или если она не требуется. Если показ не удался, функция вызывается с необязательным параметром FormError.

openAdInspector

openAdInspector(_listener): void
Открывает оверлей инспектора объявлений Google Mobile Ads SDK.

Используйте этот метод для отладки настроек медиации и источников объявлений.
Параметры
_listener: OnAdInspectorClosedListener

openDebugMenu

openDebugMenu(adUnitId): void
Открывает меню отладки.

Используйте этот метод, чтобы открыть меню отладки для определенного рекламного блока и проверить настройки объявлений или устранить неполадки.
Параметры
adUnitId: string Идентификатор рекламного блока, для которого нужно открыть меню отладки.

parseLoadAdError

parseLoadAdError(error): LoadAdError
Выполняет синтаксический анализ ошибки, возникшей при загрузке объявления, и преобразует ее в объект LoadAdError.
Параметры
error: unknown Объект ошибки, созданный нативным модулем.
Возвраты
LoadAdError Объект LoadAdError, полученный в результате синтаксического анализа.

requestConsentInfoUpdate

requestConsentInfoUpdate(params?, onComplete?): void
Запрашивает обновление информации о согласии.

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

После вызова этого API возвращаемое значение getConsentStatus синхронно обновляется и содержит статус согласия из предыдущего сеанса приложения, если он был.

getConsentStatus можно снова обновить до актуального статуса после вызова обратного вызова onComplete.
Параметры
Optional params: ConsentRequestParameters Необязательные настройки для отладки и таргетинга.
Optional onComplete: ((error?) => void) Функция обратного вызова, которая вызывается после обновления информации о согласии. Если запрос не выполнен, она может содержать объект FormError.

reset

reset(): void
Удаляет все статусы согласия из постоянного хранилища.

Используйте только для отладки.

setPublisherFirstPartyIdEnabled

setPublisherFirstPartyIdEnabled(enabled): void
Позволяет включить или отключить собственный идентификатор издателя.

Включает или отключает собственный идентификатор издателя в Google Mobile Ads SDK, ранее известный как ключ одного приложения.
Статьи по теме
Параметры
enabled: boolean Значение true включает собственный идентификатор издателя, а значение false – отключает его. Значение по умолчанию – true.

setRequestConfiguration

setRequestConfiguration(_config): void
Задает глобальную конфигурацию запроса для соблюдения требований и таргетинга.

Используйте этот метод, чтобы указать сведения о таргетинге, например максимальное возрастное ограничение для рекламного контента, настройки соблюдения требований, такие как тег учета возраста, и идентификаторы тестовых устройств.
Параметры
_config: RequestConfiguration

setUserControlledAppVolume

setUserControlledAppVolume(volume): void
Устанавливает уровень громкости аудиоконтента, которым управляет пользователь.

Используйте этот метод, чтобы настроить громкость всех объявлений относительно других аудиовыходов на устройстве.
Параметры
volume: number Уровень громкости в диапазоне от 0,0 (без звука) до 1,0 (максимальный). Допустимо любое значение с плавающей запятой в этом диапазоне (например, 0,001 или 0,33333). Значение не ограничено определенным шагом, например 0,1.

setUserMutedApp

setUserMutedApp(muted): void
Указывает, отключен ли звук в приложении.

Используйте этот метод, чтобы задать начальное состояние отключения звука для последующих объявлений.
Параметры
muted: boolean Нужно ли отключить звук приложения. Значение по умолчанию – false.

showPrivacyOptionsForm

showPrivacyOptionsForm(onDismissed?): void
Показывает форму параметров конфиденциальности.

Отображает форму параметров конфиденциальности, если getPrivacyOptionsRequirementStatus возвращает значение REQUIRED.

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

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

Обратный вызов onDismissed вызывается после того, как пользователю будет показана форма, он выберет вариант ответа и закроет форму. Также может возвращаться ошибка FormError, если:
  • Форма недоступна.
  • Форма не показывается.
  • Форма ещё загружается.
Параметры
Optional onDismissed: ((error?) => void) Функция обратного вызова, которая вызывается при закрытии формы. Если не удалось показать форму, она также может содержать необязательный параметр FormError.