Ads API •References / Ad Sets / Get Ad Sets

Get Ad Sets

Returns a list of all available ad sets.

Request

POST

/adSets

organization_ids
array of strings
ad_account_ids
array of strings
ad_set_ids
array of strings
limit
integer [int32]
Example value: 2
offset
integer [int32]
Example value: 0

Response

- id
  string [uuid]
  The Unique ID returned back when a new ad set is created.
- advertiser_id
  string [uuid]
  The Unique ID returned back when a new advertiser is created.
- budget_micro_amount
  integer [int64]
  Total budget for the ad set multiplied by 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 back when a new ad is created.
- 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
- 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.
- status
  string [ad-set-status]
  Example value: "ACTIVE"Allowed values: "ACTIVE", "APPROVED", "ARCHIVED", "COMPLETED", "PENDING_APPROVAL", "READY", "REJECTED"
- active_status
  string [ad-set-active-status]
  Example value: "ACTIVE"Allowed values: "ACTIVE", "PAUSED", "ARCHIVED"
- 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]
  Example value: "CPCL"Allowed values: "CPCL", "CPM", "CPC", "UNSET"
- Can utilise the 3 parameters to set a Frequency cap by Day, Week and Month.
- reject_reason
  string
  Example value: "Reject reason"
- serving_issues
  array of Ad Set Serving Issue
  Example value: "AD_SET_STATUS"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"
- version
  integer [int64]
  When a campaign is created or updated, it is assigned a new version.
  Example value: 1
- bid_optimization_goal
  string [bid-optimization-goal]
  Example value: "AD_COMPLETES"Allowed values: "UNSET", "AD_COMPLETES", "CLICKS", "EVEN_IMPRESSION_DELIVERY", "REACH"
- bid_strategy
  string [bid-strategy]
  Example value: "MAX_BID"Allowed values: "UNSET", "MAX_BID"
- bid_micro_amount
  integer [int64]
total_ad_sets
integer [int64]
Example value: 2

Response sample

{  "ad_sets": [    {      "id": "mk66a2eb-35cf-46a4-8d2e-0j95dfc133l8",      "advertiser_id": "za66a2eb-35cf-46a4-8d2e-0j95dfc133r4",      "budget_micro_amount": 5000000,      "created_at": "2022-11-06T14:00:00Z",      "ad_ids": ["mk66a2eb-35cf-46a4-8d2e-0j95dfc133l9"],      "start_date": "2022-11-06T14:00:00Z",      "end_date": "2022-12-06T14:00:00Z",      "name": "New ad set",      "status": "ACTIVE",      "active_status": "ACTIVE",      "ad_set_links": [        {          "id": "mk66a2eb-35cf-46a4-8d2e-0j95dfc133l9",          "ad_set_id": "mk66a2eb-35cf-46a4-8d2e-0j95dfc133l9",          "ad": {            "id": "mk66a2eb-35cf-46a4-8d2e-0j95dfc133l9",            "version": 1          },          "status": "ACTIVE",          "active_status": "ACTIVE",          "reject_reason": "Reject reason",          "version": 1        }      ],      "campaign_id": "2g5488b7-0a48-4751-b3b8-701df2d8cd91",      "cost_model": "CPM",      "frequency_caps": [        {          "frequency_unit": "DAY",          "frequency_period": 1,          "max_impressions": 2        }      ],      "budget": {        "country_code": "US",        "micro_amount": 5000000      },      "targeting": {        "age_range": {          "min": 13,          "max": 65        },        "artists": ["string"],        "cities": [0],        "country_codes": ["US"],        "dmas": [0],        "gender_names": ["MALE"],        "genres": ["string"],        "platform_names": ["IOS"],        "playlists": ["string"],        "regions": [0],        "custom_audience_ids": ["string"]      },      "artist_promotion": {        "name": "Optimization",        "artist_promotion_goal": "ARTIST_BOOST",        "artist_promotion_target": {          "artist_promotion_target_type": "ARTIST",          "target_id": "string"        },        "conversion_event": [          {            "tracking_event_type": "IMPRESSION",            "window_duration_ms": 14          }        ]      },      "reject_reason": "Rejected reason",      "serving_issues": ["AD_SET_STATUS"],      "version": 1,      "bid_optimization_goal": "AD_COMPLETES",      "bid_strategy": "MAX_BID",      "bid_micro_amount": 12000000    },    {      "id": "mk66a2eb-35cf-46a4-8d2e-0j95dfc133l8",      "advertiser_id": "za66a2eb-35cf-46a4-8d2e-0j95dfc133r4",      "budget_micro_amount": 5000000,      "created_at": "2022-11-06T14:00:00Z",      "ad_ids": ["mk66a2eb-35cf-46a4-8d2e-0j95dfc133l9"],      "start_date": "2022-11-06T14:00:00Z",      "end_date": "2022-12-06T14:00:00Z",      "name": "New ad set",      "status": "ACTIVE",      "active_status": "ACTIVE",      "ad_set_links": [        {          "id": "mk66a2eb-35cf-46a4-8d2e-0j95dfc133l9",          "ad_set_id": "mk66a2eb-35cf-46a4-8d2e-0j95dfc133l9",          "ad": {            "id": "mk66a2eb-35cf-46a4-8d2e-0j95dfc133l9",            "version": 1          },          "status": "ACTIVE",          "active_status": "ACTIVE",          "reject_reason": "Reject reason",          "version": 1        }      ],      "campaign_id": "2g5488b7-0a48-4751-b3b8-701df2d8cd91",      "cost_model": "CPM",      "frequency_caps": [        {          "frequency_unit": "DAY",          "frequency_period": 1,          "max_impressions": 2        }      ],      "budget": {        "country_code": "US",        "micro_amount": 5000000      },      "targeting": {        "age_range": {          "min": 13,          "max": 65        },        "artists": ["string"],        "cities": [0],        "country_codes": ["US"],        "dmas": [0],        "gender_names": ["MALE"],        "genres": ["string"],        "platform_names": ["IOS"],        "playlists": ["string"],        "regions": [0],        "custom_audience_ids": ["string"]      },      "artist_promotion": {        "name": "Optimization",        "artist_promotion_goal": "ARTIST_BOOST",        "artist_promotion_target": {          "artist_promotion_target_type": "ARTIST",          "target_id": "string"        },        "conversion_event": [          {            "tracking_event_type": "IMPRESSION",            "window_duration_ms": 14          }        ]      },      "reject_reason": "Rejected reason",      "serving_issues": ["AD_SET_STATUS"],      "version": 1,      "bid_optimization_goal": "AD_COMPLETES",      "bid_strategy": "MAX_BID",      "bid_micro_amount": 12000000    }  ],  "total_ad_sets": 2}