RudderStack lets you send your event data to Pinterest Conversions API via cloud mode. It sends the event calls in a batch, where each batch can contain upto 1000 events.
To use Pinterest Tag’s cloud mode (Pinterest conversions API), contact Pinterest Support to enable the beta access.
Pinterest is migrating to API v5 and will deprecate support for API v3 on June 30, 2023. Hence, it is recommended to configure Pinterest Tag as a destination in RudderStack using API v5.
Find the open source code for this destination in the GitHub repository.
Track
The track call allows you to capture the users’ conversion events.
RudderStack maps the track events as specified in the Map Your Events To Pinterest Events connection setting in the dashboard.
A sample track call is shown below:
rudderanalytics.track("Order Completed",{event_id:'eventIDordercompleted',order_id:"transactionId",value:35.00,revenue:31.98,currency:'USD',products:[{product_id:'123454387',price:3.00,quantity:2,currency:'USD',position:1,value:6.00,}]},{traits:{email:"alex@example.com",lastname:"Keener",firstname:"Alex",action_source:"offline"// or app_ios / app_android / web
}});
You can use the Ecommerce Events Specification for sending the events while instrumenting your site with the RudderStack SDK.
The following table mentions how the specific RudderStack track Ecommerce events are mapped to standard Pinterest Conversion Events:
RudderStack event
Pinterest event
Order Completed
checkout
Product Added
add_to_cart
Products Searched
search
Product List Filtered
search
You can also track a custom event that you want to include in the conversion reporting. It will be mapped to a custom Pinterest event, for example:
rudderanalytics.track("custom event")
Standard Pinterest events
Pinterest supports the following nine standard events that can be mapped and tracked for reporting. Any event apart from these is treated as a user-defined event.
checkout
add_to_cart
page_visit
signup
watch_video
lead
search
view_category
custom
Page
The page call lets you record your website’s page views with any additional relevant information about the viewed page.
view_category: RudderStack sends this event if both the name and category fields are present. The below sample event contains both the fields and is mapped to the Pinterest’s view_category event:
rudderanalytics.page("Best Seller","Games",{path:"/best-seller/games/1",url:"https://www.estore.com/best-seller/games/1",title:"Best selling games offered by EStore",search:"estore bestseller games",referrer:"https://www.google.com/search?q=estore+bestseller",testDimension:"true",})
page_visit: RudderStack sends this event if only name field is present and drops any additional properties. The below sample event contains only name and is mapped to the Pinterest’s page_visit event:
Source indicating the occurence of conversion event.
timestamp Required
event_time
Unix timestamp (in UTC) in seconds indicating when the user conversion event occurred.
destination.Config.advertiserId Required
advertiser_id
Pinterest Advertiser ID.
Integrations Object messageId
event_id
Deduplication key from the dashboard setting or messageId. The dashboard setting is given higher priority.
pageUrl
event_source_url
URL of the web conversion event.
context.device.adTrackingEnabled
opt_out
When action_source is web or offline, it defines whether the user has opted out of tracking for web conversion events.
When action_source is app_android or app_ios, it defines whether the user has enabled Limit Ad Tracking on their iOS device or opted out of Ads Personalization on their Android device.
Starting January 1, 2023, you can use Pinterest’s Limited Data Processing (LDP) flag to limit how Pinterest uses certain data to help the advertisers comply with the users’ privacy settings in accordance with the CCPA (California Consumer Privacy Act).
The following table lists the event properties required to enable Limited Data Processing and their mappings with the Pinterest fields:
Click the Ads tab and select Conversions from the dropdown.
Select API for conversions from the dropdown to see your events.
To see API for conversions option in the dropdown, you need to set up your Pinterest dashboard using the Pinterest Tag. For more information on using the Pinterest Tag, refer to the Pinterest Tag Device Mode documentation.
This site uses cookies to improve your experience while you navigate through the website. Out of
these
cookies, the cookies that are categorized as necessary are stored on your browser as they are as
essential
for the working of basic functionalities of the website. We also use third-party cookies that
help
us
analyze and understand how you use this website. These cookies will be stored in your browser
only
with
your
consent. You also have the option to opt-out of these cookies. But opting out of some of these
cookies
may
have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This
category only includes cookies that ensures basic functionalities and security
features of the website. These cookies do not store any personal information.
This site uses cookies to improve your experience. If you want to
learn more about cookies and why we use them, visit our cookie
policy. We'll assume you're ok with this, but you can opt-out if you wish Cookie Settings.