Pinterest

Pinterest is an image sharing and social media service designed to enable saving and discovery of information on the internet using images, animated GIFs and videos, in the form of pinboards. Using this destination, you can leverage Pinterest API to send events via server-side hits. More technical details are available following this LINK.

Key features

The Pinterest destination provides the following key features:

• Events structure: our Events reference model covers Pinterest's events, meaning that your data is properly bridged to the expected fields in an optimized way.

• Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.

• Automatic hashing: information is automatically hashed matching partner specifications.

• Smart mapping: data mapping can be readjusted using your datalayer defined fields.

• Support for multi-item data: information included in the item array is dispatched to Pinterest.

Destination setup

Ensure you have access to a Pinterest Ads account before configuring this destination.

Configuration

Settings	Description
Advertiser ID	Required Pinterest Advertiser ID. More details are available following this LINK.
API Access Token	Required The Pinterest Conversions API needs an access token to authenticate your activities. More details are available following this LINK.
Click Id Cookie Name	Cookie name holding the Pinterest "Click Id" that uniquely identifies a click. This is highly recommend on checkout events at least. It may improve reporting performance such as ROAS/CPA. Default cookie name: _epik. More details are available by following this LINK.
Send as a test-request	If checked, the event will not be recorded in Pinterest Ads, but the API will still return the same response messages. Use this mode to verify your requests and if your events are constructed correctly. More details are available following this LINK.

Quick reference

Commanders Act Events	Pinterest Events
page_view view_item	page_visit
purchase buy pay payment	checkout
add_to_cart addtocart	add_to_cart
search find_location	search
generate_lead submit_application contact	lead
sign_up signup completeregistration	signup
view_item_list viewcategory viewcontent	view_category
watch_video watchvideo	watch_video
add_payment_info add_shipping_info add_to_wishlist begin_checkout login refund remove_from_cart select_content select_item view_cart select_promotion view_promotion	custom

Field mappings

Most properties can be remapped using our "Smart Mapping" feature. At least one of the following statement must be fulfilled: • user_data.em is set. • user_data.hashed_maids is set. • user_data.client_ip_address and user_data.client_user_agent are set. The property event_id is required and used for deduplication. More information are available following this LINK (See section "How deduplication works").

Commanders Act Properties	Pinterest Properties
partners.pinterest.event_id	event_id [*]
partners.pinterest.action_source	action_source [1]
context.event_timestamp	event_time
context.page.url	event_source_url [2]
partners.pinterest.opt_out	opt_out [3]
context.app.namespace	app_id
context.app.name	app_name
context.app.version	app_version
context.device.manufacturer	device_brand
context.device.network.carrier	device_carrier
context.device.model	device_model
context.device.type	device_type
context.device.os.version	os_version
context.device.network.wifi	wifi [3]
context.device.lang	language
user.email_sha256	user_data.em [4]
user.phone	user_data.ph [4]
user.gender	user_data.ge [4]
user.birthdate	user_data.db [4]
user.lastname	user_data.ln [4]
user.firstname	user_data.fn [4]
user.city	user_data.ct [4]
user.state_short	user_data.st [4]
user.zipcode	user_data.zp [4]
user.country	user_data.country [4]
user.id	user_data.external_id [4]
context.device.advertising_id	user_data.hashed_maids [4]
context.device.ip	user_data.client_ip_address
context.device.user_agent	user_data.client_user_agent
context.page.url Click Id Cookie Name	user_data.click_id [5]
id	custom_data.order_id
currency	custom_data.currency
value	custom_data.value
items.X.id	custom_data.content_ids [6]
items.X.product.price	custom_data.contents.X.item_price
items.X.quantity	custom_data.contents.X.quantity
items.length	custom_data.num_items
search_term	custom_data.search_string
partners.pinterest.opt_out_type	custom_data.opt_out_type

[*] Mandatory property. [1] If this property is not provided, an action_source is retrieved using available data. Supported values: app_android , app_ios , offline and web . Default value: web . [2] If this property is not provided, a properevent_source_urlis retrieved using available data. [3] Boolean or equivalent string value supported. [4] If it's passed in clear text, it's automatically hashed. [5] Priority on the left column. If the value can't be retrieved from the URL, the Click Id Cookie Name or the default cookie name_epikis used. [6] All item identifiers are taken into account.