Menu

[NEW] Detailed Parameters of Network

Note:

  1. All Key and Value data types are String.
  2. For Supported Header Bidding Types: Unless otherwise specified, all ad formats (reward video, interstitial, etc.) are supported.
  3. For auth_content: (All Key and Value data types are String) A Key name followed by (required) indicates the advertising platform account management API1. When creating/modifying an advertising platform, this attribute must be passed regardless of whether the report has been enabled.
  4. For app_auth_content: All Key and Value data types are String.
  5. For adsource_token: (All Key and Value data types are String) The parameter following the key name (unique) represents the unique identifier of the third-party platform's ad source. Multiple unique key identifiers combine to form a unique identifier. The unique identifier of an ad source from the same third-party platform cannot be used to create duplicate TopOn ad sources.

Network Firm ID

 Network Firm Name

Supported Header Bidding Types

auth_content 

app_auth_content

 Ad Format

adsource_token 

Note: Unless otherwise specified, all attributes are required.

adsource_token

Enumeration description of the value corresponding to each key
1 Meta S2S Bidding -

app_id

app_token

property_id

 native

unit_id (unique)

unit_type

height

unit_type (Unit Type) Enum: 0 (Native (Self-rendering)); 1 (Native Banner (Template rendering)); 2 (Native (Template rendering)); 3 (Native Banner (Self-rendering));

height (Height, when unit_type=1 required) Enum: 50; 100; 120;

rewarded_video

unit_id (unique)

unit_type

 unit_type (Unit Type) Enum: 1 (Reward Video); 2 (Reward Interstitial);
 banner

unit_id (unique)

size

 size (Ad Source Size) Enum: 320x50; 320x90; 300x250; 
 interstitial

 unit_id (unique)

 -
2 Admob

1.When customizing Admob associations:  C2S Bidding

2.When official aggregating Admob: S2S Bidding

account_id

oauth_key

 app_id native

unit_id (unique)

media_ratio

render_type

template_type

button_type

media_ratio (Media Aspect Ratio) Enum: 0 (Unknown); 1 (Any); 2 (Landscape); 3 (Portrait); 4 (Square); 

render_type (Render Type) Enum: 1 (Self-rendering); 2 (TopOn template rendering); 

template_type (Template Type, when render_type=2 required) Enum: 1 (Picture Left & Text Right (ratio 2:1)); 2 (Text Left & Picture Right (ratio 2:1)); 3 (Picture Above & Text Below (ratio 4:3)); 4 (Text Above & Picture Below (ratio 4:3)); 

button_type (Click Area, when render_type=2 required) Enum: 1 (Full screen); 2 (Only CTA); 
rewarded_video

unit_id (unique)

unit_type

unit_type (Unit Type) Enum: 1 (Reward Video); 2 (Reward Interstitial); 
banner

unit_id (unique)

size

admob_clbn_sw

size (Ad Source Size) Enum: 320x50; 320x100; 300x250; 468x60; 728x90; 

admob_clbn_sw (Collapsible Banner) Enum: 1 (No); 2 (Bottom); 3 (Top); 
interstitial unit_id (unique) -
splash

unit_id (unique)

orientation

orientation (Orientation) Enum: 1 (Portrait); 2 (Landscape); 
3 Inmobi

C2S Bidding

S2S Bidding

username

password

apikey

app_id (required)

 - native

unit_id (unique)

render_type

template_type

button_type

render_type (Render Type) Enum: 1 (Self-rendering); 2 (TopOn template rendering); 

template_type (Template Type, when render_type=2 required) Enum: 1 (Picture Left & Text Right (ratio 2:1)); 2 (Text Left & Picture Right (ratio 2:1)); 3 (Picture Above & Text Below (ratio 4:3)); 4 (Text Above & Picture Below (ratio 4:3)); 

button_type (Click Area, when render_type=2 required) Enum: 1 (Full Screen); 2 (Only CTA); 
rewarded_video

unit_id (unique)

-

banner

unit_id (unique)

size

size (Ad Source Size) Enum: 320x50; 300x250; 
interstitial unit_id (unique) -
5 Applovin None

sdkkey (required)

apikey

 - rewarded_video

zone_id (unique)

-

banner

zone_id (unique)

size

size (Ad Source Size) Enum: 320x50; 300x250; 
interstitial zone_id (unique) -
6 Mintegral S2S Bidding

skey

secret

sdkkey (required)

 appid native

placement_id

unitid (unique)

unit_type

video_muted

video_autoplay

close_button

unit_type (Unit Type) Enum: 0 (Custom Rendering); 1 (Auto Rendering); 

video_muted (Video Muted) Enum: 0 (Yes); 1 (No); 

video_autoplay (Auto Play) Enum: 1 (WiFi); 2 (Never); 3 (Always); 

close_button (Close Button) Enum: 0 (Show); 1 (Hide); 
rewarded_video

placement_id

unitid (unique)

video_muted

video_muted (Video Muted) Enum: 0 (Yes); 1 (No);

banner

placement_id

unitid (unique)

size

size (Ad Source Size) Enum: 320x50; 300x250; 320x90; smar;
interstitial

placement_id

unitid (unique)

video_muted

is_video

is_video (Unit Type) Enum: 0 (Interstitial Image(Offline)); 1 (New Interstitial)

video_muted (Video Muted) Enum: 0 (Yes); 1 (No)
splash

placement_id

unitid (unique)

orientation

allows_skip

countdown

orientation (Orientation) Enum: 1 (Portrait); 2 (Landscape);

allows_skip (Allow Skip) Enum: 0 (No); 1 (Yes)

countdown (Countdown) Enum: 2~10 (Second)
8 Tencent

C2S Bidding

S2S Bidding

 

account_id

secret_key

 

 app_id native

unit_id (unique)

unit_type

video_muted

video_autoplay

video_duration

unit_type (Unit Type) Enum: 1 (News Feed Ads/interNative (Template)); 2 (News Feed Ads/interNative/DrawVideo/Banner (Self-rendering)); 3 (Paster Ads (Template)); 4 (Paster Ads (Self-rendering))

video_muted (Video Muted) Enum: 0 (No); 1 (Yes);

video_autoplay (Auto Play) Enum: 0 (WiFi); 1 (Always); 2 (Never);

video_duration: (Max Video Duration) Enum: 5~61 (Second); 0 (Not Limited);
rewarded_video

 

unit_id (unique)

unit_type

video_muted

video_autoplay

video_duration

 

unit_type (Unit Type) Enum: 1 (Reward Video); 2 (Reward Interstitial);

video_muted (Video Muted) Enum: 0 (No); 1 (Yes);

video_autoplay (Auto Play) Enum: 0 (WiFi); 1 (Always);

video_duration: (Max Video Duration) Enum: 5~61 (Second); 0 (Not Limited);

banner

unit_id (unique)

size

size (Ad Source Size) Enum: 320x50;
interstitial

 

unit_id (unique)

is_fullscreen

video_muted

video_autoplay

video_duration

 

is_fullscreen (Unit Type) Enum: 0 (Interstitial); 1 (Interstitial FullScreen); 

video_muted (Video Muted) Enum: 0 (No); 1 (Yes);

video_autoplay (Auto Play) Enum: 0 (WiFi); 1 (Always); 2 (Never);

video_duration: (Max Video Duration) Enum: 5~61 (Second); 0 (Not Limited); 
splash

 

unit_id (unique)

zoomoutad_sw

 

zoomoutad_sw (ZoomOut Ads) Enum: 1 (No); 2 (Yes); 
9 Chartboost None

 

user_id

user_signature

 

 

app_id

app_signature

 

 rewarded_video

 

location (unique)

 

 -

banner

 

location (unique)

size

 

size (Ad Source Size) Enum: 320x50; 300x250; 728x90
interstitial

 

location (unique)

 

 -
11 Ironsource S2S Bidding

 

username

secret_key

refresh_token

 

 app_key rewarded_video

 

instance_id (unique)

 

-

banner

 

instance_id (unique)

size

 

size (Ad Source Size) Enum: 320x50; 320x90; 300x250; smart;
interstitial

 

instance_id (unique)

 

-
12 UnityAd None

 

apikey

organization_core_id

 

 game_id rewarded_video

placement_id (unique when combined with game_id)

-

banner

placement_id (unique when combined with game_id)

size

 

size (Ad Source Size) Enum: 320x50; 468x60; 728x90;
interstitial

 

placement_id (unique when combined with game_id)

 

-
13 Vungle

S2S Bidding

 

apikey

account_id (required)

 app_id native

placement_id (unique)

render_type

template_type

button_type

render_type (Render Type) Enum: 1 (Self-rendering); 2 (TopOn template rendering);

template_type (Template Type, when render_type=2 required) Enum: 1 (Picture Left & Text Right (ratio 2:1)); 2 (Text Left & Picture Right (ratio 2:1)); 3 (Picture Above & Text Below (ratio 4:3)); 4 (Text Above & Picture Below (ratio 4:3)); 

button_type (Click Area, when render_type=2 required) Enum: 1 (Full Screen); 2 (Only CTA);
rewarded_video

 

placement_id (unique)

 

-

banner

 

placement_id (unique)

size_type

unit_type

 

unit_type (Unit Type) Enum: 0 (Banner); 1 (MREC); 2 (Inline);

size_type (Ad Source Size) Enum: 0 (300x250); 2 (320x50); 3 (300x50); 4 (728x90); 5 (Custom Size)

 

Note:

When unit_type=0: size_type only 2; 3; 4; 

When unit_type=1: size_type only 0
interstitial

 

placement_id (unique)

 

 

-
splash

 

placement_id (unique)

 

-
14 AdColony S2S Bidding

 

user_credentials

 

 app_id rewarded_video

 

zone_id (unique)

 

-

banner

 

zone_id (unique)

size

 

size (Ad Source Size) Enum: 320x50; 300x250; 728x90; 160x600;
interstitial

 

zone_id (unique)

 

 -
15 CSJ C2S Bidding

 

user_id

role_id

secure_key

 

 app_id native

slot_id (unique)

is_video

layout_type

is_video (Unit Type) Enum: 0 (Native Feeds); 1 (Native Draw Video); 2 (Banner Native(Self-rendering)); 3 (Interstitial Native(Self-rendering)); 4 (Self-rendering patch); 

layout_type (Rendering Type, when is_video=0/1 required, in other cases simply send 0.) Enum: 0 (Template rendering); 1 (Self-rendering); 
rewarded_video

 

slot_id (unique)

personalized_template

 

personalized_template (Rendering Type) Enum: 0 (Self-rendering); 1 (Template Rendering); 

banner

 

slot_id (unique)

layout_type

size

 

layout_type (Ad Source Type) Enum: 1 (Banner); 

size (Ad placement size ratio) Enum: 640x100 (320x50); 600x90 (300x45); 600x150 (300x75); 600x500 (300x250); 600x400 (300x200); 600x300 (300x150); 600x260 (300x130); 690x388 (345x194)
interstitial

 

slot_id (unique)

 

 -
splash

 

slot_id (unique)

zoomoutad_sw

 

zoomoutad_sw (ZoomOut Ads) Enum: 1 (No); 2 (Yes); 
22 Baidu C2S Bidding (Banner not supported)

 

access_key

 

 app_id native

ad_place_id (unique)

unit_type

video_autoplay

cta_button

button_type

dl_type

unit_type (Native Type) Enum: 0 (Return Element); 1 (Optimized Self-Rendering); 2 (Optimized Preferred-Template); 3 (Draw Video); 

video_autoplay (Auto Play, when unit_type=3 required) Enum: 1 (Yes/Default); 2 (No); 

cta_button (CTA Button, when unit_type=1 required) Enum: 0 (Default); 1 (Yes/Show); 2 (No/Hide); 

button_type (Click Area, when unit_type=1 required) Enum: 0 (Default); 1 (Full Screen); 2 (Only CTA); 

dl_type (App Download Settings, when unit_type=1 required) Enum: 0 (Default); 1 (Confirm Pop-up No); 2 (Confirm Pop-up Yes); 
rewarded_video

ad_place_id (unique)

-

banner (Offline. If you wish to continue using this service, please consult Baidu.)

ad_place_id (unique)

-
interstitial

ad_place_id (unique)

unit_type

 

unit_type (Unit Type) Enum: 1 (Full Screen Video); 2 (Express Interstitial); 

 
splash

ad_place_id (unique)

-
28 Kuaishou Ads

C2S Bidding

S2S Bidding

 

access_key

security_key

account_id (required)

 

app_id

app_name

 native

position_id (unique)

unit_type

layout_type

shake_type

unit_type (Unit Type) Enum: 0 (Native Feeds); 1 (Draw Video); 

layout_type (Native Type, when unit_typ=0 required) Enum: 0 (Self-Rendering); 1 (Template); 

shake_type (Shake Type, when layout_type=1 required) Enum: 1 (On); 2 (Off); 
rewarded_video

position_id (unique)

orientation

video_muted

orientation (Orientation) Enum: 1 (Portrait); 2 (Landscape); 

video_muted (Video Muted) Enum: 0 (No); 1 (Yes);
banner

position_id (unique)

size

size (Ad Source Size) Enum: 320x50; 300x45;
interstitial

position_id (unique)

is_video

video_muted

orientation

is_video (Unit Type) Enum: 0 (New Interstitial); 1 (Full Screen Video); 

video_muted (Video Muted) Enum: 0 (No); 1 (Yes);

orientation (Orientation) Enum: 1 (Portrait); 2 (Landscape); 
splash

position_id (unique)

-
29 Sigmob

C2S Bidding

 

public_key

secret_key

 

app_id

app_key

 native

placement_id (unique)

-
rewarded_video

placement_id (unique)

 -
interstitial

placement_id (unique)

 -
splash

placement_id (unique)

-
34 Yandex S2S Bidding

 

-

 

 - native

unit_id (unique)

unit_type

unit_type (Native Type) Enum: 0 (Native Self-rendering); 1 (Native Template rendering); 
rewarded_video

unit_id (unique)

-

banner

unit_id (unique)

size 

size (Ad Source Size) Enum: 1 (240x400); 2 (300x250); 3 (300x300); 4 (320x100); 5 (320x50); 6 (400x240); 7 (728x90); 8 (Full_Screen);
interstitial

unit_id (unique)

- 
splash

unit_id (unique)

-
37 Fyber None

 

publisher_id

consumer_key

consumer_secret

 

 app_id rewarded_video

spot_id (unique)

-

banner

spot_id (unique)

-
interstitial

spot_id (unique)

video_muted

video_muted (Video Muted) Enum: 0 (No); 1 (Yes);
39 Huawei Ads C2S Bidding

 

-

 

client_id

client_secret

 native

ad_id (unique)

orientation

video_muted

multi_img

orientation (Image Orientation) Enum: 0 (Any); 1 (Portrait); 2 (Landscape); 

video_muted (Video Muted) Enum: 0 (Yes); 1 (No);

multi_img (Multi Image) Enum: 1 (Yes); 2 (No); 
rewarded_video

ad_id (unique)

-

banner

ad_id (unique)

size

size (Ad Source Size) Enum: 320x50; 320x100; 300x250; 360x57; 360x144; smart; 468x60; 728x90;
interstitial

ad_id (unique)

-
splash

ad_id (unique)

-
50 Pangle S2S Bidding

 

user_id

secure_key

 

 app_id native

slot_id (unique)

render_type

template_type

button_type

render_type (Render Type) Enum: 1 (Self-rendering); 2 (TopOn template rendering);

template_type (Template Type, when render_type=2 required) Enum: 1 (Picture Left & Text Right (ratio 2:1)); 2 (Text Left & Picture Right (ratio 2:1)); 3 (Picture Above & Text Below (ratio 4:3)); 4 (Text Above & Picture Below (ratio 4:3)); 

button_type (Click Area, when render_type=2 required) Enum: 1 (Full Screen); 2 (Only CTA); 
rewarded_video

slot_id (unique)

-

banner

slot_id (unique)

size

size (Ad Source Size) Enum: 300x250; 320x50;
interstitial

slot_id (unique)

-
splash

slot_id (unique)

-
59 Bigo S2S Bidding

 

developer_id

token

 

 app_id native

slot_id (unique)

render_type

template_type

button_type

render_type (Render Type) Enum: 1 (Self-rendering); 2 (TopOn template rendering);

template_type (Template Type, when render_type=2 required) Enum: 1 (Picture Left & Text Right (ratio 2:1)); 2 (Text Left & Picture Right (ratio 2:1)); 3 (Picture Above & Text Below (ratio 4:3)); 4 (Text Above & Picture Below (ratio 4:3)); 

button_type (Click Area, when render_type=2 required) Enum: 1 (Full Screen); 2 (Only CTA); 
rewarded_video

slot_id (unique)

-

banner

 

slot_id (unique)

size

 

size (Ad Source Size) Enum: 320x50; 300x250;
interstitial

slot_id (unique)

-
splash

slot_id (unique)

-

 

Previous
Detailed Parameters of Network
Next
Header Bidding Support List
Last modified: 2025-08-25Powered by