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
API Access Token	Required The Pinterest Conversions API needs an access token to authenticate your activities. More details are available following this LINK.
Advertiser ID	Required Pinterest Advertiser ID. 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
add_payment_info	add_payment_info
add_to_cart addtocart	add_to_cart
add_to_wishlist	add_to_wishlist
app_install	app_install
app_open	app_open
begin_checkout	initiate_checkout
contact	contact
customize_product	customize_product
find_location	find_location
generate_lead	lead
page_view pageview pagevisit view_item	page_visit
purchase buy pay payment	checkout
schedule	schedule
search	search
sign_up signup completeregistration	signup
start_trial	start_trial
submit_application	submit_application
subscribe	subscribe
view_category viewcategory view_item_list	view_category
view_content viewcontent	view_content
watch_video watchvideo	watch_video
add_shipping_info login refund remove_from_cart select_content select_item view_cart select_promotion view_promotion	custom

Field mappings

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").

Smart Mapping Fields	Commanders Act Default Properties	Pinterest Properties
Event Id	context.event_id	event_id [*]
Action Source	partners.pinterest.action_source	action_source [1]
Event Timestamp	context.event_timestamp	event_time
Source URL	context.page.url	event_source_url [2]
User Opt-Out	partners.pinterest.opt_out	opt_out [3]
App Id	context.app.namespace	app_id
App Name	context.app.name	app_name
App Version	context.app.version	app_version
Device Brand	context.device.manufacturer	device_brand
Device Carrier	context.device.network.carrier	device_carrier
Device Model	context.device.model	device_model
Device Type	context.device.type	device_type
Device OS Version	context.device.os.version	os_version
Device WiFi	context.device.network.wifi	wifi [3]
User Language	context.device.lang	language
User Email SHA256	user.email_sha256	user_data.em [4]
User Phone	user.phone	user_data.ph [4]
User Gender	user.gender	user_data.ge [4]
User Birthdate	user.birthdate	user_data.db [4]
User Last Name	user.lastname	user_data.ln [4]
User First Name	user.firstname	user_data.fn [4]
User City	user.city	user_data.ct [4]
User State	user.state_short	user_data.st [4]
User Zipcode	user.zipcode	user_data.zp [4]
User Country	user.country	user_data.country [4]
User Id	user.id	user_data.external_id [4]
Device Mobile Identifier	context.device.advertising_id	user_data.hashed_maids [4]
Device IP	context.device.ip	user_data.client_ip_address
Device User Agent	context.device.user_agent	user_data.client_user_agent
Click Id Source URL -	partners.pinterest.click_id context.page.url Click Id Cookie Name	user_data.click_id [5]
Transaction Id	id	custom_data.order_id
Currency	currency	custom_data.currency
Value	value	custom_data.value
Item Id	items.X.id	custom_data.content_ids [6]
Item Price	items.X.product.price	custom_data.contents.X.item_price
Item Quantity	items.X.quantity	custom_data.contents.X.quantity
Item List	items.length	custom_data.num_items
Search Term	search_term	custom_data.search_string
User Opt-Out Type	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_epik is used. 6. All item identifiers are taken into account.