Skip to content
Ads APIReferences / Ad Sets / Create Ad Set

Create Ad Set

Creates a new ad set.

Request

  • ad_account_id
    string [uuid]
    Required
  • campaign_id
    string [uuid]
    Required
  • budget_micro_amount
    integer [int64]
    Required

    Total budget for the ad set multiplied by x10 to the 6th power.

    Example: 5000000
  • end_date
    string [date-time]
    Required

    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

    Example: "2022-12-06T14:00:00Z"
  • name
    string
    Required

    Name given to identify the ad set.

    Example: "New ad set"
  • start_date
    string [date-time]
    Required

    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

    Example: "2022-11-06T14:00:00Z"
  • Required
      • max
        integer
        Required
        Range: 13 - 65Example: 65
      • min
        integer
        Required
        Range: 13 - 65Example: 13
    • artist_ids
      array of strings
    • city_ids
      array of integers
    • country_codes
      array of strings
      Example: "US"
    • dma_ids
      array of integers
    • gender_names
      array of Gender
      Allowed values: "MALE", "FEMALE", "NON_BINARY"Example: "MALE"
    • genre_ids
      array of strings
    • platform_names
      array of Platform
      Allowed values: "IOS", "DESKTOP", "ANDROID", "OTHER"Example: "IOS"
    • playlist_ids
      array of strings
    • region_ids
      array of integers
    • custom_audience_ids
      array of strings
    • slot_type
      string [slot-type]
      Required
      Allowed values: "AUDIO", "VIDEO"Example: "AUDIO"
  • ad_ids
    array of strings

    The unique ID returned when a new ad is created.

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

Response

  • ad_set_id
    string [uuid]

Response sample

{  "ad_set_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"}