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

Выберите платформу: Android iOS Unity Flutter Android (устаревшая версия)

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

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

Подготовка

Прежде чем продолжить, сделайте следующее:

  • Настройте GMA Next-Gen SDK.
  • Используйте идентификатор тестового рекламного блока для объявлений с вознаграждением ca-app-pub-3940256099942544/5224354917.
    • При создании и тестировании приложения используйте тестовые объявления, а не реальные. Если вы не будете использовать идентификатор тестового рекламного блока, Google может заблокировать ваш аккаунт.
    • Перед публикацией приложения замените этот идентификатор на идентификатор своего рекламного блока.
    • Подробнее о тестовых объявлениях GMA Next-Gen SDK рассказывается в статье Как включить тестовые объявления.

Предварительная загрузка объявлений (бета)

Предварительная загрузка объявлений в GMA Next-Gen SDK автоматизирует загрузку и кеширование объявлений.

Предварительная загрузка объявлений дает следующие преимущества:

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

Как начать предварительную загрузку объявлений

Чтобы начать предварительную загрузку объявлений, вызовите метод start один раз при инициализации GMA Next-Gen SDK. После вызова метода start GMA Next-Gen SDK автоматически выполняет предварительную загрузку объявлений и повторно отправляет неудачные запросы для предварительно загруженных конфигураций.

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

Kotlin

val adRequest = AdRequest.Builder(adUnitId).build()
val preloadConfig = PreloadConfiguration(adRequest)
RewardedAdPreloader.start(adUnitId, preloadConfig)

Java

AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
RewardedAdPreloader.start(adUnitId, preloadConfig);

Замените AD_UNIT_ID идентификатором своего рекламного блока.

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

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

Получите и покажите предварительно загруженное объявление

Перед показом объявления вызовите метод pollAd. Не сохраняйте объект предварительно загруженного объявления. При вызове метода pollAd GMA Next-Gen SDK получает доступное объявление и автоматически загружает следующее в фоновом режиме. Если объявлений нет, GMA Next-Gen SDK не возвращает ничего.

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

Kotlin

private fun pollAndShowAd(activity: Activity, adUnitId: String) {
  // Polling returns the next available ad and loads another ad in the background.
  val ad = RewardedAdPreloader.pollAd(adUnitId)
  if (ad == null) {
    Log.e(TAG, "Rewarded ad is not available.")
    return
  }

  // Interact with the ad object as needed.
  Log.d(TAG, "Rewarded ad response info: ${ad.getResponseInfo()}")
  ad.adEventCallback =
    object : RewardedAdEventCallback {
      override fun onAdImpression() {
        Log.d(TAG, "Rewarded ad recorded an impression.")
      }
    }
  ad.show(activity) { rewardItem -> Log.d(TAG, "User earned reward: ${rewardItem.amount}") }
}

Java

private void pollAndShowAd(Activity activity, String adUnitId) {
  // Polling returns the next available ad and loads another ad in the background.
  final RewardedAd ad = RewardedAdPreloader.pollAd(adUnitId);

  // Interact with the ad object as needed.
  if (ad == null) {
    Log.e(TAG, "Rewarded ad is not available.");
    return;
  }

  Log.d(TAG, "Rewarded ad response info: " + ad.getResponseInfo());
  ad.setAdEventCallback(
      new RewardedAdEventCallback() {
        @Override
        public void onAdImpression() {
          Log.d(TAG, "Rewarded ad recorded an impression.");
        }
      });

  // Show the ad.
  ad.show(
      activity,
      rewardItem -> {
        Log.d(TAG, "User earned reward: " + rewardItem.getAmount());
      });
}

Когда приложение дойдет до места размещения объявления и сможет вызвать метод show, вызовите метод pollAd. Не вызывайте метод pollAd в обратных вызовах предварительной загрузки или после проверки метода isAdAvailable, чтобы удержать объявление. Если вам нужно проверить метаданные объявления перед его показом, прочитайте информацию об ответе, не удаляя объявление из кеша.

Как отслеживать события объявлений

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

Kotlin

private fun listenToAdEvents() {
  // Listen for ad events.
  val ad = rewardedAd
  if (ad == null) {
    Log.e(TAG, "Rewarded ad is not ready yet.")
    return
  }

  ad.adEventCallback =
    object : RewardedAdEventCallback {
      override fun onAdShowedFullScreenContent() {
        // Rewarded ad did show.
      }

      override fun onAdDismissedFullScreenContent() {
        // Rewarded ad did dismiss.
        rewardedAd = null
      }

      override fun onAdFailedToShowFullScreenContent(
        fullScreenContentError: FullScreenContentError
      ) {
        // Rewarded ad failed to show.
        Log.e(TAG, "Rewarded ad failed to show: ${fullScreenContentError.message}")
      }

      override fun onAdImpression() {
        // Rewarded ad did record an impression.
      }

      override fun onAdClicked() {
        // Rewarded ad did record a click.
      }
    }
}

Java

private void listenToAdEvents() {
  // Listen for ad events.
  if (rewardedAd == null) {
    Log.e(TAG, "Rewarded ad is not ready yet.");
    return;
  }

  rewardedAd.setAdEventCallback(
      new RewardedAdEventCallback() {
        @Override
        public void onAdShowedFullScreenContent() {
          // Rewarded ad did show.
        }

        @Override
        public void onAdDismissedFullScreenContent() {
          // Rewarded ad did dismiss.
          rewardedAd = null;
        }

        @Override
        public void onAdFailedToShowFullScreenContent(
            FullScreenContentError fullScreenContentError) {
          // Rewarded ad failed to show.
          Log.e(TAG, "Rewarded ad failed to show: " + fullScreenContentError.getMessage());
        }

        @Override
        public void onAdImpression() {
          // Rewarded ad did record an impression.
        }

        @Override
        public void onAdClicked() {
          // Rewarded ad did record a click.
        }
      });
}

Как проверить обратные вызовы при проверке на стороне сервера (необязательно)

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

  • Параметр запроса user_id. Позволяет идентифицировать пользователя, которому нужно начислить вознаграждение, например по идентификатору внутреннего аккаунта.
  • Параметр запроса custom_data. Содержит данные приложения, например место размещения вознаграждения, уровень игры или одноразовый код, сгенерированный сервером.

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

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

Kotlin

RewardedAd.load(
  context,
  AD_UNIT_ID,
  AdRequest.Builder().build(),
  object : RewardedAdLoadCallback() {
    override fun onAdLoaded(ad: RewardedAd) {
      rewardedAd = ad
      val options =
        ServerSideVerificationOptions.Builder().setCustomData("SAMPLE_CUSTOM_DATA_STRING").build()
      rewardedAd?.setServerSideVerificationOptions(options)
    }
  },
)

Java

RewardedAd.load(
    context,
    AD_UNIT_ID,
    new AdRequest.Builder().build(),
    new RewardedAdLoadCallback() {
      @Override
      public void onAdLoaded(RewardedAd ad) {
        rewardedAd = ad;
        ServerSideVerificationOptions options =
            new ServerSideVerificationOptions.Builder()
                .setCustomData("SAMPLE_CUSTOM_DATA_STRING")
                .build();
        rewardedAd.setServerSideVerificationOptions(options);
      }
    });

Замените SAMPLE_CUSTOM_DATA_STRING своими данными.

Важно! Параметр запроса custom_data закодирован в процентах. Прежде чем анализировать значение, декодируйте URL строки на сервере и проверьте подпись обратного вызова, прежде чем доверять параметрам запроса user_id или custom_data.

Как отслеживать события предзагрузки (необязательно)

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

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

Kotlin

val preloadCallback =
  object : PreloadCallback {
    override fun onAdFailedToPreload(preloadId: String, adError: LoadAdError) {
      Log.d(TAG, "Rewarded preload ad $preloadId failed to load with error: ${adError.message}")
    }

    override fun onAdsExhausted(preloadId: String) {
      Log.i(TAG, "Rewarded preload ad $preloadId is not available")
    }

    override fun onAdPreloaded(preloadId: String, responseInfo: ResponseInfo) {
      Log.i(TAG, "Rewarded preload ad $preloadId is available")
    }
  }
val adRequest = AdRequest.Builder(adUnitId).build()
val preloadConfig = PreloadConfiguration(adRequest)
RewardedAdPreloader.start(adUnitId, preloadConfig, preloadCallback)

Java

PreloadCallback preloadCallback =
    new PreloadCallback() {
      @Override
      public void onAdFailedToPreload(String preloadId, LoadAdError adError) {
        Log.d(
            TAG,
            String.format(
                "Rewarded preload ad %s failed to load with error: %s",
                preloadId, adError.getMessage()));
      }

      @Override
      public void onAdsExhausted(String preloadId) {
        Log.i(TAG, "Rewarded preload ad " + preloadId + " is not available");
      }

      @Override
      public void onAdPreloaded(String preloadId, ResponseInfo responseInfo) {
        Log.i(TAG, "Rewarded preload ad " + preloadId + " is available");
      }
    };

AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
RewardedAdPreloader.start(adUnitId, preloadConfig, preloadCallback);

Если объявление не загружается, GMA Next-Gen SDK автоматически выполняет предзагрузку объявлений и повторно отправляет запросы, которые не удалось выполнить. Не вызывайте запросы на загрузку вручную в обратных вызовах при сбое. В методах обратного вызова событий предзагрузки не вызывайте методы pollAd, destroy и start. Вызов этих методов в обратных вызовах может привести к рекурсивным циклам загрузки.

Проверка доступности объявления (необязательно)

Если вам нужно узнать, доступно ли объявление, проверьте его доступность. В примере ниже показано, как проверить, доступно ли предварительно загруженное объявление.

Kotlin

private fun isAdAvailable(adUnitId: String): Boolean {
  return RewardedAdPreloader.isAdAvailable(adUnitId)
}

Java

private boolean isAdAvailable(String adUnitId) {
  return RewardedAdPreloader.isAdAvailable(adUnitId);
}

Как задать размер буфера (необязательно)

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

В следующем примере показано, как задать размер буфера:

Kotlin

val adRequest = AdRequest.Builder(adUnitId).build()
// Define a PreloadConfiguration and set the buffer size to 2 preloaded ads.
val preloadConfig = PreloadConfiguration(adRequest, bufferSize = 2)
RewardedAdPreloader.start(adUnitId, preloadConfig)

Java

AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
// Define a PreloadConfiguration and set the buffer size to 2 preloaded ads.
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest, 2);
RewardedAdPreloader.start(adUnitId, preloadConfig);

Ограничения на предварительное кеширование

GMA Next-Gen SDK ограничивает общее количество предварительно загруженных объявлений во всех рекламных блоках и идентификаторах предварительной загрузки:

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

Как отключить предварительную загрузку объявлений (необязательно)

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

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

Kotlin

private fun stopPreloading(adUnitId: String) {
  // Stops the preloading and destroy preloaded ads.
  RewardedAdPreloader.destroy(adUnitId)
}

Java

private void stopPreloading(String adUnitId) {
  // Stops the preloading and destroy preloaded ads.
  RewardedAdPreloader.destroy(adUnitId);
}

Как прочитать информацию об ответах (необязательно)

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

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

Kotlin

val responseInfo = RewardedAdPreloader.peekAdResponseInfo(preloadId)
if (responseInfo == null) {
  Log.e(TAG, "Failed to peek ad response info.")
  return
}

Log.d(TAG, "Peeked ad response ID: ${responseInfo.responseId}")

Java

ResponseInfo responseInfo = RewardedAdPreloader.peekAdResponseInfo(preloadId);
if (responseInfo == null) {
  Log.e(TAG, "Failed to peek ad response info.");
  return;
}

Log.d(TAG, "Peeked ad response ID: " + responseInfo.getResponseId());