Skip to content
Ads APIReferences / Ad Sets / Get Ad Sets by Ad Account

Get Ad Sets by Ad Account

Returns ad sets for a specific ad account.

Request

  • ad_account_id
    string [uuid]
    Required
  • advertiser_ids
    string
  • statuses
    string
  • active_statuses
    string
  • name
    string
  • campaign_ids
    string
  • ad_ids
    string
  • ad_statuses
    string
  • sort_field
    string
  • sort_direction
    string
  • page_size
    integer
  • offset
    integer
  • fields
    string

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]
      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
    • 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.

  • total_ad_sets
    integer [int64]
    Example value: 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}