رویدادهای سفارشی تبلیغات پاداش
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
پیش نیازها
راه اندازی رویدادهای سفارشی را کامل کنید.
درخواست آگهی با پاداش
هنگامی که آیتم خط رویداد سفارشی در زنجیره واسطه آبشار به دست میآید، متد loadRewardedAd()
بر روی نام کلاسی که هنگام ایجاد یک رویداد سفارشی ارائه کردهاید فراخوانی میشود. در این مورد، آن متد در SampleCustomEvent
است، که سپس متد loadRewardedAd()
را در SampleRewardedCustomEventLoader
فراخوانی میکند.
برای درخواست تبلیغ پاداش، کلاسی ایجاد یا تغییر دهید که Adapter
برای پیاده سازی loadRewardedAd()
گسترش دهد. علاوه بر این، یک کلاس جدید برای پیاده سازی MediationRewardedAd
ایجاد کنید.
در مثال رویداد سفارشی ما، SampleCustomEvent
کلاس Adapter
را گسترش می دهد و سپس به SampleRewardedCustomEventLoader
واگذار می کند.
جاوا
package com.google.ads.mediation.sample.customevent;
import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.MediationRewardedAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdLoadCallback;
import com.google.android.gms.ads.mediation.MediationRewardedAd;
import com.google.android.gms.ads.mediation.MediationRewardedAdCallback;
...
public class SampleCustomEvent extends Adapter {
private SampleNativeCustomEventLoader nativeLoader;
@Override
public void loadRewardedAd(
@NonNull MediationRewardedAdConfiguration mediationRewardedAdConfiguration,
@NonNull
MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback>
mediationAdLoadCallback) {
rewardedLoader =
new SampleRewardedCustomEventLoader(
mediationRewardedAdConfiguration, mediationAdLoadCallback);
rewardedLoader.loadAd();
}
}
SampleRewardedCustomEventLoader
مسئول وظایف زیر است:
در حال بارگیری آگهی با پاداش
پیاده سازی رابط MediationRewardedAd
.
دریافت و گزارش تماسهای رویداد تبلیغاتی به Google Mobile Ads SDK.
پارامتر اختیاری تعریف شده در رابط کاربری AdMob در پیکربندی آگهی گنجانده شده است. این پارامتر از طریق adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD)
قابل دسترسی است. این پارامتر معمولاً یک شناسه واحد تبلیغاتی است که یک SDK شبکه تبلیغاتی هنگام نمونهبرداری از یک شی تبلیغاتی به آن نیاز دارد.
جاوا
package com.google.ads.mediation.sample.customevent;
import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.MediationRewardedAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdLoadCallback;
import com.google.android.gms.ads.mediation.MediationRewardedAd;
import com.google.android.gms.ads.mediation.MediationRewardedAdCallback;
...
public class SampleRewardedCustomEventLoader extends SampleRewardedAdListener
implements MediationRewardedAd {
/** Configuration for requesting the rewarded ad from the third-party network. */
private final MediationRewardedAdConfiguration mediationRewardedAdConfiguration;
/**
* A {@link MediationAdLoadCallback} that handles any callback when a Sample
* rewarded ad finishes loading.
*/
private final MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback>
mediationAdLoadCallback;
/** Callback for rewarded ad events. */
private MediationRewardedAdCallback rewardedAdCallback;
/** Constructor. */
public SampleRewardedCustomEventLoader(
@NonNull MediationRewardedAdConfiguration mediationRewardedAdConfiguration,
@NonNull MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback>
mediationAdLoadCallback) {
this.mediationRewardedAdConfiguration = mediationRewardedAdConfiguration;
this.mediationAdLoadCallback = mediationAdLoadCallback;
}
/** Loads the rewarded ad from the third-party ad network. */
public void loadAd() {
// All custom events have a server parameter named "parameter" that returns
// back the parameter entered into the AdMob UI when defining the custom event.
Log.i("RewardedCustomEvent", "Begin loading rewarded ad.");
String serverParameter = mediationRewardedAdConfiguration
.getServerParameters()
.getString(MediationConfiguration
.CUSTOM_EVENT_SERVER_PARAMETER_FIELD);
Log.d("RewardedCustomEvent", "Received server parameter.");
SampleAdRequest request = createSampleRequest(mediationRewardedAdConfiguration);
sampleRewardedAd = new SampleRewardedAd(serverParameter);
sampleRewardedAd.setListener(this);
Log.i("RewardedCustomEvent", "Start fetching rewarded ad.");
sampleRewardedAd.loadAd(request);
}
public SampleAdRequest createSampleRequest(
MediationAdConfiguration mediationAdConfiguration) {
SampleAdRequest request = new SampleAdRequest();
request.setTestMode(mediationAdConfiguration.isTestRequest());
request.setKeywords(mediationAdConfiguration.getMediationExtras().keySet());
return request;
}
}
بسته به اینکه آیا تبلیغ با موفقیت واکشی شده است یا با خطا مواجه میشود، میتوانید onSuccess()
یا onFailure()
فراخوانی کنید. onSuccess()
با ارسال نمونه ای از کلاسی که MediationRewardedAd
پیاده سازی می کند فراخوانی می شود.
به طور معمول، این روشها در داخل فراخوانهای SDK شخص ثالثی که آداپتور شما پیادهسازی میکند، پیادهسازی میشود. برای این مثال، Sample SDK دارای SampleAdListener
با تماسهای مربوطه است:
جاوا
@Override
public void onRewardedAdLoaded() {
rewardedAdCallback = mediationAdLoadCallback.onSuccess(this);
}
@Override
public void onRewardedAdFailedToLoad(SampleErrorCode errorCode) {
mediationAdLoadCallback.onFailure(SampleCustomEventError.createSampleSdkError(errorCode));
}
MediationRewardedAd
به پیاده سازی متد showAd()
برای نمایش تبلیغ نیاز دارد:
جاوا
@Override
public void showAd(Context context) {
if (!(context instanceof Activity)) {
rewardedAdCallback.onAdFailedToShow(
SampleCustomEventError.createCustomEventNoActivityContextError());
return;
}
Activity activity = (Activity) context;
if (!sampleRewardedAd.isAdAvailable()) {
rewardedAdCallback.onAdFailedToShow(
SampleCustomEventError.createCustomEventAdNotAvailableError());
return;
}
sampleRewardedAd.showAd(activity);
}
پس از فراخوانی onSuccess()
، شی MediationRewardedAdCallback
برگردانده شده میتواند توسط آداپتور برای ارسال رویدادهای ارائه از SDK شخص ثالث به Google Mobile Ads SDK استفاده شود. کلاس SampleRewardedCustomEventLoader
رابط SampleAdListener
را گسترش میدهد تا تماسهای برگشتی از شبکه تبلیغات نمونه به Google Mobile Ads SDK ارسال شود.
مهم است که رویداد سفارشی شما تا آنجایی که ممکن است این تماسهای پاسخگو را فوروارد کند تا برنامه شما این رویدادهای مشابه را از Google Mobile Ads SDK دریافت کند. در اینجا مثالی از استفاده از callback آورده شده است:
جاوا
@Override
public void onAdRewarded(final String rewardType, final int amount) {
RewardItem rewardItem =
new RewardItem() {
@Override
public String getType() {
return rewardType;
}
@Override
public int getAmount() {
return amount;
}
};
rewardedAdCallback.onUserEarnedReward(rewardItem);
}
@Override
public void onAdClicked() {
rewardedAdCallback.reportAdClicked();
}
@Override
public void onAdFullScreen() {
rewardedAdCallback.onAdOpened();
rewardedAdCallback.onVideoStart();
rewardedAdCallback.reportAdImpression();
}
@Override
public void onAdClosed() {
rewardedAdCallback.onAdClosed();
}
@Override
public void onAdCompleted() {
rewardedAdCallback.onVideoComplete();
}
این پیاده سازی رویدادهای سفارشی را برای تبلیغات پاداش تکمیل می کند. نمونه کامل در GitHub موجود است. میتوانید آن را با یک شبکه تبلیغاتی که قبلاً پشتیبانی میشود استفاده کنید یا آن را برای نمایش آگهیهای پاداش رویداد سفارشی تغییر دهید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-09-06 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2025-09-06 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eTo request a rewarded ad with custom events, extend the \u003ccode\u003eAdapter\u003c/code\u003e class and implement the \u003ccode\u003eloadRewardedAd()\u003c/code\u003e method, delegating to a loader class.\u003c/p\u003e\n"],["\u003cp\u003eThe loader class handles loading the ad, implements \u003ccode\u003eMediationRewardedAd\u003c/code\u003e, and manages ad event callbacks to the Google Mobile Ads SDK.\u003c/p\u003e\n"],["\u003cp\u003eImplement the \u003ccode\u003eshowAd()\u003c/code\u003e method in the loader class to display the rewarded ad when requested.\u003c/p\u003e\n"],["\u003cp\u003eForward ad events from the third-party ad network SDK to the Google Mobile Ads SDK using the \u003ccode\u003eMediationRewardedAdCallback\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eA complete custom event rewarded ad example is available on GitHub for reference and modification.\u003c/p\u003e\n"]]],[],null,["Prerequisites\n\nComplete the [custom events setup](/admob/android/custom-events/setup).\n\nRequest a rewarded ad\n\nWhen the custom event line item is reached in the waterfall mediation chain,\nthe `loadRewardedAd()` method is called on the class name you\nprovided when [creating a custom\nevent](/admob/android/custom-events/setup#create). In this case,\nthat method is in `SampleCustomEvent`, which then calls the `loadRewardedAd()`\nmethod in `SampleRewardedCustomEventLoader`.\n\nTo request a rewarded ad, create or modify a class that extends `Adapter` to\nimplement `loadRewardedAd()`. Additionally, create a new class to implement\n`MediationRewardedAd`.\n\nIn our [custom event example](//github.com/googleads/googleads-mobile-android-mediation/blob/main/Example/customevent/src/main/java/com/google/ads/mediation/sample/customevent/SampleCustomEvent.java),\n`SampleCustomEvent` extends the `Adapter` class and then delegates to\n`SampleRewardedCustomEventLoader`. \n\nJava \n\n```java\npackage com.google.ads.mediation.sample.customevent;\n\nimport com.google.android.gms.ads.mediation.Adapter;\nimport com.google.android.gms.ads.mediation.MediationRewardedAdConfiguration;\nimport com.google.android.gms.ads.mediation.MediationAdConfiguration;\nimport com.google.android.gms.ads.mediation.MediationAdLoadCallback;\nimport com.google.android.gms.ads.mediation.MediationRewardedAd;\nimport com.google.android.gms.ads.mediation.MediationRewardedAdCallback;\n...\n\npublic class SampleCustomEvent extends Adapter {\n\n private SampleNativeCustomEventLoader nativeLoader;\n\n @Override\n public void loadRewardedAd(\n @NonNull MediationRewardedAdConfiguration mediationRewardedAdConfiguration,\n @NonNull\n MediationAdLoadCallback\u003cMediationRewardedAd, MediationRewardedAdCallback\u003e\n mediationAdLoadCallback) {\n rewardedLoader =\n new SampleRewardedCustomEventLoader(\n mediationRewardedAdConfiguration, mediationAdLoadCallback);\n rewardedLoader.loadAd();\n }\n}\n```\n\n`SampleRewardedCustomEventLoader` is responsible for the following tasks:\n\n- Loading the rewarded ad\n\n- Implementing the `MediationRewardedAd` interface.\n\n- Receiving and reporting ad event callbacks to Google Mobile Ads SDK.\n\nThe optional parameter defined in the AdMob UI is\nincluded in the ad configuration. The parameter can be accessed through\n`adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD)`.\nThis parameter is typically an ad unit identifier that an ad network SDK\nrequires when instantiating an ad object. \n\nJava \n\n```java\npackage com.google.ads.mediation.sample.customevent;\n\nimport com.google.android.gms.ads.mediation.Adapter;\nimport com.google.android.gms.ads.mediation.MediationRewardedAdConfiguration;\nimport com.google.android.gms.ads.mediation.MediationAdLoadCallback;\nimport com.google.android.gms.ads.mediation.MediationRewardedAd;\nimport com.google.android.gms.ads.mediation.MediationRewardedAdCallback;\n...\n\npublic class SampleRewardedCustomEventLoader extends SampleRewardedAdListener\n implements MediationRewardedAd {\n\n /** Configuration for requesting the rewarded ad from the third-party network. */\n private final MediationRewardedAdConfiguration mediationRewardedAdConfiguration;\n\n /**\n * A {@link MediationAdLoadCallback} that handles any callback when a Sample\n * rewarded ad finishes loading.\n */\n private final MediationAdLoadCallback\u003cMediationRewardedAd, MediationRewardedAdCallback\u003e\n mediationAdLoadCallback;\n\n /** Callback for rewarded ad events. */\n private MediationRewardedAdCallback rewardedAdCallback;\n\n /** Constructor. */\n public SampleRewardedCustomEventLoader(\n @NonNull MediationRewardedAdConfiguration mediationRewardedAdConfiguration,\n @NonNull MediationAdLoadCallback\u003cMediationRewardedAd, MediationRewardedAdCallback\u003e\n mediationAdLoadCallback) {\n this.mediationRewardedAdConfiguration = mediationRewardedAdConfiguration;\n this.mediationAdLoadCallback = mediationAdLoadCallback;\n }\n\n /** Loads the rewarded ad from the third-party ad network. */\n public void loadAd() {\n // All custom events have a server parameter named \"parameter\" that returns\n // back the parameter entered into the AdMob UI when defining the custom event.\n Log.i(\"RewardedCustomEvent\", \"Begin loading rewarded ad.\");\n String serverParameter = mediationRewardedAdConfiguration\n .getServerParameters()\n .getString(MediationConfiguration\n .CUSTOM_EVENT_SERVER_PARAMETER_FIELD);\n Log.d(\"RewardedCustomEvent\", \"Received server parameter.\");\n SampleAdRequest request = createSampleRequest(mediationRewardedAdConfiguration);\n sampleRewardedAd = new SampleRewardedAd(serverParameter);\n sampleRewardedAd.setListener(this);\n Log.i(\"RewardedCustomEvent\", \"Start fetching rewarded ad.\");\n sampleRewardedAd.loadAd(request);\n }\n\n public SampleAdRequest createSampleRequest(\n MediationAdConfiguration mediationAdConfiguration) {\n SampleAdRequest request = new SampleAdRequest();\n request.setTestMode(mediationAdConfiguration.isTestRequest());\n request.setKeywords(mediationAdConfiguration.getMediationExtras().keySet());\n return request;\n }\n}\n```\n\nDepending on whether the ad is successfully fetched or encounters an error, you\nwould call either\n[`onSuccess()`](/admob/android/reference/com/google/android/gms/ads/mediation/MediationAdLoadCallback#onSuccess(MediationAdT))\nor\n[`onFailure()`](/admob/android/reference/com/google/android/gms/ads/mediation/MediationAdLoadCallback#onFailure(com.google.android.gms.ads.AdError)).\n`onSuccess()` is called by passing in an instance of the class that implements\n`MediationRewardedAd`.\n\nTypically, these methods are implemented inside callbacks from the\nthird-party SDK your adapter implements. For this example, the Sample SDK\nhas a `SampleAdListener` with relevant callbacks: \n\nJava \n\n```java\n@Override\npublic void onRewardedAdLoaded() {\n rewardedAdCallback = mediationAdLoadCallback.onSuccess(this);\n}\n\n@Override\npublic void onRewardedAdFailedToLoad(SampleErrorCode errorCode) {\n mediationAdLoadCallback.onFailure(SampleCustomEventError.createSampleSdkError(errorCode));\n}\n```\n\n`MediationRewardedAd` requires implementing a `showAd()` method to display\nthe ad: \n\nJava \n\n```java\n@Override\npublic void showAd(Context context) {\n if (!(context instanceof Activity)) {\n rewardedAdCallback.onAdFailedToShow(\n SampleCustomEventError.createCustomEventNoActivityContextError());\n return;\n }\n Activity activity = (Activity) context;\n\n if (!sampleRewardedAd.isAdAvailable()) {\n rewardedAdCallback.onAdFailedToShow(\n SampleCustomEventError.createCustomEventAdNotAvailableError());\n return;\n }\n sampleRewardedAd.showAd(activity);\n}\n```\n\nForward mediation events to Google Mobile Ads SDK\n\nOnce `onSuccess()` is called, the returned `MediationRewardedAdCallback`\nobject can then be used by the adapter to forward presentation events from the\nthird-party SDK to Google Mobile Ads SDK. The\n`SampleRewardedCustomEventLoader` class extends the `SampleAdListener`\ninterface to forward callbacks from the sample ad network to the Google Mobile\nAds SDK.\n\nIt's important that your custom event forwards as many of these callbacks as\npossible, so that your app receives these equivalent events from the\nGoogle Mobile Ads SDK. Here's an example of using callbacks: \n\nJava \n\n```java\n@Override\npublic void onAdRewarded(final String rewardType, final int amount) {\n RewardItem rewardItem =\n new RewardItem() {\n @Override\n public String getType() {\n return rewardType;\n }\n\n @Override\n public int getAmount() {\n return amount;\n }\n };\n rewardedAdCallback.onUserEarnedReward(rewardItem);\n}\n\n@Override\npublic void onAdClicked() {\n rewardedAdCallback.reportAdClicked();\n}\n\n@Override\npublic void onAdFullScreen() {\n rewardedAdCallback.onAdOpened();\n rewardedAdCallback.onVideoStart();\n rewardedAdCallback.reportAdImpression();\n}\n\n@Override\npublic void onAdClosed() {\n rewardedAdCallback.onAdClosed();\n}\n\n@Override\npublic void onAdCompleted() {\n rewardedAdCallback.onVideoComplete();\n}\n```\n\nThis completes the custom events implementation for rewarded ads. The full\nexample is available on\n[GitHub](//github.com/googleads/googleads-mobile-android-mediation/tree/master/Example/customevent/src/main/java/com/google/ads/mediation/sample/customevent).\nYou can use it with an ad network that is already supported or modify it to\ndisplay custom event rewarded ads."]]