Create a Screenshot Request
The Campaign object
The campaign
object is used to tell us where to store the Ad and Screenshot data for the request. You must included either campaign.id
or campaign.name
in the request.
Using campaign.name
is the most common, as we will find or create a Campaign using this key
campaign.id
-> the Ad Reform ID for an existing Campaign. Use this if you know the specific ID for the campaign you want to use, otherwise usecampaign.name
campaign.name
-> the name you want to use for the Campaign. If a Campaign already exists with this name, we'll use that, otherwise we'll create a new one with this value as the name.
The Ad object
The ad
object (within each object in the screenshot_requests
array) is used to indicate what ad data you want to use in the screenshots you're requesting. This can be entirely new ad data (i.e. an ad creative that does not yet exist in your Ad Reform account), or it can be the id
or lookup_key
pointing to an existing ad.
ad.id
-> the Ad Reform ID for an existing Ad in your accountad.lookup_key
-> a unique ID for an Ad. If an Ad already exists with this key, we'll use that Ad, otherwise we'll create a new one with this value as thelookup_key
ad.media
-> an object withtype
andcontent
keys that contains actual Ad creative data.
You can use both ad.media
(to send in raw ad data) and ad.lookup_key
together in a request, so future requests with the same lookup_key
will be associated to the same Ad in Ad Reform
The Media object
To create a new ad, provide ad creative content in the media
object (within the ad
object):
Supported media types
Here are the supported type
values and some related content
examples:
Type | Content | Description |
---|---|---|
html_tag | <img src="https://placehold.co/300x250" width="300" height="250" /> | An HTML string containing ad creative content (often a |
url | The URL for an ad creative, such as an image, video, VAST tag, or HTML5 zip file |
Supported devices
Objects in the screenshot_requests
array must include a device
object with a name
key. Here's a list of supported device.name
values:
mobile
iphone
tablet
ipad
Apple iPad
Apple iPhone 5
Apple iPhone 6
Apple iPhone 6 Plus
Apple iPhone X
Desktop
Google Nexus 10
Google Nexus 5
Google Nexus 6
Google Pixel 4
Samsung Galaxy S10
Last updated
Was this helpful?