Skip to content

Commit 053d4fe

Browse files
author
Gaurav Kochar
committed
made a section for Limited Data Processing and FAQ
1 parent 58bf421 commit 053d4fe

File tree

1 file changed

+83
-1
lines changed
  • src/connections/destinations/catalog/actions-pinterest-conversions-api

1 file changed

+83
-1
lines changed

‎src/connections/destinations/catalog/actions-pinterest-conversions-api/index.md

Lines changed: 83 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ The Pinterest Conversions API destination provides the following benefits :-
2929
- **Fewer settings**. Data mapping for actions-based destinations happens during configuration, which eliminates the need for most settings.
3030
- **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.
3131
- **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 Deduplication**. Deduplication removes duplicates events which improves the accuracy of your conversions
3233
- **Support for page calls**. Page calls can be sent to Pinterest as a standard Page View.
3334
- **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.
3435
- **Data normalization**. Data is normalized before it is hashed to send to Pinterest Conversions.
@@ -45,6 +46,21 @@ By using deduplication advertisers can report conversions using both the tag and
4546

4647
Advertisers should use deduplication for any events they expect to be reported by multiple sources across the API and the Pinterest Tag.
4748

49+
## Limited Data Processing
50+
Starting from Jan 1, 2023, Pinterest introduced the Limited Data Processing flag as per California Consumer Privacy Act (CCPA). With this flag set Pinterest will allow advertisers to comply with CCPA.
51+
52+
Advertisers are responsible for complying with user opt-outs, as well as identifying the user’s state of residency when implementing the Limited Data Processing flag.
53+
54+
Keep in mind that the Limited Data Processing flag could impact campaign performance and targeting use cases. Pinterest recommends using the Limited Data Processing flag on a per-user basis for best results.
55+
56+
LDP relies on 3 fields and is enabled only when all 3 combinations are met, if one of them is not met then LDP is disabled / ignored.
57+
58+
| Field Name | Field Description | Required Value for LDP |
59+
|--------------|------------------------------------------------|------------------------|
60+
| opt_out_type | Opt Out Type based on User’s privacy preference| "LDP" |
61+
| st | State of Residence | "CA" |
62+
| country | Country of Residence | "US" |
63+
4864
## Getting started
4965

5066
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.
@@ -65,4 +81,70 @@ To connect the Pinterst Conversions API Destination:
6581
9. Finally, enable the destination using the **Enable Destination** toggle switch and click **Save Changes**.
6682

6783

68-
{% include components/actions-fields.html settings="true"%}
84+
{% include components/actions-fields.html settings="true"%}
85+
86+
## FAQ & Troubleshooting
87+
88+
### PII Hashing
89+
90+
Segment creates a SHA-256 hash of the following fields before sending to Facebook:
91+
- External ID
92+
- Mobile Ad Identifier
93+
- Email
94+
- Phone
95+
- Gender
96+
- Date of Birth
97+
- Last Name
98+
- First Name
99+
- City
100+
- State
101+
- Zip Code
102+
- Country
103+
104+
### User Data Parameters
105+
106+
Segment automatically maps User Data fields to their corresponding parameters [as expected by the Conversions API](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#User_data%2C%20and%20%2Ccustom_data%2C%20objects){:target="_blank"} before sending to Pinterest Conversions:
107+
108+
| User Data Field | Conversions API User Data Parameter |
109+
|------------------|-------------------------------------|
110+
| External ID | external_id |
111+
| Mobile Ad Id | hashed_maids |
112+
| Client Ip Address| client_ip_address |
113+
| Client User Agent| client_user_agent |
114+
| Email | em |
115+
| Phone | ph |
116+
| Gender | ge |
117+
| Date of Birth | db |
118+
| Last Name | ln |
119+
| First Name | fn |
120+
| City | ct |
121+
| State | st |
122+
| Zip Code | zp |
123+
| Country | country |
124+
125+
### Custom Data Parameters
126+
127+
Segment automatically maps Custom Data fields to their corresponding parameters [as expected by the Conversions API](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#User_data%2C%20and%20%2Ccustom_data%2C%20objects){:target="_blank"} before sending to Pinterest Conversions:
128+
129+
| User Data Field | Conversions API Custom Data Parameter |
130+
|------------------|-------------------------------------|
131+
| Currency | currency |
132+
| Value | value |
133+
| Content IDs | content_ids |
134+
| Contents | contents |
135+
| Number of Items | num_items |
136+
| Order ID | order_id |
137+
| Search String | search_string |
138+
| Opt Out Type | opt_out_type |
139+
140+
### Server Event Parameter Requirements
141+
142+
Pinterest requires the `action_source` server event parameter for all events sent to the Pinterest Conversions API. This parameter specifies where the conversions occur.
143+
144+
### Verify Events in Pinterest Conversions Dashboard
145+
146+
After you start sending events, you should start seeing them in dashboard. You can confirm that Pinterest received them:
147+
148+
1. Go to the Events Overview.
149+
2. Click on the Event History to see all the events sent to pinterest conversions.
150+

0 commit comments

Comments
 (0)