{"data":{"id":"76368","string_id":"tJxKa0","status":"1","parent_id":"76196","slug":"9Xhkol","order":"3","name":"Cocos Creator Guide","type":"1","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","author":"","published_time":"1709722574","add_time":"1709721702","update_time":"1753862366","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":"511705","string_id":"IY9tc567","status":"1","parent_id":"76368","slug":"Cocos-SDK-API-Migration-Guide","order":"7","name":"Cocos SDK API Migration Guide","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1749033512","add_time":"1749033512","update_time":"1749035723","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"511705","content":"---\n## File Name Changes\n\n| Old File | New File |\n| --------------------------- | ---------------------- |\n| ATJSSDK.ts | ATSDK.ts |\n| ATBannerTSSDK.ts | ATBanner.ts |\n| ATIntersitialTSSDK.ts | ATInterstitial.ts |\n| ATIntersitialAutoTSSDK.ts | ATInterstitialAuto.ts |\n| ATNativeTSSDK.ts | ATNative.ts |\n| ATRewardedVideoTSSDK.ts | ATRewardedVideo.ts |\n| ATRewardedAutoVideoTSSDK.ts | ATRewardedAutoVideo.ts |\n\n---\n\n## ATSDK Migration\n\n- **Import Changes**\n\n```typescript\n\/\/ Old\nimport { ATJSSDK } from \".\/ATJSSDK\";\n\n\/\/ New\nimport { ATSDK } from \".\/ATSDK\";\n```\n\n- **No changes in function names**\n\n---\n\n## ATBanner Migration\n\n- **Import Changes**\n\n```typescript\n\/\/ Old\nimport { ATBannerTSSDK } from \".\/ATBannerTSSDK\";\n\n\/\/ New\nimport { ATBannerSDK } from \".\/ATBanner\";\n```\n\n- **Function Name Changes**\n\n| Old Function (ATBannerTSSDK) | New Function (ATBannerSDK) | Description |\n| ---------------------------------- | ---------------------------- | -------------- |\n| loadBanner | loadAd | Function renamed |\n| - | showAdInPositionAndScenario | New function |\n| - | showAdInRectangleAndScenario | New function |\n| All other functions remain unchanged | | |\n\n---\n\n## ATInterstitial Migration\n\n- **Import Changes**\n\n```typescript\n\/\/ Old\nimport { ATIntersitialTSSDK } from \".\/ATIntersitialTSSDK\";\n\n\/\/ New\nimport { ATInterstitialSDK } from \".\/ATInterstitial\";\n```\n\n- **Function Name Changes**\n\n| Old Function (ATIntersitialTSSDK) | New Function (ATInterstitialSDK) | Description |\n| ---------------------------------- | ------------------------------ | -------------- |\n| loadInterstitial | loadAd | Function renamed |\n| - | entryAdScenario | New function |\n| All other functions remain unchanged | | |\n\n---\n\n## ATInterstitialAuto Migration\n\n- **Import Changes**\n\n```typescript\n\/\/ Old\nimport { ATIntersitialAutoTSSDK } from \".\/ATIntersitialAutoTSSDK\";\n\n\/\/ New\nimport { ATInterstitialAutoAdSDK } from \".\/ATInterstitialAuto\";\n```\n\n- **Function Name Changes**\n\n| Old Function (ATIntersitialAutoTSSDK) | New Function (ATInterstitialAutoAdSDK) | Description |\n| ----------------------------------- | ------------------------------------ | ----------- |\n| - | entryAdScenario | New function |\n| All other functions remain unchanged | | |\n\n---\n\n## ATNative Migration\n\n- **Import Changes**\n\n```typescript\n\/\/ Old\nimport { ATNativeTSSDK } from \".\/ATNativeTSSDK\";\n\n\/\/ New\nimport { ATNativeSDK } from \".\/ATNative\";\n```\n\n- **Function Name Changes**\n\n| Old Function (ATNativeTSSDK) | New Function (ATNativeSDK) | Description |\n| ---------------------------------- | ------------------------ | -------------- |\n| loadNative | loadAd | Function renamed |\n| - | entryAdScenario | New function |\n| All other functions remain unchanged | | |\n\n- **Class Changes**\n\nThe `AdViewProperty` class remains unchanged, but should now be imported from `ATNative`:\n\n```typescript\n\/\/ Old\nimport { AdViewProperty } from \".\/ATNativeTSSDK\";\n\n\/\/ New\nimport { AdViewProperty } from \".\/ATNative\";\n```\n\n---\n\n## ATRewardedVideo Migration\n\n- **Import Changes**\n\n```typescript\n\/\/ Old\nimport { ATRewardedVideoTSSDK } from \".\/ATRewardedVideoTSSDK\";\n\n\/\/ New\nimport { ATRewardedVideoSDK } from \".\/ATRewardedVideo\";\n```\n\n- **Function Name Changes**\n\n| Old Function (ATRewardedVideoTSSDK) | New Function (ATRewardedVideoSDK) | Description |\n| ---------------------------------- | ------------------------------- | -------------- |\n| loadRewardedVideo | loadAd | Function renamed |\n| - | entryAdScenario | New function |\n| All other functions remain unchanged | | |\n\n---\n\n## ATRewardedAutoVideo Migration\n\n- **Import Changes**\n\n```typescript\n\/\/ Old\nimport { ATRewardedAutoVideoTSSDK } from \".\/ATRewardedAutoVideoTSSDK\";\n\n\/\/ New\nimport { ATRewardedVideoAutoAdSDK } from \".\/ATRewardedAutoVideo\";\n```\n\n- **Function Name Changes**\n\n| Old Function (ATRewardedAutoVideoTSSDK) | New Function (ATRewardedVideoAutoAdSDK) | Description |\n| ------------------------------------- | ------------------------------------- | ----------- |\n| - | entryAdScenario | New function |\n| All other functions remain unchanged | | |\n\n---\n\n

\ud83d\udccc Migration Example Code<\/summary>\n\n```typescript\n\/\/ Initialize SDK\n\/\/ Old\nimport { ATJSSDK } from \".\/ATJSSDK\";\nATJSSDK.initSDK(\"appId\", \"appKey\");\n\/\/ New\nimport { ATSDK } from \".\/ATSDK\";\nATSDK.initSDK(\"appId\", \"appKey\");\n\n\/\/ Load Banner Ad\n\/\/ Old\nimport { ATBannerTSSDK } from \".\/ATBannerTSSDK\";\nATBannerTSSDK.loadBanner(\"placementId\", settings);\n\/\/ New\nimport { ATBannerSDK } from \".\/ATBanner\";\nATBannerSDK.loadAd(\"placementId\", settings);\n\n\/\/ Load Interstitial Ad\n\/\/ Old\nimport { ATIntersitialTSSDK } from \".\/ATIntersitialTSSDK\";\nATIntersitialTSSDK.loadInterstitial(\"placementId\", settings);\n\/\/ New\nimport { ATInterstitialSDK } from \".\/ATInterstitial\";\nATInterstitialSDK.loadAd(\"placementId\", settings);\n\n\/\/ Load Native Ad\n\/\/ Old\nimport { ATNativeTSSDK } from \".\/ATNativeTSSDK\";\nATNativeTSSDK.loadNative(\"placementId\", settings);\n\/\/ New\nimport { ATNativeSDK } from \".\/ATNative\";\nATNativeSDK.loadAd(\"placementId\", settings);\n\n\/\/ Load Rewarded Video Ad\n\/\/ Old\nimport { ATRewardedVideoTSSDK } from \".\/ATRewardedVideoTSSDK\";\nATRewardedVideoTSSDK.loadRewardedVideo(\"placementId\", settings);\n\/\/ New\nimport { ATRewardedVideoSDK } from \".\/ATRewardedVideo\";\nATRewardedVideoSDK.loadAd(\"placementId\", settings);\n```\n\n<\/details>\n\n---\n\n## Summary\n\nMain migration changes:\n\n1. File names are simplified, removing the \"TSSDK\" suffix\n2. Main loading functions are unified as `loadAd`\n3. Some modules add the new `entryAdScenario` function\n4. Access to classes and constants remains unchanged, but they should be imported from the new modules\n\n---","pure_content":"File Name Changes\n\n\n\n Old File\n New File\n\n\n\n\n ATJSSDK.ts\n ATSDK.ts\n\n\n ATBannerTSSDK.ts\n ATBanner.ts\n\n\n ATIntersitialTSSDK.ts\n ATInterstitial.ts\n\n\n ATIntersitialAutoTSSDK.ts\n ATInterstitialAuto.ts\n\n\n ATNativeTSSDK.ts\n ATNative.ts\n\n\n ATRewardedVideoTSSDK.ts\n ATRewardedVideo.ts\n\n\n ATRewardedAutoVideoTSSDK.ts\n ATRewardedAutoVideo.ts\n\n\n\n\nATSDK Migration\n\n\nImport Changes\n\n\n\/\/ Old\nimport { ATJSSDK } from \".\/ATJSSDK\";\n\n\/\/ New\nimport { ATSDK } from \".\/ATSDK\";\n\n\n\nNo changes in function names\n\n\n\nATBanner Migration\n\n\nImport Changes\n\n\n\/\/ Old\nimport { ATBannerTSSDK } from \".\/ATBannerTSSDK\";\n\n\/\/ New\nimport { ATBannerSDK } from \".\/ATBanner\";\n\n\n\nFunction Name Changes\n\n\n\n\n\n Old Function (ATBannerTSSDK)\n New Function (ATBannerSDK)\n Description\n\n\n\n\n loadBanner\n loadAd\n Function renamed\n\n\n -\n showAdInPositionAndScenario\n New function\n\n\n -\n showAdInRectangleAndScenario\n New function\n\n\n All other functions remain unchanged\n \n \n\n\n\n\nATInterstitial Migration\n\n\nImport Changes\n\n\n\/\/ Old\nimport { ATIntersitialTSSDK } from \".\/ATIntersitialTSSDK\";\n\n\/\/ New\nimport { ATInterstitialSDK } from \".\/ATInterstitial\";\n\n\n\nFunction Name Changes\n\n\n\n\n\n Old Function (ATIntersitialTSSDK)\n New Function (ATInterstitialSDK)\n Description\n\n\n\n\n loadInterstitial\n loadAd\n Function renamed\n\n\n -\n entryAdScenario\n New function\n\n\n All other functions remain unchanged\n \n \n\n\n\n\nATInterstitialAuto Migration\n\n\nImport Changes\n\n\n\/\/ Old\nimport { ATIntersitialAutoTSSDK } from \".\/ATIntersitialAutoTSSDK\";\n\n\/\/ New\nimport { ATInterstitialAutoAdSDK } from \".\/ATInterstitialAuto\";\n\n\n\nFunction Name Changes\n\n\n\n\n\n Old Function (ATIntersitialAutoTSSDK)\n New Function (ATInterstitialAutoAdSDK)\n Description\n\n\n\n\n -\n entryAdScenario\n New function\n\n\n All other functions remain unchanged\n \n \n\n\n\n\nATNative Migration\n\n\nImport Changes\n\n\n\/\/ Old\nimport { ATNativeTSSDK } from \".\/ATNativeTSSDK\";\n\n\/\/ New\nimport { ATNativeSDK } from \".\/ATNative\";\n\n\n\nFunction Name Changes\n\n\n\n\n\n Old Function (ATNativeTSSDK)\n New Function (ATNativeSDK)\n Description\n\n\n\n\n loadNative\n loadAd\n Function renamed\n\n\n -\n entryAdScenario\n New function\n\n\n All other functions remain unchanged\n \n \n\n\n\n\n\nClass Changes\n\n\nThe AdViewProperty class remains unchanged, but should now be imported from ATNative:\n\/\/ Old\nimport { AdViewProperty } from \".\/ATNativeTSSDK\";\n\n\/\/ New\nimport { AdViewProperty } from \".\/ATNative\";\n\n\nATRewardedVideo Migration\n\n\nImport Changes\n\n\n\/\/ Old\nimport { ATRewardedVideoTSSDK } from \".\/ATRewardedVideoTSSDK\";\n\n\/\/ New\nimport { ATRewardedVideoSDK } from \".\/ATRewardedVideo\";\n\n\n\nFunction Name Changes\n\n\n\n\n\n Old Function (ATRewardedVideoTSSDK)\n New Function (ATRewardedVideoSDK)\n Description\n\n\n\n\n loadRewardedVideo\n loadAd\n Function renamed\n\n\n -\n entryAdScenario\n New function\n\n\n All other functions remain unchanged\n \n \n\n\n\n\nATRewardedAutoVideo Migration\n\n\nImport Changes\n\n\n\/\/ Old\nimport { ATRewardedAutoVideoTSSDK } from \".\/ATRewardedAutoVideoTSSDK\";\n\n\/\/ New\nimport { ATRewardedVideoAutoAdSDK } from \".\/ATRewardedAutoVideo\";\n\n\n\nFunction Name Changes\n\n\n\n\n\n Old Function (ATRewardedAutoVideoTSSDK)\n New Function (ATRewardedVideoAutoAdSDK)\n Description\n\n\n\n\n -\n entryAdScenario\n New function\n\n\n All other functions remain unchanged\n \n \n\n\n\n\n\ud83d\udccc Migration Example Code\n\/\/ Initialize SDK\n\/\/ Old\nimport { ATJSSDK } from \".\/ATJSSDK\";\nATJSSDK.initSDK(\"appId\", \"appKey\");\n\/\/ New\nimport { ATSDK } from \".\/ATSDK\";\nATSDK.initSDK(\"appId\", \"appKey\");\n\n\/\/ Load Banner Ad\n\/\/ Old\nimport { ATBannerTSSDK } from \".\/ATBannerTSSDK\";\nATBannerTSSDK.loadBanner(\"placementId\", settings);\n\/\/ New\nimport { ATBannerSDK } from \".\/ATBanner\";\nATBannerSDK.loadAd(\"placementId\", settings);\n\n\/\/ Load Interstitial Ad\n\/\/ Old\nimport { ATIntersitialTSSDK } from \".\/ATIntersitialTSSDK\";\nATIntersitialTSSDK.loadInterstitial(\"placementId\", settings);\n\/\/ New\nimport { ATInterstitialSDK } from \".\/ATInterstitial\";\nATInterstitialSDK.loadAd(\"placementId\", settings);\n\n\/\/ Load Native Ad\n\/\/ Old\nimport { ATNativeTSSDK } from \".\/ATNativeTSSDK\";\nATNativeTSSDK.loadNative(\"placementId\", settings);\n\/\/ New\nimport { ATNativeSDK } from \".\/ATNative\";\nATNativeSDK.loadAd(\"placementId\", settings);\n\n\/\/ Load Rewarded Video Ad\n\/\/ Old\nimport { ATRewardedVideoTSSDK } from \".\/ATRewardedVideoTSSDK\";\nATRewardedVideoTSSDK.loadRewardedVideo(\"placementId\", settings);\n\/\/ New\nimport { ATRewardedVideoSDK } from \".\/ATRewardedVideo\";\nATRewardedVideoSDK.loadAd(\"placementId\", settings);\n\n\n\nSummary\nMain migration changes:\n\nFile names are simplified, removing the \"TSSDK\" suffix\nMain loading functions are unified as loadAd\n\nSome modules add the new entryAdScenario function\nAccess to classes and constants remains unchanged, but they should be imported from the new modules","is_draft":"0","editor_type":"2","file_path":"","add_time":"1749033513","update_time":"1749035239"},"pure_content":"File Name Changes\n\n\n\n Old File\n New File\n\n\n\n\n ATJSSDK.ts\n ATSDK.ts\n\n\n ATBannerTSSDK.ts\n ATBanner.ts\n\n\n ATIntersitialTSSDK.ts\n ATInterstitial.ts\n\n\n ATIntersitialAutoTSSDK.ts\n ATInterstitialAuto.ts"},{"id":"511706","string_id":"71c1D1sD","status":"1","parent_id":"76368","slug":"Integration-BNOC","order":"6","name":"Integration","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1749033514","add_time":"1749033514","update_time":"1749036119","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"511706","content":"---\n\n1. SDK Download\n\nYou can download it from [here](https:\/\/app.takuad.com\/m\/sdk\/download?type=CocosCreator).\n\n![](https:\/\/resource-wangsu.helplook.net\/docker_production\/h6wabu\/article\/71c1D1sD\/684022e388dcb.png)\n\n---\n\n2. SDK Import\n\n> \u26a0\ufe0f Note: **CocosCreator SDK must be used together with the Android or iOS SDK**\n\n**Description of the downloaded package directory:**\n\n| Folder | Description |\n|---|---|\n| Android | SDK package required for Android integration |\n| iOS | SDK package required for iOS integration |\n| Android\\_iOS | SDK package required for both Android & iOS |\n\n**Platform directory description:**\n\n| Folder\/File Name | Description |\n|---|---|\n| Script | TypeScript code files to be imported into the Cocos Creator project |\n| bridge\/iOS | Bridge code files for Xcode project, to be added to your game's Xcode project |\n| bridge\/Android | Bridge code files for Android Studio project, including source (source dir) and aar package (library dir); choose as needed for your game's Android project |\n\n### 2.1 Android Import Instructions\n\n(1) In the SDK package, select the

*_cocosjs_bridge.aar<\/code> under the Android platform and place it in the project's libs<\/code> directory, then import it via build.gradle<\/code>:\n\n```gradle\ndependencies {\n    api fileTree(include: ['*.jar','*.aar'], dir: 'libs')\n}\n```\n\nAlternatively, you can use the source code by placing it in the project's src\/main\/java<\/code> directory. In this case, you need to add the following ProGuard rules:\n\n```text\n-keep public class com.**.cocosjs.**\n-keepclassmembers class com.**.cocosjs.** {\n   public *;\n}\n```>\n```\n\n(2) Please visit [here](https:\/\/app.takuad.com\/m\/sdk\/download?type=Android) for more details. For integration instructions, refer to [here](https:\/\/help.takuad.com\/en\/docs\/vxp6Qy).\n\n### 2.2 iOS Import Instructions\n\n(1) Drag the iOSCocosCreatorBridge<\/code> folder into the file list on the left side of Xcode. In the pop-up dialog, make the following selections (as shown in the figure):\n\n- Check \"Copy items if needed\" under Destination\n- Check \"Create groups\" under Added Folders\n- Check the target(s) you want to add under Add to targets\n\n![](https:\/\/resource-wangsu.helplook.net\/docker_production\/h6wabu\/article\/71c1D1sD\/6756aa8319c28.png)\n\n(2) Please visit [here](https:\/\/app.takuad.com\/m\/sdk\/download?type=iOS) for more details. For integration instructions, refer to [here](https:\/\/help.takuad.com\/en\/docs\/UC0qle).\n\n---\n\n3. SDK Initialization\n---------------------\n\n```typescript\nimport {ATSDK} from \"db:\/\/assets\/script\/AnyThinkAds\/ATSDK\";\n\n\/\/ ---------------GDPR Initialization Flow start------------------------------\n\/*ATSDK.getUserLocation(function (userLocation: string | number) {\n    if (userLocation === ATSDK.kATUserLocationInEU) {\n        if (ATSDK.getGDPRLevel() === ATSDK.UNKNOWN) {\n            ATSDK.showGDPRConsent(function () {\n                ATSDK.initSDK(\"your app id\", \"your app key\");\n            });\n        }\n    }\n});*\/\n\/\/ ---------------GDPR Initialization Flow end------------------------------\n\nATSDK.initSDK(\"your app id\", \"your app key\");\n```\n\n---","pure_content":"SDK Download\n\nYou can download it from here.\n\n\n\nSDK Import\n\n\n\u26a0\ufe0f Note: CocosCreator SDK must be used together with the Android or iOS SDK\n\nDescription of the downloaded package directory:\n\n\n\n Folder\n Description\n\n\n\n\n Android\n SDK package required for Android integration\n\n\n iOS\n SDK package required for iOS integration\n\n\n Android_iOS\n SDK package required for both Android & iOS\n\n\n\nPlatform directory description:\n\n\n\n Folder\/File Name\n Description\n\n\n\n\n Script\n TypeScript code files to be imported into the Cocos Creator project\n\n\n bridge\/iOS\n Bridge code files for Xcode project, to be added to your game's Xcode project\n\n\n bridge\/Android\n Bridge code files for Android Studio project, including source (source dir) and aar package (library dir); choose as needed for your game's Android project\n\n\n\n2.1 Android Import Instructions\n(1) In the SDK package, select the *_cocosjs_bridge.aar under the Android platform and place it in the project's libs directory, then import it via build.gradle:\ndependencies {\n    api fileTree(include: ['*.jar','*.aar'], dir: 'libs')\n}\n\nAlternatively, you can use the source code by placing it in the project's src\/main\/java directory. In this case, you need to add the following ProGuard rules:\n-keep public class com.**.cocosjs.**\n-keepclassmembers class com.**.cocosjs.** {\n   public *;\n}\n```>\n\n(2) Please visit here for more details. For integration instructions, refer to here.\n2.2 iOS Import Instructions\n(1) Drag the iOSCocosCreatorBridge folder into the file list on the left side of Xcode. In the pop-up dialog, make the following selections (as shown in the figure):\n\nCheck \"Copy items if needed\" under Destination\nCheck \"Create groups\" under Added Folders\nCheck the target(s) you want to add under Add to targets\n\n\n(2) Please visit here for more details. For integration instructions, refer to here.\n\n\nSDK Initialization\n\n\nimport {ATSDK} from \"db:\/\/assets\/script\/AnyThinkAds\/ATSDK\";\n\n\/\/ ---------------GDPR Initialization Flow start------------------------------\n\/*ATSDK.getUserLocation(function (userLocation: string | number) {\n    if (userLocation === ATSDK.kATUserLocationInEU) {\n        if (ATSDK.getGDPRLevel() === ATSDK.UNKNOWN) {\n            ATSDK.showGDPRConsent(function () {\n                ATSDK.initSDK(\"your app id\", \"your app key\");\n            });\n        }\n    }\n});*\/\n\/\/ ---------------GDPR Initialization Flow end------------------------------\n\nATSDK.initSDK(\"your app id\", \"your app key\");","is_draft":"0","editor_type":"2","file_path":"","add_time":"1749033515","update_time":"1749036119"},"pure_content":"SDK Download\n\nYou can download it from here.\n\n\n\nSDK Import\n\n\n\u26a0\ufe0f Note: CocosCreator SDK must be used together with the Android or iOS SDK\n\nDescription of the downloaded package directory:\n\n\n\n Folder"},{"id":"511707","string_id":"7Ix6gI0L","status":"1","parent_id":"76368","slug":"k2kNX8qn","order":"5","name":"Ad Formats","type":"1","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1749033515","add_time":"1749033515","update_time":"1749035724","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","pure_content":""},{"id":"511713","string_id":"daOb2vup","status":"1","parent_id":"76368","slug":"The-Callback-Info-ETeQ","order":"4","name":"The Callback Info","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1749033523","add_time":"1749033523","update_time":"1749035724","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"511713","content":"---\n\n## ATCallbackInfo\n\n| Variable                  | Type                      | Description                                                  |\n| ------------------------- | ------------------------- | ------------------------------------------------------------ |\n| network\\_firm\\_id         | int                       | Get the ID corresponding to the network to distinguish between networks |\n| adsource\\_id              | string                    | Get the ad source ID. You can query specific Network information through the ad source ID in the TopOn dashboard |\n| adsource\\_index           | int                       | Get the current ad source's order in the WaterFall **(starting from 0)** |\n| adsource\\_price           | double                    | Get ECPM, the unit can be obtained through getCurrency()     |\n| adsource\\_isheaderbidding | int                       | Whether it is a header bidding ad source, **1: Yes, 2: No**  |\n| id                        | string                    | Get the unique ID generated each time **an ad is displayed** |\n| publisher\\_revenue        | double                    | Get display revenue                                          |\n| currency                  | string                    | Get currency unit, e.g., \"USD\"                               |\n| country                   | string                    | Get country code, e.g., \"CN\"                                 |\n| adunit\\_id                | string                    | Get TopOn ad unit ID                                         |\n| adunit\\_format            | string                    | Get ad type, including: **\"Native\", \"RewardedVideo\", \"Banner\", \"Interstitial\", \"Splash\"** |\n| precision                 | string                    | Get ECPM precision 
 **\"publisher\\_defined\"**: eCPM defined by the developer for the ad source in the TopOn dashboard **(eCPM for interactive promotion also belongs to this type)** 
**\"estimated\":** TopOn's estimated eCPM (auto eCPM)
 **\"exact\"**: Header Bidding real-time bidding eCPM (excluding Meta) 
**\"ecpm\\_api\"**: Effective for Meta ad sources, estimated historical eCPM API based on Meta's ReportAPI data. |\n| network\\_type             | string                    | Get Network type
 **\"Network\"**: Third-party advertising platform
 **\"Cross\\_Promotion\"**: Interactive promotion
 **\"Adx\"**: Adx |\n| network\\_placement\\_id    | string                    | Get Network's ad placement ID                                |\n| ecpm\\_level               | int                       | Get the eCPM level of the ad source, **header bidding ad sources default to 0** |\n| segment\\_id               | int                       | Get traffic grouping ID                                      |\n| scenario\\_id              | string                    | Get ad scenario ID, **only supported by Rewarded Video & Interstitial** |\n| scenario\\_reward\\_name    | string                    | Get the reward name of the ad scenario, **only supported by Rewarded Video** |\n| scenario\\_reward\\_number  | int                       | Get the reward quantity of the ad scenario, **only supported by Rewarded Video** |\n| sub\\_channel              | string                    | Get sub-channel information                                  |\n| channel                   | string                    | Get channel information                                      |\n| custom\\_rule              | Dictionary | Get the custom rule **Json string** for **Placement+App dimension** |\n| getOriginJSONString()     | string                    | Original JSON string information                             |\n\n---","pure_content":"ATCallbackInfo\n\n\n\n Variable\n Type\n Description\n\n\n\n\n network_firm_id\n int\n Get the ID corresponding to the network to distinguish between networks\n\n\n adsource_id\n string\n Get the ad source ID. You can query specific Network information through the ad source ID in the TopOn dashboard\n\n\n adsource_index\n int\n Get the current ad source's order in the WaterFall (starting from 0)\n\n\n adsource_price\n double\n Get ECPM, the unit can be obtained through getCurrency()\n\n\n adsource_isheaderbidding\n int\n Whether it is a header bidding ad source, 1: Yes, 2: No\n\n\n id\n string\n Get the unique ID generated each time an ad is displayed\n\n\n publisher_revenue\n double\n Get display revenue\n\n\n currency\n string\n Get currency unit, e.g., \"USD\"\n\n\n country\n string\n Get country code, e.g., \"CN\"\n\n\n adunit_id\n string\n Get TopOn ad unit ID\n\n\n adunit_format\n string\n Get ad type, including: \"Native\", \"RewardedVideo\", \"Banner\", \"Interstitial\", \"Splash\"\n\n\n precision\n string\n Get ECPM precision  \"publisher_defined\": eCPM defined by the developer for the ad source in the TopOn dashboard (eCPM for interactive promotion also belongs to this type) \"estimated\": TopOn's estimated eCPM (auto eCPM) \"exact\": Header Bidding real-time bidding eCPM (excluding Meta) \"ecpm_api\": Effective for Meta ad sources, estimated historical eCPM API based on Meta's ReportAPI data.\n\n\n network_type\n string\n Get Network type \"Network\": Third-party advertising platform \"Cross_Promotion\": Interactive promotion \"Adx\": Adx\n\n\n network_placement_id\n string\n Get Network's ad placement ID\n\n\n ecpm_level\n int\n Get the eCPM level of the ad source, header bidding ad sources default to 0\n\n\n segment_id\n int\n Get traffic grouping ID\n\n\n scenario_id\n string\n Get ad scenario ID, only supported by Rewarded Video & Interstitial\n\n\n scenario_reward_name\n string\n Get the reward name of the ad scenario, only supported by Rewarded Video\n\n\n scenario_reward_number\n int\n Get the reward quantity of the ad scenario, only supported by Rewarded Video\n\n\n sub_channel\n string\n Get sub-channel information\n\n\n channel\n string\n Get channel information\n\n\n custom_rule\n Dictionary\n Get the custom rule Json string for Placement+App dimension\n\n\n getOriginJSONString()\n string\n Original JSON string information","is_draft":"0","editor_type":"2","file_path":"","add_time":"1749033524","update_time":"1749035700"},"pure_content":"ATCallbackInfo\n\n\n\n Variable\n Type\n Description\n\n\n\n\n network_firm_id\n int\n Get the ID corresponding to the network to distinguish between networks\n\n\n adsource_id\n string\n Get the ad source ID. You can"},{"id":"511714","string_id":"rJEVLzwi","status":"1","parent_id":"76368","slug":"How-to-Test-DYEq","order":"3","name":"How to Test","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1749033524","add_time":"1749033524","update_time":"1752230853","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"511714","content":"---\n\n## 1. Enable Log Debug Mode\n\n> **Note:** You need to turn off the log function before the app releases.\n\n```typescript\nimport { ATSDK } from \"db:\/\/assets\/script\/AnyThinkAds\/ATSDK\";\n\nATSDK.setLogDebug(true);\n```\n\n---\n\n## 2. Debugger Tool\n\n### **\u25cf How to Import**\n\n-   [Android](https:\/\/help.takuad.com\/en\/docs\/Test-Tool-Beta)\n-   [iOS](https:\/\/help.takuad.com\/en\/docs\/Testing-tools-Beta)\n\n**\u25cf How to Use**\n\n```typescript\nimport { ATSDK } from \"db:\/\/assets\/script\/AnyThinkAds\/ATSDK\";\n\nATSDK.showDebuggerUI(\"your debug key\");\n```\n\n- For more details, please refer to [Android](https:\/\/help.takuad.com\/en\/docs\/Test-Tool-Beta#3._Use_of_test_tools), [iOS](https:\/\/help.takuad.com\/en\/docs\/Testing-tools-Beta#3._Use_of_test_tools)\n\n---\n## 3. FAQ\n \n\n\u25cf During the process of displaying pop-up ads, press the home button to exit to the background, and then click on the application logo to return. If the ad is missing or there is no callback\n \n\nCheck the Manifest.xml configuration of the startup activity of the application, and the launchMode needs to be standard. Add the following code to the onCreate () method that starts the activity\uff1a\n@Override\nprotected void onCreate(Bundle savedInstanceState) {\n    super.onCreate(savedInstanceState);\n    ......\n    if ((getIntent().getFlags() & Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT) != 0) {\n        finish();\n        return;\n    }\n    ......\n}\n \n> **Note:** Android project needs to be exported for processing","pure_content":"1. Enable Log Debug Mode\n\nNote: You need to turn off the log function before the app releases.\n\nimport { ATSDK } from \"db:\/\/assets\/script\/AnyThinkAds\/ATSDK\";\n\nATSDK.setLogDebug(true);\n\n\n2. Debugger Tool\n\u25cf How to Import\n\n\nAndroid\n\n\niOS\n\n\n\u25cf How to Use\nimport { ATSDK } from \"db:\/\/assets\/script\/AnyThinkAds\/ATSDK\";\n\nATSDK.showDebuggerUI(\"your debug key\");\n\n\nFor more details, please refer to Android, iOS\n\n\n\n3. FAQ\n\u25cf During the process of displaying pop-up ads, press the home button to exit to the background, and then click on the application logo to return. If the ad is missing or there is no callback\nCheck the Manifest.xml configuration of the startup activity of the application, and the launchMode needs to be standard. Add the following code to the onCreate () method that starts the activity\uff1a\n@Override\nprotected void onCreate(Bundle savedInstanceState) {\nsuper.onCreate(savedInstanceState);\n......\nif ((getIntent().getFlags() & Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT) != 0) {\nfinish();\nreturn;\n}\n......\n}\n\nNote: Android project needs to be exported for processing","is_draft":"0","editor_type":"2","file_path":"","add_time":"1749033525","update_time":"1752230853"},"pure_content":"1. Enable Log Debug Mode\n\nNote: You need to turn off the log function before the app releases.\n\nimport { ATSDK } from \"db:\/\/assets\/script\/AnyThinkAds\/ATSDK\";\n\nATSDK.setLogDebug(true);\n\n\n2. Debugger T"},{"id":"511716","string_id":"QGOapUZS","status":"1","parent_id":"76368","slug":"Fully-automatic-loading-DHBB","order":"2","name":"Fully automatic loading","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1749033527","add_time":"1749033527","update_time":"1749035919","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"511716","content":"> **\ud83d\udca1Tips**\n>\n> - The fully automatic loading mode is a one-stop request maintenance solution launched by TopOn. It can intelligently determine the timing for preloading and caching the next ad at multiple nodes based on the user's usage status and the progress of ad consumption. While adhering to your operational strategies, it avoids the risks of real-time ad data loading failures and wasted display opportunities, reducing the negative impact on users due to ads not loading or loading smoothly. With the fully automatic loading solution, you can avoid repetitive and cumbersome manual intervention in the request process, resulting in immediately noticeable efficiency improvements.\n\n---\n\n## \u25cf Rewarded Ads\n\n---\n\n### 1.Loading a Rewarded Ad\n\n```typescript\nimport {ATRewardedVideoAutoAdSDK} from \"db:\/\/assets\/script\/AnyThinkAds\/ATRewardedAutoVideo\";\n\nlet rewardedIds: string[] = [\"your placement id1\", \"your placement id2\"];\nATRewardedVideoAutoAdSDK.addPlacementIds(rewardedIds);\n```\n\n---\n\n### 2. Setting the Listener\n\n```typescript\nprivate AutoRewardedVideoListener = {\n    onRewardedVideoAdLoaded: (placementId: any) => {\n        console.log(\"onRewardedVideoAdLoaded\", placementId)\n    },\n    onRewardedVideoAdFailed: (placementId: any, errorInfo: any) => {\n        console.log(\"onRewardedVideoAdFailed\", placementId, errorInfo)\n    },\n    onRewardedVideoAdPlayStart: (placementId: any, callbackInfo: any) => {\n        console.log(\"onRewardedVideoAdPlayStart\", placementId, callbackInfo)\n    },\n    onRewardedVideoAdPlayEnd: (placementId: any, callbackInfo: any) => {\n        console.log(\"onRewardedVideoAdPlayEnd\", placementId, callbackInfo)\n    },\n    onRewardedVideoAdPlayFailed: (placementId: any, errorInfo: any, callbackInfo: any) => {\n        console.log(\"onRewardedVideoAdPlayFailed\", placementId, callbackInfo, errorInfo)\n    },\n    onRewardedVideoAdClosed: (placementId: any, callbackInfo: any) => {\n        console.log(\"onRewardedVideoAdClosed\", placementId, callbackInfo)\n    },\n    onRewardedVideoAdPlayClicked: (placementId: any, callbackInfo: any) => {\n        console.log(\"onRewardedVideoAdPlayClicked\", placementId)\n    },\n    onReward: (placementId: any, callbackInfo: any) => {\n        console.log(\"onReward\", placementId, callbackInfo)\n    }\n};\n\nATRewardedVideoAutoAdSDK.setAdListener(this.AutoRewardedVideoListener);\n```\n\n---\n\n### 3. Showing a Rewarded Ad\n\n\n```typescript\nATRewardedVideoAutoAdSDK.entryAdScenario(\"your placement id\", \"your scenario id\")\nif (ATRewardedVideoAutoAdSDK.hasAdReady(\"your placement id\")) {\n    ATRewardedVideoAutoAdSDK.showAdInScenario(\"your placement id\", \"your scenario id\");\n}\n```\n\n---\n\n## \u25cf Interstitial Ads\n\n---\n\n### 1. Loading an Interstitial Ad\n\n```typescript\nimport {ATInterstitialAutoAdSDK} from \"db:\/\/assets\/script\/AnyThinkAds\/ATInterstitialAuto\";\n\nlet InterstitialIds: string[] = [\"your placement id1\"\uff0c \"your placement id2\"];\nATInterstitialAutoAdSDK.addPlacementIds(InterstitialIds);\n```\n\n---\n\n### 2. Setting the Listener\n\n\n```typescript\nprivate AutoInterstitialListener = {\n    onInterstitialAdLoaded: (placementId: any) => {\n        console.log(\"onInterstitialAdLoaded\", placementId);\n    },\n    onInterstitialAdLoadFail: (placementId: any, errorInfo: any) => {\n        console.log(\"onInterstitialAdLoadFail\", placementId, errorInfo);\n    },\n    onInterstitialAdShow: (placementId: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdShow\", placementId, callbackInfo);\n    },\n    onInterstitialAdStartPlayingVideo: (placementId: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdStartPlayingVideo\", placementId, callbackInfo);\n    },\n    onInterstitialAdEndPlayingVideo: (placementId: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdEndPlayingVideo\", placementId, callbackInfo);\n    },\n    onInterstitialAdFailedToPlayVideo: (placementId: any, errorInfo: any) => {\n        console.log(\"onInterstitialAdFailedToPlayVideo\", placementId, errorInfo);\n    },\n    onInterstitialAdFailedToShow: (placementId: any, errorInfo: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdFailedToShow\", placementId, callbackInfo, errorInfo);\n    },\n    onInterstitialAdClose: (placementId: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdClose\", placementId, callbackInfo);\n    },\n    onInterstitialAdClick: (placementId: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdClick\", placementId, callbackInfo);\n    }\n};\n\nATInterstitialAutoAdSDK.setAdListener(this.AutoInterstitialListener);\n```\n\n---\n\n### 3. Showing an Interstitial Ad\n\n\n```typescript\nATInterstitialAutoAdSDK.entryAdScenario(\"your placement id\", \"your scenario id\");\nif (ATInterstitialAutoAdSDK.hasAdReady(\"your placement id\")) {\n    ATInterstitialAutoAdSDK.showAdInScenario(\"your placement id\", \"your scenario id\");\n}\n```\n\n---","pure_content":"\ud83d\udca1Tips\n\nThe fully automatic loading mode is a one-stop request maintenance solution launched by TopOn. It can intelligently determine the timing for preloading and caching the next ad at multiple nodes based on the user's usage status and the progress of ad consumption. While adhering to your operational strategies, it avoids the risks of real-time ad data loading failures and wasted display opportunities, reducing the negative impact on users due to ads not loading or loading smoothly. With the fully automatic loading solution, you can avoid repetitive and cumbersome manual intervention in the request process, resulting in immediately noticeable efficiency improvements.\n\n\n\n\u25cf Rewarded Ads\n\n1.Loading a Rewarded Ad\nimport {ATRewardedVideoAutoAdSDK} from \"db:\/\/assets\/script\/AnyThinkAds\/ATRewardedAutoVideo\";\n\nlet rewardedIds: string[] = [\"your placement id1\", \"your placement id2\"];\nATRewardedVideoAutoAdSDK.addPlacementIds(rewardedIds);\n\n\n2. Setting the Listener\nprivate AutoRewardedVideoListener = {\n    onRewardedVideoAdLoaded: (placementId: any) => {\n        console.log(\"onRewardedVideoAdLoaded\", placementId)\n    },\n    onRewardedVideoAdFailed: (placementId: any, errorInfo: any) => {\n        console.log(\"onRewardedVideoAdFailed\", placementId, errorInfo)\n    },\n    onRewardedVideoAdPlayStart: (placementId: any, callbackInfo: any) => {\n        console.log(\"onRewardedVideoAdPlayStart\", placementId, callbackInfo)\n    },\n    onRewardedVideoAdPlayEnd: (placementId: any, callbackInfo: any) => {\n        console.log(\"onRewardedVideoAdPlayEnd\", placementId, callbackInfo)\n    },\n    onRewardedVideoAdPlayFailed: (placementId: any, errorInfo: any, callbackInfo: any) => {\n        console.log(\"onRewardedVideoAdPlayFailed\", placementId, callbackInfo, errorInfo)\n    },\n    onRewardedVideoAdClosed: (placementId: any, callbackInfo: any) => {\n        console.log(\"onRewardedVideoAdClosed\", placementId, callbackInfo)\n    },\n    onRewardedVideoAdPlayClicked: (placementId: any, callbackInfo: any) => {\n        console.log(\"onRewardedVideoAdPlayClicked\", placementId)\n    },\n    onReward: (placementId: any, callbackInfo: any) => {\n        console.log(\"onReward\", placementId, callbackInfo)\n    }\n};\n\nATRewardedVideoAutoAdSDK.setAdListener(this.AutoRewardedVideoListener);\n\n\n3. Showing a Rewarded Ad\nATRewardedVideoAutoAdSDK.entryAdScenario(\"your placement id\", \"your scenario id\")\nif (ATRewardedVideoAutoAdSDK.hasAdReady(\"your placement id\")) {\n    ATRewardedVideoAutoAdSDK.showAdInScenario(\"your placement id\", \"your scenario id\");\n}\n\n\n\u25cf Interstitial Ads\n\n1. Loading an Interstitial Ad\nimport {ATInterstitialAutoAdSDK} from \"db:\/\/assets\/script\/AnyThinkAds\/ATInterstitialAuto\";\n\nlet InterstitialIds: string[] = [\"your placement id1\"\uff0c \"your placement id2\"];\nATInterstitialAutoAdSDK.addPlacementIds(InterstitialIds);\n\n\n2. Setting the Listener\nprivate AutoInterstitialListener = {\n    onInterstitialAdLoaded: (placementId: any) => {\n        console.log(\"onInterstitialAdLoaded\", placementId);\n    },\n    onInterstitialAdLoadFail: (placementId: any, errorInfo: any) => {\n        console.log(\"onInterstitialAdLoadFail\", placementId, errorInfo);\n    },\n    onInterstitialAdShow: (placementId: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdShow\", placementId, callbackInfo);\n    },\n    onInterstitialAdStartPlayingVideo: (placementId: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdStartPlayingVideo\", placementId, callbackInfo);\n    },\n    onInterstitialAdEndPlayingVideo: (placementId: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdEndPlayingVideo\", placementId, callbackInfo);\n    },\n    onInterstitialAdFailedToPlayVideo: (placementId: any, errorInfo: any) => {\n        console.log(\"onInterstitialAdFailedToPlayVideo\", placementId, errorInfo);\n    },\n    onInterstitialAdFailedToShow: (placementId: any, errorInfo: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdFailedToShow\", placementId, callbackInfo, errorInfo);\n    },\n    onInterstitialAdClose: (placementId: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdClose\", placementId, callbackInfo);\n    },\n    onInterstitialAdClick: (placementId: any, callbackInfo: any) => {\n        console.log(\"onInterstitialAdClick\", placementId, callbackInfo);\n    }\n};\n\nATInterstitialAutoAdSDK.setAdListener(this.AutoInterstitialListener);\n\n\n3. Showing an Interstitial Ad\nATInterstitialAutoAdSDK.entryAdScenario(\"your placement id\", \"your scenario id\");\nif (ATInterstitialAutoAdSDK.hasAdReady(\"your placement id\")) {\n    ATInterstitialAutoAdSDK.showAdInScenario(\"your placement id\", \"your scenario id\");\n}","is_draft":"0","editor_type":"2","file_path":"","add_time":"1749033528","update_time":"1749035918"},"pure_content":"\ud83d\udca1Tips\n\nThe fully automatic loading mode is a one-stop request maintenance solution launched by TopOn. It can intelligently determine the timing for preloading and caching the next ad at multiple node"}],"content":{"icon":"","desc":"","content_id":"76368","add_time":"1709721702","update_time":"1709722574","content":"","is_traffic_less":"0","file_type":""},"hot_list":[],"user_read_num":"0","is_auth":"0"},"msg":"Success","code":200}