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 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]
      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]
        • min
          integer
          Range: 13 - 65
        • max
          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
      • artist_promotion_goal
        string [artist-promotion-goal]
        Required
        Allowed values: "ARTIST_BOOST", "ARTIST_CONTENT"Example: "ARTIST_BOOST"
        • artist_promotion_target_type
          string [artist-promotion-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
      Example: "Reject reason"
    • 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.

      Example: 1
    • bid_optimization_goal
      string [bid-optimization-goal]
      Allowed values: "UNSET", "AD_COMPLETES", "CLICKS", "EVEN_IMPRESSION_DELIVERY", "REACH"Example: "AD_COMPLETES"
    • bid_strategy
      string [bid-strategy]
      Allowed values: "UNSET", "MAX_BID"Example: "MAX_BID"
    • bid_micro_amount
      integer [int64]
  • total_ad_sets
    integer [int64]
    Example: 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}