ad

post https://asx-api.bidtheatre.com/v2.0/api/{network_id}/ad

Path Params

network_id

string

required

Body Params

integer

A unique id for this ad

campaign

integer

required

The campaign this ad belongs to

name

string

This ad's name

adType

string

required

The type of this ad

adStatus

string

required

The status for this ad

dimension

integer

The dimension of this ad

targetURL

string

Where to send user on click

clickThroughURL

string

Landing page at advertiser

isExpandable

boolean

Indicates whether this ad unit expands or not

contentURL

string

The URL to where the ad material is hosted

backupContentURL

string

The URL to where the backup ad material is hosted

html

string

Third party HTML ad code

thirdPartyAdType

string

If selected tries to integrate third party script automatically

impRedirectURL

string

adTargetTemplate

integer

Sets this ad's targets to a set of pre-defined ones based on this template

fbxTitle

string

Title text used for all Facebook ads

fbxBody

string

Body text used for all Facebook ads

fbxMessage

string

Message text used for Facebook news feed ads

isSecure

boolean

Indicates whether this ad is fully HTTPS compatible, including all tracking pixels and external resources

adStartDate

string

The date this ad should be set as active

adEndDate

string

The date this ad should be set as inactive

nativeCreative

integer

The native creative this ad should be linked to

Responses

Response body

object

integer

A unique id for this ad

campaign

integer

required

The campaign this ad belongs to

name

string

This ad's name

adType

string

required

The type of this ad

Flash banner Image banner HTML banner Text ad Video ad Mobile Web/In-app Native ad Audio ad In-banner video

adStatus

string

required

The status for this ad

Active Inactive Scheduled

dimension

integer

The dimension of this ad

targetURL

string

Where to send user on click

clickThroughURL

string

Landing page at advertiser

isExpandable

boolean

Indicates whether this ad unit expands or not

updateDate

string

The latest date this ad unit was updated

contentURL

string

The URL to where the ad material is hosted

backupContentURL

string

The URL to where the backup ad material is hosted

html

string

Third party HTML ad code

thirdPartyAdType

string

If selected tries to integrate third party script automatically

Adform Adtech Doubleclick Mediamind Mediaplex OpenX Sizmek Tradedoubler DCM

impRedirectURL

string

adTargetTemplate

integer

Sets this ad's targets to a set of pre-defined ones based on this template

fbxTitle

string

Title text used for all Facebook ads

fbxBody

string

Body text used for all Facebook ads

fbxMessage

string

Message text used for Facebook news feed ads

isSecure

boolean

Indicates whether this ad is fully HTTPS compatible, including all tracking pixels and external resources

adgroups

object

Link to ad adgroups

Has additional fields

validation

string

Validation

failed_scanning

adStartDate

string

The date this ad should be set as active

adEndDate

string

The date this ad should be set as inactive

adgroupList

array of integers

Adgroups this ad belongs to

adgroupList

nativeCreative

integer

The native creative this ad should be linked to

vendors

array of integers

Vendors in use in this ad

vendors

weight

integer

The size of the creative in bytes

creativeId

integer

The creative id this ad is based on if applicable

isInSync

boolean

Indicated if this ad is in sync with the corresponding creative if applicable

creativeSet

integer

The creative set the ad is based on if applicable

syncDate

string

The date this ad was last synced from its corresponding creative if applicable

assignedLabels

string

altVideoPreviewURL

string

400

Bad input parameter. Error message should indicate which one and why.

401

Bad or expired token. Re-authenticate to resolve.

403

Invalid auth or the request attempts to access an unavailable resource. Could be followed by an application error code that specifies the problem.

429

Too many requests. Your request have been throttled.

500

Unhandled server side problem.

503

Service Unavailable. A needed sub-service is temporarily down.

Language


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://asx-api.bidtheatre.com/v2.0/api/network_id/ad \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "adType": "Flash banner",
8
  "adStatus": "Active"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Post operation completed successfully.