Create a Screenshot Request
Last updated
Was this helpful?
Last updated
Was this helpful?
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 use campaign.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 (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 account.
ad.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 the lookup_key
.
ad.media
-> an object with type
and content
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
To create a new ad, provide ad creative content in the media
object (within the ad
object):
Here are the supported type
values and some related content
examples:
html_tag
An HTML string containing ad creative content (often a <script>
tag or an <image>
tag)
url
The URL for an ad creative, such as an image, video, VAST tag, or HTML5 zip file
Within the screenshots
array, there will be a JSON object for each screenshot for the associated ad. Each object is composed of site
object and a device
object.
The Site
object in the screenshots
array must include a url
key.
site.url
-> the website URL
The Device
object in the screenshots
array must include a name
key.
device.name
-> the device to use when generating the screenshot
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
<img src="" width="300" height="250" />
Image:
Video:
Creates a screenshot request from provided data
Organization slug
"abc-company"
Screenshot request
"Please take a screenshot of the ad on the homepage of the site"
Accepted
"screenshot_set"
"e9b4c72e-7520-4e3f-a3e8-a092b927f0d4"
"draft"
"8304d4b0-90e0-4c58-ae3d-38807b23fd9c"
"2023-02-14T09:18:48.318-05:00"
"http://{{defaultHost}}/o/abc-company/campaigns/8304d4b0-90e0-4c58-ae3d-38807b23fd9c/screenshot_sets/e9b4c72e-7520-4e3f-a3e8-a092b927f0d4"