Creative Elements
A Creative Element is an individual unit that is combined with other Creative Elements to create a Collection Ad Creative.
Attributes
| Attribute | Description | Required | Possible Values |
|---|---|---|---|
| ad_account_id | Ad Account ID | R | |
| name | Creative Element name | R | |
| type | Creative Type | R | BUTTON |
| interaction_type | Type of interaction to be used on the element | R | WEB_VIEW, APP_INSTALL, DEEP_LINK |
| description | Description of the creative element | O | |
| title | Title of the creative element | O | |
| button_properties | Properties of the button like the image to be shown | R (for type=BUTTON) | |
| web_view_properties | Web view properties | R (if interaction_type=WEB_VIEW) | |
| app_installl_properties | App Install properties | R (if interaction_type=APP_INSTALL) | |
| deep_link_properties | Deep link properties | R (if interaction_type=DEEP_LINK) |
Additional Attributes
button_properties object must contain the following attributes
| Attribute | Description | Required | Possible Values |
|---|---|---|---|
| button_overlay_media_id | The image to be used for the button tile | R | See MediaMust be at least 120 X 120px. Max size: 2MB |
web_view_properties object must contain the following attributes
| Attribute | Description | Required | Possible Values |
|---|---|---|---|
| url | Web view URL | R | |
| allow_snap_javascript_sdk | Allow Snapchat Javascript SDK to autofill form fields | O | true/false |
| block_preload | Block Snapchat from preloading the web page | O | true/false |
app_install_properties object must contain the following attributes
| Attribute | Description | Required | Possible Values |
|---|---|---|---|
| app_name | Web view URL | R | 30 characters max |
| ios_app_id | iOS App ID | R* | |
| android_app_url | Google Play Store ID | R* | |
| icon_media_id | Icon Media ID | R |
*At least one of either ios_app_id or android_app_url is required
deep_link_properties object must contain the following attributes
| Attribute | Description | Required |
|---|---|---|
| deep_link_uri | Deep Link URL | R |
| app_name | App name | R |
| ios_app_id | iOS App ID | Optional but one of ios_app_id or android_app_url is required |
| android_app_url | Google Play Store ID | Optional but one of ios_app_id or android_app_url is required |
| icon_media_id | Icon Media ID | R |
| fallback_type | Type of fallback to be used when user doesn't have the app | O |
| web_view_fallback_url | Fallback web url to be used | O |
| product_page_id | Custom product page ID from iOS App Store. Only set when using a Custom Product Page | O |
IMPORTANT! Shopify advertisers using the Snapchat Ads App for Shopify will have their "snap_campaign_id" URL parameter set to a default, unique identifier for web view and deep link ads. This is to ensure proper attribution in the Shopify Admin Dashboard. The "snap_campaign_id" URL parameter cannot be overwritten by the Snapchat URL Macros builder or with url_macro_parameters.
Create a Creative Element
curl -X POST \
-d '{"creative_elements": [{"name":"Product 1 button", "type":"BUTTON", "description": "Product 1", "interaction_type":"WEB_VIEW", "title":"Best title", "button_properties":{"button_overlay_media_id":"008a5ae9-bcc1-4c2e-a3f1-7e924d582019"},"web_view_properties":{"url":"https://snapchat.com"}}]}' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer meowmeowmeow" \
https://adsapi.snapchat.com/v1/adaccounts/8adc3db7-8148-4fbf-999c-8d2266369d74/creative_elements
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5bee332000ff06b565385cab550001737e616473617069736300016275696c642d33373039663463642d312d3232302d3000010145",
"creative_elements": [
{
"sub_request_status": "SUCCESS",
"creative_element": {
"id": "f63bb5f5-471c-404f-8f0d-e5c1a003e4d9",
"updated_at": "2018-11-16T03:01:52.907Z",
"created_at": "2018-11-16T03:01:52.907Z",
"name": "Product 1 button",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"type": "BUTTON",
"interaction_type": "WEB_VIEW",
"title": "Best title",
"description": "Product 1",
"button_properties": {
"button_overlay_media_id": "008a5ae9-bcc1-4c2e-a3f1-7e924d582019"
},
"web_view_properties": {
"url": "https://snapchat.com",
"allow_snap_javascript_sdk": false,
"use_immersive_mode": false,
"deep_link_urls": [],
"block_preload": false
}
}
}
]
}
Create Multiple Creative Elements
curl -X POST \
-d '{"creative_elements": [{"name":"Product 1 button", "type":"BUTTON", "description": "Product 1", "interaction_type":"WEB_VIEW", "title":"Best title", "button_properties":{"button_overlay_media_id":"008a5ae9-bcc1-4c2e-a3f1-7e924d582019"},"web_view_properties":{"url":"https://snapchat.com"}}, {"name":"Product 2 button", "type":"BUTTON", "description": "Product 2", "interaction_type":"WEB_VIEW", "title":"Best title", "button_properties":{"button_overlay_media_id":"008a5ae9-bcc1-4c2e-a3f1-7e924d582012"},"web_view_properties":{"url":"https://snapchat2.com"}}, {"name":"Product 3 button", "type":"BUTTON", "description": "Product 3", "interaction_type":"WEB_VIEW", "title":"Best title", "button_properties":{"button_overlay_media_id":"008a5ae9-bcc1-4c2e-a3f1-7e924d582013"},"web_view_properties":{"url":"https://snapchat3.com"}}]}' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer meowmeowmeow" \
https://adsapi.snapchat.com/v1/adaccounts/8adc3db7-8148-4fbf-999c-8d2266369d74/creative_elements
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5bee33f200ff057a031dfee6af0001737e616473617069736300016275696c642d33373039663463642d312d3232302d300001011a",
"creative_elements": [
{
"sub_request_status": "SUCCESS",
"creative_element": {
"id": "70debf44-cb4b-4b5f-8828-bd2b68b9f0ca",
"updated_at": "2018-11-16T03:05:23.241Z",
"created_at": "2018-11-16T03:05:23.241Z",
"name": "Product 1 button",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"type": "BUTTON",
"interaction_type": "WEB_VIEW",
"title": "Best title",
"description": "Product 1",
"button_properties": {
"button_overlay_media_id": "008a5ae9-bcc1-4c2e-a3f1-7e924d582019"
},
"web_view_properties": {
"url": "https://snapchat.com",
"allow_snap_javascript_sdk": false,
"use_immersive_mode": false,
"deep_link_urls": [],
"block_preload": false
}
}
},
{
"sub_request_status": "SUCCESS",
"creative_element": {
"id": "a2d1c8a0-0466-4924-b769-7a7e6ed5be3d",
"updated_at": "2018-11-16T03:05:23.241Z",
"created_at": "2018-11-16T03:05:23.241Z",
"name": "Product 2 button",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"type": "BUTTON",
"interaction_type": "WEB_VIEW",
"title": "Best title",
"description": "Product 2",
"button_properties": {
"button_overlay_media_id": "008a5ae9-bcc1-4c2e-a3f1-7e924d582012"
},
"web_view_properties": {
"url": "https://snapchat.com",
"allow_snap_javascript_sdk": false,
"use_immersive_mode": false,
"deep_link_urls": [],
"block_preload": false
}
}
},
{
"sub_request_status": "SUCCESS",
"creative_element": {
"id": "4091233e-3351-405d-8684-a97e70c3b5da",
"updated_at": "2018-11-16T03:05:23.242Z",
"created_at": "2018-11-16T03:05:23.242Z",
"name": "Product 3 button",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"type": "BUTTON",
"interaction_type": "WEB_VIEW",
"title": "Best title",
"description": "Product 3",
"button_properties": {
"button_overlay_media_id": "008a5ae9-bcc1-4c2e-a3f1-7e924d582013"
},
"web_view_properties": {
"url": "https://snapchat.com",
"allow_snap_javascript_sdk": false,
"use_immersive_mode": false,
"deep_link_urls": [],
"block_preload": false
}
}
}
]
}
Create an Interaction Zone
Attributes
| Attribute | Description | Required | Possible Values |
|---|---|---|---|
| ad_account_id | Ad Account ID | R | |
| name | Creative Element name | R | |
| headline | Headline for the interaction zone | R | Same as all allowed call_to_action values for Web View Creative |
| creative_elements | Array of Creative Element IDs | R | Must have at least 4 creative elements. |
curl -X POST \
-d '{"interaction_zones": [{"name": "First Interaction Zone", "creative_element_ids": ["d28427e5-0604-406c-8f23-167b211a3317","dc80a56f-800c-499b-846b-78e74bd39a9d","75a98c65-1e62-4507-97fe-50cbc523523a","faefe7cd-567d-4647-bb1d-b918fb0ac98a", "f63bb5f5-471c-404f-8f0d-e5c1a003e4d9"], "headline":"MORE"}]}' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer meowmeowmeow" \
https://adsapi.snapchat.com/v1/adaccounts/8adc3db7-8148-4fbf-999c-8d2266369d74/interaction_zones
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5bee38df00ff00ff5858a22dbc9f0001737e616473617069736300016275696c642d33373039663463642d312d3232302d3000010154",
"interaction_zones": [
{
"sub_request_status": "SUCCESS",
"interaction_zone": {
"id": "a218dc8b-7a79-4da6-9a1c-e5a581c7bd46",
"updated_at": "2018-11-16T03:26:23.130Z",
"created_at": "2018-11-16T03:26:23.130Z",
"name": "First Interaction Zone",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"headline": "MORE",
"creative_element_ids": [
"70debf44-cb4b-4b5f-8828-bd2b68b9f0cf",
"a2d1c8a0-0466-4924-b769-7a7e6ed5be3b",
"4091233e-3351-405d-8684-a97e70c3b5dc",
"f63bb5f5-471c-404f-8f0d-e5c1a003e4d9"
]
}
}
]
}
Get Interaction Zone using Interaction Zone Id
curl "https://adsapi.snapchat.com/v1/interaction_zones/{interaction_zone_id}" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "test-req-id-1a2b-3c4d-5e6f-7g8h",
"interaction_zones": [
{
"sub_request_status": "SUCCESS",
"interaction_zone": {
"id": "test-zone-id-1122-3344-5566-7788",
"updated_at": "2024-06-15T09:00:00.000Z",
"created_at": "2024-06-15T09:00:00.000Z",
"name": "Test Company Catalog (test-store.example.com)",
"ad_account_id": "test-ad-id-9988-7766-5544-3322",
"headline": "VIEW_PRODUCTS",
"creative_element_ids": [
"test-creative-id-1111-2222-3333-4444",
"test-creative-id-5555-6666-7777-8888",
"test-creative-id-aaaa-bbbb-cccc-dddd",
"test-creative-id-eeee-ffff-gggg-hhhh"
],
"render_type": "DYNAMIC"
}
}
]
}
This endpoint retrieves Interaction Zone using Interaction Zone Id.
HTTP Request
GET https://adsapi.snapchat.com/v1/interaction_zones/{interaction_zone_id}
URL Parameters
| Parameter | Description |
|---|---|
| interaction_zone_id | The ID of the Interaction Zone |
Get all Interaction Zones for an Ad Account
curl "https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/interaction_zones" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "test-req-id-alpha-beta-gamma-delta",
"paging": {},
"interaction_zones": [
{
"sub_request_status": "SUCCESS",
"interaction_zone": {
"id": "test-zone-id-0001-0002-0003-0004",
"updated_at": "2024-07-22T10:30:00.000Z",
"created_at": "2024-07-22T10:30:00.000Z",
"name": "Test Ad Collection A",
"ad_account_id": "test-ad-account-id-aaaa-bbbb-cccc-dddd",
"headline": "LEARN_MORE",
"creative_element_ids": [
"test-creative-id-1111-aaaa-2222-bbbb",
"test-creative-id-3333-cccc-4444-dddd",
"test-creative-id-5555-eeee-6666-ffff",
"test-creative-id-7777-gggg-8888-hhhh"
],
"render_type": "STATIC"
}
},
{
"sub_request_status": "SUCCESS",
"interaction_zone": {
"id": "test-zone-id-0005-0006-0007-0008",
"updated_at": "2024-07-21T14:00:00.000Z",
"created_at": "2024-07-21T14:00:00.000Z",
"name": "Test Duration Example",
"ad_account_id": "test-ad-account-id-aaaa-bbbb-cccc-dddd",
"headline": "WATCH_NOW",
"creative_element_ids": [
"test-creative-id-9999-iiii-0000-jjjj",
"test-creative-id-1111-kkkk-2222-llll",
"test-creative-id-3333-mmmm-4444-nnnn",
"test-creative-id-5555-oooo-6666-pppp"
],
"render_type": "DYNAMIC"
}
}
]
}
This endpoint retrieves all Interaction Zones for an Ad Account.
HTTP Request
GET https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/interaction_zones
URL Parameters
| Parameter | Description |
|---|---|
| ad_account_id | The ID of the Ad Account |
Was this page helpful?