Spotify Ads API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "spotify_ads",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"destination_configuration": {
"virtual_warehouse": "virtual_warehouse"
},
"config": {
"sync_mode": "ALL_ACCOUNTS | SPECIFIC_ACCOUNTS",
"report_list": [
{
"granularity": "HOUR | DAY",
"fields": [
"CTR | SKIPS | VIDEO_VIEWS | COMPLETES | STREAMS_PER_USER | E_CPCL | SPEND | THIRD_QUARTILES | CLICKS | NEW_LISTENER_CONVERSION_RATE | FREQUENCY | OFF_SPOTIFY_IMPRESSIONS | VIDEO_EXPAND_RATE | NEW_LISTENERS | PAID_LISTENS | IMPRESSIONS | CONVERSION_RATE | FIRST_QUARTILES | STREAMED_IMPRESSIONS | PAID_LISTENS_FREQUENCY | STREAMS_PER_NEW_LISTENER | PAID_LISTENS_REACH | LISTENERS | REACH | STARTS | NEW_LISTENER_STREAMS | STREAMS | VIDEO_EXPANDS | INTENT_RATE | MIDPOINTS | E_CPM"
],
"dimension": "AD_ACCOUNT | AD | AD_SET | CAMPAIGN",
"table": "table_2"
}
],
"timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE",
"accounts": [
"string"
],
"schema": "schema_name"
},
"auth": {
"refresh_token": "my_refresh_token",
"client_access": {
"client_secret": "my_client_secret",
"client_id": "my_client_id"
}
}
}Config parameters
| Name | Description |
|---|---|
sync_mode | Whether to sync all ad accounts or specific ad accounts. |
report_list | The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. |
report_list[0].granularity | The report granularity. |
report_list[0].fields | A list of the fields (metrics) to sync. |
report_list[0].dimension | The dimension (entity_type) to sync. |
report_list[0].table | The table name within the schema to which connector will sync the data of the specific report. |
timeframe_months | The number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: SIX. |
accounts | The list of Ad Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS. |
schema (required) | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.POST https://api.fivetran.com/v1/connections{ "service": "spotify_ads", "group_id": "group_id", "auth": { "client_access": { "client_secret": "my_client_secret", "client_id": "my_client_id" }, "refresh_token": "my_refresh_token" } }Auth Parameters
Name Description refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.client_accessclient_access.client_secretClient Secretof your Ad Studio application.client_access.client_idClient IDof your Ad Studio application. By using the Connect Card or the Fivetran dashboard.