TopOnAd

Hierarchy

TopOnAd

Index

Constructors

constructor

Properties

toponAd

Methods

Constructors

constructor

new TopOnAd(): TopOnAd

Returns TopOnAd

Properties

toponAd: TopOnAd | undefined

Methods

deniedUploadDeviceInfo

deniedUploadDeviceInfo(deniedInfo: string): void

en

Limit the collection of private data,

For iOS see https://docs.toponad.com/#/zh-cn/ios/ios_doc/ios_sdk_init_access?id=_6-%e9%9a%90%e7%a7%81%e6%95%b0%e6% 8d%ae%e8%af%b4%e6%98%8e

Android see https://docs.toponad.com/#/zh-cn/android/android_doc/android_sdk_init_access

zh

限制隐私数据收集，

iOS 参见 https://docs.toponad.com/#/zh-cn/ios/ios_doc/ios_sdk_init_access?id=_6-%e9%9a%90%e7%a7%81%e6%95%b0%e6%8d%ae%e8%af%b4%e6%98%8e

Android 参见 https://docs.toponad.com/#/zh-cn/android/android_doc/android_sdk_init_access

Parameters
- deniedInfo: string
  
  Restricted privacy name
Returns void

getBanner

getBanner(placementId: string, listener?: BannerListener): Banner

en

Get Banner ad object

zh

获取 Banner 广告对象

Parameters
- placementId: string
  
  placementId
- Optional listener: BannerListener
  
  Callback listener, if it is not passed, it must be displayed by calling the setAdListener method of the returned object, otherwise the advertisement callback will not be accepted
Returns Banner

Advertising target

getGDPRLevel

getGDPRLevel(): GDPRLevel

en

Get the current escalation level

zh

获取当前的上报等级

Returns GDPRLevel

Current escalation level

getInterstitial

getInterstitial(placementId: string, listener?: InterstitialListener): Interstitial

en

Get Interstitial ad object

zh

获取 Interstitial 广告对象

Parameters
- placementId: string
  
  placementId
- Optional listener: InterstitialListener
  
  Callback listener, if it is not passed, it must be displayed by calling the setAdListener method of the returned object, otherwise the advertisement callback will not be accepted
Returns Interstitial

Advertising target

getNative

getNative(placementId: string, listener?: NativeListener): Native

en

Get Native ad object

zh

获取 Native 广告对象

Parameters
- placementId: string
  
  placementId
- Optional listener: NativeListener
  
  Callback listener, if it is not passed, it must be displayed by calling the setAdListener method of the returned object, otherwise the advertisement callback will not be accepted
Returns Native

Advertising target

getRewardVideo

getRewardVideo(placementId: string, listener?: RewardVideoListener): RewardVideo

en

Get RewardVideo ad object

zh

获取 RewardVideo 广告对象

Parameters
- placementId: string
  
  placementId
- Optional listener: RewardVideoListener
  
  Callback listener, if it is not passed, it must be displayed by calling the setAdListener method of the returned object, otherwise the advertisement callback will not be accepted
Returns RewardVideo

Advertising target

getUserLocation

getUserLocation(callback: UserLocationCallback): void

en

Check the current network area

zh

检查当前的网络的区域

Parameters
- callback: UserLocationCallback
  
  Callback
Returns void

initCustomMap

initCustomMap(customMap: ParamMap): void

en

The custom rules of the App are global settings and are valid for all Placements.

Developers can set corresponding custom rules in the traffic grouping in the TopOn background, refer to the traffic grouping instructions (https://docs.toponad.com/#/zh-cn/android/NetworkAccess/SegmentAccess/segment_access_doc.md )

zh

App的自定义规则为全局设置，对全部Placement有效.

开发者可以在TopOn后台的流量分组中设置相应的自定义规则，具体参考流量分组使用说明(https://docs.toponad.com/#/zh-cn/android/NetworkAccess/SegmentAccess/segment_access_doc.md)

Parameters
- customMap: ParamMap
  
  Custom key-value, which can be used to match the advertisement list information issued by the backend in App dimension
Returns void

integrationChecking

integrationChecking(): void

en

Check the integration status of the advertising platform

zh

检查广告平台的集成状态

Returns void

setGDPRLevel

setGDPRLevel(level: GDPRLevel): void

en

Set the reporting level of data under GDPR

zh

设置 GDPR 下数据的上报等级

Parameters
- level: GDPRLevel
  
  level
Returns void

setLogDebug

setLogDebug(debug: boolean): void

en

Set whether there is Debug log output. It is recommended to open during the testing phase to facilitate verification of the advertising callback status

zh

设置是否有Debug日志输出。建议在测试阶段打开，方便验证广告回调状态

Parameters
- debug: boolean
  
  Whether to output log
Returns void

setPlacementCustomMap

setPlacementCustomMap(placmentId: string, customMap: ParamMap): void

en

Only valid for the current Placement, you can add custom rules specific to the Placement on the basis of the App custom rules.

Developers can set corresponding custom rules in the traffic grouping in the TopOn background, refer to the traffic grouping instructions (https://docs.toponad.com/#/zh-cn/android/NetworkAccess/SegmentAccess/segment_access_doc.md )

zh

仅对当前Placement有效，您可以在App自定义规则基础上增加Placement特有的自定义规则.

开发者可以在TopOn后台的流量分组中设置相应的自定义规则，具体参考流量分组使用说明(https://docs.toponad.com/#/zh-cn/android/NetworkAccess/SegmentAccess/segment_access_doc.md)

Parameters
- placmentId: string
  
  Current placementId
- customMap: ParamMap
  
  Custom key-value, which can be used to match the advertisement list information issued by the backend in App dimension
Returns void

showGDPRAuth

showGDPRAuth(): void

en

Display the GDPR authorization page

zh

展示GDPR授权页面

Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns TopOnAd

Properties

toponAd

Methods

deniedUploadDeviceInfo

Parameters

deniedInfo: string

Returns void

getBanner

Parameters

placementId: string

Optional listener: BannerListener

Returns Banner

getGDPRLevel

Returns GDPRLevel

getInterstitial

Parameters

placementId: string

Optional listener: InterstitialListener

Returns Interstitial

getNative

Parameters

placementId: string

Optional listener: NativeListener

Returns Native

getRewardVideo

Parameters

placementId: string

Optional listener: RewardVideoListener

Returns RewardVideo

getUserLocation

Parameters

callback: UserLocationCallback

Returns void

initCustomMap

Parameters

customMap: ParamMap

Returns void

integrationChecking

Returns void

setGDPRLevel

Parameters

level: GDPRLevel

Returns void

setLogDebug

Parameters

debug: boolean

Returns void

setPlacementCustomMap

Parameters

placmentId: string

customMap: ParamMap

Returns void

showGDPRAuth

Returns void