|
| 1 | +--- |
| 2 | +title: Pinterest Conversions API |
| 3 | +id: 63e42e512566ad7c7ca6ba9b |
| 4 | +hide-personas-partial: true |
| 5 | +hide-boilerplate: false |
| 6 | +hide-dossier: true |
| 7 | +--- |
| 8 | + |
| 9 | +Conversion tracking lets you see what a user does on your websites, in your mobile apps, or in your physical stores. When you share your users’ conversion data with Pinterest, we are able to provide you insights that will help you evaluate your ads' effectiveness and improve the content, targeting, and placement of future ad. |
| 10 | + |
| 11 | +The Pinterest API for Conversions enables advertisers to send conversions directly to Pinterest via a server-to-server method without requiring a Pinterest Tag. These conversions are mapped to Pinterest campaigns for conversion reporting to improve conversion visibility. |
| 12 | + |
| 13 | +Advertisers can send web, in-app, or offline conversions to Pinterest’s server to server endpoint in real-time or batch. Events received in real time or within an hour of the event occurring will be reported as web or app events. Events received outside of this window, as well as delayed batch events are categorized as offline events. |
| 14 | + |
| 15 | +The API for Conversions can help Pinterest in continuing to provide a more comprehensive view of your campaign performance. All advertisers who currently use the Pinterest Tag will benefit from using it in tandem with the API for Conversions, as the best practice is to use the two solutions together to maximize visibility into the conversions your campaigns are driving. |
| 16 | + |
| 17 | +## Authentication |
| 18 | +Pinterest requires users to generate a conversion token that will be sent as the access_token in the header as part of authentication whenever the Post request is sent to the Conversion API endpoint. |
| 19 | + |
| 20 | +To test authentication, a request needs to be made with ?test=true. Pinterest will return the expected response but the events will not be recorded. |
| 21 | + |
| 22 | +Document to get conversion access_token is available [here](https://developers.pinterest.com/docs/conversions/conversions/#Get%20the%20conversion%20token). |
| 23 | + |
| 24 | + |
| 25 | +## Benefits of Pinterest Conversions API (Actions) |
| 26 | + |
| 27 | +The Pinterest Conversions API destination provides the following benefits :- |
| 28 | + |
| 29 | +- **Fewer settings**. Data mapping for actions-based destinations happens during configuration, which eliminates the need for most settings. |
| 30 | +- **Clearer mapping of data**. Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to Pinterest Conversions API. |
| 31 | +- **Prebuilt mappings**. Mappings for standard Pinterest Conversions API events, like `Add to Cart`, are prebuilt with the prescribed parameters and available for customization. |
| 32 | +- **Support for page calls**. Page calls can be sent to Pinterest as a standard Page View. |
| 33 | +- **Support for Custom event**. Custom event can also be sent to Pinterest Conversions. |
| 34 | +- **Support for multi-user arrays**. User data nested within arrays, like the `User Data` array in the Order Completed event, can be sent to Pinterest. |
| 35 | +- **Data normalization**. Data is normalized before it is hashed to send to Pinterest Conversions. |
| 36 | + |
| 37 | +## Deduplication |
| 38 | + |
| 39 | +Pinterest cannot inherently know if a conversion reported by the Tag and another reported by the API for Conversions are the same. |
| 40 | + |
| 41 | +Because Pinterest recommends using both the API for Conversions and the Pinterest Tag, deduplication is an essential part of the implementation process. It helps to avoid double-counting of a single event when it’s sent through multiple sources, such as the Pinterest Tag and the Pinterest API for Conversions. |
| 42 | + |
| 43 | +For example, if a user triggers an add to cart event and the tag reports the data using “123” as the event ID. Later, their web server reports the conversion via the API and also uses “123” as the event ID. When Pinterest receives the events, we can look at the event IDs and know that they correspond with the same event. |
| 44 | + |
| 45 | +By using deduplication advertisers can report conversions using both the tag and the API without having to worry about overcounting conversions. This will result in more conversions being attributed than either alone, because if the tag doesn’t match an event, but the API does (or vice versa), the event can still be linked. |
| 46 | + |
| 47 | +Advertisers should use deduplication for any events they expect to be reported by multiple sources across the API and the Pinterest Tag. |
| 48 | + |
| 49 | +## Getting started |
| 50 | + |
| 51 | +Before connecting to the Pinterest Conversions destination, you must have a [Pinterest](https://ads.pinterest.com/login/){:target="_blank"} account and an Ad Account ID. |
| 52 | + |
| 53 | +To connect the Pinterst Conversions API Destination: |
| 54 | + |
| 55 | +1. From the Segment web app, navigate to **Connections > Catalog**. |
| 56 | +2. Search for **Pinterest Conversions API** in the Destinations Catalog, and select the destination. |
| 57 | +3. Click **Configure Pinterest Conversions API**. |
| 58 | +4. Select the source that will send data to Pinterest Conversions API and follow the steps to name your destination. |
| 59 | +5. On the **Basic Settings** page that appears, configure the following details in the respective fields: |
| 60 | + - Name of the destination |
| 61 | + - Your Ad Account ID |
| 62 | + - Conversions Token |
| 63 | +6. Navigate to the **Mappings** tab , there are already Prebuilt mapping like `Checkout,Search,Add to Cart` defined with prescribed parameter . All required ,recommended and optional fields are listed [here](https://developers.pinterest.com/docs/conversions/best/#Authenticating%20for%20the%20Conversion%20Tracking%20endpoint#The%20%2Cuser_data%2C%20and%20%2Ccustom_data%2C%20objects#Required%2C%20recommended%2C%20and%20optional%20fields#Required%2C%20recommended%2C%20and%20optional%20fields) |
| 64 | +7. If you want to create **New Mapping**, and select **Report Conversions Event** ,configure and enable it. |
| 65 | +8. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). |
| 66 | +9. Finally, enable the destination using the **Enable Destination** toggle switch and click **Save Changes**. |
| 67 | + |
| 68 | + |
| 69 | +{% include components/actions-fields.html settings="true"%} |
0 commit comments