Creating Web Ads

Static Web Ads

To create a static web ad, you need to specify:

  • Advertisable EID to add the advertisement to

  • Destination URL where to send the user when the ad is clicked

  • Image file to upload

Request:

curl --user apihelp@adroll.com:password \
    -F advertisable=8597013E81481B0FE28772 \
    -F name="Test Ad 300x250" \
    -F destination_url=https://developers.nextroll.com \
    -F file=@300x250.png \
    https://services.adroll.com/api/v1/ad/create?apikey=MYAPIKEY

Response:

{
  "results": {

    "eid": "2A842B75A34EF695A5AA9D",
    "name": "Test Ad 300x250",
    // ...
  }
}

Native Ads

To create Native Ads, you’ll need to specify type=native and inventory_type=iab when calling POST /api/v1/ad/create. For the list of supported image sizes, please refer to the Ad Format Guidelines.

Request:

curl --user apihelp@adroll.com:password \
    -F advertisable=8597013E81481B0FE28772 \
    -F type=native \
    -F inventory_type=iab \
    -F name="Test Native Ad" \
    -F body="This is the description" \
    -F destination_url=https://www.example.com/ \
    -F file=@600x500.png \
    'https://services.adroll.com/api/v1/ad/create?apikey=MYAPIKEY'

Response:

{
  "results": {
    "eid": "EABF2CB2DEED8B777E8306",
    "name": "Test Native Ad",
    "type": "native",
    // ...
  }
}

Dynamic Native Ads

To create Dynamic Native Ads, you’ll need to specify several parameters:

advertisable

Advertisable EID to create the native ad in

name

Name of the ad when shown in the dashboard and in reports

type

Always native

inventory_type

Always iab

is_liquid

Always true

format

Always 33 (600x315)

headline

Called Title in the dashboard. When rendered, the value may be truncated after 25 characters.

message

Called Description in the dashboard. When rendered, the value may be truncated after 125 characters.

brand_name

Called Brand Name in the dashboard. When rendered, the value may be truncated after 30 characters.

destination_url

Fallback destination URL. When the ad is rendered, the product’s URL will be used.

file

Fallback image. When the ad is rendered, the product’s image will be used. Pass a base64-encoded string or use the multipart/form-data content-type.

The headline, message, and brand_name parameters support the following macros that pull values from your product feed. These macros must be mapped to fields in the product feed to be useable.

%%title%%

Title of the product

%%description%%

Description of the product

%%price%%

Price of the product

%%brand%%

Brand name of the product

Request:

curl --user apihelp@adroll.com:password \
    -F advertisable=8597013E81481B0FE28772 \
    -F type=native \
    -F inventory_type=iab \
    -F is_liquid=true \
    -F name="Test Dynamic Native Ad" \
    -F headline="%%title%%" \
    -F message="%%description%%" \
    -F brand_name="%%brand%%" \
    -F destination_url=https://www.example.com/ \
    -F file=@600x315.png \
    'https://services.adroll.com/api/v1/ad/create?apikey=MYAPIKEY'

Response:

{
  "results": {
    "eid": "EABF2CB2DEED8B777E8306",
    "name": "Test Native Ad",
    "type": "native",
    // ...
  }
}

Dynamic Web Ads

To create Dynamic Web Ads, you first need to ensure you’ve uploaded a logo for your Advertisable.

Create the Dynamic Web Ads

You create a set of Dynamic Web Ads by calling /api/v1/ad/create_templated_web_ads. When calling the method, you need to specify the ID of the template you’d like to use. The table below provides the IDs and examples. The endpoint returns a list of ads created, which you can then add to your campaigns.

Template ID

Theme name

0

Classic spotlight

1

Classic carousel

2

Duotone carousel

3

Holiday spotlight

4

Holiday carousel

10

Valentine spotlight

13

Valentine carousel

21

Fall carousel

22

Fall spotlight

28

Black Friday carousel

29

Cyber Monday carousel

33

Holiday Bow carousel

36

Holiday Sparkle carousel

45

Valentine 2018 spotlight

47

Valentine 2018 carousel

64

Product Gladiator

72

Spring Stripes

80

Summer Polka Dots

83

Summer Beach

Request:

curl --user apihelp@adroll.com:password \
    -d advertisable=8597013E81481B0FE28772 \
    -d name='test' \
    -d theme_color='#FFFFFF' \
    -d text_cta='Shop Now' \
    -d dynamic_template_id=1 \
    https://services.adroll.com/api/v1/ad/create_templated_web_ads?apikey=MYAPIKEY

Response:

{
  "results": [
    {
      "eid": "05995D19B6B19DD08AAF00",
      "name": "Dynamic_728x90_3/3/2017_1_test",
      // ...
    }
  ]
}

Retrieve List of Dynamic Web Templates

Call GET /api/v1/dynamic_template/get_all_for_advertisable to retrieve the list of available templates. To create ads, use the value of the id field from the template as the dynamic_tempalte_id parameter in POST /api/v1/ad/create_templated_web_ads. See Create the Dynamic Web Ads for more on creating ads.

The response includes a list of capabilities. You can use the capabilities list to decide what fields to prompt the user for. For example, if you see the salePrice capability, then you’ll know you can use the sale_price_option field when calling POST /api/v1/ad/create_templated_web_ads. Note that capabilities are optional.

Request:

curl --user apihelp@adroll.com:password \
'https://services.adroll.com/api/v1/dynamic_template/get_all_for_advertisable?advertisable=8597013E81481B0FE28772&apikey=MYAPIKEY'

Response:

{
  "results": [
    {
      "id": 33,
      "eid": "6SJ2LVKKLZHNFCBGRZLPXA",
      "category": null,
      "in_testing": false,
      "is_private": false,
      "is_published": true,
      "is_visible": true,
      "name": "Holiday Bow NEW!",
      "capabilities": [
        {
          "id": 2,
          "eid": "RJTMLC5L4ZDVFJSGV3EMOJ",
          "name": "salePrice",
          "description": "Sale price",
          "is_enabled": true,
          "type": null
        }
      ],
      "allowed_advertisables": []
    }
  ]
}

Retrieve List of Dynamic Web Templates Capabilities

Call GET /api/v1/dynamic_template_capability_description/get_all to query the full list of capabilities that might appear in templates.

Request:

curl --user apihelp@adroll.com:password \
'https://services.adroll.com/api/v1/dynamic_template_capability_description/get_all?apikey=MYAPIKEY'

Response:

{
  "results": [{
    "id": 1,
    "eid": "CHU4RLZSVJCVNG6ZELX2RM",
    "name": "promoText",
    "description": "Promo text",
    "is_enabled": true,
    "type": null
  }, {
    "id": 2,
    "eid": "RJTMLC5L4ZDVFJSGV3EMOJ",
    "name": "salePrice",
    "description": "Sale price",
    "is_enabled": true,
    "type": null
  }]
}

Dynamic Web Templates

Classic Spotlight

../_images/dc-classic-spotlight.gif

Holiday spotlight

../_images/dc-holiday-spotlight.gif

Valentine spotlight

../_images/dc-valentines-carousel.gif

Fall spotlight

../_images/dc-fall-carousel.gif

Valentine 2018 spotlight

../_images/dc-valentines-2018-spotlight.gif

Product Gladiator

../_images/dc-product-gladiator.gif

Spring Stripes

../_images/dc-spring-stripes.gif

Summer Polka Dots

../_images/dc-summer-polka-dots.gif

Summer Beach

../_images/dc-summer-beach.gif