Spotify Conversions API
This destination is currently under final review and will be available soon.
Spotify is music streaming service provider. Using this destination you can leverage Spotify Conversions API as tagless attribution tool that allows you to pass online and offline conversion events to Spotify. The Conversions API is designed to provide comprehensive, high-fidelity attribution to help you understand the performance of your campaigns on Spotify.
Key features
The Spotify Conversions API destination provides the following key features:
Events structure: our Events reference model covers Spotify's events, meaning that your data is properly bridged to the expected fields in an optimized way.
Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Event mapping: change standard mapping between Spotify events and yours.
Support batch mode: send multiple events in one single request.
Destination setup
Configuration
Access Token
Required
Your access token. Generate your token in Spotify Ads Manager, by going to Events → Connect Data Source → Conversions API → Generate Token .
Connection Id
Required
The connection identifier is a unique key assigned to your organization that allows you to access CAPI when used with the access token. Get your identifier in Spotify Ads Manager, by going to Events → Connect Data Source → Conversions API . When you submit the form, the Spotify UI will show the newly created connection identifier (a UUID).
Event Mapping
Change the standard mapping between Spotify events and yours. Accepted values for Spotify event name : VIEW, PRODUCT, CHECK_OUT, ADD_TO_CART, PURCHASE, LEAD, SIGN_UP, CUSTOM_EVENT_1, CUSTOM_EVENT_2, CUSTOM_EVENT_3, CUSTOM_EVENT_4 and CUSTOM_EVENT_5.
Quick reference
add_to_cart
ADD_TO_CART
begin_checkout
CHECK_OUT
generate_lead
LEAD
page_view
VIEW
purchase
PURCHASE
sign_up
SIGN_UP
view_item
Details
[Any Event]
[Any Supported Event] [1]
1. See Event Mapping in Configuration for more details on Spotify supported events.
Field mappings
Properties can be remapped using our Smart Mapping feature.
At least one of the following "Smart Mapping" fields is required:
• Device IP
• Device Mobile Identifier
• User Email
• User Phone
-
Connection Id
capi_connection_id [*][1]
-
Event Mapping
event_name
event_name [*][2][3]
Event Id
context.event_id
event_id [*][2][4]
Event Timestamp
context.event_timestamp
event_time [*][2][5]
Page URL
context.page.url
event_source_url [2]
Device IP
context.device.ip
ip_address [6]
Device Mobile Identifier
context.device.advertising_id
device_id [6]
User Email
user.email
hashed_emails.0 [6]
User Phone
user.phone
hashed_phone_number [6]
Ccurrency
currency
currency [7]
Value
value
amount [7]
Content Category
partners.spotify.content_name
content_category [7]
Content Name
partners.spotify.content_name
content_name [7]
Action Source
type
action_source [2][8]
Opt-out Targeting
partners.spotify.optout_targeting
opt_out_targeting [2][9]
* Mandatory property.
1. See Connection Id in Configuration. Set in conversion_events .
2. Set in conversion_events.evennts.X .
3. See Quick reference for the standard mapping, and Event Mapping in Configuration to change the mapping or add new ones.
4. Default: context.event_id .
5. Default: event timestamp.
6. Set in conversion_events.events.X.user_data .
7. Set in conversion_events.events.X.event_details .
8. Default:
• set to WEB if type is online ,
• set to APP if type is app or mobile_app
• set to OFFLINE if type is offline
• set to WEB if none of the above applies.
9. Accepted values: true or false (boolean)
Last updated
Was this helpful?