Pinterest Tag Cloud Mode Integration

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
  }
});

Ecommerce conversion tracking

This destination does not strictly adhere to the RudderStack Ecommerce Event Spec.

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:

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:

rudderanalytics.page("Best Seller", {
  path: "/best-seller/1",
})

Common field mappings

The following table lists the mappings specific for Pinterest Conversion API and are relevant for both the track and page calls:

For mobile sources, if context.device.adTrackingEnabled is true, opt_out will be set as false and vice-versa.

User field mappings

The following table lists the mappings for fields carrying the user information for track and page calls:

To send the track or page events successfully, you need to include at least one of the following user properties:

• em
• hashed_maids
• Combination of client_ip_address and client_user_agent

Custom field mappings

The following table lists the custom fields mappings for track and page calls:

Limited Data Processing (LDP)

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:

FAQ

How can I verify if my events are being sent to Pinterest Conversions API?

Follow these steps to see your events in Pinterest Conversions API:

1. Login to your Pinterest ads manager account.
2. Click the Ads tab and select Conversions from the dropdown.
3. 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.