Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 3.63 KB

ConversionEventsCustomData.md

File metadata and controls

24 lines (19 loc) · 3.63 KB
Raw

ConversionEventsCustomData

Object containing other custom data.

Properties

Name Type Description Notes
currency str, none_type The ISO-4217 currency code. If not provided, we will default to the advertiser's currency set during account creation. Your campaign performance needs this field to report right ROAS/CPA. [optional]
value str, none_type Total value of the event. Accepted as a string in the request; it will be parsed into a double. For example, if there are two items in a checkout event, the value should be the total price. We recommend to use pre-tax, pre-shipping final value. [optional]
content_ids [str] List of products IDs. We recommend using this if you are a merchant for PageVisit, AddToCart and Checkouts. For detail, please check <a href=&quot;https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs\" target=&quot;_blank&quot;>here</a> (Install the Pinterest tag section). [optional]
content_name str, none_type The name of the page or product associated with the event. [optional]
content_category str, none_type The category of the content associated with the event. [optional]
content_brand str, none_type The brand of the content associated with the event. [optional]
contents [ConversionEventsCustomDataContents] A list of objects containing information about products, such as price and quantity. We recommend using this if you are a merchant for PageVisit, AddToCart and Checkouts. For detail, please check <a href=&quot;https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs\" target=&quot;_blank&quot;>here</a> (Install the Pinterest tag section). [optional]
num_items int Total number of products of the event. For example, the total number of items purchased in a checkout event. We recommend using this if you are a merchant for AddToCart and Checkouts. For detail, please check <a href=&quot;https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs\" target=&quot;_blank&quot;>here</a> (Install the Pinterest tag section). [optional]
order_id str, none_type The order ID. We recommend sending order_id to help us deduplicate events when necessary. This also helps to run other measurement products at Pinterest. [optional]
search_string str, none_type The search string related to the user conversion event. [optional]
opt_out_type str, none_type Flags for different privacy rights laws to opt out users of sharing personal information. Values should be comma separated. Please follow the <a href=&quot;https://help.pinterest.com/en/business/article/limited-data-processing\" target=&quot;_blank&quot;>Help Center</a> and <a href=&quot;/docs/api-features/conversion-overview/&quot; target=&quot;_blank&quot;>dev site</a> for specific opt_out_type set up. [optional]
np str, none_type Named partner. Not required, this is for Pinterest internal use only. Please do not use this unless specifically guided. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]