Set up Pinterest
Pinterest is an ad network integrated with Adjust. Our integration lets Pinterest receive attribution and in-app event data through automated callbacks.
In this article, learn how to set up measurement with Pinterest for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with Pinterest.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to Pinterest parameters. Follow the guides linked below to use this feature.
iOS | Android | Windows | Unity | React Native | Flutter | Adobe Air | Cordova | Marmalade | Xamarin | Cocos2d-x | Titanium | Corona
Credentials
TAG ID (required for events), Pinterest Account ID, and Pinterest Authentication Token
- For help finding your credentials, contact your Pinterest representative.
In your Pinterest dashboard:
Click and Impression URLs should be added within the Ad Tracking URLs section.
Select Pinterest and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > Pinterest. Select Next to move to the next screen.
- In the App selection screen, choose the app for which you want to create the link, and enable the integration to share data with Pinterest.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with Pinterest. To enable data sharing:
- Enter your TAG ID (required for events), Pinterest Account ID, and Pinterest Authentication Token.
Once you enable data sharing with Pinterest, Adjust automatically sends Pinterest the following data, by default:
- event
Set your data sharing options
If you’re working with a multi-platform app with data sharing enabled for multiple platforms, you can:
- Separate data sharing options at the platform-level by selecting Use platform-specific settings.
- Set the same data sharing settings for multiple platforms by selecting Use global settings.
Now, under What will be shared by default?, review the activities that Adjust shares with Pinterest by default.
- event
Send additional data
Choose the amount and type of data that you want to share with Pinterest through callbacks. Pinterest may use this information to optimize performance.
- Under What sources of data do you want to share?, choose the attribution source of the data you are sharing with Pinterest:
- Data from all attribution sources
- Only data attributed to Pinterest
In-app revenue (from in-app purchases)
Sharing in-app revenue lets Pinterest receive revenue amounts along with your revenue event data. You need to map events that generate revenue to share this data.
Map events
Map events that you want to share to the values that Pinterest can receive. Data for unmapped events is not shared with Pinterest.
Map individual events
If you have a multi-platform app, you can choose to share different events per platform with Pinterest. This lets you:
- Set individual events to manage campaign strategies for each platform.
- Customize data sharing per platform.
Under Map events, follow these steps to choose the in-app events you want to directly send to Pinterest.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with Pinterest.
- Under Partner event, you need to select the Pinterest event that corresponds to the Adjust event.
- For single platform apps and multi-platform apps with data sharing enabled for a single platform only, you map events for that platform only. For multi-platform apps with data sharing enabled for multiple platforms, you can:
- Select Use platform-specific mapping to map separate events at the platform-level or to not map events for certain platforms.
- Select Use global mapping to map the same events for all platforms.
- In the Partner event list, choose or enter a custom event name, that you want to map the Adjust event to.
- For single platform apps and multi-platform apps with data sharing enabled for a single platform only, you map events for that platform only. For multi-platform apps with data sharing enabled for multiple platforms, you can:
- Select Apply.
Now Pinterest will receive in-app event data for each of your linked events.
Map all events
If Pinterest supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.
Now Pinterest will receive in-app event data for all your linked events.
Map parameters
You usually need to map parameters to share custom data with Pinterest.
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Pinterest. This lets Pinterest receive custom event details for each of your linked events.
Before adding new partner parameters to the Adjust SDK, make sure no pre-existing partner parameters already fit your requirements.
To share partner parameters to Pinterest, follow these steps.
- Set up partner parameters within the Adjust SDK.
- Check Before you begin for all SDK development platform links.
- Under Set your data sharing options, select Parameters.
- Under Map parameters, you can specify how you want to send partner parameters defined in the SDK to the network:
- Select Map parameter.
- In the SDK parameter field, enter the name of the SDK parameter you want to share with the network.
- In the Partner parameter field, enter the network parameter that corresponds to the SDK parameter.
If you set up partner parameters within the Adjust SDK without setting up parameter sharing in the dashboard, Adjust forwards the parameters as named in the Adjust SDK.
Configure your link and settings
You have the option to set your:
Create your link and share it with Pinterest
In the Setup review screen, you can review your choices. You can also go back and make changes to:
- Your selected app
- Data sharing options
- Link structure parameters
- User destinations
- Attribution settings
Select Create link to create your click URL, impression URL, QR code and link token. Creating a link also enables data sharing and the integration with Pinterest.
Once you’ve created your link, share it with Pinterest for placement in campaigns.
Partner specific setup instructions
Overview
To send in-app events to Pinterest, required credentials depend on the API version you’re using:
API v5 (Recommended):
- Ad Account ID
- Access Token
Legacy API:
- Tag ID
You can retrieve your Access Token in Pinterest Ads Manager: Ad Account Overview > Conversions > Set Up API
More information available here
Best practice
Pinterest supports both iOS and Android“deep linking” conversions campaigns. Before enabling the integration, contact Pinterest so they can assist with campaign setup.
Predefined parameters
You can send predefined parameters with your events using the Adjust SDK. When attached correctly, these parameters are forwarded to Pinterest.
Refer to the SDK documentation for the correct way to attach partner parameters to your events.
Parameter | Description | Supported in API v5 | Format / Notes |
external_id | External user ID | ✅ | Comma- or semicolon-separated string list |
event_source_url | URL of the webpage where the event occurred | ✅ | String (URL format) |
em | Email address hashes | ✅ | SHA256 hash of the lowercase email address |
ph | Phone number hashes | ✅ | SHA256 hash of phone number with digits only, incl. country and area code |
event_id | Unique event identifier | ✅ | String |
content_ids | Product or content identifiers | ✅ | Comma- or semicolon-separated string list |
order_id | Order identifier | ✅ | String |
value | Value of purchase or add to cart | ✅ | Numeric (Supported also in the old API) |
currency | Currency for the value field | ✅ | ISO 4217 code (e.g., USD, EUR) — supported also in the old API |
For more details on formatting external_id
, em
and ph
, refer to the Pinterest API documentation.
The values of value and currency parameters are used as fallback values and are only forwarded to Pinterest if Adjust does not receive any revenue data for the in-app event directly from the SDK.
For more information, refer to the Adjust documentation on event revenue recording.
Grouped item-level parameters
The following parameters describe item-level metadata and should be aligned in order across the event payload.
Parameter | Description | Format / Notes |
id | Unique identifiers for items | Ordered string list (comma- or semicolon-separated) |
quantity | Quantity of each item | Ordered string list |
item_name | Name of each item | Ordered string list |
item_price | Price of each item | Ordered string list |
item_category | Category of each item | Ordered string list |
item_brand | Brand of each item | Ordered string list |
The order of values must match across these fields.
(e.g., the first value in item_price
should match the first in item_name
, id
, etc.)
List of all parameters forwarded to Pinterest
Pinterest requires Adjust to send the following parameters (data points) with your callbacks:
Placeholder | Information |
{city} | Device city |
{country} | Device two-character country code |
{currency} | Original ISO 4217 currency code sent from Adjust SDK |
{device_name} | Device model number |
{gps_adid} | Google Play Store advertising ID |
{idfa} | ID for advertisers (iOS only) |
{ip_address} | Device IP address |
{isp} | Device internet service provider |
{language} | Device two-character language code |
{os_name} | Device operating system |
{os_version} | Operating system version number |
{partner_parameters} | Custom partner parameters collected by the Adjust SDK or S2S request and transmitted to third party providers via postbacks |
{revenue_usd} | Revenue, in US dollars |
{revenue} | Revenue, as sent from Adjust SDK in cents |
{sdk_version} | Adjust SDK version (per app) |
{tracking_limited} | 1 if tracking is limited, 0 if not |
{user_agent} | Incoming raw user agent |
{app_id} | Store App ID or Google Play Store |
{app_name} | Name of the app |
{app_version_short} | App version number (Android), release-version-number for the bundle (iOS) |
{created_at} | Activity timestamp |
{impression_based} | 1 if impression-based engagement, 0 if not |