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:

Adjust S2S click links should be set as parallel click trackers in Pinterest. More information available here.

Select Pinterest and your app in Campaign Lab

1. Under Campaign Lab, select Partners.
2. Select New partner > Pinterest. Select Next to move to the next screen.
3. 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.
4. Select Next.

Enable data sharing

Enable data sharing to activate the integration with Pinterest. To enable data sharing:

1. 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:

1. Separate data sharing options at the platform-level by selecting Use platform-specific settings.
2. 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.

1. 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.

1. Select Map event.
2. In the Adjust event list, choose the Adjust event that you want to share with Pinterest.
3. Under Partner event, you need to select the Pinterest event that corresponds to the Adjust event.
   1. 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.
   2. In the Partner event list, choose or enter a custom event name, that you want to map the Adjust event to.
4. 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.

1. Set up partner parameters within the Adjust SDK.
   • Check Before you begin for all SDK development platform links.
2. Under Set your data sharing options, select Parameters.
3. Under Map parameters, you can specify how you want to send partner parameters defined in the SDK to the network:
   1. Select Map parameter.
   2. In the SDK parameter field, enter the name of the SDK parameter you want to share with the network.
   3. In the Partner parameter field, enter the network parameter that corresponds to the SDK parameter.

Configure your link and settings

You have the option to set your:

• Link structure
• User destinations
• Attribution settings

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

Transitioning from Legacy API to API v5

Pinterest will deprecate its Legacy API in favor of the API v5. This documentation walks you through the setup process, including authentication, event mapping, and removing legacy configurations.

1. Enter Credentials

After you selected Pinterest and your app in Campaign Lab, provide the following details:

• Account ID
• Access token

2. Event mapping

• Understand event mapping fields
  • Name (Legacy)– used only with the Legacy API.
  • New name (API v5) – event values required for API v5.
• Select the Adjust in-app event you want to map from the Adjust event field and map it to a value from the New name dropdown

The event name mapping recommendations from Legacy API (Name) to API v5 (New name) are shared below. You are also free to map your Legacy API (Name) events to other available API v5 (New Name) events for Pinterest.

3. Remove legacy Tag ID (optional)

The Tag ID is no longer required with API v5. You can safely remove the Tag ID from your configuration. If you still provide a Tag ID along with an Account ID and Access Token, and a value for the New Name field, the system will prioritize API v5 and ignore the Tag ID for Legacy API.

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.

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.

List of all parameters forwarded to Pinterest

Pinterest requires Adjust to send the following parameters (data points) with your callbacks: