En
Ru Id
API
Effective date: Jan 2024

1. Budget - Xtend-DSP RTB Integration (DSP)

 

1.1 Overview

 

This document provides instructions for the integration of Xtend system with external DSP system. It describes the requirements and steps needed to enable interface connection based on open RTB.

 

1.2 Steps for Integration

 

To enable DSP to connect with Midas, the steps include:

1. Sign contract: Mutual agreement contract between Xtend and DSP.

2. Register DSP account: Contact Xtend Operations PIC to register DSP account in Midas system in order to receive the token. Note: Currently Midas doesn't support auto-registration, and it is necessary to contact Xtend and provide relevant information in order to complete the account registration.

3. Proceed to system integration set-up: DSP needs to follow this document to build interface and set up integration. If there is any issue encountered during the process, Midas will provide Product and Tech PIC to support and solve the issue accordingly.

4. Test: After integration is set up, DSP and Midas need to arrange testing for the integration and make adjustments when necessary.

5. Live: After test completes, Xtend PIC from business team will follow up with official launch of integrated online traffic and start to record cost.

 

1.3  Real Time Bid

 

1.3.1 Data Transmission

 

The connection between DSP and Midas follows HTTP communication protocol, to send Bid Request via POST mode as the content for HTTP request, and use data in JSON format.

 

1.3.2 HTTP Request

 

HTTP POST mode is used to send Bid Request, instead of HTTP GET mode, as it enables more content to be attached and supports binary data better.

 

Request thread

 Name

 Value

 Remark

 x-openrtb-version

 2.5

 open rtb version

 

 

1.3.3 HTTP Response

 

If Midas is participating in bid / auction, HTTP response status code should be 200, which allows it to return to Bid Request. If not, HTTP response status code should be 204.

 

1.3.4 Display Volume and Cost Calculation

 

The billing is based on the number of displays reported in the WinNotice (default winnotice is in nurl, if the DSP does not support nurl, it is in burl) link statistics when the bid is won, so you need to replace the {AUCTION_PRICE} macro in the winnotice url when the bid is won.

DSP needs to ensure that at most one ad is reported for impression at a time; and that the reported display is within the validity of the impression delay required by Xtend.

Xtend limits the impression delay by using the bidresponse.seatbid.bid.exp field.

 

1.3.5 Precautions

 

If the following fields in the request body are empty, the Xtend platform will consider the request as invalid and will not be populated.

bid.imp[].tagid: DSP's ad space identifier

bid.app.bundle: package name information of the traffic source

bid.device.ifa: unique identifier allowed for advertisers, explicitly stated; Android passes gaid, iOS passes idfa

bid.device.ua: User-Agent field in the HTTP request header of the user's device

bid.device.ip: ip address of the user's current network

bid.device.geo.country: the country of the user's current network, using ISO-3166-1-alpha-3

 

1.4 Real Time Bid RTB Interface Parameter

 

1.4.1 Bid Request

 

 

 Parameter name

 Type

 Required?

 Description

 id

 string

 Yes

 The only identification for Bid Request

 imp

 object array

 Yes

 1 request can include only 1 impression object at a time, which represents a specific ad display placement/position. Details can be found in imp object parameter definition below

 app

 object

 Yes

 App object info of DSP, recommended to use only on app instead of website. Details can be found in app object parameter definition below

 device

 object

 Yes

 Device info. Details can be found in device object parameter definition below

 user

 object

 No

 Device user / Ad audience. Details can be found in user object parameter definition below

 at

 integer

 Yes

 Bid settlement auction type. Value of 1 means it follows First-price auction, while value of 2 means it follows Second-price plus auction.

 badv

 string array

 No

 Domain name in blacklist

 bapp

 string array

 No

 App name in blacklist.On Android, these should be bundle or package names (e.g., com.foo.mygame). On iOS, these are numeric IDs.

 regs

 object

 No

 Any industry, legal, or governmental regulations in force

 

 

4.1.1 imp object

 

 

Parameter name

Type

Required?

Description

id

string

Yes

The only identification in a Bid Request for the specific display traffic sold. 1 request can include only 1 display traffic at a time

tagid

string

Yes

Fixed identification of each specific ad display placement/position

native

object

Yes for Native traffic

Refer to native object (Supports only Native ad placement)

banner

object

Yes for Banner traffic

Refer to banner object

video

object

Yes for Video traffic

Refer to video object

audio

object

Yes for Audio traffic

Refer to audio object

exp

integer

No

Duration that may elapse between the auction and the actual display / impression.Unit is in seconds

secure

integer

No

Parameter to indicate if Bid Request needs HTTPS encrypted info and markup to ensure data privacy.Value of 0 means it doesn't need. Value of 1 means it needs. If left blank, means unknown, i.e. it doesn't need encryption

bid floor

float

No

Minimum CPM bid price for this display traffic

bidfloorcur

string

Yes

Bid price currency, currently it only supports USD

 

 

4.1.2 banner object

 

 

Parameter name

Type

Required?

Description

id

string

No

Unique identifier for this banner object. Recommended when Banner objects are used with a Video object to represent an array of companion ads. Values usually start at 1 and increase with each object; should be unique within an impression.

w

integer

Yes

Exact width in device independent pixels (DIPS); If not specified wmin and wmax , this value refers to the required display width, otherwise refers to the desired width

h

integer

Yes

Exact height in device independent pixels (DIPS); If not specified hmin and hmax , this value refers to the required display height, otherwise refers to the desired height

pos

integer

No

Ad position on screen. Section 5.5 Ad Placement/Position Attribute is the reference of its enumerated values

mimes

string array

Yes

Content MIME types supported. Popular MIME types may include "application/x-shockwave-flash", “image/jpg”, and “image/gif”SHAREit support "image/jpg""image/png", and "image/gif"

ext

object

No

Placeholder for exchange-specific extensions to OpenRTB

 

 

4.1.3 native object

 

 

Parameter name

Type

Required?

Description

request

string

Yes

Request must follow Native ad specification. Refer to native request object for details

ver

string

Yes

Use Dynamic Native Ads API version, default version is 1.2

api

integer array

No

Supported API frame of the display. Section 5.4 API frame is the reference of its enumerated values. Default setting of this parameter is that it doesn't support any enumerated value, unless specified

battr

integer array

No

Restrictions of material attributes. Section 5.3 Creative attribute list is the reference of its enumerated values

 

 

4.1.4 native request object

 

 

Parameter name

Type

Required?

Description

assets

object array

Yes

Use asset request object to show the requirement of Native ad for assets and other elements. All assets and other elements should follow this request object

ver

string

Yes

Native Markup version, default version is 1.2

context

integer

No

Ad context. Section 5.10 Context Type IDs is the reference of its enumerated values

contextsubtype

integer

No

Ad context in more details. Section 5.11 Context Sub Type IDs is the reference of its enumerated values

 

 

4.1.5 asset request object

 

 

Parameter name

Type

Required?

Description

id

integer

Yes

The only identification ID of the object

required

integer

Yes

Indicate if the asset object is a must-have for client (bidder) in order to get a bid accepted. Value of 1 means yes. Value of 0 means it is not necessary

title

object

No

Title object for title assets. Refer to title object

img

object

No

Image object for image assets. Refer to img object

video

object

No

Video object for video assets. Refer to video object

data

object

No

Data object for data assets, eg. brand, description, rating, pricing etc.Refer to data object

 

 

4.1.6 title object

 

 

Parameter name

Type

Required?

Description

len

integer

Yes

Maximum title text length. Recommended text length is 25, 90, 140 characters

 

 

4.1.7 img object

 

 

Parameter name

Type

Required?

Description

type

integer

Yes

Indicate the specific type of image. Icon image: Value = 1 Large image: Value = 3

w

integer

No

Image width

wmin

integer

Yes

Minimum image width. Unit is in pixels

h

integer

No

Image height / length

hmin

integer

Yes

Minimum image height / length. Unit is in pixels

mimes

string array

No

Supported image mime-type, including but not limited to ‘image/jpg’and ‘image/gif’

 

 

4.1.8 video object

 

 

Parameter name

Type

Required?

Description

mimes

string array

Yes

Supported content mime-type. Currently it only supports ‘video/mp4’

minduration

integer

Yes

Minimum video ad length. Unit is in seconds

maxduration

integer

Yes

Maximum video ad length. Unit is in seconds

protocols

integer array

Yes

Applicable video protocol for DSP in Bid Response. Currently it only supports type 3, i.e. vast 3.0 protocol

 

 

4.1.9 data object

 

 

Parameter name

Type

Required?

Description

type

string array

Yes

Indicate data object type ID. Each data object has a specific type. Section 5.12 Data Asset Type is the reference of its enumerated values

len

integer

Yes

Maximum number of characters allowed

 

 

4.1.10 app object

 

 

Parameter name

Type

Required?

Description

id

string

No

Internal definition of app ID

name

string

No

Internal definition of app name

bundle

string

Yes

App package name info

domain

string

No

App domain name, eg. mygame.foo.com

cat

string array

No

App IAB category.Section 5.1 IAB category is the reference of its enumerated values

ver

string

No

App version

DSP

object

Yes

DSP info.Refer to DSP object

 

 

4.1.11 DSP object

 

 

Parameter name

Type

Required?

Description

id

string

Yes

DSP ID, to apply for token info

name

string

No

DSP name

domain

string

No

DSP's highest domain name, eg. ‘DSP.com’

cat

string array

No

App IAB category. Section 5.1 IAB category is the reference of its enumerated values

 

 

4.1.12 device object

 

 

Parameter name

Type

Required?

Description

ua

string

Yes

User-Agent field in HTTP request thread of user device

ip

string

Yes

ipv4 address of user's current network

geo

object

Yes

Current geographic info of user. Refer to geo object

didsha1

string

No

Hardware device ID (eg. IMEI), via SHA1 hash

didmd5

string

No

Hardware device ID (eg. IMEI), via MD5 hash

dpidsha1

string

No

Platform device ID (eg. Android ID), via SHA1 hash

dpidmd5

string

No

Platform device ID (eg. Android ID), via MD5 hash

macsha1

string

No

Device MAC address, via SHA1 hash

macmd5

string

No

Device MAC address, via MD5 hash

make

string

No

Device manufacturer (eg. ‘Apple’)

model

string

No

Device model (eg. ‘iPhone’)

os

string

Yes

Operation system (eg. Android, iOS)

osv

string

No

Operation system version

language

string

No

Device language, following ISO-639-1-alpha-2. If unknown, put ‘unknown’

connectiontype

integer

No

Network connection mode. Section 5.8 Network Connection Mode is the reference of its enumerated values

devicetype

integer

No

Device type. Section 5.7 Device type is the reference of its enumerated values

h

integer

No

Screen physical height / length.Unit is in pixels

w

integer

No

Screen physical width.Unit is in pixels

js

integer

No

Indicate if js is supported. Value of 0 means not supported. Value of 1 means supported.

ppi

integer

No

Screen size.Unit is in pixel per inch

dnt

integer

No

‘Do Not Track’ identification set by browser in HTTP thread. Value of 0 means tracking is not restricted. Value of 1 means tracking is restricted / not allowed.

lmt

integer

No

Indicate user's authorization for ad tracking. Value of 0 means tracking is not restricted. Value of 1 means tracking is restricted / not allowed.

ifa

string

Yes

Identification used by client.Andorid: gaid, iOS: idfa

mccmnc

string

No

Mobile network carrier

 

 

4.1.13 geo object

 

 

Parameter name

Type

Required?

Description

lat

float

No

Latitude info, data range is (-90.0,+90.0). Negative value means South

lon

float

No

Longitude info, data range is (-180.0,+180.0). Negative value means West.

type

integer

No

Source type of geo info. Value of 1 means by GPS/Location service. Value of 2 means by IP address. Value of 3 means provided by user.Section 5.13 Location Typeis the reference of its enumerated values

accuracy

integer

No

Accuracy in meters. When latitude/longitude info is obtained by GPS/Location service, this field is reported.

ipservice

integer

No

IP address provider, applicable for type = 2.Section **5.14 IP Location Type **is the reference of its enumerated values

country

string

Yes

Country code following ISO-3166-1-alpha-3

region

string

No

Region code following ISO-3166-2.If country is USA, 2-letter state code is used

city

string

No

City code following UN/LOCODE

zip

string

No

Postal code

utcoffset

integer

No

Local time difference from UTC time, +/- in minutes

 

 

4.1.14 user object

 

 

Parameter name

Type

Required?

Description

id

string

No

User ID

buyeruid

string

No

User ID defined by buyer

gender

string

No

Gender. Value of M means male, F means female, 0 means other gender.

geo

object

No

User geo info

yob

integer

No

Year of birth, 4-digit number.

keywords

string

No

Keywords list of user's interests / intentions list, separated by comma (,)

customdata

string

No

Customized data

data

object array

No

Extra user data. Each data object represents a different data source

 

 

4.1.15 data object

 

 

Parameter name

Type

Required?

Description

id

string

No

ID of data provider

name

string

No

Name of data provider

segment

object array

No

Data segment that includes the actual data info.Refer to segment object

 

 

4.1.16 segment object

 

 

Parameter name

Type

Required?

Description

id

string

No

Segment ID defined by data provider

name

string

No

Segment name defined by data provider

value

string

No

Segment value

 

 

4.2 Bid Response

 

 

Parameter name

Type

Required?

Description

id

string

Yes

Identification for Bid Request, i.e. request id included in Bid Request section above

seatbid

object array

Yes

One set of SeatBid object. If a bid is offered, at least one SeatBid is filled in

bidid

string

No

Response ID generated for each bidder, assisting with logs or tracking transaction

cur

string

No

Unit of bid currency used, code following ISO-4217. If left blank, USD is used by default

ext

object

No

Placeholder for bidder-specific extensions to OpenRTB

 

 

4.2.1 seatbid object

 

Midas only supports 1 seatbid object to be responded at a time, and 1 seatbid only supports 1 bid to be responded.

 

 

Parameter name

Type

Required?

Description

bid

object array

Yes

Array that includes at least 1 bid object. Each object is related to 1 display / impression

seat

string

No

Seat identification that represents the client (bidder, eg. advertiser, agency) on whose behalf this bid is made

group

interger

No

Indicate if all bids can win or fail at the same time. Default value is 0, meaning independent bid is allowed. Value of 1 means a group of bids win or fail at the same time.

ext

object

No

Placeholder for bidder-specific extensions to OpenRTB

 

 

4.2.2 bid object

 

Each bid object must have a corresponding imp id, indicating the bid is offered for the specific impression.

 

 

Parameter name

Type

Required?

Description

id

string

Yes

Bid ID generated for each bidder, used for recording logs or tracking acitivity

impid

string

Yes

ID of imp object related to a Bid request

price

float

Yes

CPM price for each display

adid

string

No

Preloaded ad ID that can be used when a bid offer wins

nurl

string

No

Nurl link for notification when a bid wins, and will then be used by transaction platform

burl

string

Yes

Billing notice URL called by the exchange when a winning bid becomes billable based on exchange-specific business policy (e.g.,typically delivered, viewed, etc.).Substitution macros ${AUCTION_PRICE} may be included

adm

string

Yes

Convey ad content.Native ad uses adm field to return ad content. Refer to native ad response below for more detailsVideo ad uses adm field to return ad content in vast format. Refer to vast video response below for more details

adomain

string array

No

Domain name of client, used for filtering check

bundle

string

Yes for install ads

App package name, eg. Android package name: com.foo.mygame, iOS package name: id907394059

iurl

string

No

Image link to indicate ad campaign content, used for quality or security tracking

cid

string

No

Campaign ID, to assist with ad QC. Each cid has one set of creatives, which is the creatives represented by iurl

crid

string

No

ID of a set of creatives, to assist with ad QC

cat

string array

Yes

IAB category of creative.Section 5.1 IAB category is the reference of its enumerated values

attr

integer array

No

Attribute array to describe creative.Section 5.3 Creative attribute list is the reference of its enumerated values

api

integer

No

Supported API frame of the display. Section 5.4 API frame is the reference of its enumerated values

protocol

integer

No

Supported video Bid Response protocol. Section 5.6 Video bid response protocol is the reference of its enumerated values

qagmediarating

integer

Yes

Indicate rating of creative content following IQG standard.Section 5.9 IQG media rating is the reference of its enumerated values

dealid

string

No

Refer to deal.id****from the bid request if this bid pertains to a private marketplace direct deal

w

integer

No

Creative width. Unit is in pixels

h

integer

No

Creative height. Unit is in pixels

exp

integer

No

Duration that the bidder is willing to wait between the auction and the actual display / impression.Unit is in seconds, with default value of 3600

ext

object

No

Placeholder for bidder-specific extensions to OpenRTB

 

 

4.2.3 native ad response

 

Native ad response content is saved in adm field, with the content including 1 native object. Native format supports native version 1.2 protocol.

 

Native object has following attributes:

 

Parameter name

Type

Required?

Description

ver

string

No

Native Markup version in use

assets

array of objects

Yes

List of native ad's assets.Refer to asset response object

link

object

Yes

Destination link if the ad is clicked.Refer to link object

imptrackers

array of string

Yes

Array of impression tracking URLs.When a display / impression happens, tracking URLs are reported and used as the reference for cost calculation

ext

Object

No

Placeholder that may contain custom JSON

 

 

4.2.4 asset response object

 

Asset response object must strictly follow asset object in the Bid Request. Each object corresponds to an ID, which matches with the asset request object ID.

 

Parameter name

Type

Required?

Description

id

int

Yes

Asset ID that matches with ID in Bid Request

required

int

No

Set to 1 if asset is required (bidder requires it to be displayed)

title

object

No

Title object for title assets. Refer to title object

img

object

No

Image object for image assets. Refer to img object

video

object

No

Video object for video assets. Refer to video object

data

object

No

Data object for data assets, eg. rating, pricing.Refer to data object

ext

object

No

Placeholder that may contain custom JSON

 

 

4.2.5 title object

 

 

Parameter name

Type

Required?

Description

text

string

Yes

Title text

len

integer

No

Length of title text

ext

object

No

Placeholder that may contain custom JSON

 

 

4.2.6 Img object

 

 

Parameter name

Type

Required?

Description

type

integer

No

Required for assetsurl or dcourl responses, not required for embedded asset responsesIcon image: Value = 1 Large image: Value = 3

url

string

Yes

URL of the image asset

w

integer

Yes

Image width in pixels

h

integer

Yes

Image height in pixels

ext

object

No

Placeholder that may contain custom JSON

 

 

4.2.7 data object

 

 

Parameter name

Type

Required?

Description

type

integer

No

Type ID of data element, must follow 5.12 Data Asset Typeif to be submitted

label

string

No

Name of data element, must follow 5.12 Data Asset Typeif to be submitted

value

string

Yes

Formatted string of data, based on the requirement of each data type

ext

object

No

Placeholder that may contain custom JSON

 

 

4.2.8 video object

 

Video response object uses vasttag parameter for video content in vast format.

Note: Video in native ad response is just one type of assets. Therefore, it doesn't support impression and click tracking that aims only at video. Instead, it can support tracking of the rate of progress when a video is being played.

 

Parameter name

Type

Required?

Description

vasttag

string

Yes

Indicate video content in vast format

 

 

4.2.9 link object

 

 

Parameter name

Type

Required?

Description

url

string

Yes

Landing URL of the clickable link

clicktrackers

array of strings

No

List of third-party tracker URLs tobe fired on click of the URL

ext

object

No

Placeholder that may contain custom JSON

 

 

5 RTB Interface Enumerated Value List

 

5.1 IAB Category Enumerated Value

 

 

Value

Description

IAB1

Arts & Entertainment

IAB1-1

Books & Literature

IAB1-2

Celebrity Fan/Gossip

IAB1-3

Fine Art

IAB1-4

Humor

IAB1-5

Movies

IAB1-6

Music

IAB1-7

Television

IAB2

Automotive

IAB2-1

Auto Parts

IAB2-2

Auto Repair

IAB2-3

Buying/Selling Cars

IAB2-4

Car Culture

IAB2-5

Certified Pre-Owned

IAB2-6

Convertible

IAB2-7

Coupe

IAB2-8

Crossover

IAB2-9

Diesel

IAB2-10

Electric Vehicle

IAB2-11

Hatchback

IAB2-12

Hybrid

IAB2-13

Luxury

IAB2-14

Minivan

IAB2-15

Motorcycles

IAB2-16

Off-Road Vehicles

IAB2-17

Performance Vehicles

IAB2-18

Pickup

IAB2-19

Road-Side Assistance

IAB2-20

Sedan

IAB2-21

Trucks & Accessories

IAB2-22

Vintage Cars

IAB2-23

Wagon

IAB3

Business

IAB3-1

Advertising

IAB3-2

Agriculture

IAB3-3

Biotech/Biomedical

IAB3-4

Business Software

IAB3-5

Construction

IAB3-6

Forestry

IAB3-7

Government

IAB3-8

Green Solutions

IAB3-9

Human Resources

IAB3-10

Logistics

IAB3-11

Marketing

IAB3-12

Metals

IAB4

Careers

IAB4-1

Career Planning

IAB4-2

College

IAB4-3

Financial Aid

IAB4-4

Job Fairs

IAB4-5

Job Search

IAB4-6

Resume Writing/Advice

IAB4-7

Nursing

IAB4-8

Scholarships

IAB4-9

Telecommuting

IAB4-10

U.S. Military

IAB4-11

Career Advice

IAB5

Education

IAB5-1

7-12 Education

IAB5-2

Adult Education

IAB5-3

Art History

IAB5-4

College Administration

IAB5-5

College Life

IAB5-6

Distance Learning

IAB5-7

English as a 2nd Language

IAB5-8

Language Learning

IAB5-9

Graduate School

IAB5-10

Homeschooling

IAB5-11

Homework/Study Tips

IAB5-12

K-6 Educators

IAB5-13

Private School

IAB5-14

Special Education

IAB5-15

Studying Business

IAB6

Family & Parenting

IAB6-1

Adoption

IAB6-2

Babies & Toddlers

IAB6-3

Daycare/Pre School

IAB6-4

Family Internet

IAB6-5

Parenting - K-6 Kids

IAB6-6

Parenting teens

IAB6-7

Pregnancy

IAB6-8

Special Needs Kids

IAB6-9

Eldercare

IAB7

Health & Fitness

IAB7-1

Exercise

IAB7-2

ADD

IAB7-3

AIDS/HIV

IAB7-4

Allergies

IAB7-5

Alternative Medicine

IAB7-6

Arthritis

IAB7-7

Asthma

IAB7-8

Autism/PDD

IAB7-9

Bipolar Disorder

IAB7-10

Brain Tumor

IAB7-11

Cancer

IAB7-12

Cholesterol

IAB7-13

Chronic Fatigue Syndrome

IAB7-14

Chronic Pain

IAB7-15

Cold & Flu

IAB7-16

Deafness

IAB7-17

Dental Care

IAB7-18

Depression

IAB7-19

Dermatology

IAB7-20

Diabetes

IAB7-21

Epilepsy

IAB7-22

GERD/Acid Reflux

IAB7-23

Headaches/Migraines

IAB7-24

Heart Disease

IAB7-25

Herbs for Health

IAB7-26

Holistic Healing

IAB7-27

IBS/Crohn’s Disease

IAB7-28

Incest/Abuse Support

IAB7-29

Incontinence

IAB7-30

Infertility

IAB7-31

Men’s Health

IAB7-32

Nutrition

IAB7-33

Orthopedics

IAB7-34

Panic/Anxiety Disorders

IAB7-35

Pediatrics

IAB7-36

Physical Therapy

IAB7-37

Psychology/Psychiatry

IAB7-38

Senior Health

IAB7-39

Sexuality

IAB7-40

Sleep Disorders

IAB7-41

Smoking Cessation

IAB7-42

Substance Abuse

IAB7-43

Thyroid Disease

IAB7-44

Weight Loss

IAB7-45

Women's Health

IAB8

Food & Drink

IAB8-1

American Cuisine

IAB8-2

Barbecues & Grilling

IAB8-3

Cajun/Creole

IAB8-4

Chinese Cuisine

IAB8-5

Cocktails/Beer

IAB8-6

Coffee/Tea

IAB8-7

Cuisine-Specific

IAB8-8

Desserts & Baking

IAB8-9

Dining Out

IAB8-10

Food Allergies

IAB8-11

French Cuisine

IAB8-12

Health/Low-Fat Cooking

IAB8-13

Italian Cuisine

IAB8-14

Japanese Cuisine

IAB8-15

Mexican Cuisine

IAB8-16

Vegan

IAB8-17

Vegetarian

IAB8-18

Wine

IAB9

Hobbies & Interests

IAB9-1

Art/Technology

IAB9-2

Arts & Crafts

IAB9-3

Beadwork

IAB9-4

Bird-Watching

IAB9-5

Board Games/Puzzles

IAB9-6

Candle & Soap Making

IAB9-7

Card Games

IAB9-8

Chess

IAB9-9

Cigars

IAB9-10

Collecting

IAB9-11

Comic Books

IAB9-12

Drawing/Sketching

IAB9-13

Freelance Writing

IAB9-14

Genealogy

IAB9-15

Getting Published

IAB9-16

Guitar

IAB9-17

Home Recording

IAB9-18

Investors & Patents

IAB9-19

Jewelry Making

IAB9-20

Magic & Illusion

IAB9-21

Needlework

IAB9-22

Painting

IAB9-23

Photography

IAB9-24

Radio

IAB9-25

Roleplaying Games

IAB9-26

Sci-Fi & Fantasy

IAB9-27

Scrapbooking

IAB9-28

Screenwriting

IAB9-29

Stamps & Coins

IAB9-30

Video & Computer Games

IAB9-31

Woodworking

IAB10

Home & Garden

IAB10-1

Appliances

IAB10-2

Entertaining

IAB10-3

Environmental Safety

IAB10-4

Gardening

IAB10-5

Home Repair

IAB10-6

Home Theater

IAB10-7

Interior Decorating

IAB10-8

Landscaping

IAB10-9

Remodeling & Construction

IAB11

Law, Government, & Politics

IAB11-1

Immigration

IAB11-2

Legal Issues

IAB11-3

U.S. Government Resources

IAB11-4

Politics

IAB11-5

Commentary

IAB12

News

IAB12-1

International News

IAB12-2

National News

IAB12-3

Local News

IAB13

Personal Finance

IAB13-1

Beginning Investing

IAB13-2

Credit/Debt & Loans

IAB13-3

Financial News

IAB13-4

Financial Planning

IAB13-5

Hedge Fund

IAB13-6

Insurance

IAB13-7

Investing

IAB13-8

Mutual Funds

IAB13-9

Options

IAB13-10

Retirement Planning

IAB13-11

Stocks

IAB13-12

Tax Planning

IAB14

Society

IAB14-1

Dating

IAB14-2

Divorce Support

IAB14-3

Gay Life

IAB14-4

Marriage

IAB14-5

Senior Living

IAB14-6

Teens

IAB14-7

Weddings

IAB14-8

Ethnic Specific

IAB15

Science

IAB15-1

Astrology

IAB15-2

Biology

IAB15-3

Chemistry

IAB15-4

Geology

IAB15-5

Paranormal Phenomena

IAB15-6

Physics

IAB15-7

Space/Astronomy

IAB15-8

Geography

IAB15-9

Botany

IAB15-10

Weather

IAB16

Pets

IAB16-1

Aquariums

IAB16-2

Birds

IAB16-3

Cats

IAB16-4

Dogs

IAB16-5

Large Animals

IAB16-6

Reptiles

IAB16-7

Veterinary Medicine

IAB17

Sports

IAB17-1

Auto Racing

IAB17-2

Baseball

IAB17-3

Bicycling

IAB17-4

Bodybuilding

IAB17-5

Boxing

IAB17-6

Canoeing/Kayaking

IAB17-7

Cheerleading

IAB17-8

Climbing

IAB17-9

Cricket

IAB17-10

Figure Skating

IAB17-11

Fly Fishing

IAB17-12

Football

IAB17-13

Freshwater Fishing

IAB17-14

Game & Fish

IAB17-15

Golf

IAB17-16

Horse Racing

IAB17-17

Horses

IAB17-18

Hunting/Shooting

IAB17-19

Inline Skating

IAB17-20

Martial Arts

IAB17-21

Mountain Biking

IAB17-22

NASCAR Racing

IAB17-23

Olympics

IAB17-24

Paintball

IAB17-25

Power & Motorcycles

IAB17-26

Pro Basketball

IAB17-27

Pro Ice Hockey

IAB17-28

Rodeo

IAB17-29

Rugby

IAB17-30

Running/Jogging

IAB17-31

Sailing

IAB17-32

Saltwater Fishing

IAB17-33

Scuba Diving

IAB17-34

Skateboarding

IAB17-35

Skiing

IAB17-36

Snowboarding

IAB17-37

Surfing/Body-Boarding

IAB17-38

Swimming

IAB17-39

Table Tennis/Ping-Pong

IAB17-40

Tennis

IAB17-41

Volleyball

IAB17-42

Walking

IAB17-43

Waterski/Wakeboard

IAB17-44

World Soccer

IAB18

Style & Fashion

IAB18-1

Beauty

IAB18-2

Body Art

IAB18-3

Fashion

IAB18-4

Jewelry

IAB18-5

Clothing

IAB18-6

Accessories

IAB19

Technology & Computing

IAB19-1

3-D Graphics

IAB19-2

Animation

IAB19-3

Antivirus Software

IAB19-4

C/C++

IAB19-5

Cameras & Camcorders

IAB19-6

Cell Phones

IAB19-7

Computer Certification

IAB19-8

Computer Networking

IAB19-9

Computer Peripherals

IAB19-10

Computer Reviews

IAB19-11

Data Centers

IAB19-12

Databases

IAB19-13

Desktop Publishing

IAB19-14

Desktop Video

IAB19-15

Email

IAB19-16

Graphics Software

IAB19-17

Home Video/DVD

IAB19-18

Internet Technology

IAB19-19

Java

IAB19-20

JavaScript

IAB19-21

Mac Support

IAB19-22

MP3/MIDI

IAB19-23

Net Conferencing

IAB19-24

Net for Beginners

IAB19-25

Network Security

IAB19-26

Palmtops/PDAs

IAB19-27

PC Support

IAB19-28

Portable

IAB19-29

Entertainment

IAB19-30

Shareware/Freeware

IAB19-31

Unix

IAB19-32

Visual Basic

IAB19-33

Web Clip Art

IAB19-34

Web Design/HTML

IAB19-35

Web Search

IAB19-36

Windows

IAB20

Travel

IAB20-1

Adventure Travel

IAB20-2

Africa

IAB20-3

Air Travel

IAB20-4

Australia & New Zealand

IAB20-5

Bed & Breakfasts

IAB20-6

Budget Travel

IAB20-7

Business Travel

IAB20-8

By US Locale

IAB20-9

Camping

IAB20-10

Canada

IAB20-11

Caribbean

IAB20-12

Cruises

IAB20-13

Eastern Europe

IAB20-14

Europe

IAB20-15

France

IAB20-16

Greece

IAB20-17

Honeymoons/Getaways

IAB20-18

Hotels

IAB20-19

Italy

IAB20-20

Japan

IAB20-21

Mexico & Central America

IAB20-22

National Parks

IAB20-23

South America

IAB20-24

Spas

IAB20-25

Theme Parks

IAB20-26

Traveling with Kids

IAB20-27

United Kingdom

IAB21

Real Estate

IAB21-1

Apartments

IAB21-2

Architects

IAB21-3

Buying/Selling Homes

IAB22

Shopping

IAB22-1

Contests & Freebies

IAB22-2

Couponing

IAB22-3

Comparison

IAB22-4

Engines

IAB23

Religion & Spirituality

IAB23-1

Alternative Religions

IAB23-2

Atheism/Agnosticism

IAB23-3

Buddhism

IAB23-4

Catholicism

IAB23-5

Christianity

IAB23-6

Hinduism

IAB23-7

Islam

IAB23-8

Judaism

IAB23-9

Latter-Day Saints

IAB23-10

Pagan/Wiccan

IAB24****IAB25

Uncategorized****Non-Standard Content

IAB25-1

Unmoderated UGC

IAB25-2

Extreme Graphic/Explicit Violence

IAB25-3

Pornography

IAB25-4

Profane Content

IAB25-5

Hate Content

IAB25-6

Under Construction

IAB25-7

Incentivized

IAB26

Illegal Content

IAB26-1

Illegal Content

IAB26-2

Warez

IAB26-3

Spyware/Malware

IAB26-4

Copyright Infringement

 

 

5.2 Banner Ad Type Enumerated Value

|Value|Description| |:----|:----|:----|:----| |1|XHTML Text Ad (usually mobile)| |2|XHTML Banner Ad. (usually mobile)| |3|JavaScript Ad; must be valid XHTML (i.e., Script Tags Included)| |4|iframe|

 

 

5.3 Creative Attribute Enumerated Value

 

 

Value

Description

1

Audio Ad(Auto-Play)

2

Audio Ad(User Initiated)

3

Expandable(Automatic)

4

Expandable(User Initiated - Click)

5

Expandable(User Initiated - Rollover)

6

In-Banner Video Ad (Auto-Play)

7

In-Banner Video Ad (User Initiated)

8

Pop (e.g., Over, Under, or Upon Exit)

9

Provocative or Suggestive Imagery

10

Shaky, Flashing, Flickering, Extreme Animation, Smileys

11

Surveys

12

Text Only

13

User Interactive (e.g., Embedded Games)

14

Windows Dialog or Alert Style

15

Has Audio On/Off Button

16

Ad Provides Skip Button (e.g. VPAID-rendered skip button on pre-roll video)

17

Adobe Flash

 

 

5.4 API Frame Enumerated Value

 

 

Value

Description

1

VPAID 1.0

2

VPAID 2.0

3

MRAID-1

4

ORMMA

5

MRAID-2

6

MRAID-3

 

 

5.5 Ad Placement / Position Attribute Enumerated Value

 

 

Value

Description

0

Unknown

1

Above the Fold

2

DEPRECATED - May or may not be initially visible depending on screen size/resolution.

3

Below the Fold

4

Header

5

Footer

6

Sidebar

7

Full Screen

 

 

5.6 Video Bid Response Protocol Enumerated Value

 

 

Value

Description

1

VAST 1.0

2

VAST 2.0

3

VAST 3.0

4

VAST 1.0 Wrapper

5

VAST 2.0 Wrapper

6

VAST 3.0 Wrapper

7

VAST 4.0

8

DAAST 1.0

 

 

5.7 Device Type Enumerated Value

 

 

Value

Description

1

Mobile/Tablet Version 2.0

2

Personal Computer Version 2.0

3

Connected TV Version 2.0

4

Phone New for Version 2.2

5

Tablet New for Version 2.2

6

Connected Device New for Version 2.2

7

Set Top Box New for Version 2.2

 

 

5.8 Network Connection Mode Enumerated Value

 

 

Value

Description

0

Unknown

1

Ethernet

2

WIFI

3

Cellular Network – Unknown Generation

4

Cellular Network – 2G

5

Cellular Network – 3G

6

Cellular Network – 4G

7

Cellular Network – 5G

 

 

5.9 IQG Media Rating Enumerated Value

 

 

Value

Description

1

All Audiences

2

Everyone Over 12

3

Mature Audiences

 

 

5.10 Context Type IDs

 

 

Value

Description

1

Content-centric context such as newsfeed, article, image gallery, video gallery, or similar

2

Social-centric context such as social network feed, email, chat, or similar.

3

Product context such as product listings, details, recommendations, reviews, or similar.

 

 

5.11 Context Sub Type IDs

 

 

Value

Description

10

General or mixed content.

11

Primarily article content (which of course could include images, etc as part of the article)

12

Primarily video content

13

Primarily audio content

14

Primarily image content

15

User-generated content - forums, comments, etc

20

General social content such as a general social network

21

Primarily email content

22

Primarily chat/IM content

30

Content focused on selling products, whether digital or physical

31

Application store/marketplace

32

Product reviews site primarily (which may sell product secondarily)

 

 

5.12 Data Asset Type

 

|Type ID|Name|Description| |:----|:----| |1|sponsored|Sponsored By message where response should contain the brand name of the sponsor.| |2|desc|Descriptive text associated with the product or service being advertised. Longer length of text in response may be truncated or ellipsed by the exchange.| |3|rating|Rating of the product being offered to the user. For example an app’s rating in an app store from 0-5.| |4|likes|Number of social ratings or “likes” of the product being offered to the user.| |5|downloads|Number downloads/installs of this product | |6|price|Price for product / app / in-app purchase. Value should include currency symbol in localised format.| |7|saleprice|Sale price that can be used together with price to indicate a discounted price compared to a regular price. Value should include currency symbol in localised format.| |8|phone|Phone number| |9|address|Address| |10|desc2|Additional descriptive text associated with the product or service being advertised| |11|displayurl|Display URL for the text ad. To be used when sponsoring entity doesn’t own the content. IE sponsored by BRAND on SITE (where SITE is transmitted in this field).| |12|ctatext|CTA description - descriptive text describing a ‘call to action’ button for the destination URL.|

 

 

5.13 Location Type

 

 

Value

Description

1

GPS/Location Services

2

IP Address

3

User provided (e.g., registration data)

 

 

5.14 IP Location Services

 

 

Value

Description

1

ip2location

2

Neustar (Quova)

3

MaxMind

4

NetAcuity (Digital Element)

 

 

RTB Request Example

 

1a) native icon image request example

 

 

{
  "id":"123",
  "imp": [{
    "id":"1",
    "tagid":"2049",
    "bidfloor":0.01,
    "bidfloorcur":"USD",
    "native": {
      "request":"{\"assets\":[{\"required\":1,\"img\":{\"type\":1,\"wmin\":84,\"hmin\":84}}],\"ver\": \"1.2\"}",
      "ver": "1.2"
    },
    "instl":0
  }],
  "app": {
    "storeurl":"",
    "ver":"8888888",
    "DSP": {
      "id":"de30a0c4-ed1c-42bd-a5ff-af65852ef34a"
    }
  },
  "device": {
    "ip":"1.1.1.1",
    "geo": {
      "country":"IDN"
    }
  }
}

 

 

1b) native large image request example

 

 

{
  "id":"123",
  "imp":[{
    "id":"1",
    "tagid":"2049",
    "bidfloor":0.01,
    "bidfloorcur":"USD",
    "native": {
      "request": "{\"assets\":[{\"required\":1,\"img\":{\"type\":3,\"wmin\":600,\"hmin\":314}}],\"ver\": \"1.2\"}",
       "ver":"1.2"
    },
    "instl":0
  }],
  "app":{
    "storeurl":"",
    "ver":"8888888",
    "DSP":{
      "id":"de30a0c4-ed1c-42bd-a5ff-af65852ef34a"
    }
  },
  "device":{
    "ip":"1.1.1.1",
    "geo":{
      "country":"IDN"
    }
  }
}

 

 

1c) native video request example

 

 

{
  "id":"32f94228-52d3-4bce-be88-5dd1d799ae4f",
  "imp": [{
    "id":"1",
    "tagid":"2061",
    "bidfloor":1.00,
    "bidfloorcur":"USD",
    "secure":0,
    "native":{
      "request":"{\"assets\":[{\"id\":1,\"required\":1,\"title\":{\"len \":100}},{\"id\":2,\"required \":0,\"data \":{\"type \":2,\"len \":100}},{\"id\":3,\"required \":0,\"img \":{\"type \":3}},{\"id \":4,\"required \":1,\"img \":{\"type\":1}},{\"id \":5,\"required \":0,\"img\":{\"type \":1}},{\"id\":6,\"required\":0,\"data\":{\"type \":12,\"len \":100}},{\"id\":7,\"required\":1,\"video\":{\"mimes\":[\"video/mp4\"],\"maxduration\":30,\"protocols\":[3],\"w\":1280,\"h\":720,\"linearity\":1,\"skip\":0,\"battr\":[16],\"maxbitrate\":2000,\"delivery\":[2],\"companionad\":[{\"w\":1280,\"h\":720,\"id\":\"1\",\"btype\":[1,2,4],\"battr\":[16],\"pos\":7,\"mimes\":[\"application/javascript\"],\"ext\":{\"orientation\":1}}]}}], \"ver\": \"1.2\"}",
        "ver":"1.2"
    }
  }],
 
  "app": {
    "id":"100461",
    "ver":"4050618",
    "DSP": {
      "id":"bd8b25d0-413e-4886-9adf-6a796ff47740"
    }
  },
  "device": {
    "ip":"1.1.1.1",
    "geo": {
      "country":"IDN",
      "type":2
    },
    "devicetype":4,
    "make":"WIKO",
    "model":"samsung-sm-g900a",
    "os":"android",
    "osv":"5.1.1",
    "language":"en",
    "carrier":"310410",
    "connectiontype":7,
    "ifa":"5731b4c8-7cc1-4a09-bb77-24f237d93a66",
    "didsha1":"ecae9042f3e549a4fd1af27a1ed38b5f682fa3ca",
    "didmd5":"c98de3c3706ae57c89f97c0778c8121d",
    "dpidsha1":"a07713adea29cd23fd10a2e81a4fb07e23e00fb7",
    "dpidmd5":"af4935679d392191157f687f48907492"
  },
  "at":1,
  "tmax":2000
}

 

 

1dbanner request example

 

 

{
    "id": "123",
    "imp": [{
        "id": "1",
        "tagid": "2051",
        "bidfloor": 0.00001,
        "bidfloorcur": "USD",
        "banner":{
            "w":320,
            "h":50,
            "mimes": ["image/png", "image/jpg", "image/gif"]
        },
        "instl": 0
    }],
 
    "app": {
        "storeurl": "",
        "ver": "8888888",
        "DSP": {
            "id": "5e33f618-42a0-47f0-b7b1-9ad9866f3b9a"
        }
    },
    "device": {
        "ip": "1.1.1.1",
        "geo": {
            "country": "IDN"
        },
        "connectiontype": 7
    }
}

 

 

RTB Response Example

 

2a) native icon image response example

 

 

{
  "id":"123",
  "bidid":"47b61fdb-0c63-46fc-9343-df78cd5b700f",
  "seatbid":[{
    "bid":[{
      "id":"47b61fdb-0c63-46fc-9343-df78cd5b700f",
      "impid":"1",
      "price":289,
      "burl": "http://midas-tracker-dev.hellay.net/win.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b670a47da2e4cfc471bc12cab9b8b93ea9f6096bc3754a4504199138bfc3de2175b25964e6353ca9390f6b7d21d46562d114b3ce6b79aff194ecdf27e608df0042697e7b0649503d67118df10c3755021e9f0de8f7a9b81239631fcaec5085653cc924139de74a362dd9e496589f008a5fe08421489a154726e484f2a9ffd7974a17970b211becc8a6e0cbeb0da71a2ae9adeb03e38ccd710ae582d51af0d38435548613dd6ccc224e2043f773fb9d19f781248676bd6cfeb60aebed339572462c42954267f6d5674eb418481a076e1e93a80211802c27dbe661bc5261764e6ce987657027a6622954100b11934fd1e5b5034a26c4eef9d554705b9f2ac51c3f0bd4a70dec9eb1e3de6f8fefd4f565a4c11a76f3c0cdf2b039cde4bc985eb65e5f5d73ef36b82b0a67ac3031310b383067f90eb6a5ae7259c9888337e30b69a5c1f0c089e4014766a861d9e6f391a6659687391ba1c3f8b3e4c1335b8a729d305b73b985ebd4e063cf47ca2b38f3312ab92df818eaf56342bea6633b7e9d2ae195fbf5200646ea3b3afaf413a76f1c6785087c65feec214112cbc835df6f6fcab32fdc31d1288e01128279a527a8c9601e290cbf7a138230eee2eaf3023cb15&auction_price=${AUCTION_PRICE}&sid=__SID__",
      "adm":"{\"ver\":\"1.2\",\"assets\":[{\"img\":{\"type\":1,\"url\":\"http://static-dev.rqmob.com/test/sa/20210710/53da2d2e6b4f1482ecc5afd2c15bc824__FILE_CM____FILE_CM480_720____WEBP__.png\",\"w\":84,\"h\":84}}],\"link\":{\"url\":\"https://play.google.com/store/apps/details?id=com.janel.doctor.ear\&hl=en\",\"clicktrackers\":[\"http://midas-tracker-dev.hellay.net/clk.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b670a47da2e4cfc471bc12cab9b8b93ea9f6096bc3754a4504199138bfc3de2175b25964e6353ca9390f6b7d21d46562d114b3ce6b79aff194ecdf27e608df0042697e7b0649503d67118df10c3755021e9f0de8f7a9b81239631fcaec5085653cc924139de74a362dd9e496589f008a5fe08421489a154726e484f2a9ffd7974a17970b211becc8a6e0cbeb0da71a2ae9adeb03e38ccd710ae582d51af0d38435548613dd6ccc224e2043f773fb9d19f781248676bd6cfeb60aebed339572462c42954267f6d5674eb418481a076e1e93a80211802c27dbe661bc5261764e6ce987657027a6622954100b11934fd1e5b5034a26c4eef9d554705b9f2ac51c3f0bd4a70dec9eb1e3de6f8fefd4f565a4c11a76f3c0cdf2b039cde4bc985eb65e5f5d73ef36b82b0a67ac3031310b383067f90eb6a5ae7259c9888337e30b69a5c1f0c089e4014766a861d9e6f391a6659687391ba1c3f8b3e4c1335b8a729d305b73b985ebd4e063cf47ca2b38f3312ab92df818eaf56342bea6633b7e9d2ae195fbf5200646ea3b3afaf413a76f1c6785087c65feec214112cbc835df6f6fcab32fdc31d1288e01128279a527a8c9601f19dd0f5a75a3f7f38f1\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_clk.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpQ2xpY2siLCJyZXF1ZXN0X2lkIjoiNDdiNjFmZGItMGM2My00NmZjLTkzNDMtZGY3OGNkNWI3MDBmIiwic3ViX3BsYXRmb3JtIjoiY3BpIiwiY2hhbm5lbCI6Ik9NQ19TREsiLCJjbGllbnRfaXAiOiIxLjEuMS4xIiwic2NyZWVuX3NpemUiOiIweDAiLCJjb3VudHJ5IjoiaWQiLCJQYXJhbXMiOlt7ImNhbXBhaWduX2lkIjoyMjM4LCJwb3NfaWQiOiIyMDQ5IiwiYWRfaWQiOjEwMDc2NiwiY2FtcF9uYW1lIjoicGFubHVoLXNhbiIsImFkX3BhY2thZ2VfbmFtZSI6ImNvbS5qYW5lbC5kb2N0b3IuZWFyIiwiY2lkIjozODgwMywiYmlkX3ByaWNlIjoxMjMwMDAwMDAsImVjcG0iOjI4OTU1MzgwNCwiZHNwX25hbWUiOiJTaGFyZWl0IiwiYXR0cl9wbGF0Zm9ybSI6MiwiYWRzZXRfaWQiOjEzNTAsImFkX25hbWUiOiJTQU4tU0RLIiwiYWRzZXRfbmFtZSI6IlNBTi1TREsiLCJwaHlfcG9zIjoiMjA0OSJ9XSwibWlkYXNfdmVyc2lvbiI6IjIuMCJ9\&sid=__SID__\"]},\"imptrackers\":[\"http://midas-tracker-dev.hellay.net/imp.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b670a47da2e4cfc471bc12cab9b8b93ea9f6096bc3754a4504199138bfc3de2175b25964e6353ca9390f6b7d21d46562d114b3ce6b79aff194ecdf27e608df0042697e7b0649503d67118df10c3755021e9f0de8f7a9b81239631fcaec5085653cc924139de74a362dd9e496589f008a5fe08421489a154726e484f2a9ffd7974a17970b211becc8a6e0cbeb0da71a2ae9adeb03e38ccd710ae582d51af0d38435548613dd6ccc224e2043f773fb9d19f781248676bd6cfeb60aebed339572462c42954267f6d5674eb418481a076e1e93a80211802c27dbe661bc5261764e6ce987657027a6622954100b11934fd1e5b5034a26c4eef9d554705b9f2ac51c3f0bd4a70dec9eb1e3de6f8fefd4f565a4c11a76f3c0cdf2b039cde4bc985eb65e5f5d73ef36b82b0a67ac3031310b383067f90eb6a5ae7259c9888337e30b69a5c1f0c089e4014766a861d9e6f391a6659687391ba1c3f8b3e4c1335b8a729d305b73b985ebd4e063cf47ca2b38f3312ab92df818eaf56342bea6633b7e9d2ae195fbf5200646ea3b3afaf413a76f1c6785087c65feec214112cbc835df6f6fcab32fdc31d1288e01128279a527a8c9601f698cae6a06433d213ad0e27e61ecbf359716f\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_imp.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpU2hvdyIsInJlcXVlc3RfaWQiOiI0N2I2MWZkYi0wYzYzLTQ2ZmMtOTM0My1kZjc4Y2Q1YjcwMGYiLCJzdWJfcGxhdGZvcm0iOiJjcGkiLCJjaGFubmVsIjoiT01DX1NESyIsImNsaWVudF9pcCI6IjEuMS4xLjEiLCJzY3JlZW5fc2l6ZSI6IjB4MCIsImNvdW50cnkiOiJpZCIsIlBhcmFtcyI6W3siY2FtcGFpZ25faWQiOjIyMzgsInBvc19pZCI6IjIwNDkiLCJhZF9pZCI6MTAwNzY2LCJjYW1wX25hbWUiOiJwYW5sdWgtc2FuIiwiYWRfcGFja2FnZV9uYW1lIjoiY29tLmphbmVsLmRvY3Rvci5lYXIiLCJjaWQiOjM4ODAzLCJiaWRfcHJpY2UiOjEyMzAwMDAwMCwiZWNwbSI6Mjg5NTUzODA0LCJkc3BfbmFtZSI6IlNoYXJlaXQiLCJhdHRyX3BsYXRmb3JtIjoyLCJhZHNldF9pZCI6MTM1MCwiYWRfbmFtZSI6IlNBTi1TREsiLCJhZHNldF9uYW1lIjoiU0FOLVNESyIsInBoeV9wb3MiOiIyMDQ5In1dLCJtaWRhc192ZXJzaW9uIjoiMi4wIn0\&sid=__SID__\"]}",
      "adid":"100766"
    }]
  }],
  "cur":"USD"
}

 

 

2b) native large image response example

 

 

{
  "id":"123",
  "bidid":"292bb9a0-0782-4d36-b543-437b47d48fef",
  "seatbid":[{
    "bid":[{
      "id":"292bb9a0-0782-4d36-b543-437b47d48fef",
      "impid":"1",
      "price":286,
      "burl":"http://midas-tracker-dev.hellay.net/win.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b650f47da2e4cfc41a095014a039da67c124ea7967efe7813bb7a17263fad53e827b61f999d776ff1cab439eac5ca4a5a90cec45454569c719dcaeb76ecee7917aa2e81aac1b96ee38c0faed998697cef41595637e9d1789ff24157fb37d290cfd4f37c4f87682e950964cada4915e29ade88ee663dcca4ef4080a3b2c18a39c819c8c68d685c27d4fe098fb694eab0fc95fdd54c55909b3783d7556de04d0b9e0a69556da80f1f3d5d7422078be5635fff6209f88e4240728987fcc3b0117f7a87bd743356242cc8518ea5fe9ea9e545354cdeb46fd1912a21fd776145ed8df1b7bb7d185bcf119adeebb6a0004f85202f4edb7a8822be24bfaf0e2372f0fdedc91dd8bc07c63c17b1e6f2c613863e4843124a3f7f2524aa6505bfa88c9dcc8133c8e11a0e4e7b71bc3a16ce3c8cb7025af21f84288355f9f330aae9c3fadf9177b6a2c81669ef00f0da7e95ef1562ebf10da4fa26849d609a370cfc8a6ea6052b1182dd14eeb31870ce4dc064b8be92fa58ba2f33aa7c3ae1b5c2cdd5d13a1a09335730d9bf1dd473e70f0c44eea10769dc831399256b411a96cd8791ca0e978fa858717c041af3cb8b5e96fcfbf4eb9fb1d6df74249cf5a46fc831e4bf&auction_price=${AUCTION_PRICE}&sid=__SID__",
      "adm":"{\"ver\":\"1.2\",\"assets\":[{\"img\":{\"type\":3,\"url\":\"http://static-dev.rqmob.com/test/sa/20210710/95def64e487533b5415faaf8486491f5__FILE_CM____FILE_CM480_720____WEBP__.png\",\"w\":660,\"h\":346}}],\"link\":{\"url\":\"https://play.google.com/store/apps/details?id=com.janel.doctor.ear\&hl=en\",\"clicktrackers\":[\"http://midas-tracker-dev.hellay.net/clk.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b650f47da2e4cfc41a095014a039da67c124ea7967efe7813bb7a17263fad53e827b61f999d776ff1cab439eac5ca4a5a90cec45454569c719dcaeb76ecee7917aa2e81aac1b96ee38c0faed998697cef41595637e9d1789ff24157fb37d290cfd4f37c4f87682e950964cada4915e29ade88ee663dcca4ef4080a3b2c18a39c819c8c68d685c27d4fe098fb694eab0fc95fdd54c55909b3783d7556de04d0b9e0a69556da80f1f3d5d7422078be5635fff6209f88e4240728987fcc3b0117f7a87bd743356242cc8518ea5fe9ea9e545354cdeb46fd1912a21fd776145ed8df1b7bb7d185bcf119adeebb6a0004f85202f4edb7a8822be24bfaf0e2372f0fdedc91dd8bc07c63c17b1e6f2c613863e4843124a3f7f2524aa6505bfa88c9dcc8133c8e11a0e4e7b71bc3a16ce3c8cb7025af21f84288355f9f330aae9c3fadf9177b6a2c81669ef00f0da7e95ef1562ebf10da4fa26849d609a370cfc8a6ea6052b1182dd14eeb31870ce4dc064b8be92fa58ba2f33aa7c3ae1b5c2cdd5d13a1a09335730d9bf1dd473e70f0c44eea10769dc831399256b411a96cd8791ca0e978fa858717c041af3cb8b5e96fcfbf4f892aad4d91638832204\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_clk.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpQ2xpY2siLCJyZXF1ZXN0X2lkIjoiMjkyYmI5YTAtMDc4Mi00ZDM2LWI1NDMtNDM3YjQ3ZDQ4ZmVmIiwic3ViX3BsYXRmb3JtIjoiY3BpIiwiY2hhbm5lbCI6Ik9NQ19TREsiLCJjbGllbnRfaXAiOiIxLjEuMS4xIiwic2NyZWVuX3NpemUiOiIweDAiLCJjb3VudHJ5IjoiaWQiLCJQYXJhbXMiOlt7ImNhbXBhaWduX2lkIjoyMjM4LCJwb3NfaWQiOiIyMDQ5IiwiYWRfaWQiOjEwMDc2NiwiY2FtcF9uYW1lIjoicGFubHVoLXNhbiIsImFkX3BhY2thZ2VfbmFtZSI6ImNvbS5qYW5lbC5kb2N0b3IuZWFyIiwiY2lkIjozODgyNiwiYmlkX3ByaWNlIjoxMjMwMDAwMDAsImVjcG0iOjI4NjI2MjYxNCwiZHNwX25hbWUiOiJTaGFyZWl0IiwiYXR0cl9wbGF0Zm9ybSI6MiwiYWRzZXRfaWQiOjEzNTAsImFkX25hbWUiOiJTQU4tU0RLIiwiYWRzZXRfbmFtZSI6IlNBTi1TREsiLCJwaHlfcG9zIjoiMjA0OSJ9XSwibWlkYXNfdmVyc2lvbiI6IjIuMCJ9\&sid=__SID__\",\"http://ping-test.rqmob.com/click?ad=SAN-SDK\&ad_id=100766\&ad_type={ad_type}\&adpos_id=2049\&adset={adset}\&adset_id=1350\&advid=29\&_app_id=7752\&android_id=\&app_id=\&app_type=3\&beyla_id=\&c={c}\&c_id=38826\&campid=1321943\&channel_pkg=\&channel_pkg_ver=0\&cost_currency={cost_currency}\&cost_model={cost_model}\&cost_value={cost_value}\&country_code=id\&device_id=\&ext_info={ext_info}\&gaid=\&imei={imei}\&imsi={imsi}\&ip=1.1.1.1\&is_offline=1\&is_pre_install={is_pre_install}\&midas_camp_id=2238\&midas_traffic_type=1\&os_version=\&other_category={other_category}\&pkg=com.janel.doctor.ear\&placement=2049\&platform=adshonor\&real_attrplat=2\&remote_ip=1.1.1.1\&requestid=292bb9a0-0782-4d36-b543-437b47d48fef\&sid={sid}\&site_id={site_id}\&uagent=\",\"http://midas-tracker-dev.hellay.net/effect.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b650f47da2e4cfc41a095014a039da67c124ea7967efe7813bb7a17263fad53e827b61f999d776ff1cab439eac5ca4a5a90cec45454569c719dcaeb76ecee7917aa2e81aac1b96ee38c0faed998697cef41595637e9d1789ff24157fb37d290cfd4f37c4f87682e950964cada4915e29ade88ee663dcca4ef4080a3b2c18a39c819c8c68d685c27d4fe098fb694eab0fc95fdd54c55909b3783d7556de04d0b9e0a69556da80f1f3d5d7422078be5635fff6209f88e4240728987fcc3b0117f7a87bd743356242cc8518ea5fe9ea9e545354cdeb46fd1912a21fd776145ed8df1b7bb7d185bcf119adeebb6a0004f85202f4edb7a8822be24bfaf0e2372f0fdedc91dd8bc07c63c17b1e6f2c613863e4843124a3f7f2524aa6505bfa88c9dcc8133c8e11a0e4e7b71bc3a16ce3c8cb7025af21f84288355f9f330aae9c3fadf9177b6a2c81669ef00f0da7e95ef1562ebf10da4fa26849d609a370cfc8a6ea6052b1182dd14eeb31870ce4dc064b8be92fa58ba2f33aa7c3ae1b5c2cdd5d13a1a09335730d9bf1dd473e70f0c44eea10769dc831399256b411a96cd8791ca0e978fa858717c041af3cb8b5e96fcfbf4ff97b0c7de2834ae6eb4de3deb240e3b1ff423\&effect_type={EFFECT_TYPE}\&sid=__SID__\"]},\"imptrackers\":[\"http://midas-tracker-dev.hellay.net/imp.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b650f47da2e4cfc41a095014a039da67c124ea7967efe7813bb7a17263fad53e827b61f999d776ff1cab439eac5ca4a5a90cec45454569c719dcaeb76ecee7917aa2e81aac1b96ee38c0faed998697cef41595637e9d1789ff24157fb37d290cfd4f37c4f87682e950964cada4915e29ade88ee663dcca4ef4080a3b2c18a39c819c8c68d685c27d4fe098fb694eab0fc95fdd54c55909b3783d7556de04d0b9e0a69556da80f1f3d5d7422078be5635fff6209f88e4240728987fcc3b0117f7a87bd743356242cc8518ea5fe9ea9e545354cdeb46fd1912a21fd776145ed8df1b7bb7d185bcf119adeebb6a0004f85202f4edb7a8822be24bfaf0e2372f0fdedc91dd8bc07c63c17b1e6f2c613863e4843124a3f7f2524aa6505bfa88c9dcc8133c8e11a0e4e7b71bc3a16ce3c8cb7025af21f84288355f9f330aae9c3fadf9177b6a2c81669ef00f0da7e95ef1562ebf10da4fa26849d609a370cfc8a6ea6052b1182dd14eeb31870ce4dc064b8be92fa58ba2f33aa7c3ae1b5c2cdd5d13a1a09335730d9bf1dd473e70f0c44eea10769dc831399256b411a96cd8791ca0e978fa858717c041af3cb8b5e96fcfbf4ff97b0c7de2834ae6eb4de3deb240e3b1ff423\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_imp.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpU2hvdyIsInJlcXVlc3RfaWQiOiIyOTJiYjlhMC0wNzgyLTRkMzYtYjU0My00MzdiNDdkNDhmZWYiLCJzdWJfcGxhdGZvcm0iOiJjcGkiLCJjaGFubmVsIjoiT01DX1NESyIsImNsaWVudF9pcCI6IjEuMS4xLjEiLCJzY3JlZW5fc2l6ZSI6IjB4MCIsImNvdW50cnkiOiJpZCIsIlBhcmFtcyI6W3siY2FtcGFpZ25faWQiOjIyMzgsInBvc19pZCI6IjIwNDkiLCJhZF9pZCI6MTAwNzY2LCJjYW1wX25hbWUiOiJwYW5sdWgtc2FuIiwiYWRfcGFja2FnZV9uYW1lIjoiY29tLmphbmVsLmRvY3Rvci5lYXIiLCJjaWQiOjM4ODI2LCJiaWRfcHJpY2UiOjEyMzAwMDAwMCwiZWNwbSI6Mjg2MjYyNjE0LCJkc3BfbmFtZSI6IlNoYXJlaXQiLCJhdHRyX3BsYXRmb3JtIjoyLCJhZHNldF9pZCI6MTM1MCwiYWRfbmFtZSI6IlNBTi1TREsiLCJhZHNldF9uYW1lIjoiU0FOLVNESyIsInBoeV9wb3MiOiIyMDQ5In1dLCJtaWRhc192ZXJzaW9uIjoiMi4wIn0\&sid=__SID__\"]}",
      "adid":"100766",
      "bundle":"com.janel.doctor.ear"
     }]
   }],
   "cur":"USD"
}

 

 

2c) native video response example

 

 

{
  "id":"32f94228-52d3-4bce-be88-5dd1d799ae4f",
  "bidid":"a5254b1b-f95d-42b5-8415-c660712532b2",
  "seatbid":[{
    "bid":[{
      "id":"a5254b1b-f95d-42b5-8415-c660712532b2",
      "impid":"1",
      "price":50,
      "burl":"http://midas-tracker-dev.hellay.net/win.fcg?viewid=e6d8578664e2f10e11afa9c0e96cb3762e56ab1614a0eb790bda8dee1f46ddd0ed054d91e419ea8b705890309607448e65f407e9336bc0a90533085ff8f141a42984adca526e1cca8ddf69757aecb73b05a22892d982a78aabbf0a1f6079b696e653900269900c16d45a364f062e705ec9adb3b1d6334b2746ef9f3ed20dc6ef05d95e16aa65e23c7e0b52cb1ce70ee639943f7b95625198ec7ac09435643ed9c4abd37f686f89f4ea123215aa700aa73005e728bcb45d054bb75ba53b2bb105286ce8941b833064268f1fb47f6cb00b0c3030e892027fc3178b7aeda7a0fe9efcb34e32ccd590569643552cae4cb5d6a359acb6b326faf3434c5ddf7574179869e6482ca8a5fdb4b7d344ed3cb022cabf9bd33e1316be063fefb6ac55113ec00eda60f87e50c3019442885a22873312f97ffd6fed0b69871925b9fee5b1923bde7212f824eea9c66deb48a60a8a20bfb895d26a3e1fb1614eefcdd8e16d899ba83e79803d451f3f8664ea3a4263915eadb1ac314f715062365ec0fe9a97e01f3cba17f73142e937034de4aeab9e5c64a445367dbff95805c26dba982d7d97914c5b2670f5528553a93a7aefa85e4875a35d79633e319c6e65f344f47b302ef3a76f9fad88bc3d3b7890b08097a4839a8c58dcb83027b0e80ce12ee7988f8660da46b8723f736122efbee4441724ba697a81160c9014e45ab023847a4f79ad987c1e49da43b7d3a0fb3b6e3ecc6f6cd1d9cccb166e7495fcd7d41bda6ca2cf7cadfd3e8825843f081c8faa098a34121a36ae4164&auction_price=${AUCTION_PRICE}&sid=__SID__",
    "adm":"{\"assets\":[{\"id\":1,\"title\":{\"text\":\"openrtb-this is ad title\",\"len\":14}},{\"id\":7,\"video\":{\"vasttag\":\"\\\\\\\\\\\\\\\\\\\00:00:15\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}}],\"link\":{\"url\":\"https://play.google.com/store/apps/details?id=cc.forestapp\&hl=en\",\"clicktrackers\":[\"http://midas-tracker-dev.hellay.net/clk.fcg?viewid=e6d8578664e2f10e11afa9c0e96cb3762e56ab1614a0eb790bda8dee1f46ddd0ed054d91e419ea8b705890309607448e65f407e9336bc0a90533085ff8f141a42984adca526e1cca8ddf69757aecb73b05a22892d982a78aabbf0a1f6079b696e653900269900c16d45a364f062e705ec9adb3b1d6334b2746ef9f3ed20dc6ef05d95e16aa65e23c7e0b52cb1ce70ee639943f7b95625198ec7ac09435643ed9c4abd37f686f89f4ea123215aa700aa73005e728bcb45d054bb75ba53b2bb105286ce8941b833064268f1fb47f6cb00b0c3030e892027fc3178b7aeda7a0fe9efcb34e32ccd590569643552cae4cb5d6a359acb6b326faf3434c5ddf7574179869e6482ca8a5fdb4b7d344ed3cb022cabf9bd33e1316be063fefb6ac55113ec00eda60f87e50c3019442885a22873312f97ffd6fed0b69871925b9fee5b1923bde7212f824eea9c66deb48a60a8a20bfb895d26a3e1fb1614eefcdd8e16d899ba83e79803d451f3f8664ea3a4263915eadb1ac314f715062365ec0fe9a97e01f3cba17f73142e937034de4aeab9e5c64a445367dbff95805c26dba982d7d97914c5b2670f5528553a93a7aefa85e4875a35d79633e319c6e65f344f47b302ef3a76f9fad88bc3d3b7890b08097a4839a8c58dcb83027b0e80ce12ee7988f8660da46b8723f736122efbee4441724ba697a81160c9014e45ab023847a4f79ad987c1e49da43b7d3a0fb3b6e3ecc6f6cd1d9cccb166e7495fcd7d41bda6ca2cf7cadfd3e88259732131e89c815952846\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_clk.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpQ2xpY2siLCJyZXF1ZXN0X2lkIjoiYTUyNTRiMWItZjk1ZC00MmI1LTg0MTUtYzY2MDcxMjUzMmIyIiwic3ViX3BsYXRmb3JtIjoiY3BpIiwiY2hhbm5lbCI6Ik9NQ19TREsiLCJjbGllbnRfaXAiOiIxLjEuMS4xIiwicGxhdGZvcm0iOjEsIm9zX3ZlcnNpb24iOiI1LjEuMSIsImltZWkiOiJlY2FlOTA0MmYzZTU0OWE0ZmQxYWYyN2ExZWQzOGI1ZjY4MmZhM2NhIiwiYnJhbmQiOiJXSUtPIiwibW9kZWwiOiJzYW1zdW5nLXNtLWc5MDBhIiwic2NyZWVuX3NpemUiOiIweDAiLCJsYW5ndWFnZSI6ImVuIiwiZ2FpZCI6IjU3MzFiNGM4LTdjYzEtNGEwOS1iYjc3LTI0ZjIzN2Q5M2E2NiIsIm5ldHdvcmtfdHlwZSI6NywiY291bnRyeSI6ImluIiwiUGFyYW1zIjpbeyJjYW1wYWlnbl9pZCI6MjEzNiwicG9zX2lkIjoiMjA2MSIsImFkX2lkIjoxMDA2NzQsImNhbXBfbmFtZSI6IuadqOWwkeeRnC1zaGFyZWl0Lea1i-ivlS1vcGVucnRiIiwiYWRfcGFja2FnZV9uYW1lIjoiY2MuZm9yZXN0YXBwIiwiY2lkIjozODY5OCwiYmlkX3ByaWNlIjoxMDAwMDAwMDAwLCJlY3BtIjo2ODIxOTMyMDAsImRzcF9uYW1lIjoiU2hhcmVpdCIsImF0dHJfcGxhdGZvcm0iOjEsImFkc2V0X2lkIjoxMjM0LCJhZF9uYW1lIjoi5p2o5bCR55GcLW9wZW5ydGItMTjop4TmoLwt5bCP57GzIiwiYWRzZXRfbmFtZSI6IuadqOWwkeeRnC1vcGVucnRiLeWwj-exsyIsInBoeV9wb3MiOiIyMDYxIn1dLCJtaWRhc192ZXJzaW9uIjoiMi4wIn0\&sid=__SID__\"]},\"imptrackers\":[\"http://midas-tracker-dev.hellay.net/imp.fcg?viewid=e6d8578664e2f10e11afa9c0e96cb3762e56ab1614a0eb790bda8dee1f46ddd0ed054d91e419ea8b705890309607448e65f407e9336bc0a90533085ff8f141a42984adca526e1cca8ddf69757aecb73b05a22892d982a78aabbf0a1f6079b696e653900269900c16d45a364f062e705ec9adb3b1d6334b2746ef9f3ed20dc6ef05d95e16aa65e23c7e0b52cb1ce70ee639943f7b95625198ec7ac09435643ed9c4abd37f686f89f4ea123215aa700aa73005e728bcb45d054bb75ba53b2bb105286ce8941b833064268f1fb47f6cb00b0c3030e892027fc3178b7aeda7a0fe9efcb34e32ccd590569643552cae4cb5d6a359acb6b326faf3434c5ddf7574179869e6482ca8a5fdb4b7d344ed3cb022cabf9bd33e1316be063fefb6ac55113ec00eda60f87e50c3019442885a22873312f97ffd6fed0b69871925b9fee5b1923bde7212f824eea9c66deb48a60a8a20bfb895d26a3e1fb1614eefcdd8e16d899ba83e79803d451f3f8664ea3a4263915eadb1ac314f715062365ec0fe9a97e01f3cba17f73142e937034de4aeab9e5c64a445367dbff95805c26dba982d7d97914c5b2670f5528553a93a7aefa85e4875a35d79633e319c6e65f344f47b302ef3a76f9fad88bc3d3b7890b08097a4839a8c58dcb83027b0e80ce12ee7988f8660da46b8723f736122efbee4441724ba697a81160c9014e45ab023847a4f79ad987c1e49da43b7d3a0fb3b6e3ecc6f6cd1d9cccb166e7495fcd7d41bda6ca2cf7cadfd3e88259037090d8ef619b830020e3eeedd3895de2a52\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_imp.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpU2hvdyIsInJlcXVlc3RfaWQiOiJhNTI1NGIxYi1mOTVkLTQyYjUtODQxNS1jNjYwNzEyNTMyYjIiLCJzdWJfcGxhdGZvcm0iOiJjcGkiLCJjaGFubmVsIjoiT01DX1NESyIsImNsaWVudF9pcCI6IjEuMS4xLjEiLCJwbGF0Zm9ybSI6MSwib3NfdmVyc2lvbiI6IjUuMS4xIiwiaW1laSI6ImVjYWU5MDQyZjNlNTQ5YTRmZDFhZjI3YTFlZDM4YjVmNjgyZmEzY2EiLCJicmFuZCI6IldJS08iLCJtb2RlbCI6InNhbXN1bmctc20tZzkwMGEiLCJzY3JlZW5fc2l6ZSI6IjB4MCIsImxhbmd1YWdlIjoiZW4iLCJnYWlkIjoiNTczMWI0YzgtN2NjMS00YTA5LWJiNzctMjRmMjM3ZDkzYTY2IiwibmV0d29ya190eXBlIjo3LCJjb3VudHJ5IjoiaW4iLCJQYXJhbXMiOlt7ImNhbXBhaWduX2lkIjoyMTM2LCJwb3NfaWQiOiIyMDYxIiwiYWRfaWQiOjEwMDY3NCwiY2FtcF9uYW1lIjoi5p2o5bCR55GcLXNoYXJlaXQt5rWL6K-VLW9wZW5ydGIiLCJhZF9wYWNrYWdlX25hbWUiOiJjYy5mb3Jlc3RhcHAiLCJjaWQiOjM4Njk4LCJiaWRfcHJpY2UiOjEwMDAwMDAwMDAsImVjcG0iOjY4MjE5MzIwMCwiZHNwX25hbWUiOiJTaGFyZWl0IiwiYXR0cl9wbGF0Zm9ybSI6MSwiYWRzZXRfaWQiOjEyMzQsImFkX25hbWUiOiLmnajlsJHnkZwtb3BlbnJ0Yi0xOOinhOagvC3lsI_nsbMiLCJhZHNldF9uYW1lIjoi5p2o5bCR55GcLW9wZW5ydGIt5bCP57GzIiwicGh5X3BvcyI6IjIwNjEifV0sIm1pZGFzX3ZlcnNpb24iOiIyLjAifQ\&sid=__SID__\"]}",
      "adid":"100674"
    }]
  }],
  "cur":"USD"
}

 

 

2dbanner response example

 

 

{
    "id": "123",
    "bidid": "a1271eca-efa2-4f9f-8904-a853afec1289",
    "seatbid": [
        {
            "bid": [
                {
                    "id": "a1271eca-efa2-4f9f-8904-a853afec1289",
                    "impid": "1",
                    "price": 118.0806,
                    "burl": "https://midas-tracker-test.hellay.net/win.fcg?viewid=e6d8578664e2f10e11afa8c3eb6cb3763be39af447238100277632423c9c212f3987802acb093fa8f226d2beb00ad9aa5d901a36db98e81c1c0f1639ad363decc476977f6ba1dcb36318671a7a606d34961563c37535b94719f7eb4a8d53d8b3c80d002386ea6227bc2e50cdbcaa0c40a29bee9ef33b63c3f56ae4c59790d02b2be9ce6be9598e84f92c0efb7e9fdcf311fb0326d959dbd306031f78ae6a4a34675ad8bb6e84571c015638463b14fab8eded30cabefcf16c758eac517853709909da5be52230975657723bd0182b8eb7e92423a55066d07ab9c25a2c38cb0df2af9462c41155773054912137f7f508187acdfde64036bbcc7108237648df4168089d1ce5c8bae76768ae1f5a7cbda8f78a3c788123653da1a5f9294f7f410ac5a440063a7a62443efae33253b0e2bb16ed36a35b8720a1a75cd3a053a8f6415a00ecb94de70f89dff8f1e9dd5c1317a91c63f186f6e20d346da0aa4bbb9699eac716e961ac71a8048f0ad68c64b5e6ef9b3fec4e7969facea589f05d3fd1e9db885bcfea115dd393addc945f6de28f8ee1c2706e225370fc925762ef0ecb7317c28478b40b09f7b7611fc975cb19ea99226b086ca9c98895c8b86f12fa79b8086c1a3cff9f768f9b729c65121107709120f269c2ea863bda8797e77a98e3f177128fcbb4f46da9addbb1da7ef21f9aef6d0b9b1f4890d3cf764037f056e83dc7ed96a55cfab626fcf5903476d16ece901558cb0c2edc5a43cc57e4c95218c9d01e2e816d005a4f7e&auction_price=${AUCTION_PRICE}&sid=__SID__",
                    "adm":" ",
                    "adid": "128263",
                    "bundle": "com.migo.mobile"
                }
            ]
        }
    ],
    "cur": "USD"
}

2. Budget - RTA (Real Time API)

Api is called through HTTP POST request.

 

Service Endpoints

 

Region

Endpoint

xxx

https://xxxxxx

 

Change this table according to your deployment if you have multiple regions.

 

Path

/rta

 

Request Parameters

 

Name

Type

Required

Description

req_id

string

Yes

Unique id of this request

app_key

string

Yes

Unique app ID 

sign

string

Yes

Signature of this request [Ask service provider for signature generating method]

gaid

string

Yes

User's GAID

country

string

Yes

Country code using ISO-3166-1-alpha-3.

campaign_infos

[Campaign_info Object]

Yes

Campaign list,assigned by your system

client_ip

string

Yes

the IP of the client

client_os

string

Yes

Device operating system

make

string

Yes

Brand of user's terminal device

 

 

Campaign_info Object

 

Name

Type

Required

Description

campaign_id

string

Yes

Unique Campaign Id

shop_id

string

No, this field is for DPA only.

Unique id of shop

spu_list

[string]

No, this field is for DPA only.

Product info list

 

 

Response Parameters

 

Name

Type

Required

Description

code

string

Yes

Service status. 200 for OK. Others mean error, check msg for failling reasons.

msg

Enum of Reason

Yes

Failling reasons. OK for successful calls.

req_id

string

Yes

Same with req_id in the request. Specify which request this response is responding to.

data

[Status Object]

Yes

Status for every ad campaign id.

 

 

Reason Enumeration

 

Value

Meaning

OK

Successful.

CAMP_ID_INVALID

One or more campaign id is invalid.

GAID_INVALID

Gaid not valid.

 

Table would be updated, as more detailed info of failing is provided.

 

Status Object

 

Name

Type

Required

Description

campaign_id

string

Yes

Campaign id of which this status object is for.

target

string

Yes

"True" / "False", which means SUITABLE / NOT SUITABLE for user impression seperately.

shop_id

string

No. Deponds on request.

Unique id of shop

spu_list

[string]

No. Deponds on request.

Ids of SKU

 

 

Data samples

Request

{

  "req_id":"1234567890", 

  "app_key":"12345",  

  "sign":"12345abcde",   

  "gaid":"ab888726-fceb-4714-914d-58ef00c8df4d",  

  "country":"ID", 

  "campaign_infos":[

    {

      "campaign_id": "123"

    },

    {

      "campaign_id": "234",

      "shop_id": "shop_abc",

      "spu_list": [

        "spu_item_1",

        "spu_item_2"

      ]

    }

  ],  

  "client_ip":"1.2.3.4", 

  "client_os":"Android", 

  "make":"Xiaomi"

}

Response

{

  "code":"200",  

  "msg":"",     

  "req_id":"1234567890",    

  "data":[          

    {

      "campaign_id":"123",  

      "target": "true"   

    },

    {

      "campaign_id":"234",  

      "target": "true",

      "shop_id": "shop_abc",

      "spu_list": [

        "spu_item_1",

        "spu_item_2"

      ] 

    }

  ]

}

 

 

3. Traffic - Xtend-SSP RTB Integration (SSP)

 

1 Overview

 

This document provides instructions for the integration of Xtend system with external Publisher system. It 

describes the requirements and steps needed to enable interface connection based on open RTB.

 

2 Steps for Integration

 

To enable Publisher to connect with Midas, the steps include:

Sign contract: Mutual agreement contract between Xtend and Publisher.

Register Publisher account: Contact Xtend Operations PIC to register Publisher account in Midas system in order to receive the token. Note: Currently Midas doesn't support auto-registration, and it is necessary to contact Xtend and provide relevant information in order to complete the account registration. 

Proceed to system integration set-up: Publisher needs to follow this document to build interface and set up integration. If there is any issue encountered during the process, Midas will provide Product and Tech PIC to support and solve the issue accordingly.

Test: After integration is set up, Publisher and Midas need to arrange testing for the integration and make 

adjustments when necessary.

Live: After test completes, Xtend PIC from business team will follow up with official launch of integrated online traffic and start to record cost.

 

3 Real Time Bid

 

3.1 Data Transmission

The connection between Publisher and Midas follows HTTP communication protocol, to send Bid Request via 

POST mode as the content for HTTP request, and use data in JSON format.

 

3.2 HTTP Request

HTTP POST mode is used to send Bid Request, instead of HTTP GET mode, as it enables more content to be 

attached and supports binary data better.

 

Request thread:

 

Name

Value

Remark

x-openrtb-version

2.5

open rtb version

 

3.3 HTTP Response

 

If Midas is participating in bid / auction, HTTP response status code should be 200, which allows it to return to 

Bid Request. If not, HTTP response status code should be 204.

 

3.4 Display Volume and Cost Calculation

 

The billing is based on the number of displays reported in the winnotice (default winnotice is in nurl, if the 

publisher does not support nurl, it is in burl) link statistics when the bid is won, so you need to replace the

 {AUCTION_PRICE} macro in the winnotice url when the bid is won.

Publisher needs to ensure that at most one ad is reported for impression at a time; and that the reported 

display is within the validity of the impression delay required by Xtend.

Xtend limits the impression delay by using the bidresponse.seatbid.bid.exp field.

 

3.5 Precautions

 

If the following fields in the request body are empty, the Xtend platform will consider the request as invalid and 

will not be populated.

 

bid.imp[].tagid: Publisher's ad space identifier

bid.app.bundle: package name information of the traffic source

bid.device.ifa: unique identifier allowed for advertisers, explicitly stated; Android passes gaid, iOS passes idfa

bid.device.ua: User-Agent field in the HTTP request header of the user's device

bid.device.ip: ip address of the user's current network

bid.device.geo.country: the country of the user's current network, using ISO-3166-1-alpha-3

 

4 Real Time Bid RTB Interface Parameter

 

4.1 Bid Request

 

 

Parameter name

Type

Required?

Description

id

string

Yes

The only identification for Bid Request

imp

object array

Yes

1 request can include only 1 impression object at a time, which represents a specific ad display placement/position. Details can be found in imp object parameter definition below

app

object

Yes

App object info of Publisher, recommended to use only on app instead of website. Details can be found in app object parameter definition below

device

object

Yes

Device info. Details can be found in device object parameter definition below

user

object

No

Device user / Ad audience. Details can be found in user object parameter definition below

at

integer

Yes

Bid settlement auction type. Value of 1 means it follows First-price auction, while value of 2 means it follows Second-price plus auction.

badv

string array

No

Domain name in blacklist

bapp

string array

No

App name in blacklist.On Android, these should be bundle or package names (e.g., com.foo.mygame). On iOS, these are numeric IDs.

regs

object

No

Any industry, legal, or governmental regulations in force

 

 

4.1.1 imp object

 

 

Parameter name

Type

Required?

Description

id

string

Yes

The only identification in a Bid Request for the specific display traffic sold. 1 request can include only 1 display traffic at a time

tagid

string

Yes

Fixed identification of each specific ad display placement/position

native

object

Yes for Native traffic

Refer to native object (Supports only Native ad placement)

banner

object

Yes for Banner traffic

Refer to banner object

video

object

Yes for Video traffic

Refer to video object

audio

object

Yes for Audio traffic

Refer to audio object

exp

integer

No

Duration that may elapse between the auction and the actual display / impression.Unit is in seconds

secure

integer

No

Parameter to indicate if Bid Request needs HTTPS encrypted info and markup to ensure data privacy.Value of 0 means it doesn't need. Value of 1 means it needs. If left blank, means unknown, i.e. it doesn't need encryption

bid floor

float

No

Minimum CPM bid price for this display traffic

bidfloorcur

string

Yes

Bid price currency, currently it only supports USD

 

 

4.1.2 banner object

 

 

Parameter name

Type

Required?

Description

id

string

No

Unique identifier for this banner object. Recommended when Banner objects are used with a Video object to represent an array of companion ads. Values usually start at 1 and increase with each object; should be unique within an impression.

w

integer

Yes

Exact width in device independent pixels (DIPS); If not specified wmin and wmax , this value refers to the required display width, otherwise refers to the desired width

h

integer

Yes

Exact height in device independent pixels (DIPS); If not specified hmin and hmax , this value refers to the required display height, otherwise refers to the desired height

pos

integer

No

Ad position on screen. Section 5.5 Ad Placement/Position Attribute is the reference of its enumerated values

mimes

string array

Yes

Content MIME types supported. Popular MIME types may include "application/x-shockwave-flash", “image/jpg”, and “image/gif”。SHAREit support "image/jpg","image/png", and "image/gif"

ext

object

No

Placeholder for exchange-specific extensions to OpenRTB

 

 

4.1.3 native object

 

 

Parameter name

Type

Required?

Description

request

string

Yes

Request must follow Native ad specification. Refer to native request object for details

ver

string

Yes

Use Dynamic Native Ads API version, default version is 1.2

api

integer array

No

Supported API frame of the display. Section 5.4 API frame is the reference of its enumerated values. Default setting of this parameter is that it doesn't support any enumerated value, unless specified

battr

integer array

No

Restrictions of material attributes. Section 5.3 Creative attribute list is the reference of its enumerated values

 

 

4.1.4 native request object

 

 

Parameter name

Type

Required?

Description

assets

object array

Yes

Use asset request object to show the requirement of Native ad for assets and other elements. All assets and other elements should follow this request object

ver

string

Yes

Native Markup version, default version is 1.2

context

integer

No

Ad context. Section 5.10 Context Type IDs is the reference of its enumerated values

contextsubtype

integer

No

Ad context in more details. Section 5.11 Context Sub Type IDs is the reference of its enumerated values

 

 

4.1.5 asset request object

 

 

Parameter name

Type

Required?

Description

id

integer

Yes

The only identification ID of the object

required

integer

Yes

Indicate if the asset object is a must-have for client (bidder) in order to get a bid accepted. Value of 1 means yes. Value of 0 means it is not necessary

title

object

No

Title object for title assets. Refer to title object

img

object

No

Image object for image assets. Refer to img object

video

object

No

Video object for video assets. Refer to video object

data

object

No

Data object for data assets, eg. brand, description, rating, pricing etc.Refer to data object

 

 

4.1.6 title object

 

 

Parameter name

Type

Required?

Description

len

integer

Yes

Maximum title text length. Recommended text length is 25, 90, 140 characters


 

 

4.1.7 img object

 

 

Parameter name

Type

Required?

Description

type

integer

Yes

Indicate the specific type of image. Icon image: Value = 1 Large image: Value = 3

w

integer

No

Image width

wmin

integer

Yes

Minimum image width. Unit is in pixels

h

integer

No

Image height / length

hmin

integer

Yes

Minimum image height / length. Unit is in pixels

mimes

string array

No

Supported image mime-type, including but not limited to ‘image/jpg’and ‘image/gif’


 

 

4.1.8 video object

 

 

Parameter name

Type

Required?

Description

mimes

string array

Yes

Supported content mime-type. Currently it only supports ‘video/mp4’

minduration

integer

Yes

Minimum video ad length. Unit is in seconds

maxduration

integer

Yes

Maximum video ad length. Unit is in seconds

protocols

integer array

Yes

Applicable video protocol for Publisher in Bid Response. Currently it only supports type 3, i.e. vast 3.0 protocol


 

 

4.1.9 data object

 

 

Parameter name

Type

Required?

Description

type

string array

Yes

Indicate data object type ID. Each data object has a specific type. Section 5.12 Data Asset Type is the reference of its enumerated values

len

integer

Yes

Maximum number of characters allowed

 

 

4.1.10 app object

 

 

Parameter name

Type

Required?

Description

id

string

No

Internal definition of app ID

name

string

No

Internal definition of app name

bundle

string

Yes

App package name info

domain

string

No

App domain name, eg. mygame.foo.com

cat

string array

No

App IAB category.Section 5.1 IAB category is the reference of its enumerated values

ver

string

No

App version

publisher

object

Yes

Publisher info.Refer to publisher object

 

 

4.1.11 publisher object

 

 

Parameter name

Type

Required?

Description

id

string

Yes

Publisher ID, to apply for token info

name

string

No

Publisher name

domain

string

No

Publisher's highest domain name, eg. ‘publisher.com’

cat

string array

No

App IAB category. Section 5.1 IAB category is the reference of its enumerated values


 

 

4.1.12 device object

 

 

Parameter name

Type

Required?

Description

ua

string

Yes

User-Agent field in HTTP request thread of user device

ip

string

Yes

ipv4 address of user's current network

geo

object

Yes

Current geographic info of user. Refer to geo object

didsha1

string

No

Hardware device ID (eg. IMEI), via SHA1 hash

didmd5

string

No

Hardware device ID (eg. IMEI), via MD5 hash

dpidsha1

string

No

Platform device ID (eg. Android ID), via SHA1 hash

dpidmd5

string

No

Platform device ID (eg. Android ID), via MD5 hash

macsha1

string

No

Device MAC address, via SHA1 hash

macmd5

string

No

Device MAC address, via MD5 hash

make

string

No

Device manufacturer (eg. ‘Apple’)

model

string

No

Device model (eg. ‘iPhone’)

os

string

Yes

Operation system (eg. Android, iOS)

osv

string

No

Operation system version

language

string

No

Device language, following ISO-639-1-alpha-2. If unknown, put ‘unknown’

connectiontype

integer

No

Network connection mode. Section 5.8 Network Connection Mode is the reference of its enumerated values

devicetype

integer

No

Device type. Section 5.7 Device type is the reference of its enumerated values

h

integer

No

Screen physical height / length.Unit is in pixels

w

integer

No

Screen physical width.Unit is in pixels

js

integer

No

Indicate if js is supported. Value of 0 means not supported. Value of 1 means supported.

ppi

integer

No

Screen size.Unit is in pixel per inch

dnt

integer

No

‘Do Not Track’ identification set by browser in HTTP thread. Value of 0 means tracking is not restricted. Value of 1 means tracking is restricted / not allowed.

lmt

integer

No

Indicate user's authorization for ad tracking. Value of 0 means tracking is not restricted. Value of 1 means tracking is restricted / not allowed.

ifa

string

Yes

Identification used by client.Andorid: gaid, iOS: idfa

mccmnc

string

No

Mobile network carrier


 

 

4.1.13 geo object

 

 

Parameter name

Type

Required?

Description

lat

float

No

Latitude info, data range is (-90.0,+90.0). Negative value means South

lon

float

No

Longitude info, data range is (-180.0,+180.0). Negative value means West.

type

integer

No

Source type of geo info. Value of 1 means by GPS/Location service. Value of 2 means by IP address. Value of 3 means provided by user.Section 5.13 Location Typeis the reference of its enumerated values

accuracy

integer

No

Accuracy in meters. When latitude/longitude info is obtained by GPS/Location service, this field is reported.

ipservice

integer

No

IP address provider, applicable for type = 2.Section **5.14 IP Location Type **is the reference of its enumerated values

country

string

Yes

Country code following ISO-3166-1-alpha-3

region

string

No

Region code following ISO-3166-2.If country is USA, 2-letter state code is used

city

string

No

City code following UN/LOCODE

zip

string

No

Postal code

utcoffset

integer

No

Local time difference from UTC time, +/- in minutes

 

 

4.1.14 user object

 

 

Parameter name

Type

Required?

Description

id

string

No

User ID

buyeruid

string

No

User ID defined by buyer

gender

string

No

Gender. Value of M means male, F means female, 0 means other gender.

geo

object

No

User geo info

yob

integer

No

Year of birth, 4-digit number.

keywords

string

No

Keywords list of user's interests / intentions list, separated by comma (,)

customdata

string

No

Customized data

data 

object array

No

Extra user data. Each data object represents a different data source


 

 

4.1.15 data object

 

 

Parameter name

Type

Required?

Description

id

string

No

ID of data provider

name

string

No

Name of data provider

segment

object array

No

Data segment that includes the actual data info.Refer to segment object


 

 

4.1.16 segment object

 

 

Parameter name

Type

Required?

Description

id

string

No

Segment ID defined by data provider

name

string

No

Segment name defined by data provider

value

string

No

Segment value

 

 

4.2 Bid Response

 

 

Parameter name

Type

Required?

Description

id

string

Yes

Identification for Bid Request, i.e. request id included in Bid Request section above

seatbid

object array

Yes

One set of SeatBid object. If a bid is offered, at least one SeatBid is filled in

bidid

string

No

Response ID generated for each bidder, assisting with logs or tracking transaction

cur

string

No

Unit of bid currency used, code following ISO-4217. If left blank, USD is used by default

ext

object

No

Placeholder for bidder-specific extensions to OpenRTB

 

 

4.2.1 seatbid object

 

Midas only supports 1 seatbid object to be responded at a time, and 1 seatbid only supports 1 bid to be 

responded.

 

 

Parameter name

Type

Required?

Description

bid

object array

Yes

Array that includes at least 1 bid object. Each object is related to 1 display / impression

seat

string

No

Seat identification that represents the client (bidder, eg. advertiser, agency) on whose behalf this bid is made

group

interger

No

Indicate if all bids can win or fail at the same time. Default value is 0, meaning independent bid is allowed. Value of 1 means a group of bids win or fail at the same time.

ext

object

No

Placeholder for bidder-specific extensions to OpenRTB

 

 

4.2.2 bid object

 

Each bid object must have a corresponding imp id, indicating the bid is offered for the specific impression.

 

 

Parameter name

Type

Required?

Description

id

string

Yes

Bid ID generated for each bidder, used for recording logs or tracking acitivity

impid

string

Yes

ID of imp object related to a Bid request

price

float

Yes

CPM price for each display

adid

string

No

Preloaded ad ID that can be used when a bid offer wins

nurl

string

No

Nurl link for notification when a bid wins, and will then be used by transaction platform

burl

string

Yes

Billing notice URL called by the exchange when a winning bid becomes billable based on exchange-specific business policy (e.g.,typically delivered, viewed, etc.).Substitution macros ${AUCTION_PRICE} may be included

adm

string

Yes

Convey ad content.Native ad uses adm field to return ad content. Refer to native ad response below for more detailsVideo ad uses adm field to return ad content in vast format. Refer to vast video response below for more details

adomain

string array

No

Domain name of client, used for filtering check

bundle

string

Yes for install ads

App package name, eg. Android package name: com.foo.mygame, iOS package name: id907394059

iurl

string

No

Image link to indicate ad campaign content, used for quality or security tracking

cid

string

No

Campaign ID, to assist with ad QC. Each cid has one set of creatives, which is the creatives represented by iurl

crid

string

No

ID of a set of creatives, to assist with ad QC

cat

string array

Yes

IAB category of creative.Section 5.1 IAB category is the reference of its enumerated values

attr

integer array

No

Attribute array to describe creative.Section 5.3 Creative attribute list is the reference of its enumerated values

api

integer

No

Supported API frame of the display. Section 5.4 API frame is the reference of its enumerated values

protocol

integer

No

Supported video Bid Response protocol. Section 5.6 Video bid response protocol is the reference of its enumerated values

qagmediarating

integer

Yes

Indicate rating of creative content following IQG standard.Section 5.9 IQG media rating is the reference of its enumerated values

dealid

string

No

Refer to deal.id****from the bid request if this bid pertains to a private marketplace direct deal

w

integer

No

Creative width. Unit is in pixels

h

integer

No

Creative height. Unit is in pixels

exp

integer

No

Duration that the bidder is willing to wait between the auction and the actual display / impression.Unit is in seconds, with default value of 3600

ext

object

No

Placeholder for bidder-specific extensions to OpenRTB

 

 

4.2.3 native ad response

 

Native ad response content is saved in adm field, with the content including 1 native object

Native format supports native version 1.2 protocol.

 

Native object has following attributes:

 

 

Parameter name

Type

Required?

Description

ver

string

No

Native Markup version in use

assets

array of objects

Yes

List of native ad's assets.Refer to asset response object

link

object

Yes

Destination link if the ad is clicked.Refer to link object

imptrackers

array of string

Yes

Array of impression tracking URLs.When a display / impression happens, tracking URLs are reported and used as the reference for cost calculation

ext

Object

No

Placeholder that may contain custom JSON

 

 

4.2.4 asset response object

 

Asset response object must strictly follow asset object in the Bid Request. 

Each object corresponds to an ID, which matches with the asset request object ID.

 

 

Parameter name

Type

Required?

Description

id

int

Yes

Asset ID that matches with ID in Bid Request

required

int

No

Set to 1 if asset is required (bidder requires it to be displayed)

title

object

No

Title object for title assets. Refer to title object

img

object

No

Image object for image assets. Refer to img object

video

object

No

Video object for video assets. Refer to video object

data

object

No

Data object for data assets, eg. rating, pricing.Refer to data object

ext

object

No

Placeholder that may contain custom JSON

 

 

4.2.5 title object

 

 

Parameter name

Type

Required?

Description

text

string

Yes

Title text

len

integer

No

Length of title text

ext

object

No

Placeholder that may contain custom JSON

 

 

4.2.6 Img object

 

 

Parameter name

Type

Required?

Description

type

integer

No

Required for assetsurl or dcourl responses, not required for embedded asset responsesIcon image: Value = 1 Large image: Value = 3

url

string

Yes

URL of the image asset

w

integer

Yes

Image width in pixels

h

integer

Yes

Image height in pixels

ext

object

No

Placeholder that may contain custom JSON

 

 

4.2.7 data object

 

 

Parameter name

Type

Required?

Description

type

integer

No

Type ID of data element, must follow 5.12 Data Asset Typeif to be submitted

label

string

No

Name of data element, must follow 5.12 Data Asset Typeif to be submitted

value

string

Yes

Formatted string of data, based on the requirement of each data type

ext

object

No

Placeholder that may contain custom JSON

 

 

4.2.8 video object

 

Video response object uses vasttag parameter for video content in vast format. 

Note: Video in native ad response is just one type of assets. Therefore, it doesn't support impression

and click tracking that aims only at video. Instead, it can support tracking of the rate of progress

when a video is being played.

 

 

Parameter name

Type

Required?

Description

vasttag

string

Yes

Indicate video content in vast format

 

 

4.2.9 link object

 

 

Parameter name

Type

Required?

Description

url

string

Yes

Landing URL of the clickable link

clicktrackers

array of strings

No

List of third-party tracker URLs tobe fired on click of the URL

ext

object

No

Placeholder that may contain custom JSON

 

 

5 RTB Interface Enumerated Value List

 

5.1 IAB Category Enumerated Value

 

 

Value

Description

IAB1

Arts & Entertainment

IAB1-1

Books & Literature

IAB1-2

Celebrity Fan/Gossip

IAB1-3

Fine Art

IAB1-4

Humor

IAB1-5

Movies

IAB1-6

Music

IAB1-7

Television

IAB2

Automotive

IAB2-1

Auto Parts

IAB2-2

Auto Repair

IAB2-3

Buying/Selling Cars

IAB2-4

Car Culture

IAB2-5

Certified Pre-Owned

IAB2-6

Convertible

IAB2-7

Coupe

IAB2-8

Crossover

IAB2-9

Diesel

IAB2-10

Electric Vehicle

IAB2-11

Hatchback

IAB2-12

Hybrid

IAB2-13

Luxury

IAB2-14

Minivan

IAB2-15

Motorcycles

IAB2-16

Off-Road Vehicles

IAB2-17

Performance Vehicles

IAB2-18

Pickup

IAB2-19

Road-Side Assistance

IAB2-20

Sedan

IAB2-21

Trucks & Accessories

IAB2-22

Vintage Cars

IAB2-23

Wagon

IAB3

Business

IAB3-1

Advertising

IAB3-2

Agriculture

IAB3-3

Biotech/Biomedical

IAB3-4

Business Software

IAB3-5

Construction

IAB3-6

Forestry

IAB3-7

Government

IAB3-8

Green Solutions

IAB3-9

Human Resources

IAB3-10

Logistics

IAB3-11

Marketing

IAB3-12

Metals

IAB4

Careers

IAB4-1

Career Planning

IAB4-2

College

IAB4-3

Financial Aid

IAB4-4

Job Fairs

IAB4-5

Job Search

IAB4-6

Resume Writing/Advice

IAB4-7

Nursing

IAB4-8

Scholarships

IAB4-9

Telecommuting

IAB4-10

U.S. Military

IAB4-11

Career Advice

IAB5

Education

IAB5-1

7-12 Education

IAB5-2

Adult Education

IAB5-3

Art History

IAB5-4

College Administration

IAB5-5

College Life

IAB5-6

Distance Learning

IAB5-7

English as a 2nd Language

IAB5-8

Language Learning

IAB5-9

Graduate School

IAB5-10

Homeschooling

IAB5-11

Homework/Study Tips

IAB5-12

K-6 Educators

IAB5-13

Private School

IAB5-14

Special Education

IAB5-15

Studying Business

IAB6

Family & Parenting

IAB6-1

Adoption

IAB6-2

Babies & Toddlers

IAB6-3

Daycare/Pre School

IAB6-4

Family Internet

IAB6-5

Parenting - K-6 Kids

IAB6-6

Parenting teens

IAB6-7

Pregnancy

IAB6-8

Special Needs Kids

IAB6-9

Eldercare

IAB7

Health & Fitness

IAB7-1

Exercise

IAB7-2

ADD

IAB7-3

AIDS/HIV

IAB7-4

Allergies

IAB7-5

Alternative Medicine

IAB7-6

Arthritis

IAB7-7

Asthma

IAB7-8

Autism/PDD

IAB7-9

Bipolar Disorder

IAB7-10

Brain Tumor

IAB7-11

Cancer

IAB7-12

Cholesterol

IAB7-13

Chronic Fatigue Syndrome

IAB7-14

Chronic Pain

IAB7-15

Cold & Flu

IAB7-16

Deafness

IAB7-17

Dental Care

IAB7-18

Depression

IAB7-19

Dermatology

IAB7-20

Diabetes

IAB7-21

Epilepsy

IAB7-22

GERD/Acid Reflux

IAB7-23

Headaches/Migraines

IAB7-24

Heart Disease

IAB7-25

Herbs for Health

IAB7-26

Holistic Healing

IAB7-27

IBS/Crohn’s Disease

IAB7-28

Incest/Abuse Support

IAB7-29

Incontinence

IAB7-30

Infertility

IAB7-31

Men’s Health

IAB7-32

Nutrition

IAB7-33

Orthopedics

IAB7-34

Panic/Anxiety Disorders

IAB7-35

Pediatrics

IAB7-36

Physical Therapy

IAB7-37

Psychology/Psychiatry

IAB7-38

Senior Health

IAB7-39

Sexuality

IAB7-40

Sleep Disorders

IAB7-41

Smoking Cessation

IAB7-42

Substance Abuse

IAB7-43

Thyroid Disease

IAB7-44

Weight Loss

IAB7-45

Women's Health

IAB8

Food & Drink

IAB8-1

American Cuisine

IAB8-2

Barbecues & Grilling

IAB8-3

Cajun/Creole

IAB8-4

Chinese Cuisine

IAB8-5

Cocktails/Beer

IAB8-6

Coffee/Tea

IAB8-7

Cuisine-Specific

IAB8-8

Desserts & Baking

IAB8-9

Dining Out

IAB8-10

Food Allergies

IAB8-11

French Cuisine

IAB8-12

Health/Low-Fat Cooking

IAB8-13

Italian Cuisine

IAB8-14

Japanese Cuisine

IAB8-15

Mexican Cuisine

IAB8-16

Vegan

IAB8-17

Vegetarian

IAB8-18

Wine

IAB9

Hobbies & Interests

IAB9-1

Art/Technology

IAB9-2

Arts & Crafts

IAB9-3

Beadwork

IAB9-4

Bird-Watching

IAB9-5

Board Games/Puzzles

IAB9-6

Candle & Soap Making

IAB9-7

Card Games

IAB9-8

Chess

IAB9-9

Cigars

IAB9-10

Collecting

IAB9-11

Comic Books

IAB9-12

Drawing/Sketching

IAB9-13

Freelance Writing

IAB9-14

Genealogy

IAB9-15

Getting Published

IAB9-16

Guitar

IAB9-17

Home Recording

IAB9-18

Investors & Patents

IAB9-19

Jewelry Making

IAB9-20

Magic & Illusion

IAB9-21

Needlework

IAB9-22

Painting

IAB9-23

Photography

IAB9-24

Radio

IAB9-25

Roleplaying Games

IAB9-26

Sci-Fi & Fantasy

IAB9-27

Scrapbooking

IAB9-28

Screenwriting

IAB9-29

Stamps & Coins

IAB9-30

Video & Computer Games

IAB9-31

Woodworking

IAB10

Home & Garden

IAB10-1

Appliances

IAB10-2

Entertaining

IAB10-3

Environmental Safety

IAB10-4

Gardening

IAB10-5

Home Repair

IAB10-6

Home Theater

IAB10-7

Interior Decorating

IAB10-8

Landscaping

IAB10-9

Remodeling & Construction

IAB11

Law, Government, & Politics

IAB11-1

Immigration

IAB11-2

Legal Issues

IAB11-3

U.S. Government Resources

IAB11-4

Politics

IAB11-5

Commentary

IAB12

News

IAB12-1

International News

IAB12-2

National News

IAB12-3

Local News

IAB13

Personal Finance

IAB13-1

Beginning Investing

IAB13-2

Credit/Debt & Loans

IAB13-3

Financial News

IAB13-4

Financial Planning

IAB13-5

Hedge Fund

IAB13-6

Insurance

IAB13-7

Investing

IAB13-8

Mutual Funds

IAB13-9

Options

IAB13-10

Retirement Planning

IAB13-11

Stocks

IAB13-12

Tax Planning

IAB14

Society

IAB14-1

Dating

IAB14-2

Divorce Support

IAB14-3

Gay Life

IAB14-4

Marriage

IAB14-5

Senior Living

IAB14-6

Teens

IAB14-7

Weddings

IAB14-8

Ethnic Specific

IAB15

Science

IAB15-1

Astrology

IAB15-2

Biology

IAB15-3

Chemistry

IAB15-4

Geology

IAB15-5

Paranormal Phenomena

IAB15-6

Physics

IAB15-7

Space/Astronomy

IAB15-8

Geography

IAB15-9

Botany

IAB15-10

Weather

IAB16

Pets

IAB16-1

Aquariums

IAB16-2

Birds

IAB16-3

Cats

IAB16-4

Dogs

IAB16-5

Large Animals

IAB16-6

Reptiles

IAB16-7

Veterinary Medicine

IAB17

Sports

IAB17-1

Auto Racing

IAB17-2

Baseball

IAB17-3

Bicycling

IAB17-4

Bodybuilding

IAB17-5

Boxing

IAB17-6

Canoeing/Kayaking

IAB17-7

Cheerleading

IAB17-8

Climbing

IAB17-9

Cricket

IAB17-10

Figure Skating

IAB17-11

Fly Fishing

IAB17-12

Football

IAB17-13

Freshwater Fishing

IAB17-14

Game & Fish

IAB17-15

Golf

IAB17-16

Horse Racing

IAB17-17

Horses

IAB17-18

Hunting/Shooting

IAB17-19

Inline Skating

IAB17-20

Martial Arts

IAB17-21

Mountain Biking

IAB17-22

NASCAR Racing

IAB17-23

Olympics

IAB17-24

Paintball

IAB17-25

Power & Motorcycles

IAB17-26

Pro Basketball

IAB17-27

Pro Ice Hockey

IAB17-28

Rodeo

IAB17-29

Rugby

IAB17-30

Running/Jogging

IAB17-31

Sailing

IAB17-32

Saltwater Fishing

IAB17-33

Scuba Diving

IAB17-34

Skateboarding

IAB17-35

Skiing

IAB17-36

Snowboarding

IAB17-37

Surfing/Body-Boarding

IAB17-38

Swimming

IAB17-39

Table Tennis/Ping-Pong

IAB17-40

Tennis

IAB17-41

Volleyball

IAB17-42

Walking

IAB17-43

Waterski/Wakeboard

IAB17-44

World Soccer

IAB18

Style & Fashion

IAB18-1

Beauty

IAB18-2

Body Art

IAB18-3

Fashion

IAB18-4

Jewelry

IAB18-5

Clothing

IAB18-6

Accessories

IAB19

Technology & Computing

IAB19-1

3-D Graphics

IAB19-2

Animation

IAB19-3

Antivirus Software

IAB19-4

C/C++

IAB19-5

Cameras & Camcorders

IAB19-6

Cell Phones

IAB19-7

Computer Certification

IAB19-8

Computer Networking

IAB19-9

Computer Peripherals

IAB19-10

Computer Reviews

IAB19-11

Data Centers

IAB19-12

Databases

IAB19-13

Desktop Publishing

IAB19-14

Desktop Video

IAB19-15

Email

IAB19-16

Graphics Software

IAB19-17

Home Video/DVD

IAB19-18

Internet Technology

IAB19-19

Java

IAB19-20

JavaScript

IAB19-21

Mac Support

IAB19-22

MP3/MIDI

IAB19-23

Net Conferencing

IAB19-24

Net for Beginners

IAB19-25

Network Security

IAB19-26

Palmtops/PDAs

IAB19-27

PC Support

IAB19-28

Portable

IAB19-29

Entertainment

IAB19-30

Shareware/Freeware

IAB19-31

Unix

IAB19-32

Visual Basic

IAB19-33

Web Clip Art

IAB19-34

Web Design/HTML

IAB19-35

Web Search

IAB19-36

Windows

IAB20

Travel

IAB20-1

Adventure Travel

IAB20-2

Africa

IAB20-3

Air Travel

IAB20-4

Australia & New Zealand

IAB20-5

Bed & Breakfasts

IAB20-6

Budget Travel

IAB20-7

Business Travel

IAB20-8

By US Locale

IAB20-9

Camping

IAB20-10

Canada

IAB20-11

Caribbean

IAB20-12

Cruises

IAB20-13

Eastern Europe

IAB20-14

Europe

IAB20-15

France

IAB20-16

Greece

IAB20-17

Honeymoons/Getaways

IAB20-18

Hotels

IAB20-19

Italy

IAB20-20

Japan

IAB20-21

Mexico & Central America

IAB20-22

National Parks

IAB20-23

South America

IAB20-24

Spas

IAB20-25

Theme Parks

IAB20-26

Traveling with Kids

IAB20-27

United Kingdom

IAB21

Real Estate

IAB21-1

Apartments

IAB21-2

Architects

IAB21-3

Buying/Selling Homes

IAB22

Shopping

IAB22-1

Contests & Freebies

IAB22-2

Couponing

IAB22-3

Comparison

IAB22-4

Engines

IAB23

Religion & Spirituality

IAB23-1

Alternative Religions

IAB23-2

Atheism/Agnosticism

IAB23-3

Buddhism

IAB23-4

Catholicism

IAB23-5

Christianity

IAB23-6

Hinduism

IAB23-7

Islam

IAB23-8

Judaism

IAB23-9

Latter-Day Saints

IAB23-10

Pagan/Wiccan

IAB24****IAB25

Uncategorized****Non-Standard Content

IAB25-1

Unmoderated UGC

IAB25-2

Extreme Graphic/Explicit Violence

IAB25-3

Pornography

IAB25-4

Profane Content

IAB25-5

Hate Content

IAB25-6

Under Construction

IAB25-7

Incentivized

IAB26

Illegal Content

IAB26-1

Illegal Content

IAB26-2

Warez

IAB26-3

Spyware/Malware

IAB26-4

Copyright Infringement

 

 

5.2 Banner Ad Type Enumerated Value

 

|Value|Description| |:----|:----|:----|:----| |1|XHTML Text Ad (usually mobile)| |2|XHTML Banner Ad. (usually mobile)| |3|JavaScript Ad; must be valid XHTML (i.e., Script Tags Included)| |4|iframe|

 

5.3 Creative Attribute Enumerated Value

 

 

Value

Description

1

Audio Ad(Auto-Play)

2

Audio Ad(User Initiated)

3

Expandable(Automatic)

4

Expandable(User Initiated - Click)

5

Expandable(User Initiated - Rollover)

6

In-Banner Video Ad (Auto-Play)

7

In-Banner Video Ad (User Initiated)

8

Pop (e.g., Over, Under, or Upon Exit)

9

Provocative or Suggestive Imagery

10

Shaky, Flashing, Flickering, Extreme Animation, Smileys

11

Surveys

12

Text Only

13

User Interactive (e.g., Embedded Games)

14

Windows Dialog or Alert Style

15

Has Audio On/Off Button

16

Ad Provides Skip Button (e.g. VPAID-rendered skip button on pre-roll video)

17

Adobe Flash

 

 

5.4 API Frame Enumerated Value

 

 

Value

Description

1

VPAID 1.0

2

VPAID 2.0

3

MRAID-1

4

ORMMA

5

MRAID-2

6

MRAID-3

 

 

5.5 Ad Placement / Position Attribute Enumerated Value

 

 

Value

Description

0

Unknown

1

Above the Fold

2

DEPRECATED - May or may not be initially visible depending on screen size/resolution.

3

Below the Fold

4

Header

5

Footer

6

Sidebar

7

Full Screen

 

 

5.6 Video Bid Response Protocol Enumerated Value

 

 

Value

Description

1

VAST 1.0

2

VAST 2.0

3

VAST 3.0

4

VAST 1.0 Wrapper

5

VAST 2.0 Wrapper

6

VAST 3.0 Wrapper

7

VAST 4.0

8

DAAST 1.0

 

 

5.7 Device Type Enumerated Value

 

 

Value

Description

1

Mobile/Tablet Version 2.0

2

Personal Computer Version 2.0

3

Connected TV Version 2.0

4

Phone New for Version 2.2

5

Tablet New for Version 2.2

6

Connected Device New for Version 2.2

7

Set Top Box New for Version 2.2

 

 

5.8 Network Connection Mode Enumerated Value

 

 

Value

Description

0

Unknown

1

Ethernet

2

WIFI

3

Cellular Network – Unknown Generation

4

Cellular Network – 2G

5

Cellular Network – 3G

6

Cellular Network – 4G

7

Cellular Network – 5G

 

 

5.9 IQG Media Rating Enumerated Value

 

 

Value

Description

1

All Audiences

2

Everyone Over 12

3

Mature Audiences

 

 

5.10 Context Type IDs

 

 

Value

Description

1

Content-centric context such as newsfeed, article, image gallery, video gallery, or similar

2

Social-centric context such as social network feed, email, chat, or similar.

3

Product context such as product listings, details, recommendations, reviews, or similar.

 

 

5.11 Context Sub Type IDs

 

 

Value

Description

10

General or mixed content.

11

Primarily article content (which of course could include images, etc as part of the article)

12

Primarily video content

13

Primarily audio content

14

Primarily image content

15

User-generated content - forums, comments, etc

20

General social content such as a general social network

21

Primarily email content

22

Primarily chat/IM content

30

Content focused on selling products, whether digital or physical

31

Application store/marketplace

32

Product reviews site primarily (which may sell product secondarily)

 

5.12 Data Asset Type

 

|Type ID|Name|Description| |:----|:----| |1|sponsored|Sponsored By message where response should contain the brand name of the sponsor.| |2|desc|Descriptive text associated with the product or service being advertised. Longer length of text in 

response may be truncated or ellipsed by the exchange.|

 |3|rating|Rating of the product being offered to the user. For example an app’s rating in an app store from 

0-5.| |4|likes|Number of social ratings or “likes” of the product being offered to the user.| |5|downloads|

Number downloads/installs of this product | |6|price|Price for product / app / in-app purchase. Value should

include currency symbol in localised format.| |7|saleprice|Sale price that can be used together with price to

indicate a discounted price compared to a regular price. Value should include currency symbol in localised

format.| |8|phone|Phone number| |9|address|Address| |10|desc2|Additional descriptive text associated with

the product or service being advertised| |11|displayurl|Display URL for the text ad. To be used when

sponsoring entity doesn’t own the content. IE sponsored by BRAND on SITE (where SITE is transmitted in

this field).| |12|ctatext|CTA description - descriptive text describing a ‘call to action’ button for the

destination URL.|

 

5.13 Location Type

 

 

Value

Description

1

GPS/Location Services 

2

IP Address 

3

User provided (e.g., registration data)

 

 

5.14 IP Location Services

 

 

Value

Description

1

ip2location

2

Neustar (Quova)

3

MaxMind

4

NetAcuity (Digital Element) 

 

 

RTB Request Example

 

1a) native icon image request example

 

{
  "id":"123",
  "imp": [{
    "id":"1",
    "tagid":"2049",
    "bidfloor":0.01,
    "bidfloorcur":"USD",
    "native": {
      "request":"{\"assets\":[{\"required\":1,\"img\":{\"type\":1,\"wmin\":84,\"hmin\":84}}],\"ver\": \"1.2\"}",
      "ver": "1.2"
    },
    "instl":0
  }],
  "app": {
    "storeurl":"",
    "ver":"8888888",
    "publisher": {
      "id":"de30a0c4-ed1c-42bd-a5ff-af65852ef34a"
    }
  },
  "device": {
    "ip":"1.1.1.1",
    "geo": {
      "country":"IDN"
    }
  }
}

 

1b) native large image request example

 

{
  "id":"123",
  "imp":[{
    "id":"1",
    "tagid":"2049",
    "bidfloor":0.01,
    "bidfloorcur":"USD",
    "native": {
      "request": "{\"assets\":[{\"required\":1,\"img\":{\"type\":3,\"wmin\":600,\"hmin\":314}}],\"ver\": \"1.2\"}",
       "ver":"1.2"
    },
    "instl":0
  }],
  "app":{
    "storeurl":"",
    "ver":"8888888",
    "publisher":{
      "id":"de30a0c4-ed1c-42bd-a5ff-af65852ef34a"
    }
  },
  "device":{
    "ip":"1.1.1.1",
    "geo":{
      "country":"IDN"
    }
  }
}

 

1c) native video request example

 

{
  "id":"32f94228-52d3-4bce-be88-5dd1d799ae4f",
  "imp": [{
    "id":"1",
    "tagid":"2061",
    "bidfloor":1.00,
    "bidfloorcur":"USD",
    "secure":0,
    "native":{
      "request":"{\"assets\":[{\"id\":1,\"required\":1,\"title\":{\"len \":100}},{\"id\":2,\"required \":0,\"data \":{\"type \":2,\"len \":100}},{\"id\":3,\"required \":0,\"img \":{\"type \":3}},{\"id \":4,\"required \":1,\"img \":{\"type\":1}},{\"id \":5,\"required \":0,\"img\":{\"type \":1}},{\"id\":6,\"required\":0,\"data\":{\"type \":12,\"len \":100}},{\"id\":7,\"required\":1,\"video\":{\"mimes\":[\"video/mp4\"],\"maxduration\":30,\"protocols\":[3],\"w\":1280,\"h\":720,\"linearity\":1,\"skip\":0,\"battr\":[16],\"maxbitrate\":2000,\"delivery\":[2],\"companionad\":[{\"w\":1280,\"h\":720,\"id\":\"1\",\"btype\":[1,2,4],\"battr\":[16],\"pos\":7,\"mimes\":[\"application/javascript\"],\"ext\":{\"orientation\":1}}]}}], \"ver\": \"1.2\"}",
        "ver":"1.2"
    }
  }],
  
  "app": {
    "id":"100461",
    "ver":"4050618",
    "publisher": {
      "id":"bd8b25d0-413e-4886-9adf-6a796ff47740"
    }
  },
  "device": {
    "ip":"1.1.1.1",
    "geo": {
      "country":"IDN",
      "type":2
    },
    "devicetype":4,
    "make":"WIKO",
    "model":"samsung-sm-g900a",
    "os":"android",
    "osv":"5.1.1",
    "language":"en",
    "carrier":"310410",
    "connectiontype":7,
    "ifa":"5731b4c8-7cc1-4a09-bb77-24f237d93a66",
    "didsha1":"ecae9042f3e549a4fd1af27a1ed38b5f682fa3ca",
    "didmd5":"c98de3c3706ae57c89f97c0778c8121d",
    "dpidsha1":"a07713adea29cd23fd10a2e81a4fb07e23e00fb7",
    "dpidmd5":"af4935679d392191157f687f48907492"
  },
  "at":1,
  "tmax":2000
}

 

1d)banner request example

 

{
    "id": "123",
    "imp": [{
        "id": "1",
        "tagid": "2051",
        "bidfloor": 0.00001,
        "bidfloorcur": "USD",
        "banner":{
            "w":320,
            "h":50,
            "mimes": ["image/png", "image/jpg", "image/gif"]
        },
        "instl": 0
    }],
 
    "app": {
        "storeurl": "",
        "ver": "8888888",
        "publisher": {
            "id": "5e33f618-42a0-47f0-b7b1-9ad9866f3b9a"
        }
    },
    "device": {
        "ip": "1.1.1.1",
        "geo": {
            "country": "IDN"
        },
        "connectiontype": 7
    }
}

 

 

RTB Response Example

 

2a) native icon image response example

 

{
  "id":"123",
  "bidid":"47b61fdb-0c63-46fc-9343-df78cd5b700f",
  "seatbid":[{
    "bid":[{
      "id":"47b61fdb-0c63-46fc-9343-df78cd5b700f",
      "impid":"1",
      "price":289,
      "burl": "http://midas-tracker-dev.hellay.net/win.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b670a47da2e4cfc471bc12cab9b8b93ea9f6096bc3754a4504199138bfc3de2175b25964e6353ca9390f6b7d21d46562d114b3ce6b79aff194ecdf27e608df0042697e7b0649503d67118df10c3755021e9f0de8f7a9b81239631fcaec5085653cc924139de74a362dd9e496589f008a5fe08421489a154726e484f2a9ffd7974a17970b211becc8a6e0cbeb0da71a2ae9adeb03e38ccd710ae582d51af0d38435548613dd6ccc224e2043f773fb9d19f781248676bd6cfeb60aebed339572462c42954267f6d5674eb418481a076e1e93a80211802c27dbe661bc5261764e6ce987657027a6622954100b11934fd1e5b5034a26c4eef9d554705b9f2ac51c3f0bd4a70dec9eb1e3de6f8fefd4f565a4c11a76f3c0cdf2b039cde4bc985eb65e5f5d73ef36b82b0a67ac3031310b383067f90eb6a5ae7259c9888337e30b69a5c1f0c089e4014766a861d9e6f391a6659687391ba1c3f8b3e4c1335b8a729d305b73b985ebd4e063cf47ca2b38f3312ab92df818eaf56342bea6633b7e9d2ae195fbf5200646ea3b3afaf413a76f1c6785087c65feec214112cbc835df6f6fcab32fdc31d1288e01128279a527a8c9601e290cbf7a138230eee2eaf3023cb15&auction_price=${AUCTION_PRICE}&sid=__SID__",
      "adm":"{\"ver\":\"1.2\",\"assets\":[{\"img\":{\"type\":1,\"url\":\"http://static-dev.rqmob.com/test/sa/20210710/53da2d2e6b4f1482ecc5afd2c15bc824__FILE_CM____FILE_CM480_720____WEBP__.png\",\"w\":84,\"h\":84}}],\"link\":{\"url\":\"https://play.google.com/store/apps/details?id=com.janel.doctor.ear\&hl=en\",\"clicktrackers\":[\"http://midas-tracker-dev.hellay.net/clk.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b670a47da2e4cfc471bc12cab9b8b93ea9f6096bc3754a4504199138bfc3de2175b25964e6353ca9390f6b7d21d46562d114b3ce6b79aff194ecdf27e608df0042697e7b0649503d67118df10c3755021e9f0de8f7a9b81239631fcaec5085653cc924139de74a362dd9e496589f008a5fe08421489a154726e484f2a9ffd7974a17970b211becc8a6e0cbeb0da71a2ae9adeb03e38ccd710ae582d51af0d38435548613dd6ccc224e2043f773fb9d19f781248676bd6cfeb60aebed339572462c42954267f6d5674eb418481a076e1e93a80211802c27dbe661bc5261764e6ce987657027a6622954100b11934fd1e5b5034a26c4eef9d554705b9f2ac51c3f0bd4a70dec9eb1e3de6f8fefd4f565a4c11a76f3c0cdf2b039cde4bc985eb65e5f5d73ef36b82b0a67ac3031310b383067f90eb6a5ae7259c9888337e30b69a5c1f0c089e4014766a861d9e6f391a6659687391ba1c3f8b3e4c1335b8a729d305b73b985ebd4e063cf47ca2b38f3312ab92df818eaf56342bea6633b7e9d2ae195fbf5200646ea3b3afaf413a76f1c6785087c65feec214112cbc835df6f6fcab32fdc31d1288e01128279a527a8c9601f19dd0f5a75a3f7f38f1\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_clk.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpQ2xpY2siLCJyZXF1ZXN0X2lkIjoiNDdiNjFmZGItMGM2My00NmZjLTkzNDMtZGY3OGNkNWI3MDBmIiwic3ViX3BsYXRmb3JtIjoiY3BpIiwiY2hhbm5lbCI6Ik9NQ19TREsiLCJjbGllbnRfaXAiOiIxLjEuMS4xIiwic2NyZWVuX3NpemUiOiIweDAiLCJjb3VudHJ5IjoiaWQiLCJQYXJhbXMiOlt7ImNhbXBhaWduX2lkIjoyMjM4LCJwb3NfaWQiOiIyMDQ5IiwiYWRfaWQiOjEwMDc2NiwiY2FtcF9uYW1lIjoicGFubHVoLXNhbiIsImFkX3BhY2thZ2VfbmFtZSI6ImNvbS5qYW5lbC5kb2N0b3IuZWFyIiwiY2lkIjozODgwMywiYmlkX3ByaWNlIjoxMjMwMDAwMDAsImVjcG0iOjI4OTU1MzgwNCwiZHNwX25hbWUiOiJTaGFyZWl0IiwiYXR0cl9wbGF0Zm9ybSI6MiwiYWRzZXRfaWQiOjEzNTAsImFkX25hbWUiOiJTQU4tU0RLIiwiYWRzZXRfbmFtZSI6IlNBTi1TREsiLCJwaHlfcG9zIjoiMjA0OSJ9XSwibWlkYXNfdmVyc2lvbiI6IjIuMCJ9\&sid=__SID__\"]},\"imptrackers\":[\"http://midas-tracker-dev.hellay.net/imp.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b670a47da2e4cfc471bc12cab9b8b93ea9f6096bc3754a4504199138bfc3de2175b25964e6353ca9390f6b7d21d46562d114b3ce6b79aff194ecdf27e608df0042697e7b0649503d67118df10c3755021e9f0de8f7a9b81239631fcaec5085653cc924139de74a362dd9e496589f008a5fe08421489a154726e484f2a9ffd7974a17970b211becc8a6e0cbeb0da71a2ae9adeb03e38ccd710ae582d51af0d38435548613dd6ccc224e2043f773fb9d19f781248676bd6cfeb60aebed339572462c42954267f6d5674eb418481a076e1e93a80211802c27dbe661bc5261764e6ce987657027a6622954100b11934fd1e5b5034a26c4eef9d554705b9f2ac51c3f0bd4a70dec9eb1e3de6f8fefd4f565a4c11a76f3c0cdf2b039cde4bc985eb65e5f5d73ef36b82b0a67ac3031310b383067f90eb6a5ae7259c9888337e30b69a5c1f0c089e4014766a861d9e6f391a6659687391ba1c3f8b3e4c1335b8a729d305b73b985ebd4e063cf47ca2b38f3312ab92df818eaf56342bea6633b7e9d2ae195fbf5200646ea3b3afaf413a76f1c6785087c65feec214112cbc835df6f6fcab32fdc31d1288e01128279a527a8c9601f698cae6a06433d213ad0e27e61ecbf359716f\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_imp.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpU2hvdyIsInJlcXVlc3RfaWQiOiI0N2I2MWZkYi0wYzYzLTQ2ZmMtOTM0My1kZjc4Y2Q1YjcwMGYiLCJzdWJfcGxhdGZvcm0iOiJjcGkiLCJjaGFubmVsIjoiT01DX1NESyIsImNsaWVudF9pcCI6IjEuMS4xLjEiLCJzY3JlZW5fc2l6ZSI6IjB4MCIsImNvdW50cnkiOiJpZCIsIlBhcmFtcyI6W3siY2FtcGFpZ25faWQiOjIyMzgsInBvc19pZCI6IjIwNDkiLCJhZF9pZCI6MTAwNzY2LCJjYW1wX25hbWUiOiJwYW5sdWgtc2FuIiwiYWRfcGFja2FnZV9uYW1lIjoiY29tLmphbmVsLmRvY3Rvci5lYXIiLCJjaWQiOjM4ODAzLCJiaWRfcHJpY2UiOjEyMzAwMDAwMCwiZWNwbSI6Mjg5NTUzODA0LCJkc3BfbmFtZSI6IlNoYXJlaXQiLCJhdHRyX3BsYXRmb3JtIjoyLCJhZHNldF9pZCI6MTM1MCwiYWRfbmFtZSI6IlNBTi1TREsiLCJhZHNldF9uYW1lIjoiU0FOLVNESyIsInBoeV9wb3MiOiIyMDQ5In1dLCJtaWRhc192ZXJzaW9uIjoiMi4wIn0\&sid=__SID__\"]}",
      "adid":"100766"
    }]
  }],
  "cur":"USD"
}

 

2b) native large image response example

 

{
  "id":"123",
  "bidid":"292bb9a0-0782-4d36-b543-437b47d48fef",
  "seatbid":[{
    "bid":[{
      "id":"292bb9a0-0782-4d36-b543-437b47d48fef",
      "impid":"1",
      "price":286,
      "burl":"http://midas-tracker-dev.hellay.net/win.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b650f47da2e4cfc41a095014a039da67c124ea7967efe7813bb7a17263fad53e827b61f999d776ff1cab439eac5ca4a5a90cec45454569c719dcaeb76ecee7917aa2e81aac1b96ee38c0faed998697cef41595637e9d1789ff24157fb37d290cfd4f37c4f87682e950964cada4915e29ade88ee663dcca4ef4080a3b2c18a39c819c8c68d685c27d4fe098fb694eab0fc95fdd54c55909b3783d7556de04d0b9e0a69556da80f1f3d5d7422078be5635fff6209f88e4240728987fcc3b0117f7a87bd743356242cc8518ea5fe9ea9e545354cdeb46fd1912a21fd776145ed8df1b7bb7d185bcf119adeebb6a0004f85202f4edb7a8822be24bfaf0e2372f0fdedc91dd8bc07c63c17b1e6f2c613863e4843124a3f7f2524aa6505bfa88c9dcc8133c8e11a0e4e7b71bc3a16ce3c8cb7025af21f84288355f9f330aae9c3fadf9177b6a2c81669ef00f0da7e95ef1562ebf10da4fa26849d609a370cfc8a6ea6052b1182dd14eeb31870ce4dc064b8be92fa58ba2f33aa7c3ae1b5c2cdd5d13a1a09335730d9bf1dd473e70f0c44eea10769dc831399256b411a96cd8791ca0e978fa858717c041af3cb8b5e96fcfbf4eb9fb1d6df74249cf5a46fc831e4bf&auction_price=${AUCTION_PRICE}&sid=__SID__",
      "adm":"{\"ver\":\"1.2\",\"assets\":[{\"img\":{\"type\":3,\"url\":\"http://static-dev.rqmob.com/test/sa/20210710/95def64e487533b5415faaf8486491f5__FILE_CM____FILE_CM480_720____WEBP__.png\",\"w\":660,\"h\":346}}],\"link\":{\"url\":\"https://play.google.com/store/apps/details?id=com.janel.doctor.ear\&hl=en\",\"clicktrackers\":[\"http://midas-tracker-dev.hellay.net/clk.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b650f47da2e4cfc41a095014a039da67c124ea7967efe7813bb7a17263fad53e827b61f999d776ff1cab439eac5ca4a5a90cec45454569c719dcaeb76ecee7917aa2e81aac1b96ee38c0faed998697cef41595637e9d1789ff24157fb37d290cfd4f37c4f87682e950964cada4915e29ade88ee663dcca4ef4080a3b2c18a39c819c8c68d685c27d4fe098fb694eab0fc95fdd54c55909b3783d7556de04d0b9e0a69556da80f1f3d5d7422078be5635fff6209f88e4240728987fcc3b0117f7a87bd743356242cc8518ea5fe9ea9e545354cdeb46fd1912a21fd776145ed8df1b7bb7d185bcf119adeebb6a0004f85202f4edb7a8822be24bfaf0e2372f0fdedc91dd8bc07c63c17b1e6f2c613863e4843124a3f7f2524aa6505bfa88c9dcc8133c8e11a0e4e7b71bc3a16ce3c8cb7025af21f84288355f9f330aae9c3fadf9177b6a2c81669ef00f0da7e95ef1562ebf10da4fa26849d609a370cfc8a6ea6052b1182dd14eeb31870ce4dc064b8be92fa58ba2f33aa7c3ae1b5c2cdd5d13a1a09335730d9bf1dd473e70f0c44eea10769dc831399256b411a96cd8791ca0e978fa858717c041af3cb8b5e96fcfbf4f892aad4d91638832204\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_clk.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpQ2xpY2siLCJyZXF1ZXN0X2lkIjoiMjkyYmI5YTAtMDc4Mi00ZDM2LWI1NDMtNDM3YjQ3ZDQ4ZmVmIiwic3ViX3BsYXRmb3JtIjoiY3BpIiwiY2hhbm5lbCI6Ik9NQ19TREsiLCJjbGllbnRfaXAiOiIxLjEuMS4xIiwic2NyZWVuX3NpemUiOiIweDAiLCJjb3VudHJ5IjoiaWQiLCJQYXJhbXMiOlt7ImNhbXBhaWduX2lkIjoyMjM4LCJwb3NfaWQiOiIyMDQ5IiwiYWRfaWQiOjEwMDc2NiwiY2FtcF9uYW1lIjoicGFubHVoLXNhbiIsImFkX3BhY2thZ2VfbmFtZSI6ImNvbS5qYW5lbC5kb2N0b3IuZWFyIiwiY2lkIjozODgyNiwiYmlkX3ByaWNlIjoxMjMwMDAwMDAsImVjcG0iOjI4NjI2MjYxNCwiZHNwX25hbWUiOiJTaGFyZWl0IiwiYXR0cl9wbGF0Zm9ybSI6MiwiYWRzZXRfaWQiOjEzNTAsImFkX25hbWUiOiJTQU4tU0RLIiwiYWRzZXRfbmFtZSI6IlNBTi1TREsiLCJwaHlfcG9zIjoiMjA0OSJ9XSwibWlkYXNfdmVyc2lvbiI6IjIuMCJ9\&sid=__SID__\",\"http://ping-test.rqmob.com/click?ad=SAN-SDK\&ad_id=100766\&ad_type={ad_type}\&adpos_id=2049\&adset={adset}\&adset_id=1350\&advid=29\&_app_id=7752\&android_id=\&app_id=\&app_type=3\&beyla_id=\&c={c}\&c_id=38826\&campid=1321943\&channel_pkg=\&channel_pkg_ver=0\&cost_currency={cost_currency}\&cost_model={cost_model}\&cost_value={cost_value}\&country_code=id\&device_id=\&ext_info={ext_info}\&gaid=\&imei={imei}\&imsi={imsi}\&ip=1.1.1.1\&is_offline=1\&is_pre_install={is_pre_install}\&midas_camp_id=2238\&midas_traffic_type=1\&os_version=\&other_category={other_category}\&pkg=com.janel.doctor.ear\&placement=2049\&platform=adshonor\&real_attrplat=2\&remote_ip=1.1.1.1\&requestid=292bb9a0-0782-4d36-b543-437b47d48fef\&sid={sid}\&site_id={site_id}\&uagent=\",\"http://midas-tracker-dev.hellay.net/effect.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b650f47da2e4cfc41a095014a039da67c124ea7967efe7813bb7a17263fad53e827b61f999d776ff1cab439eac5ca4a5a90cec45454569c719dcaeb76ecee7917aa2e81aac1b96ee38c0faed998697cef41595637e9d1789ff24157fb37d290cfd4f37c4f87682e950964cada4915e29ade88ee663dcca4ef4080a3b2c18a39c819c8c68d685c27d4fe098fb694eab0fc95fdd54c55909b3783d7556de04d0b9e0a69556da80f1f3d5d7422078be5635fff6209f88e4240728987fcc3b0117f7a87bd743356242cc8518ea5fe9ea9e545354cdeb46fd1912a21fd776145ed8df1b7bb7d185bcf119adeebb6a0004f85202f4edb7a8822be24bfaf0e2372f0fdedc91dd8bc07c63c17b1e6f2c613863e4843124a3f7f2524aa6505bfa88c9dcc8133c8e11a0e4e7b71bc3a16ce3c8cb7025af21f84288355f9f330aae9c3fadf9177b6a2c81669ef00f0da7e95ef1562ebf10da4fa26849d609a370cfc8a6ea6052b1182dd14eeb31870ce4dc064b8be92fa58ba2f33aa7c3ae1b5c2cdd5d13a1a09335730d9bf1dd473e70f0c44eea10769dc831399256b411a96cd8791ca0e978fa858717c041af3cb8b5e96fcfbf4ff97b0c7de2834ae6eb4de3deb240e3b1ff423\&effect_type={EFFECT_TYPE}\&sid=__SID__\"]},\"imptrackers\":[\"http://midas-tracker-dev.hellay.net/imp.fcg?viewid=e6d8578664e2f10e11afa9c2e16cb37680d4df1e94d245ba2d33780f1edaba4ac6aa12fb51d3bf16e4e45ea2f5d7f6001a07323bea0c8e8feabe0dc8d191ef8ab417be2d03b8f2f42b650f47da2e4cfc41a095014a039da67c124ea7967efe7813bb7a17263fad53e827b61f999d776ff1cab439eac5ca4a5a90cec45454569c719dcaeb76ecee7917aa2e81aac1b96ee38c0faed998697cef41595637e9d1789ff24157fb37d290cfd4f37c4f87682e950964cada4915e29ade88ee663dcca4ef4080a3b2c18a39c819c8c68d685c27d4fe098fb694eab0fc95fdd54c55909b3783d7556de04d0b9e0a69556da80f1f3d5d7422078be5635fff6209f88e4240728987fcc3b0117f7a87bd743356242cc8518ea5fe9ea9e545354cdeb46fd1912a21fd776145ed8df1b7bb7d185bcf119adeebb6a0004f85202f4edb7a8822be24bfaf0e2372f0fdedc91dd8bc07c63c17b1e6f2c613863e4843124a3f7f2524aa6505bfa88c9dcc8133c8e11a0e4e7b71bc3a16ce3c8cb7025af21f84288355f9f330aae9c3fadf9177b6a2c81669ef00f0da7e95ef1562ebf10da4fa26849d609a370cfc8a6ea6052b1182dd14eeb31870ce4dc064b8be92fa58ba2f33aa7c3ae1b5c2cdd5d13a1a09335730d9bf1dd473e70f0c44eea10769dc831399256b411a96cd8791ca0e978fa858717c041af3cb8b5e96fcfbf4ff97b0c7de2834ae6eb4de3deb240e3b1ff423\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_imp.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpU2hvdyIsInJlcXVlc3RfaWQiOiIyOTJiYjlhMC0wNzgyLTRkMzYtYjU0My00MzdiNDdkNDhmZWYiLCJzdWJfcGxhdGZvcm0iOiJjcGkiLCJjaGFubmVsIjoiT01DX1NESyIsImNsaWVudF9pcCI6IjEuMS4xLjEiLCJzY3JlZW5fc2l6ZSI6IjB4MCIsImNvdW50cnkiOiJpZCIsIlBhcmFtcyI6W3siY2FtcGFpZ25faWQiOjIyMzgsInBvc19pZCI6IjIwNDkiLCJhZF9pZCI6MTAwNzY2LCJjYW1wX25hbWUiOiJwYW5sdWgtc2FuIiwiYWRfcGFja2FnZV9uYW1lIjoiY29tLmphbmVsLmRvY3Rvci5lYXIiLCJjaWQiOjM4ODI2LCJiaWRfcHJpY2UiOjEyMzAwMDAwMCwiZWNwbSI6Mjg2MjYyNjE0LCJkc3BfbmFtZSI6IlNoYXJlaXQiLCJhdHRyX3BsYXRmb3JtIjoyLCJhZHNldF9pZCI6MTM1MCwiYWRfbmFtZSI6IlNBTi1TREsiLCJhZHNldF9uYW1lIjoiU0FOLVNESyIsInBoeV9wb3MiOiIyMDQ5In1dLCJtaWRhc192ZXJzaW9uIjoiMi4wIn0\&sid=__SID__\"]}",
      "adid":"100766",
      "bundle":"com.janel.doctor.ear"
     }]
   }],
   "cur":"USD"
}

 

2c) native video response example

 

{
  "id":"32f94228-52d3-4bce-be88-5dd1d799ae4f",
  "bidid":"a5254b1b-f95d-42b5-8415-c660712532b2",
  "seatbid":[{
    "bid":[{
      "id":"a5254b1b-f95d-42b5-8415-c660712532b2",
      "impid":"1",
      "price":50,
      "burl":"http://midas-tracker-dev.hellay.net/win.fcg?viewid=e6d8578664e2f10e11afa9c0e96cb3762e56ab1614a0eb790bda8dee1f46ddd0ed054d91e419ea8b705890309607448e65f407e9336bc0a90533085ff8f141a42984adca526e1cca8ddf69757aecb73b05a22892d982a78aabbf0a1f6079b696e653900269900c16d45a364f062e705ec9adb3b1d6334b2746ef9f3ed20dc6ef05d95e16aa65e23c7e0b52cb1ce70ee639943f7b95625198ec7ac09435643ed9c4abd37f686f89f4ea123215aa700aa73005e728bcb45d054bb75ba53b2bb105286ce8941b833064268f1fb47f6cb00b0c3030e892027fc3178b7aeda7a0fe9efcb34e32ccd590569643552cae4cb5d6a359acb6b326faf3434c5ddf7574179869e6482ca8a5fdb4b7d344ed3cb022cabf9bd33e1316be063fefb6ac55113ec00eda60f87e50c3019442885a22873312f97ffd6fed0b69871925b9fee5b1923bde7212f824eea9c66deb48a60a8a20bfb895d26a3e1fb1614eefcdd8e16d899ba83e79803d451f3f8664ea3a4263915eadb1ac314f715062365ec0fe9a97e01f3cba17f73142e937034de4aeab9e5c64a445367dbff95805c26dba982d7d97914c5b2670f5528553a93a7aefa85e4875a35d79633e319c6e65f344f47b302ef3a76f9fad88bc3d3b7890b08097a4839a8c58dcb83027b0e80ce12ee7988f8660da46b8723f736122efbee4441724ba697a81160c9014e45ab023847a4f79ad987c1e49da43b7d3a0fb3b6e3ecc6f6cd1d9cccb166e7495fcd7d41bda6ca2cf7cadfd3e8825843f081c8faa098a34121a36ae4164&auction_price=${AUCTION_PRICE}&sid=__SID__",
    "adm":"{\"assets\":[{\"id\":1,\"title\":{\"text\":\"openrtb-this is ad title\",\"len\":14}},{\"id\":7,\"video\":{\"vasttag\":\"\\\\\\\\\\\\\\\\\\\00:00:15\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}}],\"link\":{\"url\":\"https://play.google.com/store/apps/details?id=cc.forestapp\&hl=en\",\"clicktrackers\":[\"http://midas-tracker-dev.hellay.net/clk.fcg?viewid=e6d8578664e2f10e11afa9c0e96cb3762e56ab1614a0eb790bda8dee1f46ddd0ed054d91e419ea8b705890309607448e65f407e9336bc0a90533085ff8f141a42984adca526e1cca8ddf69757aecb73b05a22892d982a78aabbf0a1f6079b696e653900269900c16d45a364f062e705ec9adb3b1d6334b2746ef9f3ed20dc6ef05d95e16aa65e23c7e0b52cb1ce70ee639943f7b95625198ec7ac09435643ed9c4abd37f686f89f4ea123215aa700aa73005e728bcb45d054bb75ba53b2bb105286ce8941b833064268f1fb47f6cb00b0c3030e892027fc3178b7aeda7a0fe9efcb34e32ccd590569643552cae4cb5d6a359acb6b326faf3434c5ddf7574179869e6482ca8a5fdb4b7d344ed3cb022cabf9bd33e1316be063fefb6ac55113ec00eda60f87e50c3019442885a22873312f97ffd6fed0b69871925b9fee5b1923bde7212f824eea9c66deb48a60a8a20bfb895d26a3e1fb1614eefcdd8e16d899ba83e79803d451f3f8664ea3a4263915eadb1ac314f715062365ec0fe9a97e01f3cba17f73142e937034de4aeab9e5c64a445367dbff95805c26dba982d7d97914c5b2670f5528553a93a7aefa85e4875a35d79633e319c6e65f344f47b302ef3a76f9fad88bc3d3b7890b08097a4839a8c58dcb83027b0e80ce12ee7988f8660da46b8723f736122efbee4441724ba697a81160c9014e45ab023847a4f79ad987c1e49da43b7d3a0fb3b6e3ecc6f6cd1d9cccb166e7495fcd7d41bda6ca2cf7cadfd3e88259732131e89c815952846\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_clk.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpQ2xpY2siLCJyZXF1ZXN0X2lkIjoiYTUyNTRiMWItZjk1ZC00MmI1LTg0MTUtYzY2MDcxMjUzMmIyIiwic3ViX3BsYXRmb3JtIjoiY3BpIiwiY2hhbm5lbCI6Ik9NQ19TREsiLCJjbGllbnRfaXAiOiIxLjEuMS4xIiwicGxhdGZvcm0iOjEsIm9zX3ZlcnNpb24iOiI1LjEuMSIsImltZWkiOiJlY2FlOTA0MmYzZTU0OWE0ZmQxYWYyN2ExZWQzOGI1ZjY4MmZhM2NhIiwiYnJhbmQiOiJXSUtPIiwibW9kZWwiOiJzYW1zdW5nLXNtLWc5MDBhIiwic2NyZWVuX3NpemUiOiIweDAiLCJsYW5ndWFnZSI6ImVuIiwiZ2FpZCI6IjU3MzFiNGM4LTdjYzEtNGEwOS1iYjc3LTI0ZjIzN2Q5M2E2NiIsIm5ldHdvcmtfdHlwZSI6NywiY291bnRyeSI6ImluIiwiUGFyYW1zIjpbeyJjYW1wYWlnbl9pZCI6MjEzNiwicG9zX2lkIjoiMjA2MSIsImFkX2lkIjoxMDA2NzQsImNhbXBfbmFtZSI6IuadqOWwkeeRnC1zaGFyZWl0Lea1i-ivlS1vcGVucnRiIiwiYWRfcGFja2FnZV9uYW1lIjoiY2MuZm9yZXN0YXBwIiwiY2lkIjozODY5OCwiYmlkX3ByaWNlIjoxMDAwMDAwMDAwLCJlY3BtIjo2ODIxOTMyMDAsImRzcF9uYW1lIjoiU2hhcmVpdCIsImF0dHJfcGxhdGZvcm0iOjEsImFkc2V0X2lkIjoxMjM0LCJhZF9uYW1lIjoi5p2o5bCR55GcLW9wZW5ydGItMTjop4TmoLwt5bCP57GzIiwiYWRzZXRfbmFtZSI6IuadqOWwkeeRnC1vcGVucnRiLeWwj-exsyIsInBoeV9wb3MiOiIyMDYxIn1dLCJtaWRhc192ZXJzaW9uIjoiMi4wIn0\&sid=__SID__\"]},\"imptrackers\":[\"http://midas-tracker-dev.hellay.net/imp.fcg?viewid=e6d8578664e2f10e11afa9c0e96cb3762e56ab1614a0eb790bda8dee1f46ddd0ed054d91e419ea8b705890309607448e65f407e9336bc0a90533085ff8f141a42984adca526e1cca8ddf69757aecb73b05a22892d982a78aabbf0a1f6079b696e653900269900c16d45a364f062e705ec9adb3b1d6334b2746ef9f3ed20dc6ef05d95e16aa65e23c7e0b52cb1ce70ee639943f7b95625198ec7ac09435643ed9c4abd37f686f89f4ea123215aa700aa73005e728bcb45d054bb75ba53b2bb105286ce8941b833064268f1fb47f6cb00b0c3030e892027fc3178b7aeda7a0fe9efcb34e32ccd590569643552cae4cb5d6a359acb6b326faf3434c5ddf7574179869e6482ca8a5fdb4b7d344ed3cb022cabf9bd33e1316be063fefb6ac55113ec00eda60f87e50c3019442885a22873312f97ffd6fed0b69871925b9fee5b1923bde7212f824eea9c66deb48a60a8a20bfb895d26a3e1fb1614eefcdd8e16d899ba83e79803d451f3f8664ea3a4263915eadb1ac314f715062365ec0fe9a97e01f3cba17f73142e937034de4aeab9e5c64a445367dbff95805c26dba982d7d97914c5b2670f5528553a93a7aefa85e4875a35d79633e319c6e65f344f47b302ef3a76f9fad88bc3d3b7890b08097a4839a8c58dcb83027b0e80ce12ee7988f8660da46b8723f736122efbee4441724ba697a81160c9014e45ab023847a4f79ad987c1e49da43b7d3a0fb3b6e3ecc6f6cd1d9cccb166e7495fcd7d41bda6ca2cf7cadfd3e88259037090d8ef619b830020e3eeedd3895de2a52\&auction_price=${AUCTION_PRICE}\&sid=__SID__\",\"http://midas-tracker-dev.hellay.net/cpi_imp.fcg?log=eyJldmVudF9uYW1lIjoiQURfQ3BpU2hvdyIsInJlcXVlc3RfaWQiOiJhNTI1NGIxYi1mOTVkLTQyYjUtODQxNS1jNjYwNzEyNTMyYjIiLCJzdWJfcGxhdGZvcm0iOiJjcGkiLCJjaGFubmVsIjoiT01DX1NESyIsImNsaWVudF9pcCI6IjEuMS4xLjEiLCJwbGF0Zm9ybSI6MSwib3NfdmVyc2lvbiI6IjUuMS4xIiwiaW1laSI6ImVjYWU5MDQyZjNlNTQ5YTRmZDFhZjI3YTFlZDM4YjVmNjgyZmEzY2EiLCJicmFuZCI6IldJS08iLCJtb2RlbCI6InNhbXN1bmctc20tZzkwMGEiLCJzY3JlZW5fc2l6ZSI6IjB4MCIsImxhbmd1YWdlIjoiZW4iLCJnYWlkIjoiNTczMWI0YzgtN2NjMS00YTA5LWJiNzctMjRmMjM3ZDkzYTY2IiwibmV0d29ya190eXBlIjo3LCJjb3VudHJ5IjoiaW4iLCJQYXJhbXMiOlt7ImNhbXBhaWduX2lkIjoyMTM2LCJwb3NfaWQiOiIyMDYxIiwiYWRfaWQiOjEwMDY3NCwiY2FtcF9uYW1lIjoi5p2o5bCR55GcLXNoYXJlaXQt5rWL6K-VLW9wZW5ydGIiLCJhZF9wYWNrYWdlX25hbWUiOiJjYy5mb3Jlc3RhcHAiLCJjaWQiOjM4Njk4LCJiaWRfcHJpY2UiOjEwMDAwMDAwMDAsImVjcG0iOjY4MjE5MzIwMCwiZHNwX25hbWUiOiJTaGFyZWl0IiwiYXR0cl9wbGF0Zm9ybSI6MSwiYWRzZXRfaWQiOjEyMzQsImFkX25hbWUiOiLmnajlsJHnkZwtb3BlbnJ0Yi0xOOinhOagvC3lsI_nsbMiLCJhZHNldF9uYW1lIjoi5p2o5bCR55GcLW9wZW5ydGIt5bCP57GzIiwicGh5X3BvcyI6IjIwNjEifV0sIm1pZGFzX3ZlcnNpb24iOiIyLjAifQ\&sid=__SID__\"]}",
      "adid":"100674"
    }]
  }],
  "cur":"USD"
}

 

2d)banner response example

 

{
    "id": "123",
    "bidid": "a1271eca-efa2-4f9f-8904-a853afec1289",
    "seatbid": [
        {
            "bid": [
                {
                    "id": "a1271eca-efa2-4f9f-8904-a853afec1289",
                    "impid": "1",
                    "price": 118.0806,
                    "burl": "https://midas-tracker-test.hellay.net/win.fcg?viewid=e6d8578664e2f10e11afa8c3eb6cb3763be39af447238100277632423c9c212f3987802acb093fa8f226d2beb00ad9aa5d901a36db98e81c1c0f1639ad363decc476977f6ba1dcb36318671a7a606d34961563c37535b94719f7eb4a8d53d8b3c80d002386ea6227bc2e50cdbcaa0c40a29bee9ef33b63c3f56ae4c59790d02b2be9ce6be9598e84f92c0efb7e9fdcf311fb0326d959dbd306031f78ae6a4a34675ad8bb6e84571c015638463b14fab8eded30cabefcf16c758eac517853709909da5be52230975657723bd0182b8eb7e92423a55066d07ab9c25a2c38cb0df2af9462c41155773054912137f7f508187acdfde64036bbcc7108237648df4168089d1ce5c8bae76768ae1f5a7cbda8f78a3c788123653da1a5f9294f7f410ac5a440063a7a62443efae33253b0e2bb16ed36a35b8720a1a75cd3a053a8f6415a00ecb94de70f89dff8f1e9dd5c1317a91c63f186f6e20d346da0aa4bbb9699eac716e961ac71a8048f0ad68c64b5e6ef9b3fec4e7969facea589f05d3fd1e9db885bcfea115dd393addc945f6de28f8ee1c2706e225370fc925762ef0ecb7317c28478b40b09f7b7611fc975cb19ea99226b086ca9c98895c8b86f12fa79b8086c1a3cff9f768f9b729c65121107709120f269c2ea863bda8797e77a98e3f177128fcbb4f46da9addbb1da7ef21f9aef6d0b9b1f4890d3cf764037f056e83dc7ed96a55cfab626fcf5903476d16ece901558cb0c2edc5a43cc57e4c95218c9d01e2e816d005a4f7e&auction_price=${AUCTION_PRICE}&sid=__SID__",
                    "adm":"", "adid": "128263", "bundle": "com.migo.mobile" } ] } ], "cur": "USD" }

 

4. Advertiser Data Postback - Xtend merchant API (S2S)

 

Xtend requests advertisers to provide us with more comprehensive data to improve advertising effectiveness. 

 

If the advertiser has already transmitted data to Xtend through their own data interface or integrated with a third-party SDK/API, such as connecting with a Mobile Measurement Partner, and has enabled All-Sources Postback data to Xtend, including key event settlement, then most of the data requirements for advertising optimization 

are already met. In this case, the integration can be skipped.

 

If the above two situations are not applicable, Xtend provides Merchant API as a solution for server-to-server (S2S) real-time data transmission.

 

You will send us your conversion event data; you must develop it according to this document.

 

HTTP request

 

POST http://adp-e.ginpda.com/dpa/event

 

Request Headers

 

Content-Type: application/json

 

Request Limits

Expect to request only one event at a time

 

Request body

The request body contains an instance of event

 

 

Fields

platform

string

[required]

Platform name

agency

string

[required]

Agency name

event_name

string

[required]

Event name enumeration value:

Xtend_open_app         open APP

Xtend_register         registration
Xtend_login                     log in

Xtend_content_view         view product detail page

Xtend_add_to_cart         add to cart

Xtend_add_to_wishlis       favorite Products

Xtend_add_shop_to_favourite           favorite Shop

Xtend_purchase_unpaid   click on the Buy button

Xtend_purchase               successful payment

Xtend_refund                     order Refunds

Xtend_new_purchase          first purchase completed

ga_Immediate_session       session(GA data caliber)

ga_Immediate_order          purchase and Payment(GA data caliber)

 

topads_click  Topads           landing page click on product events

Xtend_install                      new install event

gaid

 

string  

[required]

gaid

click_id

string  

[required]

click_id

android_id

string  

[option]

android_id

channel

String

[required]

Advertising media sources, e.g. 'Xtend', 'Omnichannel'

 

utm_campaign

 

String

[required]

GA monitoring parameters

brand

 

String

[option]

Mobile Phone Brand

app_id

 

String

[required]

E.g

com.lenovo.anyshare.gps

app_version

String

[required]

app version information

age

 

int64

[option]

age of user

ip

String(ip format)

[option]

The ip of the user where the event occurred

country

String

[required]

country

language

String

[option]

langue

timestamp

int64

[required]

Time of event, millisecond timestamp (13 bits)

gender

int

[option]

Gender, enumeration, 1:male, 2:female

os_version

String

[option]

OS version

os_type

String

[option]

OS platform:android、ios

product_info

Array[product_info_object]

[required]

Product-related information,list

click_info

Array[click_info_object][optional]

Click information list

Only fill in this field if event_name is topads_click, otherwise it is not required.

total

int[optional]

Total number of clicks

Only fill in this field if event_name is topads_click, otherwise it is not required.

data_path

int

[optional]

Event postback path.

1 Both postback at attribution platform and postback at s2s

2 postback  at s2s only

aux_info

String

[optional]

auxiliary info

Confirm with Xtend before usage.

shipping_fee

Float64

[required]

Shipping fee,Required for Event:Xtend_purchase、Xtend_purchase_unpaid、

Xtend_refund、ga_Immediate_order、Xtend_new_purchase

revenue

Float64

[required]

The actual amount paid by the user, in the same currency as used above,Required for Event:Xtend_purchase、Xtend_purchase_unpaid、Xtend_new_purchase、Xtend_refund、ga_Immediate_order

 

product_info_object

 

sku_id

String

[required]

sku ID,Required for Event:Xtend_content_view、time_spend_on_product、

Xtend_add_to_cart、Xtend_add_to_wishlist、adding_review、Xtend_purchase_unpaid、Xtend_purchase、Xtend_refund、Xtend_new_purchase、ga_Immediate_order

quantity

int64

[required]

quantity,Required for Event:Xtend_add_to_cart、Xtend_purchase_unpaid、Xtend_purchase、

、Xtend_refund、Xtend_new_purchase

、ga_Immediate_order

order_id

String

[required]

Order id,Required for Event:Xtend_purchase_unpaid、Xtend_purchase、Xtend_new_purchase

、Xtend_refund、ga_Immediate_order

shop_id

String

[option]

Shop id,Required for Event:Xtend_content_view、time_spend_on_product、

Xtend_add_to_cart、

Xtend_add_to_wishlist、adding_review、

Xtend_purchase_unpaid、Xtend_purchase、Xtend_refund、Xtend_new_purchase、ga_Immediate_order

price

float64

[required]

price,Required for Event:Xtend_content_view、time_spend_on_product、Xtend_add_to_cart、

Xtend_add_to_wishlist、adding_review、Xtend_purchase  、Xtend_refund、Xtend_purchase_unpaid、ga_Immediate_order、Xtend_new_purchase

currency

String

[required]

currency,Required for Event:Xtend_purchase

、Xtend_purchase_unpaid、Xtend_refund、ga_Immediate_order、Xtend_new_purchase

category

Array[String]

[required]

Products are categorized by level, Required

e.g. ["FOOD", "MEAT"].

 

click_info_object

 

utm_campaign

String

[required]

utm parameter(GA)

gaid

String

[required]

gaid

ad_id

String

[required]

Ad id

shop_id

String

[required]

Shop id

spu_id

String

[required]

Product spu id

sku_id

String(Int64 format)

[required]

Product sku id

timestamp

String(Int64 format)

[required]

Commodity expiration time

 

 

post data example

 

 

{

   "platform": "Xtend",

   "event_name": "Xtend_open_app",

   "click_id": "98da08a4-075a-44de-a297-ff2efcaa1eff",

   "gaid": "b3128e5c-3714-4ceb-a832-c2e05c4bf48b",

   "brand": "HUAWEI",

   "os_type": "ios",

   "os_version": "8.0.0",

   "ip": "197.94.235.103",

   "language": "English",

   "gender": 1,

   "age": 18,

   "android_id": "",

   "app_version": "3.13.1",

   "country": "ID",

   "app_id": "com.lenovo.anyshare.gps",

   "product_info": [

       {

           "sku_id": "7543232",

           "quantity": 2,

           "order_id": "2222032",

           "price": 122344,

           "currency": "IDR",

           "category":["FOOD","MEAT"],

           "shipping_fee": 3.4

       }

   ],

   "data_path": 1,

   "aux_info": "some_aux_info",

   "timestamp": 1661980000,

   "channel": "Xtend",

   "utm_campaign": "DPA_042022",

   "debug": true

}

 

 

 

Response Http Status Code

 

http status code

200

 

Success

400

 

Request parameter error

500

 

Server error

 

 

Response body

null

5. Advertiser Data Postback - Xtend Online Drive

 

Process

 

1. Apply for Xtend Online Driver system user account through Xtend business 

focal.

2. Xtend business team provide the name of the user ID and authorized path.

3. Xtend IT team create User ID, with limited authority of uploading files, but 

without download/edit authority.

 

Request Address

 

https://drive.uXtend.org/remote.php/webdav//

 

Path Variables

 

Field 

Value 

Description

dirserverpath 

string 

Required, the path to upload to the server

filename 

string 

Required, file name should not contain any 

special characters.

 

Request Method:

 

PUT

 

Authority Authentication: 

 

Required

 

Authorization Parameter

 

*Basic Auth

Field 

Description

username 

User ID

password 

Password of user ID

 

Body parameter

 

Example 

Description 

Type 

Required

/userlocalhostpat/test1.png 

Files to be uploaded 

Binary 

Yes

 

Status Codes

 

HTTP/2 201 

Upload new file Successful

HTTP/2 204 

Replace file Successful

HTTP/2 401 

Unauthorized error

 

Example Request

 

curl -X PUT -u "username:passwod" "https:// drive.uXtend.org/remote.php/webdav/test

dir/upload1.png" --data-binary @"/ Users/Desktop/test1.png"

 

Example Response

 

HTTP/2 201 

6. AD Performance Report

 

Version

Date

Edit

1.1

2023-05-30

1. Summary Report API URL
2. Campaign Report API  URL

3. change utm to  campaign

4.  two parameters exchange with each other: sort, order

5. change startDate, endDate format

1.2

2023-06-07

1. Summary Report API add timeZone param

2. Campaign Report API add timeZone param

1.3

2023-07-11

1. change budgetType enumeration value to NC | Dormant 

1.4

2023-08-16

1. Summary Report API add groupBy param

2. Campaign Report API add groupBy param

 

 

1. Summary Report API

 

POSThttps://dashboard.maxecom.net/dashboard/report/summary

 

Description: Get summary report overview.

Authentication Required:accountID and password should be placed in the HTTP header. e.g., userinfo: {“accountID”: “xxxx”, “password”: “xxxx”}

 

Post Body Parameters: 

 

 

Name

Type

Required or not

Description

startDate

String

Yes

format according to: yyyy-MM-dd

endDate

String

Yes

format according to: yyyy-MM-dd

conversion

String

Yes

event type

groupBy

String 

Yes

enumeration value: Day | Hour

timeZone

Integer

No

default value is 0, when timeZone required
refer to Section 4 for the enumerated values

budgetType

String[]

No

when budget type required

enumeration value: NC | Dormant

country

String[]

No

when country required

two-letter country codes

order

String

No

default by Date, when other sort required

Imps | Clicks | CTR | Cost | Convs 

| CR | eCPC | eCPA

sort

String

No

default by ascending

enumeration value: ascending | descending

 

Example:

{

         "startDate""2023-04-16",

         "endDate""2023-05-15",

         "conversion""install",

         "groupBy""Day",

         "timeZone"-8,

         "budgetType": ["NC"],

         "country": [“ID”, “PH”],

         "order""",
         "sort"""

         

}

 

 

Response Parameters:

 

 

Name

Type

Description

code

Integer

code

msg

String

message,  “SUCCESS”  if the request succeeds

total

Integer

total number of returned data,  if the request succeeds

data

Object[]

returned data if the request succeeds

Time

String

 

Imps

String

Integer

Clicks

String

Integer

CTR

String

percentage

Cost($)

String

2 decimal places

Convs

String

conversions, Integer

CR

String

conversions rate, percentage

eCPC($)

String

2 decimal places

eCPA($)

String

2 decimal places

 

Note: The real-time data of the day may fluctuate.

 

Response Code & Msg:

 

 

Code

Msg

Description

0

SUCCESS

if request succeeds

400

Invalid Params

parameters error

401

Invalid accountID OR password

authentication error

 

 

Response Examples:

when request succeeds:

{

"msg""SUCCESS",

"total"2,

"code"0,

"data": [

{

"CTR""1.00%",

"eCPA""-",

"Imps""31,814",

"Time""2023-04-16",

"Convs""0",

"Clicks""2,338",

"Cost""102.86",

"CR""0.01%",

"eCPC""0.12"

},

{

"CTR""1.05%",

"eCPA""-",

"Imps""81,606",

"Time""2023-04-17",

"Convs""104",

"Clicks""1,386",

"Cost""0.68",

"CR""0.00%",

"eCPC""0.00"

},…

]

}

when request fails:

{

"msg""Invalid accountID OR password",

"code"401

}

 

 

 

2. Campaign Report API

 

POSThttps://dashboard.maxecom.net/dashboard/report/campaign

 

Post Body Parameters: 

 

 

Name

Type

Required or not

Description

startDate

String

Yes

format according to: yyyy-MM-dd

endDate

String

Yes

format according to: yyyy-MM-dd

conversion

String

Yes

event type

groupBy

String

Yes

enumeration value: Day | Hour

timeZone

Integer

No

default value is 0, when timeZone required
refer to Section 4 for the enumerated values

campaign

String[]

No

when specific campaign required, otherwise return all campaigns

budgetType

String[]

No

when budget type required

enumeration value: NC | Dormant

country

String[]

No

when country required

two-letter country codes

order

String

No

default by Campaign, when other sort required

Imps | Clicks | CTR | Cost | Convs | CR | eCPC | eCPA

sort

String

No

default by ascending

enumeration value: ascending | descending

 

 

Example:

{

         "startDate""2023-04-16",

         "endDate""2023-05-15",

         "conversion""install",

         "groupBy""Day",

         "order""Cost",

         "sort""ascending"

 

 

Response Parameters:

 

 

Name

Type

Description

code

Integer

code

msg

String

message,  “SUCCESS”  if the request succeeds

total

Integer

total number of returned data,  if the request succeeds

data

Object[]

returned data if the request succeeds

Campaign

String

 

Time

String

 

Imps

String

Integer

Clicks

String

Integer

CTR

String

percentage

Cost($)

String

2 decimal places

Convs

String

conversions, Integer

CR

String

conversions rate, percentage

eCPC($)

String

2 decimal places

eCPA($)

String

2 decimal places

 

 

Response Code & Msg:

 

 

Code

Msg

Description

0

SUCCESS

if request succeeds

400

Invalid Params

parameters error

401

Invalid accountID OR password

authentication error

 

 

Response Examples:

when request succeeds:

{

"msg""SUCCESS",

"total"2,

"code"0,

"data": [

{

"CTR""1.00%",

"eCPA""-",

"Imps""31,814",

"Time""2023-04-16",

"Convs""0",

"Clicks""2,338",

"Cost""102.86",

"Campaign""xxxx",

"CR""0.01%",

"eCPC""0.12"

},

{

"CTR""1.05%",

"eCPA""-",

"Imps""81,606",

"Time""2023-04-17",

"Cost""0.68",

"Campaign""xxxx",

"CR""0.00%",

"eCPC""-"

},...

]

when request fails:

{

"msg""Invalid accountID OR password",

"code"401

 

 

Descript{ion: Get inventory report overview.

 

 

Post Body Parameters: 

 

 

Name

Type

Required or not

Description

startDate

String

Yes

format according to: yyyyMMdd

endDate

String

Yes

format according to: yyyyMMdd

conversion

String

Yes

event type

groupBy

String

Yes

enumeration value: Day | Hour

timeZone

Integer

No

default value is 0, when timeZone required

refer to Section 4 for the enumerated values

inventory

String[]

No

when specific inventory required, otherwise return all inventories

budgetType

String[]

No

when budget type required

enumeration value: NC | Dormant

country

String[]

No

when country required

two-letter country codes

order

String

No

default by Inventory, when other sort required

 Imps | Clicks | CTR | Cost | Convs | CR | eCPC | eCPA

sort

String

No

default by ascending

enumeration value: ascending | descending

 

 

Example:

{

         "startDate""2023-04-16",

         "groupBy""Day",

         "timeZone"-4,
        "inventory": ["xxxx"],

}

 

 

Response Code & Msg:

 

 

Code

Msg

Description

0

SUCCESS

if request succeeds

400

Invalid Params

parameters error

401

Invalid accountID OR password

authentication error

 

 

Response Example:

when request succeeds:

{

"msg""SUCCESS",

"total"2,

"code"0,

"data": [

{

"CTR""1.00%",

"eCPA""-",

"Imps""31,814",

"Time""2023-04-16",

"Convs""0",

"Clicks""2,338",

"Cost""102.86",

"Inventory""xxxx",

"CR""0.01%",

"eCPC""0.12"

},

{

"CTR""1.05%",

"eCPA""-",

"Imps""81,606",

"Time""2023-04-17",

"Convs""104",

"Cost""0.68",

"Inventory""xxxx",

"CR""0.00%",

"eCPC""-"

},...

{

"msg""Invalid params",

}

 

 

4. timeZone enumeration

 

Note: If the value is a floating-point type,  only the integer part of the value is considered valid. For example, with value: -7.6, value will be -7; 

with value: 8.6, value will be 8.

 

[

  { "label": "(UTC+00:00) GMT,WET", "value": 0 },

  { "label": "(UTC+01:00) CET", "value": -1 },

  { "label": "(UTC+02:00) EET", "value": -2 },

  { "label": "(UTC+03:00) MSK", "value": -3 },

  { "label": "(UTC+04:00) GST", "value": -4 },

  { "label": "(UTC+05:00) PKT", "value": -5 },

  { "label": "(UTC+06:00) BHT", "value": -6 },

  { "label": "(UTC+07:00) ICT", "value": -7 },

  { "label": "(UTC+08:00) CT", "value": -8 },

  { "label": "(UTC+09:00) JST", "value": -9 },

  { "label": "(UTC+10:00) AEST", "value": -10 },

  { "label": "(UTC+11:00) VUT", "value": -11 },

  { "label": "(UTC+12:00) NZST", "value": -12 },

  { "label": "(UTC+13:00) PHOT", "value": -13 },

  { "label": "(UTC+14:00) LINT", "value": -14 },

  { "label": "(UTC-01:00) CVT", "value": 1 },

  { "label": "(UTC-02:00) FNT", "value": 2 },

  { "label": "(UTC-03:00) BRT", "value": 3 },

  { "label": "(UTC-04:00) AST", "value": 4 },

  { "label": "(UTC-07:00) MST", "value": 7 },

  { "label": "(UTC-08:00) PST", "value": 8 },

  { "label": "(UTC-09:00) AKST", "value": 9 },

  { "label": "(UTC-10:00) HST", "value": 10 },

  { "label": "(UTC-11:00) SST", "value": 11 },

               { "label": "(UTC-12:00) IDLW", "value": 12 }

]