Skip to content
Documentation
Documentation
Products
Web API
Web Playback SDK
Ads API
iOS
Android
Embeds
Commercial Hardware
Open Access
Guidelines
Design
Accessibility
Legal
Community
0
Documentation
Documentation
Products
Web API
Web Playback SDK
Ads API
iOS
Android
Embeds
Commercial Hardware
Open Access
Guidelines
Design
Accessibility
Legal
Community
Ads API
Introduction
Introduction
Introduction
About
Next Steps
Support
Subscribe to Newsletter
API Design
Rate Limiting
Breaking v. Non-Breaking Changes Policy
Versioning
Time format
Pagination
Release Notes
Quickstart
Quickstart
Quickstart
Account Prerequisites
Initialize your new Ads API application
Authenticate your Ad Studio account
Using the refresh token
Guides
Guides
Guides
Object hierarchy
Ad Accounts
Campaigns
Ad Sets
Ads
Assets
Campaign Management
Overview
Eligibility Criteria
Differences from the UI
Build a Campaign
Reporting
Overview
Eligibility Criteria
Differences from the UI (Reporting)
Metrics Glossary
Campaign Performance Metrics
Streaming Conversion Metrics
Pixel Metrics
App Conversion Metrics
Reference
General info
ad-accounts
ad-accounts
ad-accounts
Get Ad Account by ID
Update Ad Account
Get Ad Accounts for Current User by Business ID
Create Ad Account
ad-categories
ad-categories
ad-categories
Get Ad Categories
ad-sets
ad-sets
ad-sets
Get Ad Set by ID
Update Ad Set
Get Ad Sets by Ad Account ID
Create an Ad Set
ads
ads
ads
Get Ads by Ad Account ID
Create an Ad
Get Ad by ID
Update an Ad
assets
assets
assets
Get Assets by Ad Account
Create Asset
Get Asset by ID
Update Asset
Upload Asset
Start Upload Chunked Asset
Transfer Chunked Asset
Complete Upload Chunked Asset
audiences
audiences
audiences
List Audiences accessible to an Ad Account
Create an Audience
Get an Audience
Delete an Audience
Edit an Audience
Get Signed GCS upload URL to upload a user list file
Get Signed GCS upload URL to upload a user list file for an existing audience
List Datasets eligible for creating Custom Audiences
businesses
businesses
businesses
Get Businesses for Current User
Create Business
Get Business by ID
Update Business
campaigns
campaigns
campaigns
Get Campaigns by Ad Account ID
Create a Campaign
Get Campaign by ID
Update a Campaign
capi-measurement
capi-measurement
capi-measurement
Get CAPI Integrations for Business
Create CAPI Integration
Get CAPI Integration
Update CAPI Integration
Get CAPI Auth Token(s)
Create CAPI Auth Token
Delete CAPI Auth Token
estimates
estimates
estimates
Estimate audience
Estimate bid
measurement-datasets
measurement-datasets
measurement-datasets
Get Datasets for Business
Create Dataset
Get Dataset
Update Dataset
Remove Integration From Dataset
Get Datasets for Ad Account
Get diagnostics for a dataset.
Share A Dataset With An Ad Account
Unshare A Dataset With An Ad Account
mobile-measurement
mobile-measurement
mobile-measurement
Get all mobile apps for a business
Create mobile app
Get the mobile app by its id.
Update the specified mobile app.
Get all mobile apps for an ad account
Share A Mobile App With An Ad Account
Unshare A Mobile App With An Ad Account
partnerships
partnerships
partnerships
Get partnerships for a business
pixel-measurement
pixel-measurement
pixel-measurement
Get all pixels for a business account
Create pixel
Get pixel by id for a given business.
Update pixel
podcast-shows
podcast-shows
podcast-shows
Get Podcast Shows
reports
reports
reports
Get Aggregate Report by Ad Account ID
Get Insight Report by Ad Account ID
Create a CSV Report Asynchronously
Get CSV Report Status by ID
targets
targets
targets
Get Artist Targets
Get Genre Targets
Get Geo Targets
Get Interest Targets
Get Language Targets
Get Playlist Targets
Get Podcast Episode Topic Targets
Get Sensitive Topic Targets
Ads API
Introduction
Introduction
Introduction
About
Next Steps
Support
Subscribe to Newsletter
API Design
Rate Limiting
Breaking v. Non-Breaking Changes Policy
Versioning
Time format
Pagination
Release Notes
Quickstart
Quickstart
Quickstart
Account Prerequisites
Initialize your new Ads API application
Authenticate your Ad Studio account
Using the refresh token
Guides
Guides
Guides
Object hierarchy
Ad Accounts
Campaigns
Ad Sets
Ads
Assets
Campaign Management
Overview
Eligibility Criteria
Differences from the UI
Build a Campaign
Reporting
Overview
Eligibility Criteria
Differences from the UI (Reporting)
Metrics Glossary
Campaign Performance Metrics
Streaming Conversion Metrics
Pixel Metrics
App Conversion Metrics
Reference
General info
ad-accounts
ad-accounts
ad-accounts
Get Ad Account by ID
Update Ad Account
Get Ad Accounts for Current User by Business ID
Create Ad Account
ad-categories
ad-categories
ad-categories
Get Ad Categories
ad-sets
ad-sets
ad-sets
Get Ad Set by ID
Update Ad Set
Get Ad Sets by Ad Account ID
Create an Ad Set
ads
ads
ads
Get Ads by Ad Account ID
Create an Ad
Get Ad by ID
Update an Ad
assets
assets
assets
Get Assets by Ad Account
Create Asset
Get Asset by ID
Update Asset
Upload Asset
Start Upload Chunked Asset
Transfer Chunked Asset
Complete Upload Chunked Asset
audiences
audiences
audiences
List Audiences accessible to an Ad Account
Create an Audience
Get an Audience
Delete an Audience
Edit an Audience
Get Signed GCS upload URL to upload a user list file
Get Signed GCS upload URL to upload a user list file for an existing audience
List Datasets eligible for creating Custom Audiences
businesses
businesses
businesses
Get Businesses for Current User
Create Business
Get Business by ID
Update Business
campaigns
campaigns
campaigns
Get Campaigns by Ad Account ID
Create a Campaign
Get Campaign by ID
Update a Campaign
capi-measurement
capi-measurement
capi-measurement
Get CAPI Integrations for Business
Create CAPI Integration
Get CAPI Integration
Update CAPI Integration
Get CAPI Auth Token(s)
Create CAPI Auth Token
Delete CAPI Auth Token
estimates
estimates
estimates
Estimate audience
Estimate bid
measurement-datasets
measurement-datasets
measurement-datasets
Get Datasets for Business
Create Dataset
Get Dataset
Update Dataset
Remove Integration From Dataset
Get Datasets for Ad Account
Get diagnostics for a dataset.
Share A Dataset With An Ad Account
Unshare A Dataset With An Ad Account
mobile-measurement
mobile-measurement
mobile-measurement
Get all mobile apps for a business
Create mobile app
Get the mobile app by its id.
Update the specified mobile app.
Get all mobile apps for an ad account
Share A Mobile App With An Ad Account
Unshare A Mobile App With An Ad Account
partnerships
partnerships
partnerships
Get partnerships for a business
pixel-measurement
pixel-measurement
pixel-measurement
Get all pixels for a business account
Create pixel
Get pixel by id for a given business.
Update pixel
podcast-shows
podcast-shows
podcast-shows
Get Podcast Shows
reports
reports
reports
Get Aggregate Report by Ad Account ID
Get Insight Report by Ad Account ID
Create a CSV Report Asynchronously
Get CSV Report Status by ID
targets
targets
targets
Get Artist Targets
Get Genre Targets
Get Geo Targets
Get Interest Targets
Get Language Targets
Get Playlist Targets
Get Podcast Episode Topic Targets
Get Sensitive Topic Targets
Ads API •
References / info
Ads API v3.0
Servers
Production server.
https://api-partner.spotify.com/ads/v3
Sandbox server for user testing.
https://api-partner.spotify.com/ads-sandbox/v3