Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AdInfo

Hierarchy

  • AdInfo

Index

Properties

Properties

adsource_id

adsource_id: string
en

Advertising source ID. The specific network information can be queried through the advertising source ID in the developer background or TopOn Open API

zh

广告源 ID. 可在开发者后台或 TopOn Open API 通过广告源 ID 查询具体的 Network 信息

adsource_index

adsource_index: number
en

The current ranking of ad sources in WaterFall (starting from 0, 0 has the highest priority)

zh

当前广告源在 WaterFall 中的排序（从0开始，0优先级最高）

adsource_isheaderbidding

adsource_isheaderbidding: 1 | 2
en

Whether it is the advertising source of the head bidding, 1: Yes, 2: No

zh

是否为头部竞价的广告源，1：是，2：否

adsource_price

adsource_price: number
en

eCPM, currency acquisition, precision can be acquired through precision

zh

eCPM，currency 获取, 精度可通过 precision 获取

adunit_format

adunit_format: "Native" | "RewardedVideo" | "Banner" | "Interstitial" | "Splash"
en

Advertising types, including: "Native", "RewardedVideo", "Banner", "Interstitial", "Splash"

zh

广告类型，包括："Native"、"RewardedVideo"、"Banner"、"Interstitial"、"Splash"

adunit_id

adunit_id: string
en

TopOn Advertising Slot ID

zh

TopOn 广告位ID

channel

channel: string
en

Channel information

zh

渠道信息

country

country: string
en

Country code, for example: "CN"

zh

国家代码， 例如：”CN"

currency

currency: string
en

Currency unit, for example: "USD"

zh

货币单位，例如："USD"

custom_rule

custom_rule: {}
en

Custom rules of Placement+App dimension

zh

Placement+App维度的自定义规则

Type declaration

  • [name: string]: any

ecpm_level

ecpm_level: number
en

Ad slot ID of the advertising platform

zh

广告源的eCPM层级(对应开发者后台聚合管理页面的优先级），头部竞价广告源默认为0

ext_info

ext_info: { creative_id: string; is_deeplink: 0 | 1; network_ecpm: string; network_id: string; network_unit_id: string; offer_id: string }
en

Advertising custom information, for Adx, OnlineAPI and custom advertising platform, Adx, OnlineAPI related key reference

zh

广告的自定义信息，针对Adx、OnlineAPI以及自定义广告平台，Adx、OnlineAPI相关Key参考

Type declaration

  • [name: string]: any
  • creative_id: string
    en

    Material ID of Adx & OnlineAPI Offer

    zh

    Adx & OnlineAPI Offer的素材 ID

  • is_deeplink: 0 | 1
    en

    Determine whether the order type of Adx & OnlineAPI Offer is a Deeplink or JumpURL order 0: No, 1: Yes

    zh

    判断Adx & OnlineAPI Offer的单子类型是否为Deeplink或JumpURL的单子 0: 否、1: 是

  • network_ecpm: string
  • network_id: string
  • network_unit_id: string
  • offer_id: string
    en

    Advertising ID of Adx & OnlineAPI Offer

    zh

    Adx & OnlineAPI Offer的广告 ID

id

id: number
en

A unique ID generated every time an ad is displayed

zh

每次展示广告时生成的独立ID

network_firm_id

network_firm_id: number
en

The ID corresponding to the advertising platform, used to distinguish the advertising platform. Refer to https://docs.toponad.com/#/zh-cn/android/android_doc/android_sdk_callback_access?id=network_firm_id

zh

广告平台对应的ID，用于区分广告平台，参考 https://docs.toponad.com/#/zh-cn/android/android_doc/android_sdk_callback_access?id=network_firm_id

network_placement_id

network_placement_id: string
en
zh

广告平台的广告位 ID

network_type

network_type: "Network" | "Cross_Promotion" | "Adx"
en

Network type

"Network": Third-party advertising platform

"Cross_Promotion": Interactive promotion

"Adx": TopOn Adx

zh

Network类型

"Network"：第三方广告平台

"Cross_Promotion"：交互推广

"Adx"：TopOn Adx

precision

precision: "publisher_defined" | "estimated" | "exact"
en

ECPM accuracy

"publisher_defined": The eCPM defined by the developer for the advertising source in the TopOn backend (cross-promotion eCPM also belongs to this type)

"estimated": The eCPM calculated by TopOn based on historical data after the automatic price function of advertising sources is turned on in the TopOn background

"exact": eCPM for real-time bidding

zh

ECPM精度

"publisher_defined"：开发者在TopOn后台为广告源定义的eCPM（交叉推广的eCPM也属于该类型)

"estimated": 在TopOn后台开启广告源的自动价格功能后，TopOn根据历史数据计算出的eCPM

"exact"：实时竞价的eCPM

publisher_revenue

publisher_revenue: number
en

Display income, the unit can be obtained by currency, and the precision can be obtained by precision

zh

展示收益，单位可通过 currency 获取， 精度可通过 precision 获取

reward_custom_data

reward_custom_data: {}

Type declaration

  • [name: string]: any

scenario_id

scenario_id: string
en
zh

广告场景 ID，仅 RewardVideo、Interstitial 支持

scenario_reward_name

scenario_reward_name: string
en

Ad scene ID, only supported by RewardVideo and Interstitial

zh

广告场景的激励名称，仅 RewardeVideo 支持

scenario_reward_number

scenario_reward_number: number
en

The number of incentives for advertising scenes, only supported by RewardVideo

zh

广告场景的激励数量，仅 RewardVideo 支持

segment_id

segment_id: number
en

Traffic group ID

zh

流量分组 ID

sub_channel

sub_channel: string
en

Json string of custom rule of Placement+App dimension

zh

Placement+App维度的自定义规则的Json字符串

Generated using TypeDoc