Реклама с вознаграждением — это реклама, с которой пользователи могут взаимодействовать в обмен на вознаграждения в приложении. В этом руководстве показано, как интегрировать рекламу с вознаграждением из AdMob в приложение Unity.
Прочтите несколько историй успеха клиентов: практический пример 1 , практический пример 2 .
В этом руководстве объясняется, как интегрировать рекламу с вознаграждением в приложение Unity.
Предварительные условия
- Заполните руководство по началу работы .
Всегда тестируйте с помощью тестовых объявлений
Следующий пример кода содержит идентификатор рекламного блока, который можно использовать для запроса тестовых объявлений. Он был специально настроен для возврата тестовых объявлений, а не рабочих объявлений по каждому запросу, что делает его безопасным в использовании.
Однако после того, как вы зарегистрировали приложение в веб-интерфейсе AdMob и создали собственные идентификаторы рекламных блоков для использования в нем, во время разработки явно настройте свое устройство как тестовое .
Андроид
ca-app-pub-3940256099942544/5224354917
iOS
ca-app-pub-3940256099942544/1712485313
Инициализируйте SDK мобильной рекламы
Перед загрузкой рекламы попросите ваше приложение инициализировать Mobile Ads SDK, вызвав MobileAds.Initialize()
. Это необходимо сделать только один раз, в идеале при запуске приложения.
using GoogleMobileAds;
using GoogleMobileAds.Api;
public class GoogleMobileAdsDemoScript : MonoBehaviour
{
public void Start()
{
// Initialize the Google Mobile Ads SDK.
MobileAds.Initialize((InitializationStatus initStatus) =>
{
// This callback is called once the MobileAds SDK is initialized.
});
}
}
Если вы используете медиацию, подождите, пока произойдет обратный вызов, прежде чем загружать объявления, так как это обеспечит инициализацию всех адаптеров медиации.
Выполнение
Основные шаги по интеграции рекламы с вознаграждением:
- Загрузите объявление с вознаграждением
- [Необязательно] Проверка обратных вызовов проверки на стороне сервера (SSV).
- Покажите объявление с вознаграждением с обратным вызовом с вознаграждением
- Слушайте рекламные события с вознаграждением
- Очистите рекламу с вознаграждением
- Предварительная загрузка следующего объявления с вознаграждением
Загрузите объявление с вознаграждением
Загрузка объявления с вознаграждением осуществляется с помощью статического метода Load()
класса RewardedAd
. Загруженный объект RewardedAd
предоставляется в качестве параметра обработчика завершения. В примере ниже показано, как загрузить RewardedAd
.
// These ad units are configured to always serve test ads.
#if UNITY_ANDROID
private string _adUnitId = "ca-app-pub-3940256099942544/5224354917";
#elif UNITY_IPHONE
private string _adUnitId = "ca-app-pub-3940256099942544/1712485313";
#else
private string _adUnitId = "unused";
#endif
private RewardedAd rewardedAd;
/// <summary>
/// Loads the rewarded ad.
/// </summary>
public void LoadRewardedAd()
{
// Clean up the old ad before loading a new one.
if (rewardedAd != null)
{
rewardedAd.Destroy();
rewardedAd = null;
}
Debug.Log("Loading the rewarded ad.");
// create our request used to load the ad.
var adRequest = new AdRequest.Builder().Build();
// send the request to load the ad.
RewardedAd.Load(_adUnitId, adRequest,
(RewardedAd ad, LoadAdError error) =>
{
// if error is not null, the load request failed.
if (error != null || ad == null)
{
Debug.LogError("Rewarded ad failed to load an ad " +
"with error : " + error);
return;
}
Debug.Log("Rewarded ad loaded with response : "
+ ad.GetResponseInfo());
rewardedAd = ad;
});
}
[Необязательно] Проверка обратных вызовов проверки на стороне сервера (SSV).
Приложения, которым требуются дополнительные данные в обратных вызовах проверки на стороне сервера, должны использовать функцию пользовательских данных объявлений с вознаграждением. Любое строковое значение, установленное для объекта рекламы с вознаграждением, передается в параметр запроса custom_data
обратного вызова SSV. Если значение настраиваемых данных не установлено, значение параметра запроса custom_data
не будет присутствовать в обратном вызове SSV.
В следующем примере кода показано, как настроить параметры SSV после загрузки объявления с вознаграждением.
// send the request to load the ad.
RewardedAd.Load(_adUnitId, adRequest, (RewardedAd ad, LoadAdError error) =>
{
// If the operation failed, an error is returned.
if (error != null || ad == null)
{
Debug.LogError("Rewarded ad failed to load an ad with error : " + error);
return;
}
// If the operation completed successfully, no error is returned.
Debug.Log("Rewarded ad loaded with response : " + ad.GetResponseInfo());
// Create and pass the SSV options to the rewarded ad.
var options = new ServerSideVerificationOptions
.Builder()
.SetCustomData("SAMPLE_CUSTOM_DATA_STRING")
.Build()
ad.SetServerSideVerificationOptions(options);
});
Если вы хотите установить специальную строку вознаграждения, это необходимо сделать до показа объявления.
Покажите объявление с вознаграждением с обратным вызовом с вознаграждением
При показе объявления вы должны предоставить обратный вызов для обработки вознаграждения для пользователя. Объявления могут показываться только один раз за загрузку. Используйте метод CanShowAd()
, чтобы убедиться, что объявление готово к показу.
Следующий код представляет лучший метод отображения рекламы с вознаграждением.
public void ShowRewardedAd()
{
const string rewardMsg =
"Rewarded ad rewarded the user. Type: {0}, amount: {1}.";
if (rewardedAd != null && rewardedAd.CanShowAd())
{
rewardedAd.Show((Reward reward) =>
{
// TODO: Reward the user.
Debug.Log(String.Format(rewardMsg, reward.Type, reward.Amount));
});
}
}
Слушайте рекламные события с вознаграждением
Чтобы дополнительно настроить поведение вашего объявления, вы можете подключиться к ряду событий жизненного цикла объявления: открытие, закрытие и т. д. Прослушивайте эти события, зарегистрировав делегата, как показано ниже.
private void RegisterEventHandlers(RewardedAd ad)
{
// Raised when the ad is estimated to have earned money.
ad.OnAdPaid += (AdValue adValue) =>
{
Debug.Log(String.Format("Rewarded ad paid {0} {1}.",
adValue.Value,
adValue.CurrencyCode));
};
// Raised when an impression is recorded for an ad.
ad.OnAdImpressionRecorded += () =>
{
Debug.Log("Rewarded ad recorded an impression.");
};
// Raised when a click is recorded for an ad.
ad.OnAdClicked += () =>
{
Debug.Log("Rewarded ad was clicked.");
};
// Raised when an ad opened full screen content.
ad.OnAdFullScreenContentOpened += () =>
{
Debug.Log("Rewarded ad full screen content opened.");
};
// Raised when the ad closed full screen content.
ad.OnAdFullScreenContentClosed += () =>
{
Debug.Log("Rewarded ad full screen content closed.");
};
// Raised when the ad failed to open full screen content.
ad.OnAdFullScreenContentFailed += (AdError error) =>
{
Debug.LogError("Rewarded ad failed to open full screen content " +
"with error : " + error);
};
}
Очистите рекламу с вознаграждением
Когда вы закончите работу с RewardedAd
, обязательно вызовите метод Destroy()
прежде чем удалять ссылку на него:
rewardedAd.Destroy();
Это уведомляет плагин о том, что объект больше не используется и занимаемая им память может быть освобождена. Невызов этого метода приводит к утечкам памяти.
Предварительная загрузка следующего объявления с вознаграждением
RewardedAd
— это объект одноразового использования. Это означает, что после показа объявления с вознаграждением объект нельзя будет использовать снова. Чтобы запросить еще одно объявление с вознаграждением, вам необходимо создать новый объект RewardedAd
.
Чтобы подготовить объявление с вознаграждением к следующему показу, предварительно загрузите объявление с вознаграждением после возникновения события объявления OnAdFullScreenContentClosed
или OnAdFullScreenContentFailed
.
private void RegisterReloadHandler(RewardedAd ad)
{
// Raised when the ad closed full screen content.
ad.OnAdFullScreenContentClosed += () =>
{
Debug.Log("Rewarded Ad full screen content closed.");
// Reload the ad so that we can show another as soon as possible.
LoadRewardedAd();
};
// Raised when the ad failed to open full screen content.
ad.OnAdFullScreenContentFailed += (AdError error) =>
{
Debug.LogError("Rewarded ad failed to open full screen content " +
"with error : " + error);
// Reload the ad so that we can show another as soon as possible.
LoadRewardedAd();
};
}
Дополнительные ресурсы
Образцы
- Пример HelloWorld : минимальная реализация всех форматов рекламы.