Ads APIReferences / pricing / Get pricing for a reserved ad product.

Get pricing for a reserved ad product.

Get pricing for a reserved ad product (fCPM). Supported ad products: CONTENT (Reserved Podcasts), FPMNG (Reserved Music).

Request

  • ad_account_idstring [uuid]
    Required

    A unique identifier for an Ad Account.

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

    Ad product for reserved buying. CONTENT: Reserved Podcasts. FPMNG: Reserved Music.

    Allowed values: "CONTENT", "FPMNG"Example: "CONTENT"
  • start_datestring [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_datestring [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"
  • 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"
    • Unique items

      Day parting targeting for the spotify user's time zone.

      Day parting targeting for the ad set.

      • day_of_weekarray of strings

        List of days of the week to target.

        Allowed values: "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
      • List of hour ranges (0-23) to target.

        • mininteger [int32]

          Start of the hour range (0-23, inclusive). Hour values represent the start of each 1-hour slot; for example, 9 means 9:00 AM.

          Range: 0 - 23
        • maxinteger [int32]

          End of the hour range (0-23, inclusive). The end hour slot is fully included; for example, a max of 9 means targeting runs through the 9:00–10:00 AM slot, ending at 10:00 AM.

          Range: 0 - 23
  • asset_formatstring

    Format of the asset.

    Allowed values: "AUDIO", "VIDEO", "IMAGE", "CATALOG"Example: "AUDIO"

Response

Price response.

  • cost_microinteger [int64]

    Total cost multiplied by x10 to the 6th power. Ex: cost of $250, would be a cost_micro of 250000000.

    Example: 250000000
  • currencystring

    The currency of the cost.

    Example: "USD"

Response sample

{  "cost_micro": 250000000,  "currency": "USD"}