{"data":{"id":"862983","string_id":"20JQv4F0","status":"1","parent_id":"76196","slug":"20JQv4F0","order":"18","name":"Custom Adapter","type":"1","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","author":"Welch","published_time":"0","add_time":"1783421010","update_time":"1783478001","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","tags":[],"parent_name":"SDK Access Guide","parent_type":"1","parent_slug":"cUkkAX","child":[{"id":"862985","string_id":"HYhJVHun","status":"1","parent_id":"862983","slug":"HYhJVHun","order":"7","name":"Base Flow","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"Welch","published_time":"1783477702","add_time":"1783421033","update_time":"1783477705","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"862985","content":"For a detailed example of implementing a custom Adapter, refer to: [Taku Demo](https:\/\/github.com\/TakuMediation\/Taku_Android_Demo)\n\n **1.** Class Descriptions for Implementing Each Ad Format\n----------------------\n\nDevelopers need to inherit the class corresponding to the required ad format (see the table below) and override all abstract methods. In the corresponding methods, call the ad platform's API, callback the load result through the class member variable mLoadListener, and callback ad impression, click, close, and other event results through the class member variable mImpressionListener.\n\n| Ad Format | Class Name |\n|---|---|\n| Rewarded Video | com.anythink.rewardvideo.unitgroup.api.CustomRewardVideoAdapter |\n| Interstitial Ad | com.anythink.interstitial.unitgroup.api.CustomInterstitialAdapter |\n| Banner Ad | com.anythink.banner.unitgroup.api.CustomBannerAdapter |\n| Native Ad | com.anythink.nativead.unitgroup.api.CustomNativeAdapter |\n| Splash Ad | com.anythink.splash.unitgroup.api.CustomSplashAdapter |\n\n[See how to create a Custom Adapter in the Taku dashboard](\/docs\/fRMh7C)\n\nIf you need to implement Bidding functionality using a custom Adapter, please check: [Custom Advanced Configuration](\/docs\/qJT7q0)\n\n**2.** Implementation of Common Abstract Methods and Ad Loading Event Callbacks\n-----------------------\n\n### 2.1 Implementation of Common Abstract Methods\n\n| Abstract Method | Parameter Description | Return Value | Purpose | Required | Description |\n|---|---|---|---|---|---|\n| loadCustomNetworkAd | Context context: Context Map serverExtra: Custom parameters configured on the server side Map localExtra: Custom parameters passed for this load | void | Implement the loading logic for the custom ad platform's ads. | Yes | **context parameter**: Corresponds to the context value passed to ATRewardVideoAd, ATInterstitial, ATNative, ATBannerView, or ATSplashAd. For Splash Ads, the context type is Activity; for Rewarded Video, Interstitial, Native (Info Feed) Ads, and Banner Ads, the context type depends on the Context passed to ATRewardVideoAd, ATInterstitial, ATNative, ATBannerView. **serverExtra parameter**: The key-value pairs in the JSON string configured in the Taku dashboard can all be obtained through the serverExtra parameter. Custom key-value pairs will transparently pass the configured placement ID (key=slot\\_id) by default. **localExtra parameter**: The key-value pairs passed through methods such as ATRewardVideoAd#setLocalExtra(), ATInterstitial#setLocalExtra(), ATNative#setLocalExtra(), ATBannerView#setLocalExtra(), etc., can all be obtained through the localExtra parameter. |\n| destory | - | void | Implement the destruction logic for the custom ad platform. | Yes | The Taku SDK will internally call this method at the appropriate time to destroy the ad platform's resources. |\n| getNetworkPlacementId | - | void | Provide the ad placement ID of the custom ad platform for this load. | Yes | Used for the ATAdInfo object in Taku SDK callback methods and related internal logic, etc. |\n| getNetworkSDKVersion | - | void | Provide the SDK version of the custom ad platform for this load. | Yes | Used for the ATAdInfo object in Taku SDK callback methods and related internal logic, etc. |\n| setUserDataConsent | Context context: Context boolean isConsent: Whether the user has authorized isEUTraffic: Whether it is the EU region | boolean | Provide the user's authorization status and EU information to the custom ad platform to implement GDPR settings. **(Return true if implemented. Taku will use it for statistical recording.)** | No **(Recommended to implement for releases in the EU region)** | - |\n| getNetworkInfoMap | - | Map | Provide custom information for the custom ad. | No | In this method, you can create a Map and add some extra information to this Map and return it. Developers can ultimately obtain this extra information by calling the **ATAdInfo.getExtInfoMap()** method through the ATAdInfo object in each Taku SDK callback method. |\n\n### 2.2 Callbacks for Common Ad Loading Events\n\n**Use the member variable ATCustomLoadListener in the Adapter to implement callbacks for ad loading results.**\n\n| Callback Method | Parameter Description | Description |\n|---|---|---|\n| onAdCacheLoaded | BaseAd... baseAds: Mainly used for calling back ad objects for Native Ads. Other ad formats do not need to add parameter callbacks. | When ad content and creative materials are loaded successfully, call this method to notify the Taku SDK. Eventually, the Taku SDK will call back the **load success** method to notify the developer. |\n| onAdLoadError | String errorCode: Error code info String errorMsg: Detailed error info | When ad loading fails, call this method to notify the Taku SDK. Eventually, the Taku SDK will call back the **load failure** method to notify the developer (errorCode and errorMsg will be encapsulated in the AdError object in the Taku SDK callback method). |\n\n**Note: When using the member variable ATCustomLoadListener, null-check handling is required, because the Mediation SDK may internally reclaim this Listener object.**\n\n**3.** Usage and Notes for Custom Ad Platform Adapters\n--------------------------\n\n### 3.1 Usage Flow\n\n \u2022 Developers only need to inherit the relevant classes and override the relevant methods. All methods in the custom Adapter do not need to be called by the developer. When the Ad Source for the custom ad platform is configured under the Ad Placement in the Taku dashboard, the SDK will internally call the relevant methods in the custom Adapter at the appropriate time.\n\n \u2022 The developer calls the Taku SDK's load API to load an ad. The Taku SDK will create an instance of the custom Adapter class through reflection based on the class name configured in the dashboard, and call loadCustomNetworkAd() to request the ad. The loading result of the custom ad platform's ad needs to notify the Taku SDK by calling the methods of ATCustomLoadListener (onAdCacheLoaded, onAdLoadError). Eventually, the Taku SDK will notify the developer through the Taku callback methods.\n\n \u2022 The parameters needed for loading ads on the custom ad platform (AppID, AppKey, PlacementID, etc.) should be configured in JSON string format in the Ad Source of that ad platform in the Taku dashboard. For example:\n\n```java\n{\n \"app_id\":\"2004533529842888\",\n \"unit_id\":\"VID_HD_16_9_15S_APP_INSTALL#2004533529842888_2110107055952201\"\n}\n```\n\nWhen the Taku SDK retrieves the backend strategy, it will convert this JSON string into a Map and pass it to loadCustomNetworkAd(Context context, Map).\n\n \u2022 When the developer calls the Taku SDK's isAdReady API, it will call the custom Adapter's isAdReady() method.\n\n \u2022 When the developer calls the Taku SDK's show API, it will call the custom Adapter's isAdReady() and show(Activity activity) methods.\n\n### 3.2 Notes\n\n \u2022 When adding a custom ad platform in the Taku dashboard, the Adapter class name must be configured with the full path class name (package name + class name), otherwise the Adapter class will not be created correctly when loading ads.\n\n \u2022 Since the SDK internally creates the Adapter class through reflection, when building a release package, you must ensure that the Adapter class is not obfuscated. An example of the obfuscation rule is as follows:\n\n```java\n# Replace with the developer's own Adapter class name. \n-keep class { *;} \n-keepclassmembers public class { \n public *; \n}\n```\n\n \u2022 For any issues encountered, refer to [How to Test Ads](\/docs\/ZkqOxS) for solutions.","pure_content":"For a detailed example of implementing a custom Adapter, refer to: Taku Demo\n1. Class Descriptions for Implementing Each Ad Format\nDevelopers need to inherit the class corresponding to the required ad format (see the table below) and override all abstract methods. In the corresponding methods, call the ad platform's API, callback the load result through the class member variable mLoadListener, and callback ad impression, click, close, and other event results through the class member variable mImpressionListener.\n\n\n\n Ad Format\n Class Name\n\n\n\n\n Rewarded Video\n com.anythink.rewardvideo.unitgroup.api.CustomRewardVideoAdapter\n\n\n Interstitial Ad\n com.anythink.interstitial.unitgroup.api.CustomInterstitialAdapter\n\n\n Banner Ad\n com.anythink.banner.unitgroup.api.CustomBannerAdapter\n\n\n Native Ad\n com.anythink.nativead.unitgroup.api.CustomNativeAdapter\n\n\n Splash Ad\n com.anythink.splash.unitgroup.api.CustomSplashAdapter\n\n\n\nSee how to create a Custom Adapter in the Taku dashboard\nIf you need to implement Bidding functionality using a custom Adapter, please check: Custom Advanced Configuration\n2. Implementation of Common Abstract Methods and Ad Loading Event Callbacks\n2.1 Implementation of Common Abstract Methods\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Required\n Description\n\n\n\n\n loadCustomNetworkAd\n Context context: Context Map serverExtra: Custom parameters configured on the server side Map localExtra: Custom parameters passed for this load\n void\n Implement the loading logic for the custom ad platform's ads.\n Yes\n context parameter: Corresponds to the context value passed to ATRewardVideoAd, ATInterstitial, ATNative, ATBannerView, or ATSplashAd. For Splash Ads, the context type is Activity; for Rewarded Video, Interstitial, Native (Info Feed) Ads, and Banner Ads, the context type depends on the Context passed to ATRewardVideoAd, ATInterstitial, ATNative, ATBannerView. serverExtra parameter: The key-value pairs in the JSON string configured in the Taku dashboard can all be obtained through the serverExtra parameter. Custom key-value pairs will transparently pass the configured placement ID (key=slot_id) by default. localExtra parameter: The key-value pairs passed through methods such as ATRewardVideoAd#setLocalExtra(), ATInterstitial#setLocalExtra(), ATNative#setLocalExtra(), ATBannerView#setLocalExtra(), etc., can all be obtained through the localExtra parameter.\n\n\n destory\n -\n void\n Implement the destruction logic for the custom ad platform.\n Yes\n The Taku SDK will internally call this method at the appropriate time to destroy the ad platform's resources.\n\n\n getNetworkPlacementId\n -\n void\n Provide the ad placement ID of the custom ad platform for this load.\n Yes\n Used for the ATAdInfo object in Taku SDK callback methods and related internal logic, etc.\n\n\n getNetworkSDKVersion\n -\n void\n Provide the SDK version of the custom ad platform for this load.\n Yes\n Used for the ATAdInfo object in Taku SDK callback methods and related internal logic, etc.\n\n\n setUserDataConsent\n Context context: Context boolean isConsent: Whether the user has authorized isEUTraffic: Whether it is the EU region\n boolean\n Provide the user's authorization status and EU information to the custom ad platform to implement GDPR settings. (Return true if implemented. Taku will use it for statistical recording.)\n No (Recommended to implement for releases in the EU region)\n -\n\n\n getNetworkInfoMap\n -\n Map\n Provide custom information for the custom ad.\n No\n In this method, you can create a Map and add some extra information to this Map and return it. Developers can ultimately obtain this extra information by calling the ATAdInfo.getExtInfoMap() method through the ATAdInfo object in each Taku SDK callback method.\n\n\n\n2.2 Callbacks for Common Ad Loading Events\nUse the member variable ATCustomLoadListener in the Adapter to implement callbacks for ad loading results.\n\n\n\n Callback Method\n Parameter Description\n Description\n\n\n\n\n onAdCacheLoaded\n BaseAd... baseAds: Mainly used for calling back ad objects for Native Ads. Other ad formats do not need to add parameter callbacks.\n When ad content and creative materials are loaded successfully, call this method to notify the Taku SDK. Eventually, the Taku SDK will call back the load success method to notify the developer.\n\n\n onAdLoadError\n String errorCode: Error code info String errorMsg: Detailed error info\n When ad loading fails, call this method to notify the Taku SDK. Eventually, the Taku SDK will call back the load failure method to notify the developer (errorCode and errorMsg will be encapsulated in the AdError object in the Taku SDK callback method).\n\n\n\nNote: When using the member variable ATCustomLoadListener, null-check handling is required, because the Mediation SDK may internally reclaim this Listener object.\n3. Usage and Notes for Custom Ad Platform Adapters\n3.1 Usage Flow\n\u2022 Developers only need to inherit the relevant classes and override the relevant methods. All methods in the custom Adapter do not need to be called by the developer. When the Ad Source for the custom ad platform is configured under the Ad Placement in the Taku dashboard, the SDK will internally call the relevant methods in the custom Adapter at the appropriate time.\n\u2022 The developer calls the Taku SDK's load API to load an ad. The Taku SDK will create an instance of the custom Adapter class through reflection based on the class name configured in the dashboard, and call loadCustomNetworkAd() to request the ad. The loading result of the custom ad platform's ad needs to notify the Taku SDK by calling the methods of ATCustomLoadListener (onAdCacheLoaded, onAdLoadError). Eventually, the Taku SDK will notify the developer through the Taku callback methods.\n\u2022 The parameters needed for loading ads on the custom ad platform (AppID, AppKey, PlacementID, etc.) should be configured in JSON string format in the Ad Source of that ad platform in the Taku dashboard. For example:\n{\n \"app_id\":\"2004533529842888\",\n \"unit_id\":\"VID_HD_16_9_15S_APP_INSTALL#2004533529842888_2110107055952201\"\n}\n\nWhen the Taku SDK retrieves the backend strategy, it will convert this JSON string into a Map and pass it to loadCustomNetworkAd(Context context, Map).\n\u2022 When the developer calls the Taku SDK's isAdReady API, it will call the custom Adapter's isAdReady() method.\n\u2022 When the developer calls the Taku SDK's show API, it will call the custom Adapter's isAdReady() and show(Activity activity) methods.\n3.2 Notes\n\u2022 When adding a custom ad platform in the Taku dashboard, the Adapter class name must be configured with the full path class name (package name + class name), otherwise the Adapter class will not be created correctly when loading ads.\n\u2022 Since the SDK internally creates the Adapter class through reflection, when building a release package, you must ensure that the Adapter class is not obfuscated. An example of the obfuscation rule is as follows:\n# Replace with the developer's own Adapter class name. \n-keep class { *;} \n-keepclassmembers public class { \n public *; \n}\n\n\u2022 For any issues encountered, refer to How to Test Ads for solutions.","is_draft":"0","editor_type":"2","file_path":"","add_time":"1783421033","update_time":"1783477705"},"pure_content":"For a detailed example of implementing a custom Adapter, refer to: Taku Demo\n1. Class Descriptions for Implementing Each Ad Format\nDevelopers need to inherit the class corresponding to the required ad"},{"id":"862984","string_id":"e1xv4Vsf","status":"1","parent_id":"862983","slug":"e1xv4Vsf","order":"6","name":"Banner Ad","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"Welch","published_time":"1783477705","add_time":"1783421033","update_time":"1783477705","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"862984","content":"1. Banner Ad Abstract Method Implementation and Ad Event Callbacks\n--------------------\n\n### 1.1 Additional Abstract Methods Required for Banner Ad\n\n| Abstract Method | Parameter Description | Return Value | Purpose | Required |\n|---|---|---|---|---|\n| getBannerView | - | View | Needs to return the BannerView object that has already been loaded successfully. | Yes |\n\n### 1.2 Banner Ad Event Callbacks\n\n**Use the CustomBannerEventListener member variable of CustomBannerAdapter to implement ad event callbacks.**\n\n| Callback Method | Parameter Description | Description |\n|---|---|---|\n| onBannerAdClicked | - | Callback to the developer when the ad is clicked. |\n| onBannerAdShow | - | Callback to the developer when the ad is displayed. |\n| onBannerAdClose | - | Callback to the developer when the ad is closed. |\n\n**Note: When using the member variable CustomBannerEventListener, null-check handling is required, because the Mediation SDK may internally reclaim this Listener object.**\n\n### 1.3 Sample Code\n\n```java\npublic class FacebookBannerAdapter extends CustomBannerAdapter {\n\n private String unitid = \"\";\n AdView mBannerView;\n String size = \"\";\n\n @Override\n public void loadCustomNetworkAd(final Context activity, Map serverExtras, Map localExtras) {\n\n if (serverExtras.containsKey(\"unit_id\")) {\n unitid = (String) serverExtras.get(\"unit_id\");\n\n } else {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"facebook unitid is empty.\");\n }\n return;\n }\n\n FacebookInitManager.getInstance().initSDK(activity.getApplicationContext(), serverExtras);\n\n if (serverExtras.containsKey(\"size\")) {\n size = serverExtras.get(\"size\").toString();\n }\n\n final AdListener adListener = new AdListener() {\n @Override\n public void onAdLoaded(Ad ad) {\n mBannerView = (AdView) ad;\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded();\n\n }\n }\n\n @Override\n public void onError(Ad ad, AdError adError) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(adError.getErrorCode() + \"\", adError.getErrorMessage());\n }\n }\n\n @Override\n public void onAdClicked(Ad ad) {\n if (mImpressionEventListener != null) {\n mImpressionEventListener.onBannerAdClicked();\n }\n }\n\n @Override\n public void onLoggingImpression(Ad ad) {\n if (mImpressionEventListener != null) {\n mImpressionEventListener.onBannerAdShow();\n }\n }\n };\n\n AdView adView = null;\n switch (size) {\n case \"320x50\":\n adView = new AdView(activity, unitid, AdSize.BANNER_HEIGHT_50);\n break;\n case \"320x90\":\n adView = new AdView(activity, unitid, AdSize.BANNER_HEIGHT_90);\n break;\n case \"300x250\":\n adView = new AdView(activity, unitid, AdSize.RECTANGLE_HEIGHT_250);\n break;\n default:\n adView = new AdView(activity, unitid, AdSize.BANNER_HEIGHT_50);\n break;\n }\n adView.loadAd(adView.buildLoadAdConfig().withAdListener(adListener).build());\n }\n\n @Override\n public View getBannerView() {\n return mBannerView;\n }\n\n @Override\n public void destory() {\n if (mBannerView != null) {\n mBannerView.destroy();\n mBannerView = null;\n }\n }\n\n @Override\n public String getNetworkSDKVersion() {\n return FacebookInitManager.getInstance().getNetworkVersion();\n }\n\n @Override\n public String getNetworkName() {\n return FacebookInitManager.getInstance().getNetworkName();\n }\n\n @Override\n public boolean setUserDataConsent(Context context, boolean isConsent, boolean isEUTraffic) {\n return false;\n }\n\n @Override\n public String getNetworkPlacementId() {\n return unitid;\n }\n}\n```","pure_content":"Banner Ad Abstract Method Implementation and Ad Event Callbacks\n\n\n1.1 Additional Abstract Methods Required for Banner Ad\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Required\n\n\n\n\n getBannerView\n -\n View\n Needs to return the BannerView object that has already been loaded successfully.\n Yes\n\n\n\n1.2 Banner Ad Event Callbacks\nUse the CustomBannerEventListener member variable of CustomBannerAdapter to implement ad event callbacks.\n\n\n\n Callback Method\n Parameter Description\n Description\n\n\n\n\n onBannerAdClicked\n -\n Callback to the developer when the ad is clicked.\n\n\n onBannerAdShow\n -\n Callback to the developer when the ad is displayed.\n\n\n onBannerAdClose\n -\n Callback to the developer when the ad is closed.\n\n\n\nNote: When using the member variable CustomBannerEventListener, null-check handling is required, because the Mediation SDK may internally reclaim this Listener object.\n1.3 Sample Code\npublic class FacebookBannerAdapter extends CustomBannerAdapter {\n\n private String unitid = \"\";\n AdView mBannerView;\n String size = \"\";\n\n @Override\n public void loadCustomNetworkAd(final Context activity, Map serverExtras, Map localExtras) {\n\n if (serverExtras.containsKey(\"unit_id\")) {\n unitid = (String) serverExtras.get(\"unit_id\");\n\n } else {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"facebook unitid is empty.\");\n }\n return;\n }\n\n FacebookInitManager.getInstance().initSDK(activity.getApplicationContext(), serverExtras);\n\n if (serverExtras.containsKey(\"size\")) {\n size = serverExtras.get(\"size\").toString();\n }\n\n final AdListener adListener = new AdListener() {\n @Override\n public void onAdLoaded(Ad ad) {\n mBannerView = (AdView) ad;\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded();\n\n }\n }\n\n @Override\n public void onError(Ad ad, AdError adError) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(adError.getErrorCode() + \"\", adError.getErrorMessage());\n }\n }\n\n @Override\n public void onAdClicked(Ad ad) {\n if (mImpressionEventListener != null) {\n mImpressionEventListener.onBannerAdClicked();\n }\n }\n\n @Override\n public void onLoggingImpression(Ad ad) {\n if (mImpressionEventListener != null) {\n mImpressionEventListener.onBannerAdShow();\n }\n }\n };\n\n AdView adView = null;\n switch (size) {\n case \"320x50\":\n adView = new AdView(activity, unitid, AdSize.BANNER_HEIGHT_50);\n break;\n case \"320x90\":\n adView = new AdView(activity, unitid, AdSize.BANNER_HEIGHT_90);\n break;\n case \"300x250\":\n adView = new AdView(activity, unitid, AdSize.RECTANGLE_HEIGHT_250);\n break;\n default:\n adView = new AdView(activity, unitid, AdSize.BANNER_HEIGHT_50);\n break;\n }\n adView.loadAd(adView.buildLoadAdConfig().withAdListener(adListener).build());\n }\n\n @Override\n public View getBannerView() {\n return mBannerView;\n }\n\n @Override\n public void destory() {\n if (mBannerView != null) {\n mBannerView.destroy();\n mBannerView = null;\n }\n }\n\n @Override\n public String getNetworkSDKVersion() {\n return FacebookInitManager.getInstance().getNetworkVersion();\n }\n\n @Override\n public String getNetworkName() {\n return FacebookInitManager.getInstance().getNetworkName();\n }\n\n @Override\n public boolean setUserDataConsent(Context context, boolean isConsent, boolean isEUTraffic) {\n return false;\n }\n\n @Override\n public String getNetworkPlacementId() {\n return unitid;\n }\n}","is_draft":"0","editor_type":"2","file_path":"","add_time":"1783421033","update_time":"1783477705"},"pure_content":"Banner Ad Abstract Method Implementation and Ad Event Callbacks\n\n\n1.1 Additional Abstract Methods Required for Banner Ad\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Required"},{"id":"862986","string_id":"PkqSEavK","status":"1","parent_id":"862983","slug":"PkqSEavK","order":"5","name":"Custom Client Bidding Ad","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"Welch","published_time":"1783477705","add_time":"1783421034","update_time":"1783477705","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"862986","content":"This document mainly describes how to integrate Client Bidding with a custom Adapter. For more custom Adapter implementations, please refer to this document: [Custom Adapter](\/docs\/4jQy7C).\n\nThe Client Bidding loading flow is shown below:\n\n![Article Image](https:\/\/resource.helplook.net\/docker_production\/5expvy\/article\/YMKymM\/65e842759dc7f.png)\n\n**1.** Inherit the Custom Adapter Class\n----------------\n\n- Taking Interstitial Ad as an example, developers need to inherit CustomInterstitialAdapter to implement the Client Bidding feature.\n\n### 1.1 Sample Code\n\n```java\npublic class CustomSDKInterstitialAdapter extends CustomInterstitialAdapter { \n ...\n}\n```\n\n**2.** Initiate Bidding\n-------\n\n- When the developer calls the load() API of ATInterstitialAd, the custom Adapter's startBiddingRequest() method will be called.\n- Developers need to override startBiddingRequest(). In this method, call the custom ad platform's API to initiate ad bidding.\n\n### 2.1 API Description\n\n| Abstract Method | Parameter Description | Return Value | Purpose | Description |\n|---|---|---|---|---|\n| startBiddingRequest | Context applicationContext: Context Map | boolean | Initiate a Client Bidding request and return the bidding result through biddingListener. | In this method, initiate the header bidding request and notify the Taku SDK of the bidding result through **biddingListener's onC2SBiddingResultWithCache(ATBiddingResult bidResult,BaseAd baseAd)** method. **Note: This method must return true.** |\n\n### 2.2 Sample Code\n\n```java\n\n\/\/ Custom ad platform's ad placement ID\nString placementId;\n\n@Override\npublic boolean startBiddingRequest(final Context context, Map serverExtra, Map localExtra, final ATBiddingListener biddingListener) {\n\n \/\/ Get the custom platform's ad placement ID configured in the dashboard from serverExtra.\n placementId = (String) serverExtra.get(\"unit_id\");\n\n CustomSDKInitManager.getInstance().initSDK(context, serverExtra, new MediationInitCallback() {\n @Override\n public void onSuccess() {\n\n \/\/ Initiate bidding request after the ad platform Initialization succeeds.\n startBid(context, biddingListener);\n\n }\n\n @Override\n public void onFail(String errorMsg) {\n\n \/\/ Callback bidding failure through ATBiddingListener.\n if (biddingListener != null) {\n \tbiddingListener.onC2SBiddingResultWithCache(ATBiddingResult.fail(errorMsg), null);\n }\n }\n });\n\n \/\/ Must return true.\n return true;\n} \n```\n\n**3.** Notify Taku SDK of the Bidding Result\n-----------------\n\n- Ad load success: Call the ad platform's API to obtain the returned price, currency unit, etc., and call the onC2SBiddingResultWithCache() method through ATBiddingListener to notify the Taku SDK that the bidding was successful.\n- Ad load failure: Call the onC2SBiddingResultWithCache() method through ATBiddingListener to notify the Taku SDK of the bidding failure error info.\n\n### 3.1 API Description\n\n**ATBiddingListener Bidding Result Callback Description**\n\n| Callback Method | Parameter Description | Description |\n|---|---|---|\n| onC2SBiddingResultWithCache | (ATBiddingResult biddingResult, BaseAd baseAd) | Return the bidding result to Taku after the ad bidding ends. biddingResult: Bidding success or failure. See the ATBiddingResult description below. baseAd: On bidding success, **Native Ads** need to return CustomNativeAd to provide creative info (please refer to Native Ad instructions for returning this object). Other ad formats can return null. On bidding failure, return null. |\n\n**ATBiddingResult Bidding Result Method Description**\n\n| Method | Parameter Description | Return Value | Purpose |\n|---|---|---|---|\n| success | double price: The bid price for this time String cacheId: The cache ID of this bidding ad ATBiddingNotice biddingNotice: Ad bidding related event management class. **Can be passed as null.** For details, refer to the appendix section of this document. **ATAdConst.CURRENCY currency**: Price currency unit. Supports RMB (CNY), RMB\\_CENT (CNY cents), USD (US dollars). | ATBiddingResult | Return a bidding success result and pass the bidding related information to Taku. |\n| success | double sortPrice: The sorting price for this ad. Other parameters have the same meaning as above. | ATBiddingResult | Same purpose as above. **Note**: sortPrice affects the ranking of this ad within Taku's internal WaterFall. The larger the sortPrice, the more likely this ad will be prioritized. If there is no special need, please use the above method. |\n| fail | String errorMsg: Bidding failure description. | ATBiddingResult | Return a bidding failure result and notify Taku that this Ad Source has failed to bid. |\n\n### 3.2 Sample Code\n\n```java\n...\n\nCustomInterstitialAd customInterstitialAd;\n\nprivate void startBid(Context context, final ATBiddingListener biddingListener) {\n\t\n\tcustomInterstitialAd = new CustomInterstitialAd(placementId);\n\n\tcustomInterstitialAd.load(placementId, new CustomAdLoadListener() {\n \t\n \t@Override\n \tpublic void onLoadSuccess() {\n \t\t\/\/ Get price\n \t\tdouble bidPrice = customInterstitialAd.getBidPrice();\n \t\t\n \t\t\/\/ Get currency unit\n \t\tATAdConst.CURRENCY currency = ATAdConst.CURRENCY.USD;\n \t\tif (customInterstitialAd.getCurrency() == \"RMB\") {\n \t\t\tcurrency = ATAdConst.CURRENCY.RMB;\n \t\t}\n \t\t\n \t\t\/\/ A unique ID used to identify this bidding. UUID or timestamp can be used.\n \t\tString token = UUID.randomUUID().toString();\n \t\t\n \t\t\/\/ Ad bidding related event management class. Can be passed as null.\n \t\tATBiddingNotice biddingNotice = new CustomSDKBiddingNotice(customInterstitialAd);\n \t\t\n \t\t\/\/ Native Ads need to return BaseAd. Other ad formats can pass null.\n \t\tBaseAd basead = null;\n \t\t\n \t\t\/\/ Notify Taku SDK of the bidding result.\n \t\tif (biddingListener != null) {\n \tbiddingListener.onC2SBiddingResultWithCache(\n ATBiddingResult.success(bidPrice, token, biddingNotice, currency), basead\n );\n }\n\t\n \t}\n \t\t\n \t@Override\n \tpublic void onLoadFailed(String errorMsg) {\n \t\t\/\/ Notify Taku SDK of the bidding result.\n if (biddingListener != null) {\n \tbiddingListener.onC2SBiddingResultWithCache(ATBiddingResult.fail(errorMsg), null);\n }\n \t}\n \t\n });\n \n}\n```\n\n**4.** Check Whether the Ad is Ready\n------------\n\n- When the developer calls the isAdReady() API of ATInterstitialAd, the custom Adapter's isAdReady() method will be called.\n- Developers need to override the isAdReady() method. In this method, call the custom ad platform's API to return the ad's status.\n\n### 4.1 API Description\n\n| Abstract Method | Parameter Description | Return Value | Purpose | Description |\n|---|---|---|---|---|\n| isAdReady | - | boolean | Used to determine whether the custom ad platform's Interstitial Ad is in a ready state. | Used to determine whether the ad is in a ready state. |\n\n### 4.2 Sample Code\n\n```java\n...\nCustomInterstitialAd customInterstitialAd;\n\n@Override\npublic boolean isAdReady() {\n if (customInterstitialAd != null) {\n return customInterstitialAd.isReady();\n }\n return false;\n}\n```\n\n**5.** Display the Ad\n-------\n\n- When the developer calls the show() API of ATInterstitialAd, the custom Adapter's isAdReady() and show() methods will be called in sequence.\n- Developers need to override the show() method. In this method, call the custom ad platform's API to display the custom ad. Notify the Taku SDK of ad impression, click, close, and other events through CustomInterstitialEventListener.\n\n### 5.1 API Description\n\n| Abstract Method | Parameter Description | Return Value | Purpose | Description |\n|---|---|---|---|---|\n| show | Depends on the ad format. | void | Implement the logic for displaying the custom ad platform's ad. | Implement the ad display logic. |\n\n### 5.2 Sample Code\n\n```java\n...\nCustomInterstitialAd customInterstitialAd;\n\n@Override\npublic void show(Activity activity) {\n if (customInterstitialAd != null) {\n \n customInterstitialAd.setEventListener(new CustomAdEventListener() {\n @Override\n public void onAdImpression() {\n \/\/ Notify Taku SDK that the ad impression was successful.\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdShow();\n }\n }\n \n @Override\n public void onADClicked() {\n \/\/ Notify Taku SDK that the ad was clicked.\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdClicked();\n }\n }\n \n @Override\n public void onADClicked() {\n \/\/ Notify Taku SDK that the ad was closed.\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdClose();\n }\n }\n \n });\n \n \/\/ Trigger ad display.\n customInterstitialAd.show(activity);\n }\n}\n```\n\nAppendix: Implement ATBiddingNotice to Notify the Custom Platform of Bidding Results\n-------------------------------\n\nBy implementing the ATBiddingNotice interface and overriding the relevant methods, you can notify the custom ad platform of bid win or bid loss events.\n\n### 1. Implement ATBiddingNotice\n\n- Taking Interstitial Ad as an example, developers can choose to implement the ATBiddingNotice interface to notify the custom ad platform of bidding result events (the specific sending timing is determined by the Taku SDK).\n\n#### 1.1 Sample Code\n\n```\npublic class CustomSDKBiddingNotice implements ATBiddingNotice {\n\n\t\/\/ Custom ad platform's ad object\n\tCustomInterstitialAd customInterstitialAd;\n\n protected GDTATBiddingNotice(CustomInterstitialAd customInterstitialAd) {\n this.customInterstitialAd = customInterstitialAd;\n }\n\n}\n```\n\n### 2. Notify Bid Win\n\n- When this platform's ad is the highest priced in this load, the notifyBidWin() method is triggered.\n- Developers need to override the `notifyBidWin()` method. In this method, call the custom ad platform's API to notify the ad platform that the bid has won.\n\n#### 2.1 API Description\n\n| Abstract Method | Parameter Description | Return Value | Purpose | Required | Description |\n|---|---|---|---|---|---|\n| notifyBidWin | double costPrice: The winning bid price double secondPrice: The price of the first losing bidder Map Map | void | Implement notification to the custom ad platform that the ad bid has won. | Yes | This method is triggered when this ad's bidding succeeds. **costPrice parameter**: The winning party's price. **secondPrice parameter**: The price of the party ranked after the winning party (second price). **Note**: The currency unit of the price is the ATAdConst.CURRENCY passed by the developer when calling the ATBiddingResult.success() method. |\n\n#### 2.2 Sample Code\n\n```java\n@Override\npublic void notifyBidWin(double costPrice, double secondPrice, Map extra) {\n \n Map map = new HashMap<>();\n\n map.put(CustomSDK.COST_PRICE, costPrice);\n map.put(CustomSDK.HIGHEST_LOSS_PRICE, secondPrice);\n\n \/\/ Notify bid win.\n customInterstitialAd.sendWinNotification(map);\n\n customInterstitialAd = null;\n}\n```\n\n### 3. Notify Bid Loss\n\n- When this platform's ad is considered to have lost the bid by Taku due to reasons such as cache expiration, the notifyBidLoss() method is triggered.\n- Developers need to override the `notifyBidLoss()` method. In this method, call the custom ad platform's API to notify the ad platform that the bid has lost.\n\n#### 3.1 API Description\n\n| Abstract Method | Parameter Description | Return Value | Purpose | Required | Description |\n|---|---|---|---|---|---|\n| notifyBidLoss | String lossCode: Bid loss code double winPrice: The winning bid price Map Map | void | Implement notification to the custom ad platform that the ad bid has lost. | Yes | This method is triggered when this ad's bidding fails. **lossCode parameter**: Failure reason. Refer to the ATAdConst.BIDDING\\_TYPE class. See the description below. **extra parameter**: You can use Key: ATBiddingNotice.ADN\\_ID to obtain the winning channel from extra. For the enumeration value of the winning channel, refer to the ATAdConst.BIDDING\\_ADN\\_ID class. See the description below. **Note**: The currency unit of the price is the ATAdConst.CURRENCY passed by the developer when calling the ATBiddingResult.success() method. |\n\n**ATAdConst.BIDDING\\_TYPE**: Bid Loss Reasons\n\n| Enum | Description |\n|---|---|\n| BIDDING\\_LOSS\\_WITH\\_LOW\\_PRICE\\_IN\\_NORMAL | Price is lower than regular non-bidding ads. |\n| BIDDING\\_LOSS\\_WITH\\_LOW\\_PRICE\\_IN\\_HB | Price is lower than other bidding ads. |\n| BIDDING\\_LOSS\\_WITH\\_BIDDING\\_TIMEOUT | Bidding timed out, e.g., no bidding result was notified to Taku SDK for a long time. |\n| BIDDING\\_LOSS\\_WITH\\_EXPIRE | Ad cache expired. |\n\n**ATAdConst.BIDDING\\_ADN\\_ID**: Winning Channel\n\n| Enum | Description |\n|---|---|\n| LOSE\\_TO\\_NORMAL\\_IN\\_SAME\\_ADN | Lost to a regular non-bidding ad from the same ad platform. |\n| LOSE\\_TO\\_HB\\_IN\\_SAME\\_ADN | Lost to a bidding ad from the same ad platform. |\n| LOSE\\_TO\\_OWN\\_ADN | Lost to an owned ad (Direct Ad, Cross-Promotion). |\n| LOSE\\_TO\\_OTHER\\_ADN | Lost to another ad platform. |\n\n#### 3.2 Sample Code\n\n```java\n@Override\npublic void notifyBidLoss(String lossCode, double winPrice, Map extra) {\n \n \/\/ Determine the bid loss reason.\n int lossReason = CustomSDKLossReason.OTHER;\n switch (lossCode) {\n case ATAdConst.BIDDING_TYPE.BIDDING_LOSS_WITH_BIDDING_TIMEOUT:\n lossReason = CustomSDKLossReason.NO_AD;\n break;\n case ATAdConst.BIDDING_TYPE.BIDDING_LOSS_WITH_LOW_PRICE_IN_HB:\n case ATAdConst.BIDDING_TYPE.BIDDING_LOSS_WITH_LOW_PRICE_IN_NORMAL:\n lossReason = CustomSDKLossReason.LOW_PRICE;\n break;\n }\n\n\n \/\/ Determine the winning channel.\n int adnId = ATInitMediation.getIntFromMap(extra, ATBiddingNotice.ADN_ID, -1);\n switch (adnId) {\n case ATAdConst.BIDDING_ADN_ID.LOSE_TO_NORMAL_IN_SAME_ADN:\n adnId = CustomSDKADNID.NORMAL;\n break;\n case ATAdConst.BIDDING_ADN_ID.LOSE_TO_HB_IN_SAME_ADN:\n adnId = CustomSDKADNID.HB;\n break;\n case ATAdConst.BIDDING_ADN_ID.LOSE_TO_OWN_ADN:\n adnId = CustomSDKADNID.OWN_AD;\n break;\n case ATAdConst.BIDDING_ADN_ID.LOSE_TO_OTHER_ADN:\n adnId = CustomSDKADNID.OTHER;\n break;\n }\n\n\n Map map = new HashMap<>();\n\n map.put(CustomSDK.WIN_PRICE, winPrice);\n map.put(CustomSDK.LOSS_REASON, lossReason);\n map.put(CustomSDK.ADN_ID, adnId);\n\n \/\/ Notify bid loss.\n customInterstitialAd.sendLossNotification(map);\n\n customInterstitialAd = null;\n}\n```\n\n### 4. Other API Description\n\n| Abstract Method | Parameter Description | Return Value | Purpose | Required | Description |\n|---|---|---|---|---|---|\n| notifyBidDisplay | boolean isWinner: Whether it is the winning party double displayPrice: The price of the ad currently being impressed. | void | Implement notification to the custom ad platform's ad that an ad is currently being impressed. | Yes | This method is triggered when an ad impression occurs. **isWinner parameter**: Whether the ad currently being impressed is the winning party. **displayPrice**: The price of the ad currently being impressed. **Note**: The currency unit of the price is the ATAdConst.CURRENCY passed by the developer when calling the ATBiddingResult.success() method. |","pure_content":"This document mainly describes how to integrate Client Bidding with a custom Adapter. For more custom Adapter implementations, please refer to this document: Custom Adapter.\nThe Client Bidding loading flow is shown below:\n\n1. Inherit the Custom Adapter Class\n\nTaking Interstitial Ad as an example, developers need to inherit CustomInterstitialAdapter to implement the Client Bidding feature.\n\n1.1 Sample Code\npublic class CustomSDKInterstitialAdapter extends CustomInterstitialAdapter { \n ...\n}\n\n2. Initiate Bidding\n\nWhen the developer calls the load() API of ATInterstitialAd, the custom Adapter's startBiddingRequest() method will be called.\nDevelopers need to override startBiddingRequest(). In this method, call the custom ad platform's API to initiate ad bidding.\n\n2.1 API Description\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Description\n\n\n\n\n startBiddingRequest\n Context applicationContext: Context Map\n boolean\n Initiate a Client Bidding request and return the bidding result through biddingListener.\n In this method, initiate the header bidding request and notify the Taku SDK of the bidding result through biddingListener's onC2SBiddingResultWithCache(ATBiddingResult bidResult,BaseAd baseAd) method. Note: This method must return true.\n\n\n\n2.2 Sample Code\n\n\/\/ Custom ad platform's ad placement ID\nString placementId;\n\n@Override\npublic boolean startBiddingRequest(final Context context, Map serverExtra, Map localExtra, final ATBiddingListener biddingListener) {\n\n \/\/ Get the custom platform's ad placement ID configured in the dashboard from serverExtra.\n placementId = (String) serverExtra.get(\"unit_id\");\n\n CustomSDKInitManager.getInstance().initSDK(context, serverExtra, new MediationInitCallback() {\n @Override\n public void onSuccess() {\n\n \/\/ Initiate bidding request after the ad platform Initialization succeeds.\n startBid(context, biddingListener);\n\n }\n\n @Override\n public void onFail(String errorMsg) {\n\n \/\/ Callback bidding failure through ATBiddingListener.\n if (biddingListener != null) {\n \tbiddingListener.onC2SBiddingResultWithCache(ATBiddingResult.fail(errorMsg), null);\n }\n }\n });\n\n \/\/ Must return true.\n return true;\n} \n\n3. Notify Taku SDK of the Bidding Result\n\nAd load success: Call the ad platform's API to obtain the returned price, currency unit, etc., and call the onC2SBiddingResultWithCache() method through ATBiddingListener to notify the Taku SDK that the bidding was successful.\nAd load failure: Call the onC2SBiddingResultWithCache() method through ATBiddingListener to notify the Taku SDK of the bidding failure error info.\n\n3.1 API Description\nATBiddingListener Bidding Result Callback Description\n\n\n\n Callback Method\n Parameter Description\n Description\n\n\n\n\n onC2SBiddingResultWithCache\n (ATBiddingResult biddingResult, BaseAd baseAd)\n Return the bidding result to Taku after the ad bidding ends. biddingResult: Bidding success or failure. See the ATBiddingResult description below. baseAd: On bidding success, Native Ads need to return CustomNativeAd to provide creative info (please refer to Native Ad instructions for returning this object). Other ad formats can return null. On bidding failure, return null.\n\n\n\nATBiddingResult Bidding Result Method Description\n\n\n\n Method\n Parameter Description\n Return Value\n Purpose\n\n\n\n\n success\n double price: The bid price for this time String cacheId: The cache ID of this bidding ad ATBiddingNotice biddingNotice: Ad bidding related event management class. Can be passed as null. For details, refer to the appendix section of this document. ATAdConst.CURRENCY currency: Price currency unit. Supports RMB (CNY), RMB_CENT (CNY cents), USD (US dollars).\n ATBiddingResult\n Return a bidding success result and pass the bidding related information to Taku.\n\n\n success\n double sortPrice: The sorting price for this ad. Other parameters have the same meaning as above.\n ATBiddingResult\n Same purpose as above. Note: sortPrice affects the ranking of this ad within Taku's internal WaterFall. The larger the sortPrice, the more likely this ad will be prioritized. If there is no special need, please use the above method.\n\n\n fail\n String errorMsg: Bidding failure description.\n ATBiddingResult\n Return a bidding failure result and notify Taku that this Ad Source has failed to bid.\n\n\n\n3.2 Sample Code\n...\n\nCustomInterstitialAd customInterstitialAd;\n\nprivate void startBid(Context context, final ATBiddingListener biddingListener) {\n\t\n\tcustomInterstitialAd = new CustomInterstitialAd(placementId);\n\n\tcustomInterstitialAd.load(placementId, new CustomAdLoadListener() {\n \t\n \t@Override\n \tpublic void onLoadSuccess() {\n \t\t\/\/ Get price\n \t\tdouble bidPrice = customInterstitialAd.getBidPrice();\n \t\t\n \t\t\/\/ Get currency unit\n \t\tATAdConst.CURRENCY currency = ATAdConst.CURRENCY.USD;\n \t\tif (customInterstitialAd.getCurrency() == \"RMB\") {\n \t\t\tcurrency = ATAdConst.CURRENCY.RMB;\n \t\t}\n \t\t\n \t\t\/\/ A unique ID used to identify this bidding. UUID or timestamp can be used.\n \t\tString token = UUID.randomUUID().toString();\n \t\t\n \t\t\/\/ Ad bidding related event management class. Can be passed as null.\n \t\tATBiddingNotice biddingNotice = new CustomSDKBiddingNotice(customInterstitialAd);\n \t\t\n \t\t\/\/ Native Ads need to return BaseAd. Other ad formats can pass null.\n \t\tBaseAd basead = null;\n \t\t\n \t\t\/\/ Notify Taku SDK of the bidding result.\n \t\tif (biddingListener != null) {\n \tbiddingListener.onC2SBiddingResultWithCache(\n ATBiddingResult.success(bidPrice, token, biddingNotice, currency), basead\n );\n }\n\t\n \t}\n \t\t\n \t@Override\n \tpublic void onLoadFailed(String errorMsg) {\n \t\t\/\/ Notify Taku SDK of the bidding result.\n if (biddingListener != null) {\n \tbiddingListener.onC2SBiddingResultWithCache(ATBiddingResult.fail(errorMsg), null);\n }\n \t}\n \t\n });\n \n}\n\n4. Check Whether the Ad is Ready\n\nWhen the developer calls the isAdReady() API of ATInterstitialAd, the custom Adapter's isAdReady() method will be called.\nDevelopers need to override the isAdReady() method. In this method, call the custom ad platform's API to return the ad's status.\n\n4.1 API Description\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Description\n\n\n\n\n isAdReady\n -\n boolean\n Used to determine whether the custom ad platform's Interstitial Ad is in a ready state.\n Used to determine whether the ad is in a ready state.\n\n\n\n4.2 Sample Code\n...\nCustomInterstitialAd customInterstitialAd;\n\n@Override\npublic boolean isAdReady() {\n if (customInterstitialAd != null) {\n return customInterstitialAd.isReady();\n }\n return false;\n}\n\n5. Display the Ad\n\nWhen the developer calls the show() API of ATInterstitialAd, the custom Adapter's isAdReady() and show() methods will be called in sequence.\nDevelopers need to override the show() method. In this method, call the custom ad platform's API to display the custom ad. Notify the Taku SDK of ad impression, click, close, and other events through CustomInterstitialEventListener.\n\n5.1 API Description\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Description\n\n\n\n\n show\n Depends on the ad format.\n void\n Implement the logic for displaying the custom ad platform's ad.\n Implement the ad display logic.\n\n\n\n5.2 Sample Code\n...\nCustomInterstitialAd customInterstitialAd;\n\n@Override\npublic void show(Activity activity) {\n if (customInterstitialAd != null) {\n \n customInterstitialAd.setEventListener(new CustomAdEventListener() {\n @Override\n public void onAdImpression() {\n \/\/ Notify Taku SDK that the ad impression was successful.\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdShow();\n }\n }\n \n @Override\n public void onADClicked() {\n \/\/ Notify Taku SDK that the ad was clicked.\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdClicked();\n }\n }\n \n @Override\n public void onADClicked() {\n \/\/ Notify Taku SDK that the ad was closed.\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdClose();\n }\n }\n \n });\n \n \/\/ Trigger ad display.\n customInterstitialAd.show(activity);\n }\n}\n\nAppendix: Implement ATBiddingNotice to Notify the Custom Platform of Bidding Results\nBy implementing the ATBiddingNotice interface and overriding the relevant methods, you can notify the custom ad platform of bid win or bid loss events.\n1. Implement ATBiddingNotice\n\nTaking Interstitial Ad as an example, developers can choose to implement the ATBiddingNotice interface to notify the custom ad platform of bidding result events (the specific sending timing is determined by the Taku SDK).\n\n1.1 Sample Code\npublic class CustomSDKBiddingNotice implements ATBiddingNotice {\n\n\t\/\/ Custom ad platform's ad object\n\tCustomInterstitialAd customInterstitialAd;\n\n protected GDTATBiddingNotice(CustomInterstitialAd customInterstitialAd) {\n this.customInterstitialAd = customInterstitialAd;\n }\n\n}\n\n2. Notify Bid Win\n\nWhen this platform's ad is the highest priced in this load, the notifyBidWin() method is triggered.\nDevelopers need to override the notifyBidWin() method. In this method, call the custom ad platform's API to notify the ad platform that the bid has won.\n\n2.1 API Description\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Required\n Description\n\n\n\n\n notifyBidWin\n double costPrice: The winning bid price double secondPrice: The price of the first losing bidder Map Map\n void\n Implement notification to the custom ad platform that the ad bid has won.\n Yes\n This method is triggered when this ad's bidding succeeds. costPrice parameter: The winning party's price. secondPrice parameter: The price of the party ranked after the winning party (second price). Note: The currency unit of the price is the ATAdConst.CURRENCY passed by the developer when calling the ATBiddingResult.success() method.\n\n\n\n2.2 Sample Code\n@Override\npublic void notifyBidWin(double costPrice, double secondPrice, Map extra) {\n \n Map map = new HashMap();\n\n map.put(CustomSDK.COST_PRICE, costPrice);\n map.put(CustomSDK.HIGHEST_LOSS_PRICE, secondPrice);\n\n \/\/ Notify bid win.\n customInterstitialAd.sendWinNotification(map);\n\n customInterstitialAd = null;\n}\n\n3. Notify Bid Loss\n\nWhen this platform's ad is considered to have lost the bid by Taku due to reasons such as cache expiration, the notifyBidLoss() method is triggered.\nDevelopers need to override the notifyBidLoss() method. In this method, call the custom ad platform's API to notify the ad platform that the bid has lost.\n\n3.1 API Description\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Required\n Description\n\n\n\n\n notifyBidLoss\n String lossCode: Bid loss code double winPrice: The winning bid price Map Map\n void\n Implement notification to the custom ad platform that the ad bid has lost.\n Yes\n This method is triggered when this ad's bidding fails. lossCode parameter: Failure reason. Refer to the ATAdConst.BIDDING_TYPE class. See the description below. extra parameter: You can use Key: ATBiddingNotice.ADN_ID to obtain the winning channel from extra. For the enumeration value of the winning channel, refer to the ATAdConst.BIDDING_ADN_ID class. See the description below. Note: The currency unit of the price is the ATAdConst.CURRENCY passed by the developer when calling the ATBiddingResult.success() method.\n\n\n\nATAdConst.BIDDING_TYPE: Bid Loss Reasons\n\n\n\n Enum\n Description\n\n\n\n\n BIDDING_LOSS_WITH_LOW_PRICE_IN_NORMAL\n Price is lower than regular non-bidding ads.\n\n\n BIDDING_LOSS_WITH_LOW_PRICE_IN_HB\n Price is lower than other bidding ads.\n\n\n BIDDING_LOSS_WITH_BIDDING_TIMEOUT\n Bidding timed out, e.g., no bidding result was notified to Taku SDK for a long time.\n\n\n BIDDING_LOSS_WITH_EXPIRE\n Ad cache expired.\n\n\n\nATAdConst.BIDDING_ADN_ID: Winning Channel\n\n\n\n Enum\n Description\n\n\n\n\n LOSE_TO_NORMAL_IN_SAME_ADN\n Lost to a regular non-bidding ad from the same ad platform.\n\n\n LOSE_TO_HB_IN_SAME_ADN\n Lost to a bidding ad from the same ad platform.\n\n\n LOSE_TO_OWN_ADN\n Lost to an owned ad (Direct Ad, Cross-Promotion).\n\n\n LOSE_TO_OTHER_ADN\n Lost to another ad platform.\n\n\n\n3.2 Sample Code\n@Override\npublic void notifyBidLoss(String lossCode, double winPrice, Map extra) {\n \n \/\/ Determine the bid loss reason.\n int lossReason = CustomSDKLossReason.OTHER;\n switch (lossCode) {\n case ATAdConst.BIDDING_TYPE.BIDDING_LOSS_WITH_BIDDING_TIMEOUT:\n lossReason = CustomSDKLossReason.NO_AD;\n break;\n case ATAdConst.BIDDING_TYPE.BIDDING_LOSS_WITH_LOW_PRICE_IN_HB:\n case ATAdConst.BIDDING_TYPE.BIDDING_LOSS_WITH_LOW_PRICE_IN_NORMAL:\n lossReason = CustomSDKLossReason.LOW_PRICE;\n break;\n }\n\n\n \/\/ Determine the winning channel.\n int adnId = ATInitMediation.getIntFromMap(extra, ATBiddingNotice.ADN_ID, -1);\n switch (adnId) {\n case ATAdConst.BIDDING_ADN_ID.LOSE_TO_NORMAL_IN_SAME_ADN:\n adnId = CustomSDKADNID.NORMAL;\n break;\n case ATAdConst.BIDDING_ADN_ID.LOSE_TO_HB_IN_SAME_ADN:\n adnId = CustomSDKADNID.HB;\n break;\n case ATAdConst.BIDDING_ADN_ID.LOSE_TO_OWN_ADN:\n adnId = CustomSDKADNID.OWN_AD;\n break;\n case ATAdConst.BIDDING_ADN_ID.LOSE_TO_OTHER_ADN:\n adnId = CustomSDKADNID.OTHER;\n break;\n }\n\n\n Map map = new HashMap();\n\n map.put(CustomSDK.WIN_PRICE, winPrice);\n map.put(CustomSDK.LOSS_REASON, lossReason);\n map.put(CustomSDK.ADN_ID, adnId);\n\n \/\/ Notify bid loss.\n customInterstitialAd.sendLossNotification(map);\n\n customInterstitialAd = null;\n}\n\n4. Other API Description\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Required\n Description\n\n\n\n\n notifyBidDisplay\n boolean isWinner: Whether it is the winning party double displayPrice: The price of the ad currently being impressed.\n void\n Implement notification to the custom ad platform's ad that an ad is currently being impressed.\n Yes\n This method is triggered when an ad impression occurs. isWinner parameter: Whether the ad currently being impressed is the winning party. displayPrice: The price of the ad currently being impressed. Note: The currency unit of the price is the ATAdConst.CURRENCY passed by the developer when calling the ATBiddingResult.success() method.","is_draft":"0","editor_type":"2","file_path":"","add_time":"1783421034","update_time":"1783477705"},"pure_content":"This document mainly describes how to integrate Client Bidding with a custom Adapter. For more custom Adapter implementations, please refer to this document: Custom Adapter.\nThe Client Bidding loading"},{"id":"862987","string_id":"kHjrCBaR","status":"1","parent_id":"862983","slug":"kHjrCBaR","order":"4","name":"Interstitial Ad","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"Welch","published_time":"1783477705","add_time":"1783421035","update_time":"1783477705","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"862987","content":"**1.** Interstitial Ad Abstract Method Implementation and Ad Event Callbacks\n---------------------\n\n### 1.1 Additional Abstract Methods Required for Interstitial Ad\n\n| Abstract Method | Parameter Description | Return Value | Purpose | Required |\n|---|---|---|---|---|\n| isAdReady | - | boolean | Used to determine whether the custom ad platform's Interstitial Ad is in a ready state. | Yes |\n| show | Activity activity: The activity context. | void | Implement the logic for displaying the custom ad platform's Interstitial Ad. | Yes |\n\n### 1.2 Interstitial Ad Event Callbacks\n\n**Use the CustomInterstitialEventListene member variable of CustomInterstitialAdapter to implement ad event callbacks.**\n\n| Callback Method | Parameter Description | Description |\n|---|---|---|\n| onInterstitialAdVideoStart | - | Callback to the developer when ad video playback starts. |\n| onInterstitialAdVideoEnd | - | Callback to the developer when ad video playback ends. |\n| onInterstitialAdVideoError | String errorCode: Error code info String errorMsg: Detailed error info | Callback to the developer when ad video playback fails. |\n| onInterstitialAdClose | - | Callback to the developer when the ad page is closed. |\n| onInterstitialAdClicked | - | Callback to the developer when the ad is clicked. |\n| onInterstitialAdShow | - | Callback to the developer when the ad page is displayed. |\n\n**Note: When using the member variable CustomInterstitialEventListene, null-check handling is required, because the Mediation SDK may internally reclaim this Listener object.**\n\n### 1.3 Sample Code\n\n```java\npublic class FacebookInterstitialAdapter extends CustomInterstitialAdapter {\n\n InterstitialAd mInterstitialAd;\n String mUnitid;\n String mPayload;\n\n \/***\n * load ad\n *\/\n private void startLoad(final Context context) {\n\n final InterstitialAdListener interstitialAdListener = new InterstitialAdListener() {\n\n @Override\n public void onError(Ad ad, AdError adError) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(adError.getErrorCode() + \"\", \"\" + adError.getErrorMessage());\n }\n }\n\n @Override\n public void onAdLoaded(Ad ad) {\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded();\n }\n }\n\n @Override\n public void onAdClicked(Ad ad) {\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdClicked();\n }\n }\n\n @Override\n public void onLoggingImpression(Ad ad) {\n }\n\n @Override\n public void onInterstitialDisplayed(Ad ad) {\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdShow();\n }\n }\n\n @Override\n public void onInterstitialDismissed(Ad ad) {\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdClose();\n }\n }\n };\n\n mInterstitialAd = new InterstitialAd(context.getApplicationContext(), mUnitid);\n \/\/ Load a new interstitial.\n final InterstitialAd.InterstitialAdLoadConfigBuilder adConfig = mInterstitialAd.buildLoadAdConfig()\n .withAdListener(interstitialAdListener);\n\n if (!TextUtils.isEmpty(mPayload)) {\n adConfig.withBid(mPayload);\n }\n\n mInterstitialAd.loadAd(adConfig.build());\n }\n\n @Override\n public void destory() {\n try {\n if (mInterstitialAd != null) {\n mInterstitialAd.setAdListener(null);\n mInterstitialAd.destroy();\n mInterstitialAd = null;\n }\n } catch (Exception e) {\n }\n }\n\n @Override\n public void loadCustomNetworkAd(Context context, Map serverExtras, Map localExtras) {\n\n if (serverExtras.containsKey(\"unit_id\")) {\n mUnitid = (String) serverExtras.get(\"unit_id\");\n } else {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"facebook sdkkey is empty.\");\n }\n return;\n }\n\n if (serverExtras.containsKey(\"payload\")) {\n mPayload = serverExtras.get(\"payload\").toString();\n }\n\n FacebookInitManager.getInstance().initSDK(context.getApplicationContext(), serverExtras);\n startLoad(context);\n }\n\n @Override\n public boolean isAdReady() {\n if (mInterstitialAd == null || !mInterstitialAd.isAdLoaded()) {\n return false;\n }\n\n if (mInterstitialAd.isAdInvalidated()) {\n return false;\n }\n\n return true;\n }\n\n @Override\n public boolean setUserDataConsent(Context context, boolean isConsent, boolean isEUTraffic) {\n return false;\n }\n\n @Override\n public void show(Activity activity) {\n if (mInterstitialAd != null) {\n mInterstitialAd.show();\n }\n }\n\n @Override\n public String getNetworkSDKVersion() {\n return FacebookInitManager.getInstance().getNetworkVersion();\n }\n\n @Override\n public String getNetworkName() {\n return FacebookInitManager.getInstance().getNetworkName();\n }\n\n @Override\n public String getNetworkPlacementId() {\n return mUnitid;\n }\n}\n```","pure_content":"1. Interstitial Ad Abstract Method Implementation and Ad Event Callbacks\n1.1 Additional Abstract Methods Required for Interstitial Ad\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Required\n\n\n\n\n isAdReady\n -\n boolean\n Used to determine whether the custom ad platform's Interstitial Ad is in a ready state.\n Yes\n\n\n show\n Activity activity: The activity context.\n void\n Implement the logic for displaying the custom ad platform's Interstitial Ad.\n Yes\n\n\n\n1.2 Interstitial Ad Event Callbacks\nUse the CustomInterstitialEventListene member variable of CustomInterstitialAdapter to implement ad event callbacks.\n\n\n\n Callback Method\n Parameter Description\n Description\n\n\n\n\n onInterstitialAdVideoStart\n -\n Callback to the developer when ad video playback starts.\n\n\n onInterstitialAdVideoEnd\n -\n Callback to the developer when ad video playback ends.\n\n\n onInterstitialAdVideoError\n String errorCode: Error code info String errorMsg: Detailed error info\n Callback to the developer when ad video playback fails.\n\n\n onInterstitialAdClose\n -\n Callback to the developer when the ad page is closed.\n\n\n onInterstitialAdClicked\n -\n Callback to the developer when the ad is clicked.\n\n\n onInterstitialAdShow\n -\n Callback to the developer when the ad page is displayed.\n\n\n\nNote: When using the member variable CustomInterstitialEventListene, null-check handling is required, because the Mediation SDK may internally reclaim this Listener object.\n1.3 Sample Code\npublic class FacebookInterstitialAdapter extends CustomInterstitialAdapter {\n\n InterstitialAd mInterstitialAd;\n String mUnitid;\n String mPayload;\n\n \/***\n * load ad\n *\/\n private void startLoad(final Context context) {\n\n final InterstitialAdListener interstitialAdListener = new InterstitialAdListener() {\n\n @Override\n public void onError(Ad ad, AdError adError) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(adError.getErrorCode() + \"\", \"\" + adError.getErrorMessage());\n }\n }\n\n @Override\n public void onAdLoaded(Ad ad) {\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded();\n }\n }\n\n @Override\n public void onAdClicked(Ad ad) {\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdClicked();\n }\n }\n\n @Override\n public void onLoggingImpression(Ad ad) {\n }\n\n @Override\n public void onInterstitialDisplayed(Ad ad) {\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdShow();\n }\n }\n\n @Override\n public void onInterstitialDismissed(Ad ad) {\n if (mImpressListener != null) {\n mImpressListener.onInterstitialAdClose();\n }\n }\n };\n\n mInterstitialAd = new InterstitialAd(context.getApplicationContext(), mUnitid);\n \/\/ Load a new interstitial.\n final InterstitialAd.InterstitialAdLoadConfigBuilder adConfig = mInterstitialAd.buildLoadAdConfig()\n .withAdListener(interstitialAdListener);\n\n if (!TextUtils.isEmpty(mPayload)) {\n adConfig.withBid(mPayload);\n }\n\n mInterstitialAd.loadAd(adConfig.build());\n }\n\n @Override\n public void destory() {\n try {\n if (mInterstitialAd != null) {\n mInterstitialAd.setAdListener(null);\n mInterstitialAd.destroy();\n mInterstitialAd = null;\n }\n } catch (Exception e) {\n }\n }\n\n @Override\n public void loadCustomNetworkAd(Context context, Map serverExtras, Map localExtras) {\n\n if (serverExtras.containsKey(\"unit_id\")) {\n mUnitid = (String) serverExtras.get(\"unit_id\");\n } else {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"facebook sdkkey is empty.\");\n }\n return;\n }\n\n if (serverExtras.containsKey(\"payload\")) {\n mPayload = serverExtras.get(\"payload\").toString();\n }\n\n FacebookInitManager.getInstance().initSDK(context.getApplicationContext(), serverExtras);\n startLoad(context);\n }\n\n @Override\n public boolean isAdReady() {\n if (mInterstitialAd == null || !mInterstitialAd.isAdLoaded()) {\n return false;\n }\n\n if (mInterstitialAd.isAdInvalidated()) {\n return false;\n }\n\n return true;\n }\n\n @Override\n public boolean setUserDataConsent(Context context, boolean isConsent, boolean isEUTraffic) {\n return false;\n }\n\n @Override\n public void show(Activity activity) {\n if (mInterstitialAd != null) {\n mInterstitialAd.show();\n }\n }\n\n @Override\n public String getNetworkSDKVersion() {\n return FacebookInitManager.getInstance().getNetworkVersion();\n }\n\n @Override\n public String getNetworkName() {\n return FacebookInitManager.getInstance().getNetworkName();\n }\n\n @Override\n public String getNetworkPlacementId() {\n return mUnitid;\n }\n}","is_draft":"0","editor_type":"2","file_path":"","add_time":"1783421035","update_time":"1783477705"},"pure_content":"1. Interstitial Ad Abstract Method Implementation and Ad Event Callbacks\n1.1 Additional Abstract Methods Required for Interstitial Ad\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose"},{"id":"862988","string_id":"d4h81L8I","status":"1","parent_id":"862983","slug":"d4h81L8I","order":"3","name":"Native Ad","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"Welch","published_time":"1783477705","add_time":"1783421036","update_time":"1783477705","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"862988","content":"**1.** Implementation of Native Ad Abstract Methods and Ad Event Callbacks\n---------------------\n\n### 1.1 Additional Abstract Methods Required for Native Ads\n\n**Only need to inherit CustomNativeAdapter and implement the common abstract methods.**\n\nAfter the ad loads successfully, the custom ad platform's ad information needs to be wrapped in an object that inherits **CustomNativeAd**, and called back through the ATCustomLoadListener.onAdCacheLoaded method. The ad content needs to be provided by overriding the methods of CustomNativeAd: **(The method implementations can follow the custom ad platform's requirements. They do not all need to be implemented.)**\n\n| Method | Parameters | Return Value | Description |\n|---|---|---|---|\n| isNativeExpress | - | boolean | Used to determine whether the current native ad is a template ad. |\n| getCustomAdContainer | - | ViewGroup | Provide the container inherent to the custom ad platform for loading native ads. |\n| getAdMediaView | - | View | Used to provide the main image or video View of the native ad (if it is a template ad, the template ad's View should be provided through this method). |\n| getTitle | - | String | Used to provide the native ad title. |\n| getDescriptionText | - | String | Used to provide the native ad description. |\n| getMainImageUrl | - | String | Used to provide the native ad main image URL. |\n| getIconImageUrl | - | String | Used to provide the native ad icon URL. |\n| getCallToActionText | - | String | Used to provide the native ad CTA button text. |\n| getStarRating | - | Double | Used to provide the native ad star rating. |\n| getAdChoiceIconUrl | - | String | Used to provide the native ad's ad identifier URL. |\n| getAdFrom | - | String | Used to provide the native ad's ad source text. |\n| getImageUrlList | - | List<String> | Used to provide the native ad's image list. |\n| prepare | View view: The container displaying the native ad FrameLayout.LayoutParams layoutParams: The position of the ad badge. | void | Implement binding the native ad's click events. |\n| prepare | View view: The container displaying the native ad List<View> clickViewList: The list of Views that need click event binding FrameLayout.LayoutParams layoutParams: The position of the ad badge. | void | Implement binding the native ad's click events. |\n| clear | View view: The container displaying the native ad | void | Implement removing the ad click event binding. |\n| onResume | - | void | Executed when the native ad is displayed. |\n| onPause | - | void | Executed when the native ad is not displayed. |\n| destory | - | void | Executed when the native ad is destroyed. |\n\n### 1.2 Native Ad Event Callbacks\n\nAfter wrapping the custom ad platform information in a class inheriting CustomNativeAd, ad event callbacks can be executed through the methods inside CustomNativeAd:\n\n| Method | Description |\n|---|---|\n| notifyAdClicked | Callback to the developer when the ad is clicked. |\n| notifyAdDislikeClick | Callback to the developer when the ad's Dislike button is clicked (not required if not implemented). |\n| notifyAdVideoStart | Callback to the developer when the ad's video starts playing (not required if not implemented). |\n| notifyAdVideoEnd | Callback to the developer when the ad's video ends (not required if not implemented). |\n\n### 1.3 Sample Code\n\n```java\npublic class FacebookNativeAdapter extends CustomNativeAdapter {\n\n String mPayload;\n String unitId = \"\";\n String unitType = \"\";\n String unitHeight = \"\";\n boolean isAutoPlay = false;\n\n @Override\n public void loadCustomNetworkAd(final Context context, final Map serverExtras, final Map localExtras) {\n try {\n if (serverExtras.containsKey(\"unit_id\")) {\n unitId = serverExtras.get(\"unit_id\").toString();\n }\n\n if (serverExtras.containsKey(\"unit_type\")) {\n unitType = serverExtras.get(\"unit_type\").toString();\n }\n\n if (serverExtras.containsKey(\"height\")) {\n unitHeight = serverExtras.get(\"height\").toString();\n }\n } catch (Exception e) {\n e.printStackTrace();\n }\n\n if (TextUtils.isEmpty(unitId)) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"facebook unitId is empty.\");\n }\n return;\n }\n\n try {\n if (serverExtras != null) {\n isAutoPlay = Boolean.parseBoolean(serverExtras.get(CustomNativeAd.IS_AUTO_PLAY_KEY).toString());\n }\n } catch (Exception e) {\n\n }\n\n FacebookInitManager.getInstance().initSDK(context.getApplicationContext(), serverExtras);\n\n if (serverExtras.containsKey(\"payload\")) {\n mPayload = serverExtras.get(\"payload\").toString();\n }\n\n startAdLoad(context);\n\n }\n\n private void startAdLoad(final Context context) {\n NativeAdListener nativeAdListener = new NativeAdListener() {\n @Override\n public void onMediaDownloaded(Ad ad) {\n\n }\n\n @Override\n public void onError(Ad ad, AdError adError) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(adError.getErrorCode() + \"\", adError.getErrorMessage());\n }\n }\n\n @Override\n public void onAdLoaded(Ad ad) {\n switch (unitType) {\n case \"1\":\n FacebookNativeBannerAd nativeBanner = new FacebookNativeBannerAd(context, (NativeBannerAd) ad, unitHeight);\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded(nativeBanner);\n }\n break;\n default:\n FacebookNativeAd nativeAd = new FacebookNativeAd(context, (NativeAd) ad);\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded(nativeAd);\n }\n break;\n }\n\n }\n\n @Override\n public void onAdClicked(Ad ad) {\n\n }\n\n @Override\n public void onLoggingImpression(Ad ad) {\n\n }\n };\n\n switch (unitType) {\n case \"1\":\n NativeBannerAd nativeBanner = new NativeBannerAd(context, unitId);\n nativeBanner.setAdListener(nativeAdListener);\n nativeBanner.loadAd();\n\n break;\n default:\n NativeAd nativeAd = new NativeAd(context, unitId);\n nativeAd.setAdListener(nativeAdListener);\n nativeAd.loadAd();\n break;\n }\n }\n\n @Override\n public void destory() {\n\n }\n\n @Override\n public String getNetworkName() {\n return FacebookInitManager.getInstance().getNetworkName();\n }\n\n @Override\n public boolean setUserDataConsent(Context context, boolean isConsent, boolean isEUTraffic) {\n return false;\n }\n\n @Override\n public String getNetworkPlacementId() {\n return unitId;\n }\n\n @Override\n public String getNetworkSDKVersion() {\n return FacebookInitManager.getInstance().getNetworkVersion();\n }\n}\n```\n\n```java\npublic class FacebookNativeAd extends CustomNativeAd implements NativeAdListener {\n\n NativeAd mFacebookNativeAd;\n Context mContext;\n\n public FacebookNativeAd(Context context, NativeAd nativeAd) {\n mContext = context.getApplicationContext();\n mFacebookNativeAd = nativeAd;\n mFacebookNativeAd.setAdListener(this);\n }\n\n public void loadAd(String bidPayload) {\n if (TextUtils.isEmpty(bidPayload)) {\n mFacebookNativeAd.loadAd();\n } else {\n mFacebookNativeAd.loadAdFromBid(bidPayload);\n }\n\n }\n\n \/\/ Lifecycle Handlers\n @Override\n public void prepare(final View view, FrameLayout.LayoutParams layoutParams) {\n if (view == null) {\n return;\n }\n try {\n if (mContainer != null) {\n mFacebookNativeAd.registerViewForInteraction(mContainer, mMediaView, mAdIconView);\n } else {\n mFacebookNativeAd.registerViewForInteraction(view, mMediaView, mAdIconView);\n }\n prepareFacebookAdChoiceView(view, layoutParams);\n\n } catch (Exception e) {\n\n }\n }\n\n private void prepareFacebookAdChoiceView(View view, FrameLayout.LayoutParams layoutParams) {\n AdOptionsView adOptionsView = new AdOptionsView(view.getContext(), mFacebookNativeAd, mContainer);\n if (layoutParams == null) {\n layoutParams = new FrameLayout.LayoutParams(FrameLayout.LayoutParams.WRAP_CONTENT, FrameLayout.LayoutParams.WRAP_CONTENT);\n layoutParams.gravity = Gravity.RIGHT | Gravity.TOP;\n }\n\n if (layoutParams.height > 0) {\n float scale = mContext.getResources().getDisplayMetrics().density;\n int iconSize = (int) (layoutParams.height \/ scale + 0.5f);\n adOptionsView.setIconSizeDp(iconSize);\n }\n\n mContainer.addView(adOptionsView, layoutParams);\n }\n\n @Override\n public void prepare(View view, List clickViewList, FrameLayout.LayoutParams layoutParams) {\n if (view == null) {\n return;\n }\n try {\n if (mContainer != null) {\n mFacebookNativeAd.registerViewForInteraction(mContainer, mMediaView, mAdIconView, clickViewList);\n } else {\n mFacebookNativeAd.registerViewForInteraction(view, mMediaView, mAdIconView, clickViewList);\n }\n prepareFacebookAdChoiceView(view, layoutParams);\n\n } catch (Exception e) {\n e.printStackTrace();\n }\n }\n\n NativeAdLayout mContainer;\n\n @Override\n public ViewGroup getCustomAdContainer() {\n mContainer = new NativeAdLayout(mContext);\n return mContainer;\n }\n\n MediaView mMediaView;\n\n @Override\n public View getAdMediaView(Object... object) {\n try {\n if (mMediaView != null) {\n mMediaView.setListener(null);\n mMediaView.destroy();\n mMediaView = null;\n }\n mMediaView = new MediaView(mContext);\n mMediaView.setListener(new MediaViewListener() {\n @Override\n public void onPlay(MediaView mediaView) {\n }\n\n @Override\n public void onVolumeChange(MediaView mediaView, float v) {\n }\n\n @Override\n public void onPause(MediaView mediaView) {\n }\n\n @Override\n public void onComplete(MediaView mediaView) {\n notifyAdVideoEnd();\n }\n\n @Override\n public void onEnterFullscreen(MediaView mediaView) {\n }\n\n @Override\n public void onExitFullscreen(MediaView mediaView) {\n }\n\n @Override\n public void onFullscreenBackground(MediaView mediaView) {\n }\n\n @Override\n public void onFullscreenForeground(MediaView mediaView) {\n }\n });\n return mMediaView;\n } catch (Exception e) {\n e.printStackTrace();\n }\n return null;\n\n }\n\n AdIconView mAdIconView;\n\n @Override\n public View getAdIconView() {\n try {\n if (mAdIconView != null) {\n mAdIconView.destroy();\n mAdIconView = null;\n }\n mAdIconView = new AdIconView(mContext);\n return mAdIconView;\n } catch (Exception e) {\n e.printStackTrace();\n }\n return null;\n }\n\n @Override\n public void clear(final View view) {\n if (mMediaView != null) {\n mMediaView.setListener(null);\n mMediaView.destroy();\n mMediaView = null;\n }\n if (mFacebookNativeAd != null) {\n mFacebookNativeAd.unregisterView();\n }\n\n }\n\n @Override\n public void destroy() {\n if (mFacebookNativeAd != null) {\n mFacebookNativeAd.setAdListener(null);\n mFacebookNativeAd.unregisterView();\n mFacebookNativeAd.destroy();\n mFacebookNativeAd = null;\n }\n if (mMediaView != null) {\n mMediaView.setListener(null);\n mMediaView.destroy();\n mMediaView = null;\n }\n mContext = null;\n if (mAdIconView != null) {\n mAdIconView.destroy();\n mAdIconView = null;\n }\n if (mContainer != null) {\n mContainer.removeAllViews();\n mContainer = null;\n }\n }\n\n \/**\n * facebook listener--------------------------------------------------------------------------------\n **\/\n\n @Override\n public void onError(Ad ad, AdError adError) {\n\n }\n\n @Override\n public void onAdLoaded(Ad ad) {\n }\n\n @Override\n public String getTitle() {\n if (mFacebookNativeAd != null) {\n return mFacebookNativeAd.getAdHeadline();\n }\n return \"\";\n }\n\n @Override\n public String getDescriptionText() {\n if (mFacebookNativeAd != null) {\n return mFacebookNativeAd.getAdBodyText();\n }\n return \"\";\n }\n\n @Override\n public String getCallToActionText() {\n if (mFacebookNativeAd != null) {\n return mFacebookNativeAd.getAdCallToAction();\n }\n return \"\";\n }\n\n @Override\n public String getAdFrom() {\n if (mFacebookNativeAd != null) {\n return mFacebookNativeAd.getSponsoredTranslation();\n }\n return \"\";\n }\n\n @Override\n public void onAdClicked(Ad ad) {\n notifyAdClicked();\n }\n\n @Override\n public void onLoggingImpression(Ad ad) {\n }\n\n boolean mIsAutoPlay;\n\n public void setIsAutoPlay(boolean isAutoPlay) {\n mIsAutoPlay = isAutoPlay;\n }\n\n @Override\n public void onMediaDownloaded(Ad ad) {\n\n }\n}\n```","pure_content":"1. Implementation of Native Ad Abstract Methods and Ad Event Callbacks\n1.1 Additional Abstract Methods Required for Native Ads\nOnly need to inherit CustomNativeAdapter and implement the common abstract methods.\nAfter the ad loads successfully, the custom ad platform's ad information needs to be wrapped in an object that inherits CustomNativeAd, and called back through the ATCustomLoadListener.onAdCacheLoaded method. The ad content needs to be provided by overriding the methods of CustomNativeAd: (The method implementations can follow the custom ad platform's requirements. They do not all need to be implemented.)\n\n\n\n Method\n Parameters\n Return Value\n Description\n\n\n\n\n isNativeExpress\n -\n boolean\n Used to determine whether the current native ad is a template ad.\n\n\n getCustomAdContainer\n -\n ViewGroup\n Provide the container inherent to the custom ad platform for loading native ads.\n\n\n getAdMediaView\n -\n View\n Used to provide the main image or video View of the native ad (if it is a template ad, the template ad's View should be provided through this method).\n\n\n getTitle\n -\n String\n Used to provide the native ad title.\n\n\n getDescriptionText\n -\n String\n Used to provide the native ad description.\n\n\n getMainImageUrl\n -\n String\n Used to provide the native ad main image URL.\n\n\n getIconImageUrl\n -\n String\n Used to provide the native ad icon URL.\n\n\n getCallToActionText\n -\n String\n Used to provide the native ad CTA button text.\n\n\n getStarRating\n -\n Double\n Used to provide the native ad star rating.\n\n\n getAdChoiceIconUrl\n -\n String\n Used to provide the native ad's ad identifier URL.\n\n\n getAdFrom\n -\n String\n Used to provide the native ad's ad source text.\n\n\n getImageUrlList\n -\n List\n Used to provide the native ad's image list.\n\n\n prepare\n View view: The container displaying the native ad FrameLayout.LayoutParams layoutParams: The position of the ad badge.\n void\n Implement binding the native ad's click events.\n\n\n prepare\n View view: The container displaying the native ad List clickViewList: The list of Views that need click event binding FrameLayout.LayoutParams layoutParams: The position of the ad badge.\n void\n Implement binding the native ad's click events.\n\n\n clear\n View view: The container displaying the native ad\n void\n Implement removing the ad click event binding.\n\n\n onResume\n -\n void\n Executed when the native ad is displayed.\n\n\n onPause\n -\n void\n Executed when the native ad is not displayed.\n\n\n destory\n -\n void\n Executed when the native ad is destroyed.\n\n\n\n1.2 Native Ad Event Callbacks\nAfter wrapping the custom ad platform information in a class inheriting CustomNativeAd, ad event callbacks can be executed through the methods inside CustomNativeAd:\n\n\n\n Method\n Description\n\n\n\n\n notifyAdClicked\n Callback to the developer when the ad is clicked.\n\n\n notifyAdDislikeClick\n Callback to the developer when the ad's Dislike button is clicked (not required if not implemented).\n\n\n notifyAdVideoStart\n Callback to the developer when the ad's video starts playing (not required if not implemented).\n\n\n notifyAdVideoEnd\n Callback to the developer when the ad's video ends (not required if not implemented).\n\n\n\n1.3 Sample Code\npublic class FacebookNativeAdapter extends CustomNativeAdapter {\n\n String mPayload;\n String unitId = \"\";\n String unitType = \"\";\n String unitHeight = \"\";\n boolean isAutoPlay = false;\n\n @Override\n public void loadCustomNetworkAd(final Context context, final Map serverExtras, final Map localExtras) {\n try {\n if (serverExtras.containsKey(\"unit_id\")) {\n unitId = serverExtras.get(\"unit_id\").toString();\n }\n\n if (serverExtras.containsKey(\"unit_type\")) {\n unitType = serverExtras.get(\"unit_type\").toString();\n }\n\n if (serverExtras.containsKey(\"height\")) {\n unitHeight = serverExtras.get(\"height\").toString();\n }\n } catch (Exception e) {\n e.printStackTrace();\n }\n\n if (TextUtils.isEmpty(unitId)) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"facebook unitId is empty.\");\n }\n return;\n }\n\n try {\n if (serverExtras != null) {\n isAutoPlay = Boolean.parseBoolean(serverExtras.get(CustomNativeAd.IS_AUTO_PLAY_KEY).toString());\n }\n } catch (Exception e) {\n\n }\n\n FacebookInitManager.getInstance().initSDK(context.getApplicationContext(), serverExtras);\n\n if (serverExtras.containsKey(\"payload\")) {\n mPayload = serverExtras.get(\"payload\").toString();\n }\n\n startAdLoad(context);\n\n }\n\n private void startAdLoad(final Context context) {\n NativeAdListener nativeAdListener = new NativeAdListener() {\n @Override\n public void onMediaDownloaded(Ad ad) {\n\n }\n\n @Override\n public void onError(Ad ad, AdError adError) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(adError.getErrorCode() + \"\", adError.getErrorMessage());\n }\n }\n\n @Override\n public void onAdLoaded(Ad ad) {\n switch (unitType) {\n case \"1\":\n FacebookNativeBannerAd nativeBanner = new FacebookNativeBannerAd(context, (NativeBannerAd) ad, unitHeight);\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded(nativeBanner);\n }\n break;\n default:\n FacebookNativeAd nativeAd = new FacebookNativeAd(context, (NativeAd) ad);\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded(nativeAd);\n }\n break;\n }\n\n }\n\n @Override\n public void onAdClicked(Ad ad) {\n\n }\n\n @Override\n public void onLoggingImpression(Ad ad) {\n\n }\n };\n\n switch (unitType) {\n case \"1\":\n NativeBannerAd nativeBanner = new NativeBannerAd(context, unitId);\n nativeBanner.setAdListener(nativeAdListener);\n nativeBanner.loadAd();\n\n break;\n default:\n NativeAd nativeAd = new NativeAd(context, unitId);\n nativeAd.setAdListener(nativeAdListener);\n nativeAd.loadAd();\n break;\n }\n }\n\n @Override\n public void destory() {\n\n }\n\n @Override\n public String getNetworkName() {\n return FacebookInitManager.getInstance().getNetworkName();\n }\n\n @Override\n public boolean setUserDataConsent(Context context, boolean isConsent, boolean isEUTraffic) {\n return false;\n }\n\n @Override\n public String getNetworkPlacementId() {\n return unitId;\n }\n\n @Override\n public String getNetworkSDKVersion() {\n return FacebookInitManager.getInstance().getNetworkVersion();\n }\n}\n\npublic class FacebookNativeAd extends CustomNativeAd implements NativeAdListener {\n\n NativeAd mFacebookNativeAd;\n Context mContext;\n\n public FacebookNativeAd(Context context, NativeAd nativeAd) {\n mContext = context.getApplicationContext();\n mFacebookNativeAd = nativeAd;\n mFacebookNativeAd.setAdListener(this);\n }\n\n public void loadAd(String bidPayload) {\n if (TextUtils.isEmpty(bidPayload)) {\n mFacebookNativeAd.loadAd();\n } else {\n mFacebookNativeAd.loadAdFromBid(bidPayload);\n }\n\n }\n\n \/\/ Lifecycle Handlers\n @Override\n public void prepare(final View view, FrameLayout.LayoutParams layoutParams) {\n if (view == null) {\n return;\n }\n try {\n if (mContainer != null) {\n mFacebookNativeAd.registerViewForInteraction(mContainer, mMediaView, mAdIconView);\n } else {\n mFacebookNativeAd.registerViewForInteraction(view, mMediaView, mAdIconView);\n }\n prepareFacebookAdChoiceView(view, layoutParams);\n\n } catch (Exception e) {\n\n }\n }\n\n private void prepareFacebookAdChoiceView(View view, FrameLayout.LayoutParams layoutParams) {\n AdOptionsView adOptionsView = new AdOptionsView(view.getContext(), mFacebookNativeAd, mContainer);\n if (layoutParams == null) {\n layoutParams = new FrameLayout.LayoutParams(FrameLayout.LayoutParams.WRAP_CONTENT, FrameLayout.LayoutParams.WRAP_CONTENT);\n layoutParams.gravity = Gravity.RIGHT | Gravity.TOP;\n }\n\n if (layoutParams.height > 0) {\n float scale = mContext.getResources().getDisplayMetrics().density;\n int iconSize = (int) (layoutParams.height \/ scale + 0.5f);\n adOptionsView.setIconSizeDp(iconSize);\n }\n\n mContainer.addView(adOptionsView, layoutParams);\n }\n\n @Override\n public void prepare(View view, List clickViewList, FrameLayout.LayoutParams layoutParams) {\n if (view == null) {\n return;\n }\n try {\n if (mContainer != null) {\n mFacebookNativeAd.registerViewForInteraction(mContainer, mMediaView, mAdIconView, clickViewList);\n } else {\n mFacebookNativeAd.registerViewForInteraction(view, mMediaView, mAdIconView, clickViewList);\n }\n prepareFacebookAdChoiceView(view, layoutParams);\n\n } catch (Exception e) {\n e.printStackTrace();\n }\n }\n\n NativeAdLayout mContainer;\n\n @Override\n public ViewGroup getCustomAdContainer() {\n mContainer = new NativeAdLayout(mContext);\n return mContainer;\n }\n\n MediaView mMediaView;\n\n @Override\n public View getAdMediaView(Object... object) {\n try {\n if (mMediaView != null) {\n mMediaView.setListener(null);\n mMediaView.destroy();\n mMediaView = null;\n }\n mMediaView = new MediaView(mContext);\n mMediaView.setListener(new MediaViewListener() {\n @Override\n public void onPlay(MediaView mediaView) {\n }\n\n @Override\n public void onVolumeChange(MediaView mediaView, float v) {\n }\n\n @Override\n public void onPause(MediaView mediaView) {\n }\n\n @Override\n public void onComplete(MediaView mediaView) {\n notifyAdVideoEnd();\n }\n\n @Override\n public void onEnterFullscreen(MediaView mediaView) {\n }\n\n @Override\n public void onExitFullscreen(MediaView mediaView) {\n }\n\n @Override\n public void onFullscreenBackground(MediaView mediaView) {\n }\n\n @Override\n public void onFullscreenForeground(MediaView mediaView) {\n }\n });\n return mMediaView;\n } catch (Exception e) {\n e.printStackTrace();\n }\n return null;\n\n }\n\n AdIconView mAdIconView;\n\n @Override\n public View getAdIconView() {\n try {\n if (mAdIconView != null) {\n mAdIconView.destroy();\n mAdIconView = null;\n }\n mAdIconView = new AdIconView(mContext);\n return mAdIconView;\n } catch (Exception e) {\n e.printStackTrace();\n }\n return null;\n }\n\n @Override\n public void clear(final View view) {\n if (mMediaView != null) {\n mMediaView.setListener(null);\n mMediaView.destroy();\n mMediaView = null;\n }\n if (mFacebookNativeAd != null) {\n mFacebookNativeAd.unregisterView();\n }\n\n }\n\n @Override\n public void destroy() {\n if (mFacebookNativeAd != null) {\n mFacebookNativeAd.setAdListener(null);\n mFacebookNativeAd.unregisterView();\n mFacebookNativeAd.destroy();\n mFacebookNativeAd = null;\n }\n if (mMediaView != null) {\n mMediaView.setListener(null);\n mMediaView.destroy();\n mMediaView = null;\n }\n mContext = null;\n if (mAdIconView != null) {\n mAdIconView.destroy();\n mAdIconView = null;\n }\n if (mContainer != null) {\n mContainer.removeAllViews();\n mContainer = null;\n }\n }\n\n \/**\n * facebook listener--------------------------------------------------------------------------------\n **\/\n\n @Override\n public void onError(Ad ad, AdError adError) {\n\n }\n\n @Override\n public void onAdLoaded(Ad ad) {\n }\n\n @Override\n public String getTitle() {\n if (mFacebookNativeAd != null) {\n return mFacebookNativeAd.getAdHeadline();\n }\n return \"\";\n }\n\n @Override\n public String getDescriptionText() {\n if (mFacebookNativeAd != null) {\n return mFacebookNativeAd.getAdBodyText();\n }\n return \"\";\n }\n\n @Override\n public String getCallToActionText() {\n if (mFacebookNativeAd != null) {\n return mFacebookNativeAd.getAdCallToAction();\n }\n return \"\";\n }\n\n @Override\n public String getAdFrom() {\n if (mFacebookNativeAd != null) {\n return mFacebookNativeAd.getSponsoredTranslation();\n }\n return \"\";\n }\n\n @Override\n public void onAdClicked(Ad ad) {\n notifyAdClicked();\n }\n\n @Override\n public void onLoggingImpression(Ad ad) {\n }\n\n boolean mIsAutoPlay;\n\n public void setIsAutoPlay(boolean isAutoPlay) {\n mIsAutoPlay = isAutoPlay;\n }\n\n @Override\n public void onMediaDownloaded(Ad ad) {\n\n }\n}","is_draft":"0","editor_type":"2","file_path":"","add_time":"1783421036","update_time":"1783477705"},"pure_content":"1. Implementation of Native Ad Abstract Methods and Ad Event Callbacks\n1.1 Additional Abstract Methods Required for Native Ads\nOnly need to inherit CustomNativeAdapter and implement the common abstrac"},{"id":"862989","string_id":"ROr1IE3j","status":"1","parent_id":"862983","slug":"ROr1IE3j","order":"2","name":"Rewarded Video","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"Welch","published_time":"1783477705","add_time":"1783421037","update_time":"1783477705","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"862989","content":"1. Implementation of Rewarded Video Abstract Methods and Ad Event Callbacks\n-------------------\n\n### 1.1 Additional Abstract Methods Required for Rewarded Video\n\n| Abstract Method | Parameter Description | Return Value | Purpose | Required |\n|---|---|---|---|---|\n| isAdReady | - | boolean | Used to determine whether the custom ad platform's Rewarded Video Ad is in a ready state. | Yes |\n| show | Activity activity: The Activity context | void | Implement the logic for displaying the custom ad platform's Rewarded Video. | Yes |\n\n**Note: The parent class of the Adapter provides externally set mUserId and mCustomData member variables (i.e., the values of ATAdConst.KEY.USER\\_ID and ATAdConst.KEY.USER\\_CUSTOM\\_DATA set through the ATRewardVideoAd#setLocalExtra() method), which can be provided to the custom ad platform to implement the Server-to-Server reward method.**\n\n### 1.2 Rewarded Video Ad Event Callbacks\n\n**Use the CustomRewardedVideoEventListener member variable of CustomRewardVideoAdapter to implement ad event callbacks.**\n\n| Callback Method | Parameter Description | Description |\n|---|---|---|\n| onRewardedVideoAdPlayStart | - | Callback to the developer when ad playback starts. |\n| onRewardedVideoAdPlayEnd | - | Callback to the developer when ad playback ends. |\n| onRewardedVideoAdPlayFailed | String errorCode: Error code info String errorMsg: Detailed error info | Callback to the developer when ad playback fails. |\n| onRewardedVideoAdClosed | - | Callback to the developer when the ad page is closed. |\n| onRewardedVideoAdPlayClicked | - | Callback to the developer when the ad is clicked. |\n| onReward | - | Callback to the developer when a reward is distributed to the user. |\n\n**Note: When using the member variable CustomRewardedVideoEventListener, null-check handling is required, because the Mediation SDK may internally reclaim this Listener object.**\n\n### 1.3 Sample Code\n\n```java\npublic class FacebookRewardVideoAdapter extends CustomRewardVideoAdapter {\n\n RewardedVideoAd rewardedVideoAd;\n String mUnitid;\n String mPayload;\n\n \/***\n * load ad\n *\/\n private void startLoad(final Context context) {\n\n final RewardedVideoAdListener rewardedVideoAdListener = new RewardedVideoAdListener() {\n @Override\n public void onError(Ad ad, AdError error) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(error.getErrorCode() + \"\", \"\" + error.getErrorMessage());\n }\n }\n\n @Override\n public void onAdLoaded(Ad ad) {\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded();\n }\n }\n\n @Override\n public void onAdClicked(Ad ad) {\n if (mImpressionListener != null) {\n mImpressionListener.onRewardedVideoAdPlayClicked();\n }\n }\n\n @Override\n public void onLoggingImpression(Ad ad) {\n if (mImpressionListener != null) {\n mImpressionListener.onRewardedVideoAdPlayStart();\n }\n }\n\n @Override\n public void onRewardedVideoCompleted() {\n if (mImpressionListener != null) {\n mImpressionListener.onRewardedVideoAdPlayEnd();\n }\n\n if (mImpressionListener != null) {\n mImpressionListener.onReward();\n }\n }\n\n @Override\n public void onRewardedVideoClosed() {\n if (mImpressionListener != null) {\n mImpressionListener.onRewardedVideoAdClosed();\n }\n\n }\n };\n\n rewardedVideoAd = new RewardedVideoAd(context.getApplicationContext(), mUnitid);\n RewardedVideoAd.RewardedVideoAdLoadConfigBuilder adConfig = rewardedVideoAd\n .buildLoadAdConfig()\n .withAdListener(rewardedVideoAdListener)\n .withFailOnCacheFailureEnabled(true)\n .withRVChainEnabled(true);\n\n adConfig.withRewardData(new RewardData(mUserId, mUserData));\n\n if (!TextUtils.isEmpty(mPayload)) {\n adConfig.withBid(mPayload);\n }\n rewardedVideoAd.loadAd(adConfig.build());\n }\n\n @Override\n public void destory() {\n try {\n if (rewardedVideoAd != null) {\n rewardedVideoAd.setAdListener(null);\n rewardedVideoAd.destroy();\n }\n } catch (Exception e) {\n }\n }\n\n\n @Override\n public void loadCustomNetworkAd(Context context, Map serverExtras, Map localExtras) {\n\n if (serverExtras.containsKey(\"unit_id\")) {\n mUnitid = (String) serverExtras.get(\"unit_id\");\n } else {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"facebook sdkkey is empty.\");\n }\n return;\n }\n FacebookInitManager.getInstance().initSDK(context.getApplicationContext(), serverExtras);\n\n if (serverExtras.containsKey(\"payload\")) {\n mPayload = serverExtras.get(\"payload\").toString();\n }\n\n startLoad(context);\n }\n\n @Override\n public boolean isAdReady() {\n if (rewardedVideoAd == null || !rewardedVideoAd.isAdLoaded()) {\n return false;\n }\n if (rewardedVideoAd.isAdInvalidated()) {\n return false;\n }\n return true;\n }\n\n @Override\n public boolean setUserDataConsent(Context context, boolean isConsent, boolean isEUTraffic) {\n return false;\n }\n\n @Override\n public void show(Activity activity) {\n if (rewardedVideoAd != null) {\n rewardedVideoAd.show();\n }\n }\n\n @Override\n public String getNetworkSDKVersion() {\n return FacebookInitManager.getInstance().getNetworkVersion();\n }\n\n @Override\n public String getNetworkName() {\n return FacebookInitManager.getInstance().getNetworkName();\n }\n\n @Override\n public String getNetworkPlacementId() {\n return mUnitid;\n }\n}\n```","pure_content":"Implementation of Rewarded Video Abstract Methods and Ad Event Callbacks\n\n\n1.1 Additional Abstract Methods Required for Rewarded Video\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpose\n Required\n\n\n\n\n isAdReady\n -\n boolean\n Used to determine whether the custom ad platform's Rewarded Video Ad is in a ready state.\n Yes\n\n\n show\n Activity activity: The Activity context\n void\n Implement the logic for displaying the custom ad platform's Rewarded Video.\n Yes\n\n\n\nNote: The parent class of the Adapter provides externally set mUserId and mCustomData member variables (i.e., the values of ATAdConst.KEY.USER_ID and ATAdConst.KEY.USER_CUSTOM_DATA set through the ATRewardVideoAd#setLocalExtra() method), which can be provided to the custom ad platform to implement the Server-to-Server reward method.\n1.2 Rewarded Video Ad Event Callbacks\nUse the CustomRewardedVideoEventListener member variable of CustomRewardVideoAdapter to implement ad event callbacks.\n\n\n\n Callback Method\n Parameter Description\n Description\n\n\n\n\n onRewardedVideoAdPlayStart\n -\n Callback to the developer when ad playback starts.\n\n\n onRewardedVideoAdPlayEnd\n -\n Callback to the developer when ad playback ends.\n\n\n onRewardedVideoAdPlayFailed\n String errorCode: Error code info String errorMsg: Detailed error info\n Callback to the developer when ad playback fails.\n\n\n onRewardedVideoAdClosed\n -\n Callback to the developer when the ad page is closed.\n\n\n onRewardedVideoAdPlayClicked\n -\n Callback to the developer when the ad is clicked.\n\n\n onReward\n -\n Callback to the developer when a reward is distributed to the user.\n\n\n\nNote: When using the member variable CustomRewardedVideoEventListener, null-check handling is required, because the Mediation SDK may internally reclaim this Listener object.\n1.3 Sample Code\npublic class FacebookRewardVideoAdapter extends CustomRewardVideoAdapter {\n\n RewardedVideoAd rewardedVideoAd;\n String mUnitid;\n String mPayload;\n\n \/***\n * load ad\n *\/\n private void startLoad(final Context context) {\n\n final RewardedVideoAdListener rewardedVideoAdListener = new RewardedVideoAdListener() {\n @Override\n public void onError(Ad ad, AdError error) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(error.getErrorCode() + \"\", \"\" + error.getErrorMessage());\n }\n }\n\n @Override\n public void onAdLoaded(Ad ad) {\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded();\n }\n }\n\n @Override\n public void onAdClicked(Ad ad) {\n if (mImpressionListener != null) {\n mImpressionListener.onRewardedVideoAdPlayClicked();\n }\n }\n\n @Override\n public void onLoggingImpression(Ad ad) {\n if (mImpressionListener != null) {\n mImpressionListener.onRewardedVideoAdPlayStart();\n }\n }\n\n @Override\n public void onRewardedVideoCompleted() {\n if (mImpressionListener != null) {\n mImpressionListener.onRewardedVideoAdPlayEnd();\n }\n\n if (mImpressionListener != null) {\n mImpressionListener.onReward();\n }\n }\n\n @Override\n public void onRewardedVideoClosed() {\n if (mImpressionListener != null) {\n mImpressionListener.onRewardedVideoAdClosed();\n }\n\n }\n };\n\n rewardedVideoAd = new RewardedVideoAd(context.getApplicationContext(), mUnitid);\n RewardedVideoAd.RewardedVideoAdLoadConfigBuilder adConfig = rewardedVideoAd\n .buildLoadAdConfig()\n .withAdListener(rewardedVideoAdListener)\n .withFailOnCacheFailureEnabled(true)\n .withRVChainEnabled(true);\n\n adConfig.withRewardData(new RewardData(mUserId, mUserData));\n\n if (!TextUtils.isEmpty(mPayload)) {\n adConfig.withBid(mPayload);\n }\n rewardedVideoAd.loadAd(adConfig.build());\n }\n\n @Override\n public void destory() {\n try {\n if (rewardedVideoAd != null) {\n rewardedVideoAd.setAdListener(null);\n rewardedVideoAd.destroy();\n }\n } catch (Exception e) {\n }\n }\n\n\n @Override\n public void loadCustomNetworkAd(Context context, Map serverExtras, Map localExtras) {\n\n if (serverExtras.containsKey(\"unit_id\")) {\n mUnitid = (String) serverExtras.get(\"unit_id\");\n } else {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"facebook sdkkey is empty.\");\n }\n return;\n }\n FacebookInitManager.getInstance().initSDK(context.getApplicationContext(), serverExtras);\n\n if (serverExtras.containsKey(\"payload\")) {\n mPayload = serverExtras.get(\"payload\").toString();\n }\n\n startLoad(context);\n }\n\n @Override\n public boolean isAdReady() {\n if (rewardedVideoAd == null || !rewardedVideoAd.isAdLoaded()) {\n return false;\n }\n if (rewardedVideoAd.isAdInvalidated()) {\n return false;\n }\n return true;\n }\n\n @Override\n public boolean setUserDataConsent(Context context, boolean isConsent, boolean isEUTraffic) {\n return false;\n }\n\n @Override\n public void show(Activity activity) {\n if (rewardedVideoAd != null) {\n rewardedVideoAd.show();\n }\n }\n\n @Override\n public String getNetworkSDKVersion() {\n return FacebookInitManager.getInstance().getNetworkVersion();\n }\n\n @Override\n public String getNetworkName() {\n return FacebookInitManager.getInstance().getNetworkName();\n }\n\n @Override\n public String getNetworkPlacementId() {\n return mUnitid;\n }\n}","is_draft":"0","editor_type":"2","file_path":"","add_time":"1783421037","update_time":"1783477705"},"pure_content":"Implementation of Rewarded Video Abstract Methods and Ad Event Callbacks\n\n\n1.1 Additional Abstract Methods Required for Rewarded Video\n\n\n\n Abstract Method\n Parameter Description\n Return Value\n Purpos"},{"id":"862990","string_id":"kLLbbBuH","status":"1","parent_id":"862983","slug":"kLLbbBuH","order":"1","name":"Splash Ad","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"Welch","published_time":"1783477705","add_time":"1783421044","update_time":"1783477705","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"862990","content":"**1.** Implementation of Splash Ad Abstract Methods and Ad Event Callbacks\n---------------------\n\n### 1.1 Additional Abstract Methods Required for Splash Ad\n\n| Method | Parameters | Return Value | Description | Required |\n|---|---|---|---|---|\n| show | Activity activity: Activity ViewGroup container: Container of ad | void | Show splash ad | Yes |\n\nCustomSplashAdapter provides an **ad load timeout** member variable, i.e., the fetchAdTimeout variable passed by the developer through the ATSplashAd constructor. This variable can be used to set the timeout for the ad platform.\n\n### 1.2 Splash Ad Event Callbacks\n\n**Use the CustomSplashEventListener member variable of CustomSplashAdapter to implement ad event callbacks.**\n\n| Callback Method | Parameter Description | Description |\n|---|---|---|\n| onSplashAdClicked | - | Callback to the developer when the ad is clicked. |\n| onSplashAdShow | - | Callback to the developer when the ad is displayed. |\n| onSplashAdDismiss | - | Callback to the developer when the ad is closed. |\n\n**Note: When using the member variable CustomSplashEventListener, null-check handling is required, because the Mediation SDK may internally reclaim this Listener object.**\n\n### 1.3 Sample Code\n\n```java\npublic class PangleSplashAdapter extends CustomSplashAdapter implements TTSplashAd.AdInteractionListener {\n private final String TAG = getClass().getSimpleName();\n\n String appId = \"\";\n String slotId = \"\";\n String personalizedTemplate = \"\";\n\n TTSplashAd splashAd;\n\n @Override\n public void loadCustomNetworkAd(final Context context, Map serverExtra, final Map localExtra) {\n if (serverExtra.containsKey(\"app_id\") && serverExtra.containsKey(\"slot_id\")) {\n appId = (String) serverExtra.get(\"app_id\");\n slotId = (String) serverExtra.get(\"slot_id\");\n\n } else {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"app_id or slot_id is empty!\");\n }\n return;\n }\n\n personalizedTemplate = \"0\";\n if (serverExtra.containsKey(\"personalized_template\")) {\n personalizedTemplate = (String) serverExtra.get(\"personalized_template\");\n }\n\n PangleInitManager.getInstance().initSDK(context, serverExtra, true, new PangleInitManager.InitCallback() {\n @Override\n public void onFinish() {\n startLoad(context, localExtra);\n }\n });\n }\n\n private void startLoad(Context context, Map localExtra) {\n TTAdManager ttAdManager = TTAdSdk.getAdManager();\n\n final TTAdNative mTTAdNative = ttAdManager.createAdNative(context);\/\/baseContext is recommended for activity\n final AdSlot.Builder adSlotBuilder = new AdSlot.Builder().setCodeId(slotId);\n\n int width = 0;\n int height = 0;\n try {\n if (localExtra.containsKey(ATAdConst.KEY.AD_WIDTH)) {\n width = Integer.parseInt(localExtra.get(ATAdConst.KEY.AD_WIDTH).toString());\n }\n } catch (Throwable e) {\n e.printStackTrace();\n }\n\n try {\n if (localExtra.containsKey(ATAdConst.KEY.AD_HEIGHT)) {\n height = Integer.parseInt(localExtra.get(ATAdConst.KEY.AD_HEIGHT).toString());\n }\n } catch (Throwable e) {\n e.printStackTrace();\n }\n\n adSlotBuilder.setImageAcceptedSize(width, height); \/\/Must be set\n\n if (TextUtils.equals(\"1\", personalizedTemplate)) {\/\/ Native Express\n adSlotBuilder.setExpressViewAcceptedSize(width, height);\n }\n\n postOnMainThread(new Runnable() {\n @Override\n public void run() {\n AdSlot adSlot = adSlotBuilder.build();\n mTTAdNative.loadSplashAd(adSlot, new TTAdNative.SplashAdListener() {\n @Override\n public void onError(int i, String s) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(i + \"\", s);\n }\n }\n\n @Override\n public void onTimeout() {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"onTimeout\");\n }\n }\n\n @Override\n public void onSplashAdLoad(TTSplashAd ttSplashAd) {\n splashAd = ttSplashAd;\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded();\n }\n }\n }, mFetchAdTimeout);\n }\n });\n\n }\n\n @Override\n public boolean isAdReady() {\n return splashAd != null;\n }\n\n @Override\n public void show(Activity activity, ViewGroup container) {\n if (splashAd != null) {\n splashAd.setSplashInteractionListener(PangleSplashAdapter.this);\n View splashView = splashAd.getSplashView();\n if (splashView != null) {\n container.addView(splashView);\n }\n }\n }\n\n @Override\n public String getNetworkName() {\n return PangleInitManager.getInstance().getNetworkName();\n }\n\n @Override\n public void destory() {\n\n }\n\n @Override\n public String getNetworkPlacementId() {\n return slotId;\n }\n\n @Override\n public String getNetworkSDKVersion() {\n return PangleInitManager.getInstance().getNetworkVersion();\n }\n\n @Override\n public void onAdClicked(View view, int i) {\n if (mImpressionListener != null) {\n mImpressionListener.onSplashAdClicked();\n }\n\n }\n\n @Override\n public void onAdShow(View view, int i) {\n if (mImpressionListener != null) {\n mImpressionListener.onSplashAdShow();\n }\n\n }\n\n @Override\n public void onAdSkip() {\n if (mImpressionListener != null) {\n mImpressionListener.onSplashAdDismiss();\n }\n }\n\n @Override\n public void onAdTimeOver() {\n if (mImpressionListener != null) {\n mImpressionListener.onSplashAdDismiss();\n }\n }\n\n}\n```","pure_content":"1. Implementation of Splash Ad Abstract Methods and Ad Event Callbacks\n1.1 Additional Abstract Methods Required for Splash Ad\n\n\n\n Method\n Parameters\n Return Value\n Description\n Required\n\n\n\n\n show\n Activity activity: Activity ViewGroup container: Container of ad\n void\n Show splash ad\n Yes\n\n\n\nCustomSplashAdapter provides an ad load timeout member variable, i.e., the fetchAdTimeout variable passed by the developer through the ATSplashAd constructor. This variable can be used to set the timeout for the ad platform.\n1.2 Splash Ad Event Callbacks\nUse the CustomSplashEventListener member variable of CustomSplashAdapter to implement ad event callbacks.\n\n\n\n Callback Method\n Parameter Description\n Description\n\n\n\n\n onSplashAdClicked\n -\n Callback to the developer when the ad is clicked.\n\n\n onSplashAdShow\n -\n Callback to the developer when the ad is displayed.\n\n\n onSplashAdDismiss\n -\n Callback to the developer when the ad is closed.\n\n\n\nNote: When using the member variable CustomSplashEventListener, null-check handling is required, because the Mediation SDK may internally reclaim this Listener object.\n1.3 Sample Code\npublic class PangleSplashAdapter extends CustomSplashAdapter implements TTSplashAd.AdInteractionListener {\n private final String TAG = getClass().getSimpleName();\n\n String appId = \"\";\n String slotId = \"\";\n String personalizedTemplate = \"\";\n\n TTSplashAd splashAd;\n\n @Override\n public void loadCustomNetworkAd(final Context context, Map serverExtra, final Map localExtra) {\n if (serverExtra.containsKey(\"app_id\") && serverExtra.containsKey(\"slot_id\")) {\n appId = (String) serverExtra.get(\"app_id\");\n slotId = (String) serverExtra.get(\"slot_id\");\n\n } else {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"app_id or slot_id is empty!\");\n }\n return;\n }\n\n personalizedTemplate = \"0\";\n if (serverExtra.containsKey(\"personalized_template\")) {\n personalizedTemplate = (String) serverExtra.get(\"personalized_template\");\n }\n\n PangleInitManager.getInstance().initSDK(context, serverExtra, true, new PangleInitManager.InitCallback() {\n @Override\n public void onFinish() {\n startLoad(context, localExtra);\n }\n });\n }\n\n private void startLoad(Context context, Map localExtra) {\n TTAdManager ttAdManager = TTAdSdk.getAdManager();\n\n final TTAdNative mTTAdNative = ttAdManager.createAdNative(context);\/\/baseContext is recommended for activity\n final AdSlot.Builder adSlotBuilder = new AdSlot.Builder().setCodeId(slotId);\n\n int width = 0;\n int height = 0;\n try {\n if (localExtra.containsKey(ATAdConst.KEY.AD_WIDTH)) {\n width = Integer.parseInt(localExtra.get(ATAdConst.KEY.AD_WIDTH).toString());\n }\n } catch (Throwable e) {\n e.printStackTrace();\n }\n\n try {\n if (localExtra.containsKey(ATAdConst.KEY.AD_HEIGHT)) {\n height = Integer.parseInt(localExtra.get(ATAdConst.KEY.AD_HEIGHT).toString());\n }\n } catch (Throwable e) {\n e.printStackTrace();\n }\n\n adSlotBuilder.setImageAcceptedSize(width, height); \/\/Must be set\n\n if (TextUtils.equals(\"1\", personalizedTemplate)) {\/\/ Native Express\n adSlotBuilder.setExpressViewAcceptedSize(width, height);\n }\n\n postOnMainThread(new Runnable() {\n @Override\n public void run() {\n AdSlot adSlot = adSlotBuilder.build();\n mTTAdNative.loadSplashAd(adSlot, new TTAdNative.SplashAdListener() {\n @Override\n public void onError(int i, String s) {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(i + \"\", s);\n }\n }\n\n @Override\n public void onTimeout() {\n if (mLoadListener != null) {\n mLoadListener.onAdLoadError(\"\", \"onTimeout\");\n }\n }\n\n @Override\n public void onSplashAdLoad(TTSplashAd ttSplashAd) {\n splashAd = ttSplashAd;\n if (mLoadListener != null) {\n mLoadListener.onAdCacheLoaded();\n }\n }\n }, mFetchAdTimeout);\n }\n });\n\n }\n\n @Override\n public boolean isAdReady() {\n return splashAd != null;\n }\n\n @Override\n public void show(Activity activity, ViewGroup container) {\n if (splashAd != null) {\n splashAd.setSplashInteractionListener(PangleSplashAdapter.this);\n View splashView = splashAd.getSplashView();\n if (splashView != null) {\n container.addView(splashView);\n }\n }\n }\n\n @Override\n public String getNetworkName() {\n return PangleInitManager.getInstance().getNetworkName();\n }\n\n @Override\n public void destory() {\n\n }\n\n @Override\n public String getNetworkPlacementId() {\n return slotId;\n }\n\n @Override\n public String getNetworkSDKVersion() {\n return PangleInitManager.getInstance().getNetworkVersion();\n }\n\n @Override\n public void onAdClicked(View view, int i) {\n if (mImpressionListener != null) {\n mImpressionListener.onSplashAdClicked();\n }\n\n }\n\n @Override\n public void onAdShow(View view, int i) {\n if (mImpressionListener != null) {\n mImpressionListener.onSplashAdShow();\n }\n\n }\n\n @Override\n public void onAdSkip() {\n if (mImpressionListener != null) {\n mImpressionListener.onSplashAdDismiss();\n }\n }\n\n @Override\n public void onAdTimeOver() {\n if (mImpressionListener != null) {\n mImpressionListener.onSplashAdDismiss();\n }\n }\n\n}","is_draft":"0","editor_type":"2","file_path":"","add_time":"1783421044","update_time":"1783477705"},"pure_content":"1. Implementation of Splash Ad Abstract Methods and Ad Event Callbacks\n1.1 Additional Abstract Methods Required for Splash Ad\n\n\n\n Method\n Parameters\n Return Value\n Description\n Required\n\n\n\n\n show\n Act"}],"content":{"icon":"","desc":"","content_id":"862983","add_time":"1783421010","update_time":"1783421010","content":"","is_traffic_less":"0","file_type":""},"hot_list":[],"user_read_num":"0","is_auth":"0"},"msg":"Success","code":200}