Ads API •References / Ad Sets / Get Ad Sets by Campaign

Get Ad Sets by Campaign

Returns a list of ad sets for a specific campaign.

Request

ad_account_id
string [uuid]
Required
campaign_id
string [uuid]
Required
fields
string
pageSize
integer
offset
integer

Response

- id
  string [uuid]
  The unique ID returned when a new ad set is created.
- advertiser_id
  string [uuid]
  The unique ID returned when a new advertiser is created.
- budget_micro_amount
  integer [int64]
  Total budget for the ad set multiplied by x10 to the 6th power.
- cost_micro_amount
  integer [int64]
  It is The cost per 1000 impressions or listens depending on the Cost_model of the ad set (cost model availability will vary by geo). Micro ammount is x10 to the 6th power.
- created_at
  string [date-time]
  Date the ad set was created. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
- ad_ids
  array of strings
  The unique ID returned when a new ad is created.
- end_date
  string [date-time]
  Date the ad set will end on. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
- name
  string
  Name given to identify the ad set.
- start_date
  string [date-time]
  Date the ad set will start on. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
- status
  string [ad-set-status]
  Allowed values: "ACTIVE", "APPROVED", "ARCHIVED", "COMPLETED", "PENDING_APPROVAL", "READY", "REJECTED"Example: "ACTIVE"
- active_status
  string [ad-set-active-status]
  Allowed values: "ACTIVE", "PAUSED", "ARCHIVED"Example: "ACTIVE"
- id
  string [uuid]
  ad_set_id
  string [uuid]
  id
  string [uuid]
  Required
  version
  integer [int64]
  Required
  Example: 1
  status
  string [ad-set-link-approval-status]
  Allowed values: "ACTIVE", "APPROVED", "PENDING_APPROVAL", "REJECTED", "REQUIRES_REAPPROVAL", "ARCHIVED"Example: "ACTIVE"
  active_status
  string [ad-set-link-active-status]
  Allowed values: "ACTIVE", "PAUSED"Example: "ACTIVE"
  reject_reason
  string
  Example: "Reject reason"
  version
  integer [int64]
  Example: 1
- campaign_id
  string [uuid]
  ID associated with the campaign that will contain one to many ad sets within it.
- cost_model
  string [ad-set-cost-model]
  Allowed values: "CPCL", "CPM", "CPC", "UNSET"Example: "CPCL"
- Can utilise the 3 parameters to set a Frequency cap by Day, Week and Month.
  frequency_unit
  string [frequency-cap-frequency-unit]
  Allowed values: "DAY", "MONTH", "WEEK"Example: "DAY"
  frequency_period
  integer [int32]
  Example: 1
  max_impressions
  integer [int32]
  Example: 2
- country_code
  string
  micro_amount
  integer [int64]
- max
  integer
  Range: 13 - 65
  min
  integer
  Range: 13 - 65
  id
  string
  Required
  Required
  height
  integer [int64]
  url
  string [uri]
  width
  integer [int64]
  name
  string
  Required
  country_code
  string
  Example: "US"
  id
  integer [int32]
  Required
  name
  string
  Required
  type
  string
  Allowed values: "COUNTRY", "REGION", "DMA_REGION", "CITY"Example: "COUNTRY"
  country_codes
  array of strings
  country_code
  string
  Example: "US"
  id
  integer [int32]
  Required
  name
  string
  Required
  type
  string
  Allowed values: "COUNTRY", "REGION", "DMA_REGION", "CITY"Example: "COUNTRY"
  gender_names
  array of Gender
  Allowed values: "MALE", "FEMALE", "NON_BINARY"Example: "MALE"
  id
  string
  Required
  name
  string
  Required
  platform_names
  array of Platform
  Allowed values: "IOS", "DESKTOP", "ANDROID", "OTHER"Example: "IOS"
  id
  string
  name
  string
  country_code
  string
  Example: "US"
  id
  integer [int32]
  Required
  name
  string
  Required
  type
  string
  Allowed values: "COUNTRY", "REGION", "DMA_REGION", "CITY"Example: "COUNTRY"
  custom_audience_ids
  array of strings
- name
  string
  Required
  optimization_goal
  string [optimization-goal]
  Required
  Allowed values: "ARTIST_BOOST"Example: "ARTIST_BOOST"
  Required
  optimization_target_type
  string [optimization-target-type]
  Required
  Allowed values: "ARTIST"Example: "ARTIST"
  target_id
  string
  Required
  tracking_event_type
  string
  Required
  Allowed values: "IMPRESSION", "CLICKED", "COMPLETE"
  window_duration_ms
  integer [int32]
  Required
- reject_reason
  string
- serving_issues
  array of Ad Set Serving Issue
  Allowed values: "AD_SET_STATUS", "AD_SET_INACTIVE", "AD_SET_LINK_ALL_STATUS", "AD_SET_LINK_ALL_INACTIVE", "AD_ALL_STATUS", "ASSET_ALL_STATUS", "COMPANION_ALL_STATUS", "CAMPAIGN_STATUS"Example: "AD_SET_STATUS"
- version
  integer [int64]
  When a campaign is created or updated, it is assigned a new version.
total_ad_sets
integer [int64]
Example: 2

Response sample

{  "ad_sets": [    {      "id": "string",      "advertiser_id": "string",      "budget_micro_amount": 0,      "cost_micro_amount": 0,      "created_at": "string",      "ad_ids": ["string"],      "end_date": "string",      "name": "string",      "start_date": "string",      "status": "ACTIVE",      "active_status": "ACTIVE",      "ad_set_links": [        {          "id": "string",          "ad_set_id": "string",          "ad": {            "id": "string",            "version": 1          },          "status": "ACTIVE",          "active_status": "ACTIVE",          "reject_reason": "Reject reason",          "version": 1        }      ],      "campaign_id": "string",      "cost_model": "CPCL",      "frequency_caps": [        {          "frequency_unit": "DAY",          "frequency_period": 1,          "max_impressions": 2        }      ],      "budget": {        "country_code": "string",        "micro_amount": 0      },      "targeting": {        "age_range": {          "max": 13,          "min": 13        },        "artists": [          {            "id": "id",            "images": [              {                "height": 0,                "url": "http://example.com/aeiou",                "width": 6              },              {                "height": 0,                "url": "http://example.com/aeiou",                "width": 6              }            ],            "name": "name"          }        ],        "cities": [          {            "country_code": "US",            "id": 1,            "name": "name",            "type": "COUNTRY"          }        ],        "country_codes": ["string"],        "dmas": [          {            "country_code": "US",            "id": 1,            "name": "name",            "type": "COUNTRY"          }        ],        "gender_names": ["MALE"],        "genres": [          {            "id": "id",            "name": "name"          }        ],        "platform_names": ["IOS"],        "playlists": [          {            "id": "id",            "name": "name"          }        ],        "regions": [          {            "country_code": "US",            "id": 1,            "name": "name",            "type": "COUNTRY"          }        ],        "custom_audience_ids": ["string"]      },      "ad_setOptimization": {        "name": "string",        "optimization_goal": "ARTIST_BOOST",        "optimization_target": {          "optimization_target_type": "ARTIST",          "target_id": "string"        },        "conversion_event": [          {            "tracking_event_type": "IMPRESSION",            "window_duration_ms": 5          }        ]      },      "reject_reason": "string",      "serving_issues": ["AD_SET_STATUS"],      "version": 0    }  ],  "total_ad_sets": 2}