Spotify Conversions Connector Setup Guide (Alpha)
This article describes how to set up the Spotify Conversions connector.
This connector is currently in Alpha and is only available to select customers. If you are interested in trying this connector, contact your Tealium Support representative. The Spotify team must allow the Client ID to access the API.
API Information
This connector uses the following vendor API:
- API Name: Spotify API
- API Version: v1.0
- API Endpoint:
https://api-partner.spotify.com/ads/v1
Connector Actions
ACTION NAME | AUDIENCESTREAM | EVENTSTREAM |
---|---|---|
Send Conversion Event | ✓ | ✓ |
How it Works
The Spotify Conversions connector captures conversion event tracking and sends this data to Spotify, helping you track and measure ad spend for your web campaigns. The Conversion API is a direct, server-to-server integration that allows you to share conversion data without the need for a pixel.
You may need to include the following information when you enable conversion tracking for your web campaigns:
- Page Views: User visits a landing page on an advertiser’s site.
- Complete Registration: User completes registration for the advertiser’s service.
- Add to Cart: User adds to cart of a product or service on the advertiser’s site.
- Check Out: User initiates checkout of a product or service on the advertiser’s site.
- Purchase: User completes a purchase of a product or service on the advertiser’s site.
- Search: User performs a search from the advertiser’s site.
- Lead: User enters into a lead status from the advertiser’s site.
- Subscribe: User signs up for the advertiser’s service, newsletter, or email communication.
Spotify recommends only using the Purchase event for the initial Alpha.
The Spotify Conversion API supports only email address as a matching identifier. Tealium provides the ability to apply SHA256 hashing, or you can map an already-hashed value to be used in the API.
Configure Settings
Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.
After adding the connector, configure the following settings:
- Conversion Tracker ID: Required.
- A Conversion Tracker ID is required for all event requests to the Spotify Conversions API. It is a unique ID used to attribute events to a specific advertiser’s campaigns.
- Click Create Tracker ID to create an ID.
- Advertiser Name: Required. The advertiser name.
- Description: Required. A description of the type of events associated with the Tracker ID.
Before partners can begin using the Conversions API, they must reach out to Spotify to link their Conversion Tracker ID to an advertiser/ad account.
Click Done when you are finished configuring the connector.
Action Settings — Parameters and Options
Click Continue to configure the connector actions. Enter a name for the action and then select the action type from the drop-down menu.
The following section describes how to set up parameters and options for each action.
Action — Send Conversion Event
During the connector’s Alpha release, Spotify recommends that you only use the Purchase event.
Parameters
PARAMETER | DESCRIPTION |
---|---|
Event Name | Describes the conversion event. |
Event ID | (Required) The event ID. |
Event Time | The timestamp in RFC 3339 format. Indicates when the actual event occurred. The timestamp provided should represent a time in the past. For example, 2022-12-25T15:30:50Z . If no timestamp is provided, the connector will use the current timestamp. |
Event Source URL | The browser URL where the event happened. The URL should begin with http:// or https:// and match the verified domain. |
Amount | Monetary value. Required for Purchase event. |
Currency | Valid currency code as per ISO - 4217. Required for Purchase events. |
Content Name | Product name or page name. |
Content Category The category of the content associated with the event. Content category must correspond to Google’s Product Taxonomy. | |
Action Source | Part of an event. Must be one of the following:
|
Email Address (already SHA256 hashed) | Provide an email address (must include an @ ) that has already been SHA256 hashed. |
Email Address (apply SHA256 hash) | Provide a plain text email address and the connector will whitespace trim, lowercase, and hash this value using the SHA256 hash. If the user has more than one email address, list the email addresses as an array. |
IP Address | The IP address sending the event. |
Phone Number | The user phone number. |
Opt Out Targeting | A flag indicating that this event should not be used for retargeting. If set to true , use the event for attribution only. |
This page was last updated: May 16, 2023