Ads API •References / ad-sets / Create an Ad Set

Create an Ad Set

Create a new ad set.

Request

  • ad_account_idstring [uuid]
    Required

    A unique identifier for an Ad Account.

    Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a

Represents a create request.

  • namestring
    Required

    Name given to identify the ad set.

    Length between 2 and 200Example: "New Ad Set"
  • start_timestring [date-time]
    Required

    Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ

    Example: "2023-09-23T04:56:07Z"
  • end_timestring [date-time]

    Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ

    Example: "2023-09-23T04:56:07Z"
  • Unique items

    Specify maximum impressions per user over a given period of time. Will default to the maximum (5 per day, 35 per week, 50 per month) if not specified in the CREATE request, OR if an empty array [] is sent in the PATCH request.

    Array maximum length: 3

    Can utilize the 3 parameters to set a Frequency Cap by Day, Week and Month.

    • frequency_unitstring
      Required

      Unit of time for the frequency cap.

      Allowed values: "DAY", "MONTH", "WEEK"Example: "DAY"
    • frequency_periodinteger [int32]
      Required

      Period of time for the frequency cap. Ex: To specify a cap for a 1 day/week/month period, input 1 as the frequency_period.

      Minimum value: 1Example: 1
    • max_impressionsinteger [int32]
      Required

      Maximum impressions per user over the frequency period.

      Minimum value: 1Example: 2
  • bid_micro_amountinteger [int64]

    The amount of your bid per 1000 impressions, multiplied by x10 to the 6th power. Behavior of this field depends on the bid_strategy specified. Ex: In order to set a bid of $20, you would specify a bid_micro_amount of 20000000.

    Example: 1000000
  • base_rate_micro_amountinteger [int64]

    The base rate per 1000 impressions or actions, multiplied by x10 to the 6th power. Ex: In order to set a base rate of $15, you would specify a base_rate_micro_amount of 15000000.

    Example: 15000000
  • List of cost modifiers to apply to the base rate.

    Cost modifier object containing rate adjustment information.

    • idstring [uuid]
      Required

      Unique identifier for the cost modifier.

      Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
    • namestring
      Required

      Name of the cost modifier.

      Example: "Premium Placement"
    • ratenumber [double]
      Required

      Rate multiplier for the cost modifier.

      Example: 1.25
  • deliverystring

    Toggles the delivery of the entity ON or OFF. Cannot be set in Ad Set PATCH request alongside other fields (delivery must be the only field present).

    Allowed values: "ON", "OFF"Example: "ON"
  • dataset_idstring [uuid]

    The unique identifier for a dataset attached to an adset.

    Supported content-type(s): Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
  • video_delivery_formatsarray of strings
    Unique items

    The allowed delivery formats of the ad set, which define how the ads within them will be shown to users. This field is only applicable for video ad sets. For video views campaigns, the only allowed value (and default value) is OPT_IN, for clicks campaigns, the only allowed value (and default value) is IN_STREAM, and for all other campaigns with video ad sets, the default is both OPT_IN and IN_STREAM.

    Example: ["IN_STREAM","OPT_IN"]
    Allowed values: "IN_STREAM", "OPT_IN"
  • categorystring
    Deprecated

    Category ID of the ad set.

    Example: "ADV_1_1"
  • Required

    Users should specify one budget when creating an ad set.

    • micro_amountinteger [int64]
      Required

      Total budget for the ad set multiplied by x10 to the 6th power. Ex: In order to set a budget of $250, you would specify a budget_micro_amount of 250000000.

      Example: 15000000
    • typestring
      Required
      Allowed values: "DAILY", "LIFETIME"Example: "DAILY"
  • Required

    The targeting used for this ad set.

    • Age range(s) to target.

      • mininteger [int32]

        Minimum age to target.

        Range: 13 - 99Example: 13
      • maxinteger [int32]

        Maximum age to target.

        Default: 99Range: 13 - 99Example: 65
    • artist_idsarray of strings
      Unique items

      ID(s) of artist(s) to target. In compliance with the Digital Services Act, fan targeting may not apply when targeting only minors in the United States, the United Kingdom, or a European Union member country, If the age targeting includes but is not limited to minors, fan targeting will apply but minors may be excluded.

      Example: ["06HL4z0CvFAxyc27GXpf02"]
    • Geographical areas to target.

      • country_codestring

        Two-letter ISO code of the country to target.

        Example: "US"
      • city_idsarray of strings
        Unique items

        ID(s) of the city/cities to target.

        Example: ["4174700"]
      • dma_idsarray of strings
        Unique items

        ID(s) of the DMA(s) to target.

        Example: ["501"]
      • postal_code_idsarray of strings
        Unique items

        ID(s) of the postal codes(s) to target.

        Example: ["US:73170"]
      • region_idsarray of strings
        Unique items

        ID(s) of the region(s) to target.

        Example: ["5279468"]
    • gendersarray of strings
      Unique items

      Name(s) of the gender to target. In compliance with the Digital Services Act, gender targeting may not apply when targeting only minors in the United States, the United Kingdom, or a European Union member country, If the age targeting includes but is not limited to minors, gender targeting will apply but minors may be excluded.

      Example: ["MALE","FEMALE","NON_BINARY"]
      Allowed values: "MALE", "FEMALE", "NON_BINARY"
    • genre_idsarray of strings
      Unique items

      ID(s) of the genre(s) to target.

      Example: ["rock","blues"]
    • interest_idsarray of strings
      Unique items

      ID(s) of the interest(s) to target. In compliance with the Digital Services Act, interest targeting may not apply when targeting only minors in the United States, the United Kingdom, or a European Union member country, If the age targeting includes but is not limited to minors, interest targeting will apply but minors may be excluded.

      Example: ["7ebe6459-5fea-4a50-887d-273c06080c78","46b303e4-09a4-4c8e-998b-37186ff8120a"]
    • platformsarray of strings
      Unique items

      ID(s) of the platform(s) to target. If no platform targeting is passed, ["ANDROID", "DESKTOP", "IOS"] will be targeted by default in the CREATE request, OR if an empty array [] is sent in the PATCH request.

      Example: ["IOS"]
      Allowed values: "ANDROID", "DESKTOP", "IOS"
    • podcast_episode_topic_idsarray of strings
      Unique items

      Podcast episode topics to target. Allowed values: automotive, books-and-literature, business-and-finance, careers, education, events-and-attractions, family-and-relationships, fine-art, food-and-drink, healthy-living, hobbies-and-interests, home-and-garden, medical-health, movies, music-and-audio, news-and-politics, personal-finance, pets, pop-culture, real-estate, religion-and-spirituality, science, shopping, sports, style-and-fashion, technology-and-computing, television, travel, video-gaming.

      Example: ["automotive","books-and-literature"]
    • Exclude sensitive topics with a given filter level or pass a filter level for all sensitive topics. For example, passing tobacco with a restricted filter will prevent any ad targeting on podcast episodes associated with tobacco. Another example, passing a global filter will apply the filter to all available sensitive topics. Both topic-level filters and global filters cannot be passed at the same time. Allowed filter levels: standard, limited, partial, restricted Allowed sensitive topic ids: alcohol, crime-violence, drugs, gambling, hate-speech, pornography, terrorism, tobacco, weapons.

      Here is an example JSON for passing in topic-level filters:


      _10
      sensitive_topic_exclusions: { topics: [ { id: "alcohol", filter_option: "RESTRICTED" } ] }

      Here is an example JSON for passing in a global filter:


      _10
      sensitive_topic_exclusions: { filter_option: "PARTIAL" }

        • idstring
          Required
        • filter_optionstring
          Required

          How restrictive the ads system should be when considering serving an ad on a particular podcast episode based on the sensitive topics associated with the episode. These filters can either be applied on a per topic basis or globally for all sensitive topics, but cannot be applied at both levels.

          Allowed values: "STANDARD", "PARTIAL", "LIMITED", "RESTRICTED"Example: "LIMITED"
      • filter_optionstring

        How restrictive the ads system should be when considering serving an ad on a particular podcast episode based on the sensitive topics associated with the episode. These filters can either be applied on a per topic basis or globally for all sensitive topics, but cannot be applied at both levels.

        Allowed values: "STANDARD", "PARTIAL", "LIMITED", "RESTRICTED"Example: "LIMITED"
    • languagestring

      ID of the language to target. If no language targeting is passed, all languages will be targeted.

      Length between 2 and 2Example: "en"
    • playlist_idsarray of strings
      Unique items

      ID(s) of the playlist(s) to target.

      Example: ["holidays","cooking"]
    • placementsarray of strings
      Unique items

      This field is REQUIRED. Indicates surfaces in the client where the ad(s) will be served.

      Example: ["PODCAST","MUSIC"]

      Placement of the ad.

      Allowed values: "MUSIC", "PODCAST"Example: "MUSIC"
    • audience_idsarray of strings

      ID(s) of audiences to target.

      A unique identifier for the entity.

      Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
    • audience_ids_exclusionsarray of strings

      ID(s) of audiences to exclude from targeting.

      A unique identifier for the entity.

      Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
  • pacingstring

    Set a pacing option to deliver your ads throughout the schedule of your ad set with standard pacing("PACING_EVEN"), or accelerated pacing("PACING_ASAP") to deliver your ads as quickly as possible.

    Allowed values: "PACING_ASAP", "PACING_EVEN"Example: "PACING_EVEN"
  • bid_strategystring
    Required

    Strategy for how bids will be applied in the auction.

    • "MAX_BID": the bid_micro_amount will act as a bid cap, meaning the maximum amount paid per 1000 impressions.
    Allowed values: "COST_PER_RESULT", "MAX_BID", "UNSET"Example: "MAX_BID"
  • This would be artist promo or podcast promo.

    • promotion_goalstring
      Required

      "ARTIST_PROMO": Promote an artist's music on Spotify. With this goal, Streaming Conversion Metrics ("SCM"), which track how the ad set drove results for the artist on Spotify, will be enabled for the ad set. | "PODCAST_PROMO": Promote a podcast show.

      Allowed values: "ARTIST_PROMO", "PODCAST_PROMO"Example: "ARTIST_PROMO"
    • promotion_target_idstring

      ID of the artist or podcast show to promote. This is required for "ARTIST_MUSIC_PROMO" and "PODCAST_PROMO".

      Example: "4q3ewBCX7sLwd24euuV69X"
    • Unique items

      For streaming conversion metrics.

      • tracking_event_typestring
        Required

        The event type that will be tracked as a conversion.

        Allowed values: "IMPRESSION", "CLICKED", "COMPLETE"Example: "IMPRESSION"
      • window_duration_msinteger [int32]
        Required

        The window of time after an impression during which a conversion will be counted, expressed in milliseconds. Ex: To specify a conversion window of 14 days, input 121000000000 as the window_duration_ms.

        Range: 28800000 - 2147483647Example: 86400000
  • campaign_idstring [uuid]

    ID of the campaign under which the ad set will be created. This field is required.

    Supported content-type(s): Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
  • asset_formatstring
    Required

    Format of the asset.

    Allowed values: "AUDIO", "VIDEO", "IMAGE"Example: "AUDIO"
  • mobile_app_idstring [uuid]

    ID of the mobile app to be tied to this ad set.

    Supported content-type(s): Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
  • placementsarray of strings
    Deprecated

    Placement of the ad.

    Allowed values: "MUSIC", "PODCAST"Example: "MUSIC"
  • delivery_goalstring

    The goal of the ad set.

    Allowed values: "UNSET", "IMPRESSIONS", "REACH", "VIDEO_VIEWS", "CLICKS", "PAGE_VIEWS", "APP_INSTALLS", "STREAMS", "LEADS"

Response

Ad set response.

An ad set is the core component of your Ad Studio advertising campaign. It contains all the essential information Ad Studio needs to execute your campaign. For example, an ad set contains: Information about how, when, and where your campaign runs (e .g., start and end dates, budgets, targeting, etc). A single ad set can’t be used across multiple campaigns. A single ad set is associated with only one campaign.

  • namestring

    Name given to identify the ad set.

    Length between 2 and 200Example: "New Ad Set"
  • start_timestring [date-time]

    Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ

    Example: "2023-09-23T04:56:07Z"
  • end_timestring [date-time]

    Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ

    Example: "2023-09-23T04:56:07Z"
  • Unique items

    Specify maximum impressions per user over a given period of time. Will default to the maximum (5 per day, 35 per week, 50 per month) if not specified in the CREATE request, OR if an empty array [] is sent in the PATCH request.

    Array maximum length: 3

    Can utilize the 3 parameters to set a Frequency Cap by Day, Week and Month.

    • frequency_unitstring
      Required

      Unit of time for the frequency cap.

      Allowed values: "DAY", "MONTH", "WEEK"Example: "DAY"
    • frequency_periodinteger [int32]
      Required

      Period of time for the frequency cap. Ex: To specify a cap for a 1 day/week/month period, input 1 as the frequency_period.

      Minimum value: 1Example: 1
    • max_impressionsinteger [int32]
      Required

      Maximum impressions per user over the frequency period.

      Minimum value: 1Example: 2
  • bid_micro_amountinteger [int64]

    The amount of your bid per 1000 impressions, multiplied by x10 to the 6th power. Behavior of this field depends on the bid_strategy specified. Ex: In order to set a bid of $20, you would specify a bid_micro_amount of 20000000.

    Example: 1000000
  • base_rate_micro_amountinteger [int64]

    The base rate per 1000 impressions or actions, multiplied by x10 to the 6th power. Ex: In order to set a base rate of $15, you would specify a base_rate_micro_amount of 15000000.

    Example: 15000000
  • List of cost modifiers to apply to the base rate.

    Cost modifier object containing rate adjustment information.

    • idstring [uuid]
      Required

      Unique identifier for the cost modifier.

      Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
    • namestring
      Required

      Name of the cost modifier.

      Example: "Premium Placement"
    • ratenumber [double]
      Required

      Rate multiplier for the cost modifier.

      Example: 1.25
  • deliverystring

    Toggles the delivery of the entity ON or OFF. Cannot be set in Ad Set PATCH request alongside other fields (delivery must be the only field present).

    Allowed values: "ON", "OFF"Example: "ON"
  • dataset_idstring [uuid]

    The unique identifier for a dataset attached to an adset.

    Supported content-type(s): Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
  • video_delivery_formatsarray of strings
    Unique items

    The allowed delivery formats of the ad set, which define how the ads within them will be shown to users. This field is only applicable for video ad sets. For video views campaigns, the only allowed value (and default value) is OPT_IN, for clicks campaigns, the only allowed value (and default value) is IN_STREAM, and for all other campaigns with video ad sets, the default is both OPT_IN and IN_STREAM.

    Example: ["IN_STREAM","OPT_IN"]
    Allowed values: "IN_STREAM", "OPT_IN"
  • idstring [uuid]

    ID of the ad set.

    Supported content-type(s): Example: "39ff503e-4baa-4e7a-9dd2-4b3f49653801"
  • categorystring

    Category ID of the ad set.

    Example: "ADV_1_1"
  • campaign_idstring [uuid]

    ID associated with the campaign that will contain one or more ad sets within it.

    Supported content-type(s): Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
  • cost_modelstring

    Method used to determine how advertisers are charged for their ad campaigns.

    • "CPM": Cost Per Thousand Impressions.
    • "CPCL": Cost Per Thousand Listens.
    Allowed values: "CPM", "CPCL"Example: "CPM"
  • created_atstring [date-time]

    Date the entity was created. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ

    Example: "2026-01-23T04:56:07Z"
  • updated_atstring [date-time]

    Date the entity was updated. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ

    Example: "2026-01-23T04:56:07Z"
  • asset_formatstring

    Format of the asset.

    Allowed values: "AUDIO", "VIDEO", "IMAGE"Example: "AUDIO"
  • Users should specify one budget when creating an ad set.

    • micro_amountinteger [int64]
      Required

      Total budget for the ad set multiplied by x10 to the 6th power. Ex: In order to set a budget of $250, you would specify a budget_micro_amount of 250000000.

      Example: 15000000
    • typestring
      Required
      Allowed values: "DAILY", "LIFETIME"Example: "DAILY"
    • currencystring
      Read only
      Example: "USD"
  • This would be artist promo or podcast promo.

    • promotion_goalstring
      Required

      "ARTIST_PROMO": Promote an artist's music on Spotify. With this goal, Streaming Conversion Metrics ("SCM"), which track how the ad set drove results for the artist on Spotify, will be enabled for the ad set. | "PODCAST_PROMO": Promote a podcast show.

      Allowed values: "ARTIST_PROMO", "PODCAST_PROMO"Example: "ARTIST_PROMO"
    • promotion_target_idstring

      ID of the artist or podcast show to promote. This is required for "ARTIST_MUSIC_PROMO" and "PODCAST_PROMO".

      Example: "4q3ewBCX7sLwd24euuV69X"
    • Unique items

      For streaming conversion metrics.

      • tracking_event_typestring
        Required

        The event type that will be tracked as a conversion.

        Allowed values: "IMPRESSION", "CLICKED", "COMPLETE"Example: "IMPRESSION"
      • window_duration_msinteger [int32]
        Required

        The window of time after an impression during which a conversion will be counted, expressed in milliseconds. Ex: To specify a conversion window of 14 days, input 121000000000 as the window_duration_ms.

        Range: 28800000 - 2147483647Example: 86400000
  • bid_strategystring

    Strategy for how bids will be applied in the auction. Allowed values:

    • "MAX_BID": The bid_micro_amount will act as a bid cap, meaning the maximum amount paid per 1,000 impressions
    • "COST_PER_RESULT: Currently only comptabile with the CLICKS campaign objective. When used with the CLICKS campaign objective, the bid_micro_amount will act as a target Cost Per Click.
    • "UNSET": Ad sets that were pre-auction will not have a bid strategy set.
    Allowed values: "COST_PER_RESULT", "MAX_BID"Example: "MAX_BID"
  • reject_reasonstring

    The reason why the ad set was rejected.

    Example: "Your ad wasn’t approved. Create a new ad, or contact us at adstudio@spotify.com."
  • Rejection and remediation information and keys.

    Rejection and remediation text and keys.

    • rejectionstring

      Rejection reason.

      Example: "Clickthrough URL doesn't work"
    • rejection_keystring

      Rejection reason key.

      Example: "AD_POLICY_VIOLATION_REJECTION"
    • remediationstring

      Remediation information.

      Example: "Submit a new ad with an updated clickthrough URL."
    • remediation_keystring

      Remediation key.

      Example: "AD_POLICY_VIOLATION_REMEDIATION"
  • statusstring

    Status of the ad set.

    Allowed values: "ACTIVE", "ACTIVE_RESTRICTED", "APPROVED", "ARCHIVED", "COMPLETED", "PENDING_APPROVAL", "READY", "REJECTED"Example: "ACTIVE"
  • The targeting used for this ad set.

    • Age range(s) to target.

      • mininteger [int32]

        Minimum age to target.

        Range: 13 - 99Example: 13
      • maxinteger [int32]

        Maximum age to target.

        Default: 99Range: 13 - 99Example: 65
    • artist_idsarray of strings
      Unique items

      ID(s) of artist(s) to target. In compliance with the Digital Services Act, fan targeting may not apply when targeting only minors in the United States, the United Kingdom, or a European Union member country, If the age targeting includes but is not limited to minors, fan targeting will apply but minors may be excluded.

      Example: ["06HL4z0CvFAxyc27GXpf02"]
    • Geographical areas to target.

      • country_codestring

        Two-letter ISO code of the country to target.

        Example: "US"
      • city_idsarray of strings
        Unique items

        ID(s) of the city/cities to target.

        Example: ["4174700"]
      • dma_idsarray of strings
        Unique items

        ID(s) of the DMA(s) to target.

        Example: ["501"]
      • postal_code_idsarray of strings
        Unique items

        ID(s) of the postal codes(s) to target.

        Example: ["US:73170"]
      • region_idsarray of strings
        Unique items

        ID(s) of the region(s) to target.

        Example: ["5279468"]
    • gendersarray of strings
      Unique items

      Name(s) of the gender to target. In compliance with the Digital Services Act, gender targeting may not apply when targeting only minors in the United States, the United Kingdom, or a European Union member country, If the age targeting includes but is not limited to minors, gender targeting will apply but minors may be excluded.

      Example: ["MALE","FEMALE","NON_BINARY"]
      Allowed values: "MALE", "FEMALE", "NON_BINARY"
    • genre_idsarray of strings
      Unique items

      ID(s) of the genre(s) to target.

      Example: ["rock","blues"]
    • interest_idsarray of strings
      Unique items

      ID(s) of the interest(s) to target. In compliance with the Digital Services Act, interest targeting may not apply when targeting only minors in the United States, the United Kingdom, or a European Union member country, If the age targeting includes but is not limited to minors, interest targeting will apply but minors may be excluded.

      Example: ["7ebe6459-5fea-4a50-887d-273c06080c78","46b303e4-09a4-4c8e-998b-37186ff8120a"]
    • platformsarray of strings
      Unique items

      ID(s) of the platform(s) to target. If no platform targeting is passed, ["ANDROID", "DESKTOP", "IOS"] will be targeted by default in the CREATE request, OR if an empty array [] is sent in the PATCH request.

      Example: ["IOS"]
      Allowed values: "ANDROID", "DESKTOP", "IOS"
    • podcast_episode_topic_idsarray of strings
      Unique items

      Podcast episode topics to target. Allowed values: automotive, books-and-literature, business-and-finance, careers, education, events-and-attractions, family-and-relationships, fine-art, food-and-drink, healthy-living, hobbies-and-interests, home-and-garden, medical-health, movies, music-and-audio, news-and-politics, personal-finance, pets, pop-culture, real-estate, religion-and-spirituality, science, shopping, sports, style-and-fashion, technology-and-computing, television, travel, video-gaming.

      Example: ["automotive","books-and-literature"]
    • Exclude sensitive topics with a given filter level or pass a filter level for all sensitive topics. For example, passing tobacco with a restricted filter will prevent any ad targeting on podcast episodes associated with tobacco. Another example, passing a global filter will apply the filter to all available sensitive topics. Both topic-level filters and global filters cannot be passed at the same time. Allowed filter levels: standard, limited, partial, restricted Allowed sensitive topic ids: alcohol, crime-violence, drugs, gambling, hate-speech, pornography, terrorism, tobacco, weapons.

      Here is an example JSON for passing in topic-level filters:


      _10
      sensitive_topic_exclusions: { topics: [ { id: "alcohol", filter_option: "RESTRICTED" } ] }

      Here is an example JSON for passing in a global filter:


      _10
      sensitive_topic_exclusions: { filter_option: "PARTIAL" }

        • idstring
          Required
        • filter_optionstring
          Required

          How restrictive the ads system should be when considering serving an ad on a particular podcast episode based on the sensitive topics associated with the episode. These filters can either be applied on a per topic basis or globally for all sensitive topics, but cannot be applied at both levels.

          Allowed values: "STANDARD", "PARTIAL", "LIMITED", "RESTRICTED"Example: "LIMITED"
      • filter_optionstring

        How restrictive the ads system should be when considering serving an ad on a particular podcast episode based on the sensitive topics associated with the episode. These filters can either be applied on a per topic basis or globally for all sensitive topics, but cannot be applied at both levels.

        Allowed values: "STANDARD", "PARTIAL", "LIMITED", "RESTRICTED"Example: "LIMITED"
    • languagestring

      ID of the language to target. If no language targeting is passed, all languages will be targeted.

      Length between 2 and 2Example: "en"
    • playlist_idsarray of strings
      Unique items

      ID(s) of the playlist(s) to target.

      Example: ["holidays","cooking"]
    • placementsarray of strings
      Unique items

      This field is REQUIRED. Indicates surfaces in the client where the ad(s) will be served.

      Example: ["PODCAST","MUSIC"]

      Placement of the ad.

      Allowed values: "MUSIC", "PODCAST"Example: "MUSIC"
    • audience_idsarray of strings

      ID(s) of audiences to target.

      A unique identifier for the entity.

      Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
    • audience_ids_exclusionsarray of strings

      ID(s) of audiences to exclude from targeting.

      A unique identifier for the entity.

      Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
  • pacingstring

    Set a pacing option to deliver your ads throughout the schedule of your ad set with standard pacing("PACING_EVEN"), or accelerated pacing("PACING_ASAP") to deliver your ads as quickly as possible.

    Allowed values: "PACING_ASAP", "PACING_EVEN"Example: "PACING_EVEN"
  • mobile_app_idstring [uuid]

    ID of the mobile app to be tied to this ad set.

    Supported content-type(s): Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
  • delivery_goalstring

    The goal of the ad set.

    Allowed values: "UNSET", "IMPRESSIONS", "REACH", "VIDEO_VIEWS", "CLICKS", "PAGE_VIEWS", "APP_INSTALLS", "STREAMS", "LEADS"
  • is_pausedboolean
    Read only

    Derived boolean field indicating if the ad set is currently paused. Returns true if either the user has manually paused the ad set (delivery: OFF) or if the ad account is greylisted/suspended, causing the ad set to be force-paused.

    Example: false
  • pause_reasonstring [int64]
    Read only

    Indicates the reason why the ad set is paused, if applicable. Only present when is_paused is true.

    Allowed values: "USER_PAUSED", "ACCOUNT_GREYLISTED", "ACCOUNT_SUSPENDED"Example: "ACCOUNT_GREYLISTED"

Response sample