Campaigns
A campaign has a business objective and organizes Ad Squads. You can define a goal and view stats for this campaign to see whether your goal has been reached. The reports and stats combines all the ad squads within this campaign.
Campaign Attributes
Attribute | Description | Required | Possible Values |
---|---|---|---|
ad_account_id | Ad Account ID | R | |
daily_budget_micro | Daily Spend Cap (micro-currency) | O | |
end_time | End time | O | |
name | Campaign name | R | max length: 375 characters |
start_time | Start time | R | |
status | Campaign status | R | ACTIVE, PAUSED |
lifetime_spend_cap_micro | Lifetime spend cap for the campaign (microcurrency) | O | |
measurement_spec | The apps to be tracked for this campaign | R - Required for tracking installs for campaigns containing these ad types: APP_INSTALL, DEEP_LINK, STORY (which swipes up to APP_INSTALL, DEEP_LINK) LENS_APP_INSTALL, LENS_DEEP_LINK | {"ios_app_id":"1234", "android_app_url":"com.snapchat.android"} |
objective | Objective of the Campaign | O | BRAND_AWARENESS (default), APP_CONVERSION, APP_INSTALL, CATALOG_SALES, ENGAGEMENT, LEAD_GENERATION, VIDEO_VIEW, WEB_CONVERSION, PROMOTE_STORIES, PROMOTE_PLACES |
objective_v2_properties | See table for Campaign Objective V2 properties | O | See table for Campaign Objective V2 properties |
buy_model** | Buy Model | O | AUCTION(default), RESERVED |
regulations++ | Required for Campaigns that run Ads for Credit, Housing, Employment (CHE) | O | { "restricted_delivery_signals": true } |
regulations+- | The candidate / ballot field is optional, but may be required in certain states | O | { "candidate_ballot_information":"Voting rights for dogs" } |
delivery_status | Delivery status | Read-only | See Delivery status |
deleted | Indicates whether the entity has been deleted or not, only shown when using the parameter read_deleted_entities | Read-only | true |
** Coming soon. See Reach And Frequency
++ The regulations attribute alongside restricted_delivery_signals is required for Campaigns running Ads promoting Housing, Credit, Employment (HCE), this attribute has to be activated at Ad Account level first or it cannot be used at Campaign level; https://businesshelp.snapchat.com/en-US/a/create-ad-account. Ad Squads created within a Campaign promoting HCE has a limited option of Optimization Goals.
+- The regulations attribute alongside the candidate_ballot_information field is optional, but may be required in certain states The paying_advertiser attribute has to be activated at Ad Account level first or the candidate/ballot field cannot be used at Campaign level; https://businesshelp.snapchat.com/en-US/a/create-ad-account
To enable app install and post-install attribution on ads, the measurement_spec
field must be populated with the corresponding iOS and Android app IDs on campaign creation.
lifetime_spend_cap_micro
can be increased and removed. Reducing the limit is allowed as long as the new limit is 1.1 times the amount already spent. daily_budget_micro
set at the campaign level & the new lifetime_spend_cap_micro
are evaluated independently. Delivery stops when either the Ad Account spend cap or the Campaign Lifetime spend cap is reached.
Campaign Objective V2 properties
The following attributes are used by the property objective_v2_properties
Attribute | Description | Required | Possible Values |
---|---|---|---|
objective_v2_type | The Objective type | O | AWARENESS_AND_ENGAGEMENT, SALES, TRAFFIC, APP_PROMOTION, LEADS |
promotion_type | The Promotion type | O | PROMOTE_PLACES, PROMOTE_SHOWS, APP_INSTALL, APP_REENGAGEMENT |
Campaign Objective V2
The new Campaign level attribute objective_v2_properties replaces the objective attribute, the objective attribute offered users a choice of 12 different Campaign objectives when setting up a Campaign, with the introduction of objective_v2_properties this has changed to 5 options.
The objective_v2_properties attribute is optional, just as the objective attribute was, and is used only for the business logic surfaced by Snap Ads Manager, determining the Optimization Goal options available to Ad Squads. If your application is currently making use of the objective attribute, you are expected to start using objective_v2_properties before 2025.
Along with the launch of objective_v2_properties we are also launching a new entity named Ad Squad Render UI Data ( ad_squad_ui_render_data ), this entity has a one-to-one relationship with the Ad Squad entity and is part of the business logic decision tree. The Ad Squad Render UI Data tells the business logic whether the Ad Squad contains ads for WEB, APP, or MIXED in the case of a combination of the two,
Timelines Objective V2
Time | Phase | Description |
---|---|---|
September - December 2024 | Roll-out of objective_v2_properties | The default state for Ads creation in Ads Manager will be the new Advanced creation flow that use objective_v2_properties. We will continue to set both the objective and objective_v2_properties for Campaigns to ensure that Partner applications can still handle these Campaigns - see table Snap Ads Manager - objective to objective_v2 Applications that make use of the objective value are expected to make the transition from objective and fully adopt objective_v2_properties see table Business logic - objective to objective_v2 for guidance on the new Business logic. |
Q4 - 2024 | Backfill of objective_v2_properties | In the final quarter of the year we will automatically populate the objective_v2_properties for campaigns that only contain the objective value. After the backfill any application that still sets up Campaigns with the objective only will have an objective_v2_properties value inferred based on the objective value - see table API Campaign creation default behaviour in 2024 - Q4 . |
2025 | Deprecation of the objective attribute | At some point in 2025 the Marketing API will reject Campaign creation requests that don’t contain objective_v2_properties |
Business logic - objective to objective_v2
This table compares the business logic of the objective attribute to the new objective_v2_properties attribute, this allows 3rd party applicationss to fully or partly follow the same Business Logic that Snap Ads Manager offers.
The left side of the table presents Optimization Goals based on the old objective attribute, the right side of the table presents the Optimization Goals based on objective_v2_properties. The conversion_location column refers to the new entity ad_squad_ui_render_data and defines goals offered based on the intended location of conversion, Web, App or Lead form.
Note that validation given SKAd enablement, Dynamic Ads and HCE (Housing Credit Employment) still is applicable to the Optimization Goals available. Read about HCE and Optimization Goals
Previous logic - objective only | New logic - Campaign objective_v2_type - promotion_type - Ad Squad UI Render Data | ||||
---|---|---|---|---|---|
objective | optimization goals | objective_v2_type | promotion_type | conversion_location | optimization goals |
BRAND_AWARENESS | IMPRESSIONS, SWIPES, STORY_OPENS, USES | AWARENESS_AND_ENGAGEMENT | - | - | IMPRESSIONS, SWIPES, STORY_OPENS, USES, VIDEO_VIEWS, VIDEO_VIEWS_15_SEC |
PROMOTE_STORIES | IMPRESSIONS | AWARENESS_AND_ENGAGEMENT | PROMOTE_STORIES* | - | IMPRESSIONS |
PROMOTE_PLACES | SWIPES | AWARENESS_AND_ENGAGEMENT | PROMOTE_PLACES* | - | SWIPES |
APP_CONVERSION | SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN, LANDING_PAGE_VIEW | APP_PROMOTION | APP_INSTALL | APP | IMPRESSIONS, SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW |
APP_CONVERSION with Dynamic Ads | SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN | APP_PROMOTION | APP_INSTALL with Dynamic Ads | APP | IMPRESSIONS, SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW |
APP_CONVERSION with SKAdNetwork enabled | SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART | APP_PROMOTION | APP_INSTALL with SKAdNetwork enabled | APP | IMPRESSIONS, SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART |
APP_CONVERSION with Dynamic Ads and SKAdNetwork enabled | SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP | APP_PROMOTION | APP_INSTALL with Dynamic Ads and SKAdNetwork enabled | APP | IMPRESSIONS, SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART |
WEB_CONVERSION | SWIPES, STORY_OPENS, PIXEL_PAGE_VIEW, PIXEL_SIGNUP, PIXEL_ADD_TO_CART, PIXEL_PURCHASE, PIXEL_PURCHASE_VO, LANDING_PAGE_VIEW | SALES | - | WEB | SWIPES, STORY_OPENS, PIXEL_PURCHASE, PIXEL_SIGNUP, PIXEL_ADD_TO_CART, PIXEL_PAGE_VIEW, LANDING_PAGE_VIEW |
LEAD_GENERATION | LEAD_FORM_SUBMISSIONS, SWIPES, STORY_OPENS, PIXEL_SIGN_UP | LEADS | - | WEB | SWIPES, STORY_OPENS, PIXEL_SIGN_UP, LANDING_PAGE_VIEW |
LEAD_GENERATION | LEAD_FORM_SUBMISSIONS, SWIPES, STORY_OPENS, PIXEL_SIGN_UP | LEADS | - | LEAD_FORM | SWIPES, LEAD_FORM_SUBMISSIONS |
- | - | LEADS | - | CALL, TEXT | IMPRESSIONS, SWIPES |
APP_INSTALL | SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_AD_VIEW | APP_PROMOTION | APP_INSTALL | - | SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW |
APP_INSTALL with Dynamic Ads | SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART | APP_PROMOTION | APP_INSTALL with Dynamic Ads | - | SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW |
APP_INSTALL with SKAdNetwork enabled | SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART | APP_PROMOTION | APP_INSTALL with SKAdNetwork enable | - | SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART |
APP_INSTALL with Dynamic Ads and SKAdNetwork enabled | SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART | APP_PROMOTION | APP_INSTALL with Dynamic Ads and SKAdNetwork enabled | - | SWIPES, IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART |
APP_CONVERSION | SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_LEVEL_COMPLETE, APP_ACHIEVEMENT_UNLOCKED, APP_AD_VIEW, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN LANDING_PAGE_VIEW | APP_PROMOTION | APP_REENGAGEMENT | - | SWIPES, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN, LANDING_PAGE_VIEW |
APP_CONVERSION with Dynamic Ads | SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART | APP_PROMOTION | APP_REENGAGEMENT with Dynamic Ads | - | SWIPES, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN, LANDING_PAGE_VIEW |
APP_CONVERSION with SKAdNetwork enabled | SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART | APP_PROMOTION | APP_REENGAGEMENT with SKAdNetwork enabled | - | SWIPES, LANDING_PAGE_VIEW |
APP_CONVERSION with Dynamic Ads and SKAdNetwork enabled | SWIPES, APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART | — | — | - | This combination is not available when using objective_v2_type |
CATALOG_SALES | SWIPES, STORY_OPENS, PIXEL_PURCHASE, PIXEL_ADD_TO_CART, PIXEL_SIGNUP, PIXEL_PAGE_VIEW, PIXEL_PURCHASE_VO, LANDING_PAGE_VIEW | SALES | - | WEB | SWIPES, STORY_OPENS, PIXEL_PURCHASE, PIXEL_SIGNUP, PIXEL_ADD_TO_CART, PIXEL_PAGE_VIEW, LANDING_PAGE_VIEW |
CATALOG_SALES | IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_ADD_TO_CART, APP_SIGNUP, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN | SALES | - | APP | IMPRESSIONS, SWIPES, APP_REENGAGE_PURCHASE APP_REENGAGE_OPEN, |
CATALOG_SALES with SKAdNetwork enabled | IMPRESSIONS, APP_INSTALLS, APP_PURCHASE, APP_ADD_TO_CART, APP_SIGNUP, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN | SALES | - | APP | SKAd Network opted-in IMPRESSIONS, SWIPES, STORY_OPENS |
CATALOG_SALES | SWIPES, STORY_OPENS, PIXEL_PURCHASE, PIXEL_ADD_TO_CART, PIXEL_SIGNUP, PIXEL_PAGE_VIEW, PIXEL_PURCHASE_VO, LANDING_PAGE_VIEW | SALES | - | WEB | SWIPES, STORY_OPENS, PIXEL_PURCHASE, PIXEL_SIGNUP, PIXEL_ADD_TO_CART, PIXEL_PAGE_VIEW, LANDING_PAGE_VIEW |
VIDEO_VIEW | IMPRESSIONS, VIDEO_VIEWS, VIDEO_VIEWS_15_SEC | AWARENESS_AND_ENGAGEMENT | - | - | IMPRESSIONS, SWIPES, STORY_OPENS, USES, VIDEO_VIEWS, VIDEO_VIEWS_15_SEC |
ENGAGEMENT | SWIPES, USES, STORY_OPENS, PIXEL_PURCHASE | AWARENESS_AND_ENGAGEMENT | - | - | IMPRESSIONS, SWIPES, STORY_OPENS, USES, VIDEO_VIEWS, VIDEO_VIEWS_15_SEC |
WEB_VIEW | SWIPES, PIXEL_PAGE_VIEW, LANDING_PAGE_VIEW | TRAFFIC | - | WEB | SWIPES, PIXEL_PAGE_VIEW, LANDING_PAGE_VIEW |
APP_REENGAGEMENT | SWIPES, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN, LANDING_PAGE_VIEW | TRAFFIC | - | APP | SWIPES, APP_REENGAGE_PURCHASE, APP_REENGAGE_OPEN, LANDING_PAGE_VIEW |
WEB_VIEW | IMPRESSIONS, SWIPES | TRAFFIC | - | PUBLIC_PROFILE, CALL, TEXT | IMPRESSIONS, SWIPES |
*The objectives PROMOTE_STORIES and PROMOTE_PLACES are generally not available to create via the API.
Snap Ads Manager - objective to objective_v2
This table explains how Snap Ads Manager is currently setting the Campaign objective valued based on the new Campaign objective_v2_properties logic.
objective_v2_type | promotion_type | catalog_id present | conversion_location | objective |
---|---|---|---|---|
AWARENESS_AND_ENGAGEMENT | PROMOTE_STORIES* | - | PROMOTE_STORIES* | |
AWARENESS_AND_ENGAGEMENT | PROMOTE_PLACES* | - | PROMOTE_PLACES* | |
AWARENESS_AND_ENGAGEMENT | - | - | BRAND_AWARENESS | |
TRAFFIC | - | - | WEB | WEB_VIEW |
TRAFFIC | - | - | APP | APP_REENGAGEMENT |
TRAFFIC | - | - | WEB | WEB_VIEW |
LEADS | - | - | LEAD GENERATION | |
APP_PROMOTION | APP_INSTALL | NO | APP_INSTALL | |
APP_PROMOTION | APP_INSTALL | YES | CATALOG_SALES | |
APP_PROMOTION | APP_REENGAGEMENT | NO | APP_CONVERSION | |
APP_PROMOTION | APP_REENGAGEMENT | YES | CATALOG_SALES | |
SALES | - | NO | WEB | WEB_CONVERSION |
SALES | - | NO | APP | APP_CONVERSION |
SALES | - | NO | WEB | WEB_CONVERSION |
SALES | - | YES | WEB | CATALOG_SALES |
SALES | - | YES | APP | CATALOG_SALES |
objective_v2 - API Campaign creation default behaviour in 2024 - Q4
This table explains how default values for objective_v2_properties will be set for 3rd party applications in 2024 Q4, this only concerns applications that are only setting the objective attribute.
objective | catalog_id present | objective_v2_type | promotion_type |
---|---|---|---|
BRAND_AWARENESS | - | AWARENESS_AND_ENGAGEMENT | - |
PROMOTE_STORIES | - | AWARENESS_AND_ENGAGEMENT | PROMOTE_SHOWS |
PROMOTE_PLACES | - | AWARENESS_AND_ENGAGEMENT | PROMOTE_PLACES |
LEAD_GENERATION | LEADS | ||
APP_INSTALL | - | APP_PROMOTION | APP_INSTALL |
APP_CONVERSION | - | APP_PROMOTION | APP_REENGAGEMENT |
CATALOG_SALES | YES | APP_PROMOTION | APP_INSTALL |
CATALOG_SALES | YES | APP_PROMOTION | APP_REENGAGEMENT |
WEB_CONVERSION | - | SALES | - |
APP_CONVERSION | - | SALES | - |
CATALOG_SALES | YES | SALES | - |
VIDEO_VIEW | - | AWARENESS_AND_ENGAGEMENT | - |
ENGAGEMENT | - | AWARENESS_AND_ENGAGEMENT | - |
WEB_VIEW | - | TRAFFIC | - |
APP_REENGAGEMENT | - | TRAFFIC | - |
Create a Campaign
curl -X POST \
-H "Authorization: Bearer meowmeowmeow" \
-H "Content-Type: application/json" \
-d '{"campaigns": [{"name": "Cool Campaign", "ad_account_id": "3b0fbace-04b4-4f04-a425-33b5e0af1d0d", "status": "PAUSED", "start_time": "2016-08-11T22:03:58.869Z"}]}' \
"https://adsapi.snapchat.com/v1/adaccounts/{ad_acount_id}/campaigns"
The above command returns JSON structured like this:
{
"request_status": "success",
"request_id": "57b002ad00ff07e1f50fd2267f0001737e616473617069736300016275696c642d35396264653638322d312d31312d370001010d",
"campaigns": [
{
"sub_request_status": "success",
"campaign": {
"id": "92e1c28a-a331-45b4-8c26-fd3e0eea8c39",
"updated_at": "2016-08-14T05:33:33.876Z",
"created_at": "2016-08-14T05:33:33.876Z",
"name": "Cool Campaign",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"status": "PAUSED",
"start_time": "2016-08-11T22:03:58.869Z"
}
}
]
}
This endpoint will create a campaign within a specified ad account.
HTTP Request
POST https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/campaigns
Parameters
Parameter | Default | Description |
---|---|---|
ad_account_id | Ad Account ID |
Update a Campaign
curl -X PUT \
-H "Authorization: Bearer meowmeowmeow" \
-H "Content-Type: application/json" \
-d '{"campaigns": [{"name": "Cool Campaign", "ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74", "status": "PAUSED", "start_time": "2016-08-11T22:03:58.869Z", "end_time": "2016-08-21T22:03:58.869-0700", "id": "92e1c28a-a331-45b4-8c26-fd3e0eea8c39"}]}'
https://adsapi.snapchat.com/v1/adaccounts/8adc3db7-8148-4fbf-999c-8d2266369d74/campaigns
The above command returns JSON structured like this:
{
"request_status": "success",
"request_id": "57b0032700ff07e0cfdaa5e1a40001737e616473617069736300016275696c642d35396264653638322d312d31312d3700010105",
"campaigns": [
{
"sub_request_status": "success",
"campaign": {
"id": "92e1c28a-a331-45b4-8c26-fd3e0eea8c39",
"updated_at": "2016-08-14T05:35:35.943Z",
"created_at": "2016-08-14T05:33:33.876Z",
"name": "Cool Campaign",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"status": "PAUSED",
"start_time": "2016-08-11T22:03:58.869Z",
"end_time": "2016-08-22T05:03:58.869Z"
}
}
]
}
This endpoint will update a specified campaign.
Attributes that can be updated
Attribute | Description | Required | Possible Values |
---|---|---|---|
end_time | End time | O | |
name | Campaign name | R | |
daily_budget_micro | Daily Spend Cap (micro-currency) | O | |
lifetime_spend_cap_micro | Lifetime spend cap for the campaign (micro-currency) | O | |
start_time | Start time | O | |
status | Campaign status | R | ACTIVE, PAUSED |
HTTP Request
PUT https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/campaigns
Parameters
Parameter | Default | Description |
---|---|---|
ad_account_id | Ad Account ID |
Get All Campaigns
curl "https://adsapi.snapchat.com/v1/adaccounts/8adc3db7-8148-4fbf-999c-8d2266369d74/campaigns" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "success",
"request_id": "57b003c700ff0f2e66c37f96c20001737e616473617069736300016275696c642d35396264653638322d312d31312d3700010103",
"campaigns": [
{
"sub_request_status": "success",
"campaign": {
"id": "06302efa-4c0f-4e36-b880-a395a36cef64",
"updated_at": "2016-08-12T20:28:58.738Z",
"created_at": "2016-08-12T20:28:58.738Z",
"name": "Campaign One",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"daily_budget_micro": 200000000,
"status": "ACTIVE",
"start_time": "2016-08-10T17:12:49.707Z",
"end_time": "2016-08-13T17:12:49.707Z"
}
},
{
"sub_request_status": "success",
"campaign": {
"id": "0fc8e179-6f3b-46e7-be8e-ca53fd404ece",
"updated_at": "2016-08-12T21:06:18.343Z",
"created_at": "2016-08-12T21:06:18.343Z",
"name": "Campaign Deux",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"daily_budget_micro": 500000000,
"status": "ACTIVE",
"start_time": "2016-08-10T17:12:49.707Z",
"end_time": "2016-08-13T17:12:49.707Z"
}
},
[[[ snip ]]]
{
"sub_request_status": "success",
"campaign": {
"id": "92e1c28a-a331-45b4-8c26-fd3e0eea8c39",
"updated_at": "2016-08-14T05:36:46.441Z",
"created_at": "2016-08-14T05:33:33.876Z",
"name": "Cool Campaign",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"status": "PAUSED",
"start_time": "2016-08-11T22:03:58.869Z",
"end_time": "2016-08-22T05:03:58.869Z"
}
},
{
"sub_request_status": "success",
"campaign": {
"id": "fedf8e04-0176-4ce3-a1ca-148204aee62c",
"updated_at": "2016-08-12T02:18:33.412Z",
"created_at": "2016-08-12T02:18:33.412Z",
"name": "Crazy Campaign",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"start_time": "2016-08-11T22:03:58.869Z",
"status": "PAUSED"
}
}
]
}
This endpoint retrieves all campaigns within a specified ad account.
HTTP Request
GET https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/campaigns
Parameters
Parameter | Default | Description |
---|---|---|
ad_account_id | Ad Account ID | |
read_deleted_entities | true | optional parameter, this param will return the deleted attribute on deleted Campaign entities |
Get a Specific Campaign
curl "https://adsapi.snapchat.com/v1/campaigns/92e1c28a-a331-45b4-8c26-fd3e0eea8c39" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "success",
"request_id": "57b0049c00ff0e8cb21af5199c0001737e616473617069736300016275696c642d35396264653638322d312d31312d3700010107",
"campaigns": [
{
"sub_request_status": "success",
"campaign": {
"id": "92e1c28a-a331-45b4-8c26-fd3e0eea8c39",
"updated_at": "2016-08-14T05:36:46.441Z",
"created_at": "2016-08-14T05:33:33.876Z",
"name": "Cool Campaign",
"ad_account_id": "8adc3db7-8148-4fbf-999c-8d2266369d74",
"status": "PAUSED",
"start_time": "2016-08-11T22:03:58.869Z",
"end_time": "2016-08-22T05:03:58.869Z"
}
}
]
}
This endpoint retrieves a specific campaign.
HTTP Request
GET https://adsapi.snapchat.com/v1/campaigns/{campaign_id}
URL Parameters
Parameter | Default | Description |
---|---|---|
campaign_id | Campaign ID | |
read_deleted_entities | true | optional parameter, this param will return the deleted attribute on deleted Campaign entities |
Delete a Specific Campaign
curl -X DELETE "https://adsapi.snapchat.com/v1/campaigns/92e1c28a-a331-45b4-8c26-fd3e0eea8c39" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "success",
"request_id": "57b004dc00ff0e29c26b5d51840001737e616473617069736300016275696c642d35396264653638322d312d31312d3700010106",
"campaigns": []
}
This endpoint deletes a specific campaign.
HTTP Request
DELETE https://adsapi.snapchat.com/v1/campaigns/<ID>
URL Parameters
Parameter | Description |
---|---|
ID | The ID of the campaign to delete |