Introduction

Datasources and destinations

Fields listing for Spotify Ads

Campaign Id
Id of a Campaign.
Field IDcampaign/id
TypeTEXT
Data Typedimension
Campaign name
Campaign name that will be displayed to the user
Field IDcampaign/name
TypeTEXT
Data Typedimension
Campaign Purchase Order
A purchase order number, to be shown on your invoice, for your own personal organization.
Field IDcampaign/purchase_order
TypeTEXT
Data Typedimension
Campaign Objective
Objective for a campaign. UNSET should not be used.
Field IDcampaign/objective
TypeTEXT
Data Typedimension
Campaign Status
Allowed values:'UNSET', 'ACTIVE', 'PAUSED', 'ARCHIVED', 'UNRECOGNIZED'
Field IDcampaign/status
TypeTEXT
Data Typedimension
Campaign Created At
Date the Campaign was created.
Field IDcampaign/created_on
TypeYEAR_MONTH_DAY
Data Typedimension
Campaign Updated At
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
Field IDcampaign/updated_at
TypeYEAR_MONTH_DAY
Data Typedimension
Year
Year such as 2017.
Field ID_NORMALIZED_DATE_FIELD_YEAR
TypeYEAR
Data Typedimension
Year Quarter
Year and quarter.
Field ID_NORMALIZED_DATE_FIELD_YEAR_QUARTER
TypeYEAR_QUARTER
Data Typedimension
Year month
Year and month.
Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH
TypeYEAR_MONTH
Data Typedimension
Year week
Year and week.
Field ID_NORMALIZED_DATE_FIELD_YEAR_WEEK
TypeYEAR_WEEK
Data Typedimension
Date
Year, month, and day.
Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH_DAY
TypeYEAR_MONTH_DAY
Data Typedimension
Year month day hour
Year, month, day, and hour.
Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH_DAY_HOUR
TypeYEAR_MONTH_DAY_HOUR
Data Typedimension
Quarter of the year
Quarter of the year
Field ID_NORMALIZED_DATE_FIELD_QUARTER
TypeQUARTER
Data Typedimension
Month of the year
Month of the year
Field ID_NORMALIZED_DATE_FIELD_MONTH
TypeMONTH
Data Typedimension
Week of the year
Week of the year
Field ID_NORMALIZED_DATE_FIELD_WEEK
TypeWEEK
Data Typedimension
Month and day
Month and day
Field ID_NORMALIZED_DATE_FIELD_MONTH_DAY
TypeMONTH_DAY
Data Typedimension
Day of the week
Week of the year
Field ID_NORMALIZED_DATE_FIELD_DAY_OF_WEEK
TypeDAY_OF_WEEK
Data Typedimension
Day of the month
Day of the year
Field ID_NORMALIZED_DATE_FIELD_DAY
TypeDAY
Data Typedimension
Hour of the day
Hour of the day
Field ID_NORMALIZED_DATE_FIELD_HOUR
TypeHOUR
Data Typedimension
Ad Set Id
Id of an Ad Set.
Field IDad_set/id
TypeTEXT
Data Typedimension
Ad Set Created At
Date the Ad Set was created.
Field IDad_set/created_at
TypeYEAR_MONTH_DAY
Data Typedimension
Ad Set Start Date
Date the ad set will start on.
Field IDad_set/start_date
TypeYEAR_MONTH_DAY
Data Typedimension
Ad Set End Date
Date the ad set will end on.
Field IDad_set/end_date
TypeYEAR_MONTH_DAY
Data Typedimension
Ad Set Budget Amount
Total budget for the ad set
Field IDad_set/budget_micro_amount
TypeNUMBER
Data Typedimension
Ad Set Budget Type
Allowed values: "DAILY", "LIFETIME"
Field IDad_set/budget_type
TypeTEXT
Data Typedimension
Ad Set Budget Currency
Currency of the budget
Field IDad_set/budget_currency
TypeTEXT
Data Typedimension
Ad Set name
Ad Set name that will be displayed to the user
Field IDad_set/name
TypeTEXT
Data Typedimension
Ad Set Status
Allowed values:'ACTIVE', 'APPROVED', 'ARCHIVED', 'COMPLETED', 'PENDING_APPROVAL', 'READY', 'REJECTED'
Field IDad_set/status
TypeTEXT
Data Typedimension
Ad Set Active Status
Allowed values:'ACTIVE', 'PAUSED', 'ARCHIVED'
Field IDad_set/active_status
TypeTEXT
Data Typedimension
Ad Set Cost Model
Allowed values:'CPCL', 'CPM', 'CPC', 'UNSET'
Field IDad_set/cost_model
TypeTEXT
Data Typedimension
Ad Set Artist Promotion Name
The artist promotion name of Ad Set
Field IDad_set/artist_promotion_name
TypeTEXT
Data Typedimension
Ad Set Artist Promotion Goal
The artist promotion goal of Ad Set
Field IDad_set/artist_promotion_goal
TypeTEXT
Data Typedimension
Ad Set Artist Promotion Target Type
The artist promotion target type of Ad Set
Field IDad_set/artist_promotion_target_type
TypeTEXT
Data Typedimension
Ad Set Artist Promotion Target Id
The artist promotion target id of Ad Set
Field IDad_set/artist_promotion_target_id
TypeTEXT
Data Typedimension
Ad Set Artist Promotion Conversion Tracking Event Type
The artist promotion conversion tracking event type of Ad Set
Field IDad_set/artist_promotion_conversion_event_tracking_event_type
TypeTEXT
Data Typedimension
Ad Set Artist Promotion Conversion Event Window Duration
The artist promotion target id of Ad Set
Field IDad_set/artist_promotion_conversion_event_window_duration_ms
TypeTEXT
Data Typedimension
Ad Set Reject Reason
The Ad Set reject reason.
Field IDad_set/reject_reason
TypeTEXT
Data Typedimension
Ad Set Serving Issues
The Ad Set serving issues.
Field IDad_set/serving_issues
TypeTEXT
Data Typedimension
Ad Set Bid Optimization Goal
Allowed values:'UNSET', 'AD_COMPLETES', 'CLICKS', 'EVEN_IMPRESSION_DELIVERY', 'REACH'
Field IDad_set/bid_optimization_goal
TypeTEXT
Data Typedimension
Ad Set Bid Strategy
Allowed values:'UNSET', 'MAX_BID'
Field IDad_set/bid_strategy
TypeTEXT
Data Typedimension
Ad Set Bid Amount
The ad set bid amount.
Field IDad_set/bid_micro_amount
TypeNUMBER
Data Typedimension
Ad Set Version
When an Ad Set is created or updated, it is assigned a new version.
Field IDad_set/version
TypeNUMBER
Data Typedimension
Ad Id
Id of an Ad.
Field IDad/id
TypeTEXT
Data Typedimension
Ad Created At
Date the Ad was created.
Field IDad/created
TypeYEAR_MONTH_DAY
Data Typedimension
Ad Landing Page Domain
URL the campaign will direct to
Field IDad/landing_page_domain
TypeTEXT
Data Typedimension
Ad Clickthrough Url
The link to the ads desired landing page activated by a button labelled CTA below and also the cover art image.
Field IDad/clickthrough_url
TypeTEXT
Data Typedimension
Ad name
Name given to identify your ad.
Field IDad/name
TypeTEXT
Data Typedimension
Ad Status
Allowed values: "ACTIVE", "PENDING", "PENDING_USER_APPROVAL", "PENDING_ADMIN_APPROVAL", "APPROVED", "REJECTED", "ARCHIVED", "UNRECOGNIZED"
Field IDad/status
TypeTEXT
Data Typedimension
Ad Reject Reason
Ad reject reason
Field IDad/reject_reason
TypeTEXT
Data Typedimension
Ad brand name
Brand name of the Ad.
Field IDad/brand_name
TypeTEXT
Data Typedimension
Ad Tagline
Tagline of the Ad.
Field IDad/tagline
TypeTEXT
Data Typedimension
Ad version
Version of the Ad.
Field IDad/version
TypeNUMBER
Data Typedimension
Ad Asset Id
The ID provided back when an upload url is requested. Note this does not mean it's processed successfully; you will need to check the status for that.
Field IDad/asset_asset_id
TypeTEXT
Data Typedimension
Ad Companion Asset Id
The ID provided back when an companion image upload url is requested. Note this does not mean its Processed successfully, you will need to check the status for that* bbbv , cv.
Field IDad/asset_companion_asset_id
TypeTEXT
Data Typedimension
Ad Asset Logo Id
A unique identifier for an IMAGE asset.
Field IDad/asset_logo_asset_id
TypeTEXT
Data Typedimension
Ad Asset Canvas Id
A unique identifier for an IMAGE or VIDEO asset with 9:16 aspect ratio.
Field IDad/asset_canvas_asset_id
TypeTEXT
Data Typedimension
Image Asset Id
Id of an image asset.
Field IDimage_asset/id
TypeTEXT
Data Typedimension
Image Asset Name
Name of an image asset.
Field IDimage_asset/name
TypeTEXT
Data Typedimension
Image Asset Type
Image Asset Type.
Field IDimage_asset/assetType
TypeTEXT
Data Typedimension
Image Asset Status
Status of an image asset. it can be READY, PROCESSING, WAITING_UPLOAD, PENDING_APPROVAL or ERROR.
Field IDimage_asset/status
TypeTEXT
Data Typedimension
Image Asset URL
URL of an image asset.
Field IDimage_asset/url
TypeTEXT
Data Typedimension
Image Asset Created At
Date the Image Asset was created.
Field IDimage_asset/created_at
TypeYEAR_MONTH_DAY
Data Typedimension
Image Asset Updated At
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
Field IDimage_asset/updated_at
TypeYEAR_MONTH_DAY
Data Typedimension
Image Asset Image Type
The type of image asset. Allowed values: "COMPANION", "LOGO", "USER_UPLOADED_IMAGE"Example: "COMPANION"
Field IDimage_asset/image_type
TypeTEXT
Data Typedimension
Image Asset File Type
The file type of the image asset as defined by the 'file type' specification of the ISO base media file format standard. Allowed values: "JPEG", "PNG"
Field IDimage_asset/file_type
TypeTEXT
Data Typedimension
Image Asset Aspect Ratio
The aspect ratio of the asset with double precision. Example: 0.5625
Field IDimage_asset/aspect_ratio
TypeNUMBER
Data Typedimension
Image Asset Width
Width of an image asset.
Field IDimage_asset/width
TypeNUMBER
Data Typedimension
Image Asset Height
Height of an image asset.
Field IDimage_asset/height
TypeNUMBER
Data Typedimension
Audio Asset Id
Id of an Audio Asset.
Field IDaudio_asset/id
TypeTEXT
Data Typedimension
Audio Asset Name
Name of an Audio Asset.
Field IDaudio_asset/name
TypeTEXT
Data Typedimension
Audio Asset Type
Audio Asset Type.
Field IDaudio_asset/assetType
TypeTEXT
Data Typedimension
Audio Asset Status
The current status of an asset throughout lifecycle processes. Allowed values: "ERROR", "PROCESSING", "READY", "WAITING_UPLOAD" Example: "READY"
Field IDaudio_asset/status
TypeTEXT
Data Typedimension
Audio Asset URL
URL of asset. Will be either Google Cloud Storage URL or CDN URL depending on the asset type and the transcoding completion status.
Field IDaudio_asset/url
TypeTEXT
Data Typedimension
Audio Asset Audio Type
The type of audio asset. Allowed values: "BACKGROUND_MUSIC", "STOCK_BACKGROUND_MUSIC", "USER_UPLOADED_AUDIO Example: "USER_UPLOADED_AUDIO"
Field IDaudio_asset/audio_type
TypeTEXT
Data Typedimension
Audio Asset File Type
The file type of the audio asset as defined by the 'file type' specification of the ISO base media file format standard. Allowed values: "MP3", "OGG", "WAV"
Field IDaudio_asset/file_type
TypeTEXT
Data Typedimension
Audio Asset Duration
The duration of the asset. This value is populated as part of asset processing, and will be null until the asset is in ready state
Field IDaudio_asset/duration_ms
TypeNUMBER
Data Typedimension
Audio Asset Created At
Date the Audio Asset was created.
Field IDaudio_asset/created_at
TypeYEAR_MONTH_DAY
Data Typedimension
Audio Asset Updated At
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
Field IDaudio_asset/updated_at
TypeYEAR_MONTH_DAY
Data Typedimension
Video Asset Id
Id of a Video Asset.
Field IDvideo_asset/id
TypeTEXT
Data Typedimension
Video Asset Name
Name of a Video Asset.
Field IDvideo_asset/name
TypeTEXT
Data Typedimension
Video Asset Type
Video Asset Type.
Field IDvideo_asset/assetType
TypeTEXT
Data Typedimension
Video Asset Status
Status of a Video Asset. It can be READY, PROCESSING, WAITING_UPLOAD, PENDING_APPROVAL, REJECTED or ERROR.
Field IDvideo_asset/status
TypeTEXT
Data Typedimension
Video Asset URL
URL of a Video Asset.
Field IDvideo_asset/url
TypeTEXT
Data Typedimension
Video Asset Created At
Date the Video Asset was created.
Field IDvideo_asset/created_at
TypeYEAR_MONTH_DAY
Data Typedimension
Video Asset Updated At
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
Field IDvideo_asset/updated_at
TypeYEAR_MONTH_DAY
Data Typedimension
Video Asset Duration
Duration of a Video Asset in seconde.
Field IDvideo_asset/duration_ms
TypeNUMBER
Data Typedimension
Video Asset Aspect Ratio
The aspect ratio of the asset with double precision. Example: 0.5625
Field IDvideo_asset/aspect_ratio
TypeNUMBER
Data Typedimension
Video Asset Width
Width of a video asset.
Field IDvideo_asset/width
TypeNUMBER
Data Typedimension
Video Asset Height
Height of a video asset.
Field IDvideo_asset/height
TypeNUMBER
Data Typedimension
Video Asset File Type
The file type of the video asset as defined by the 'file type' specification of the ISO base media file format standard. Allowed values: "MP4", "QUICKTIME"
Field IDvideo_asset/file_type
TypeTEXT
Data Typedimension
Video Asset Has Audio
The file type of the video asset as defined by the 'file type' specification of the ISO base media file format standard. Allowed values: "MP4", "QUICKTIME"
Field IDvideo_asset/has_audio
TypeBOOLEAN
Data Typedimension
Video Asset Thumbnail URL
URL of thumbnail image of the video asset. Example: "https://adstudio-video-preview-image.spotifycdn.com/123-preview"
Field IDvideo_asset/thumbnail_url
TypeTEXT
Data Typedimension
Clicks
The number of impressions in which your ad was clicked (#)
Field IDCLICKS
TypeNUMBER
Data Typemetric
Completes
The number of ads served that was played to the end (#)
Field IDCOMPLETES
TypeNUMBER
Data Typemetric
CTR
The percentage of ads that were clicked (%)
Field IDCTR
TypeNUMBER
Data Typemetric
ECPM
The average cost per 1,000 impressions
Field IDECPM
TypeNUMBER
Data Typemetric
ECPL
The average cost per 1,000 completed listens - NOTE: Applies to active audio/CPCL campaigns only
Field IDECPCL
TypeNUMBER
Data Typemetric
First Quartiles
The percentage of users who listened or viewed a given percentage of the ad (%)
Field IDFIRST_QUARTILES
TypeNUMBER
Data Typemetric
Frequency
The average number of times each person heard or viewed your ad (#)
Field IDFREQUENCY
TypeNUMBER
Data Typemetric
Impressions
The number of times an ad has been successfully served (#) -- NOTE: The API reports on exact impressions, whereas the UI only reports impressions delivered within budgets
Field IDIMPRESSIONS
TypeNUMBER
Data Typemetric
Midpoints
The number of users for which the ad played to the midpoint of the ads total length (#)
Field IDMIDPOINTS
TypeNUMBER
Data Typemetric
Off Spotify Impressions
The number of ads served off of Spotify (#)
Field IDOFF_SPOTIFY_IMPRESSIONS
TypeNUMBER
Data Typemetric
Paid Listens
The number of listens for a CPCL campaign where a user did NOT skip the ad -- NOTE: Applies to active audio/CPCL campaigns only
Field IDPAID_LISTENS
TypeNUMBER
Data Typemetric
Paid Listens Frequency
The average frequency for listens on a CPCL campaign -- NOTE: Applies to CPCL campaigns only
Field IDPAID_LISTENS_FREQUENCY
TypeNUMBER
Data Typemetric
Paid Listens Reach
The number of unique users who had a paid listen for this CPCL campaign -- NOTE: Applies to active audio/CPCL campaigns only
Field IDPAID_LISTENS_REACH
TypeNUMBER
Data Typemetric
Third Quartiles
The percentage of users who listened or viewed a given percentage of the ad (%)
Field IDTHIRD_QUARTILES
TypeNUMBER
Data Typemetric
Reach
The number of unique users who received your ad (#)
Field IDREACH
TypeNUMBER
Data Typemetric
Spend
The total amount spent in this campaign, represented in micros -- i.e., multiplied by 10 to the power of 6 (#)
Field IDSPEND
TypeNUMBER
Data Typemetric
Starts
The number of times a user starts hearing/viewing your ad (#)
Field IDSTARTS
TypeNUMBER
Data Typemetric
Skips
The number of times a user skips an ad -- NOTE: Skippable ads are currently supported in AU only (#)
Field IDSKIPS
TypeNUMBER
Data Typemetric
Week of the year (start Sunday)
Week of the year
Field ID_NORMALIZED_DATE_FIELD_WEEK_START_SUNDAY
TypeWEEK
Data Typedimension
Conversion Rate
The percentage of users who listened to the artist for the first time in at least a month after seeing or hearing the ad (%)
Field IDCONVERSION_RATE
TypeNUMBER
Data Typemetric
Intent Rate
The percentage of users who listened to the artist for the first time in at least a month after seeing or hearing the ad (%)
Field IDINTENT_RATE
TypeNUMBER
Data Typemetric
New Listeners
The number of times a user skips an ad -- NOTE: Skippable ads are currently supported in AU only (#)
Field IDNEW_LISTENERS
TypeNUMBER
Data Typemetric
New Listener Streams
The percentage of users who listened to the artist for the first time in at least a month after seeing or hearing the ad (%)
Field IDNEW_LISTENER_STREAMS
TypeNUMBER
Data Typemetric
New Listeners Conversion Rate
The percentage of users who listened to the artist for the first time in at least a month after seeing or hearing the ad (%)
Field IDNEW_LISTENER_CONVERSION_RATE
TypeNUMBER
Data Typemetric
Streams
The total number of streams from listeners who saw/heard the ad (#)
Field IDSTREAMS
TypeNUMBER
Data Typemetric
Streams per Listener
The average number of times each listener streamed the artist after seeing/hearing the ad (#)
Field IDSTREAMS_PER_USER
TypeNUMBER
Data Typemetric
Streams per New Listener
The average number of times each new listener streamed the artist after seeing/hearing the ad (#)
Field IDSTREAMS_PER_NEW_LISTENER
TypeNUMBER
Data Typemetric
Unique Listeners
The number of users who listened to the artist after hearing/seeing an ad (#)
Field IDLISTENERS
TypeNUMBER
Data Typemetric
Extracted Date
The date where the extraction take times.
Field ID_catchr_date_extract
TypeYEAR_MONTH_DAY_SECOND
Data Typedimension
Platform Name
Return the platform name
Field ID_catchr_platform_name
TypeTEXT
Data Typedimension