POST /ads
Create an ad.
Note if the assets are missing the eid, those assets will also be created. This way we offer a way to create the assets of an ad in an atomic way
Servers
- https://services.adroll.com/ad/api/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
advertisable |
String | Yes |
EID of the Advertisable. Default value: "Current User's Advertisable EID." |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
subtype |
String | No |
Possible values:
|
multiple_products |
Integer | No | |
height |
Integer | No | |
width |
Integer | No | |
assets[] |
Array | No | |
assets[].subtype |
String | No |
Asset subtype values depending on the asset type. text => url, display_url, title, call_to_action, link_description, message, impression_tracker, third_party_click_tracker, instagram_permalink_url, object_story_id, brand_name, utm_tracking, preview_url, html, ad_blocker_url, tracking_urls, ad_text, fallback_type, actor_id, display_name image => ad, logo, placeholder video => default Possible values:
|
assets[].height |
Number | No |
height is only applicable to image or video assets. |
assets[].created_date |
String | No |
Creation date |
assets[].width |
Number | No |
width is only applicable to image or video assets. |
assets[].filename |
String | No |
This is the value for text assets. |
assets[].advertiser |
Object | No | |
assets[].advertiser.eid |
String | No | |
assets[].image_url |
String | No |
URL for image assets only. |
assets[].duration |
Integer | No |
Duration in seconds, applies to video assets only. |
assets[].updated_date |
String | No |
Last update date |
assets[].name |
String | No |
Display name of the Asset |
assets[].eid |
String | No |
Identifier of the Asset |
assets[].text |
String | No |
This is the value for text assets. |
assets[].video_url |
String | No |
URL for video assets only. |
assets[].type |
String | No |
Type of the Asset Possible values:
|
status |
String | No | |
read_only |
Boolean | No | |
do_not_forward |
Boolean | No | |
is_dynamic |
Boolean | No | |
name |
String | No | |
is_multi_share_optimized |
Boolean | No | |
type |
String | No |
Possible values:
|
ad_parameters[] |
Array | No |
Dynamic ads ad parameters |
ad_parameters[].eid |
String | No |
Identifier of the AdParameter |
ad_parameters[].key |
String | No |
Key of the AdParameter |
ad_parameters[].value |
String | No |
Value of the AdParameter |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.