Pinterest Pixel and Conversions API for Magento

Add Pinterest Pixel (Pinterest Tag) and Pinterest API for Conversions (Pinterest Conversions API / Pinterest Server-Side API) To Magento With Just A Few Clicks!

Compatible with both Magento v2 and Magento v1!

(Two separate versions of the extension. One for Magento v2 and one for Magento v1.)

Works great with Catalog Product Feed!

Apptrian Pinterest Pixel & Conversions API extension for Magento adds Pinterest Pixel (Pinterest Tag) and Pinterest API for Conversions (Pinterest Conversions API / Pinterest Server-Side API) on CMS pages (including the home page), category pages, product pages, catalog search pages, catalog advanced search pages, customer registration page, checkout page (default Magento one but also any other without any coding, only by typing page handle (full action name) into our extension config.), and checkout success page. The extension supports Enhanced Match (if the customer is logged in) and has the ability to add custom parameters.

The Pinterest Pixel (Pinterest Tag) is a piece of JavaScript code for your website that enables you to measure, optimize and build audiences for your ad campaigns. Using the Pinterest pixel, you can leverage the actions people take on your website across devices to inform more effective Pinterest advertising campaigns.

The Pinterest API for Conversions (Pinterest Conversions API / Pinterest Server-Side API) (for web) allows advertisers to send web events from their servers directly to Pinterest. Server-side events are linked to a pixel and are processed like browser pixel events. This means that server-side events are used in measurement, reporting, and optimization in the same way as browser pixel events.

Optionally Pinterest Pixel block can be added to any other Magento page or any other extension page (blogs, form pages, etc.) via our extension config by typing the page handle (full action name). The Pinterest Pixel allows you to place a single pixel on your entire website to report conversions, build audiences and get rich insights into how people use your website.

Conversion measurement lets you track actions people take after viewing your Pinterest Ads across multiple devices, including mobile phones, tablets, and desktop computers. By creating a Pinterest Pixel and adding it to the pages of your website where conversions happen, like the checkout page, you will see who converts as a result of your Pinterest Ads. The pixel will continue to monitor the actions people take after clicking on your ad. You can see which device they saw the ad on and which device they ultimately converted on.

Account & Pricing

To use this extension, a free Pinterest Ads Manager account is required.

NOTE: Pinterest Advertising service is not free; additional charges apply to users running Pinterest Ad Campaigns.

Features

Pinterest Pixel (Pinterest Tag)

• An easy way to enable or disable Pinterest Pixel.
• Enhanced Match (if the customer is logged in).
• Works out of the box just type your Pinterest Pixel ID (or comma-separated IDs for multipixel setups) in our extension config.
• Option to type page handles (full action names) where you want Pinterest Pixel. Using this option Pinterest Pixel can be added to any other Magento page or any other extension page (blogs, form pages, etc.).
• Option to enable or disable Pinterest Pixel base code.
• Option to enable or disable Pinterest Pixel noscript tag.
• Option to enable or disable Pinterest Pixel first-party cookies.
• Option to enable or disable Pinterest Pixel metadata enrichment.
• Individual options to enable or disable AddToCart, AddToWishlist (Custom), Signup, InitiateCheckout (Custom), Lead, Checkout, Search, and PageVisit events.
• Option to fire Lead event with other events: Signup, InitiateCheckout (Custom), Checkout, Search, and PageVisit.
• Options to detect selected SKUs for all product types including bundle, configurable, and grouped products. WARNING! *

* WARNING! Pinterest Pixel detection of selected SKUs feature is heavily dependent on the theme you are using and its customization. It is impossible to predict all possible themes and customizations. Because of this detection will not work on every theme. This is why the extension default configuration comes with this feature turned off. You can turn it on and try it out. If it is working for you leave it on otherwise, turn it off. If you are a developer you will be pleased to know that everything is conveniently located in code.phtml file. To make it work, in some cases only the adjustment of a few jQuery selectors is needed in others complete rewrite of the detection code is needed. Because of this, we do not give any warranty for the detection feature, nor it is covered by our support service.

Unlike Pinterest Pixel (Pinterest Tag) client-side detection, Pinterest Server-Side detection is not dependent on the theme you are using and its customization. Therefore if you want to use detection, we recommend you server-side detection and events.

Pinterest API for Conversions (Pinterest Conversions API / Pinterest Server-Side API)

• An easy way to enable or disable Pinterest API for Conversions (Pinterest Conversions API / Pinterest Server-Side API).
• Enhanced Match (if the customer is logged in).
• Option to type your Pinterest Access Token in our extension config.
• Option to type your Pinterest Ad Account ID in our extension config.
• Option to type your Pinterest API Version in our extension config.
• Option to type your Test Event Code in our extension config.
• Option to log server-side fired events in the Magento log file.
• Individual options to enable or disable AddToCart, AddToWishlist (Custom), Signup, InitiateCheckout (Custom), Lead, Checkout, Search, and PageVisit events. * Notice
• Option to fire Lead event with other events: Signup, InitiateCheckout (Custom), Checkout, Search, and PageVisit.
• Options to detect selected SKUs for all product types including bundle, configurable, and grouped products.

* Notice Since version 3.0.0 you can send both the Pinterest Pixel (Pinterest Tag) event and Pinterest Conversions API (Pinterest API for Conversions) event simultaneously. The server-side events are not visible in the Pinterest Tag Helper extension for Chrome. You can see server-side events in your Pinterest Ads Manager.

Category (Category Page)

• Option to type page handles (full action names) where you want category-related code.
• Option to type the event name you want to use for category tracking.
• Options to add custom parameters to your category-related event with parameters to attributes mapping. Example: product_category=name|google_product_category=google_product_category. The format is simple param1=attribute1|param2=attribute2 Pinterest Pixel custom parameter and Magento category attribute are connected by = sign and pairs are separated by | sign.

Product (Product Page - AddToCart, AddToWishlist, PageVisit Events)

• Option to type page handles (full action names) where you want product-related code.
• Option to select SKU you want to use for bundle products. Options: Product SKU as (id), Children SKUs as (id)s, Children SKUs as (id)s and Product SKU as (item_group_id)
• Option to select SKU you want to use for configurable products. Options: Product SKU as (id), Child SKU as (id), Child SKU as (id) and Product SKU as (item_group_id)
• Option to select SKU you want to use for downloadable products. Options: Product SKU as (id), Product SKU as (id) and Parent SKU as (item_group_id)
• Option to select SKU you want to use for grouped products. Options: Product SKU as (id), Children SKUs as (id)s, Children SKUs as (id)s and Product SKU as (item_group_id)
• Option to select SKU you want to use for simple products. Options: Product SKU as (id), Product SKU as (id) and Parent SKU as (item_group_id)
• Option to select SKU you want to use for virtual products. Options: Product SKU as (id), Product SKU as (id) and Parent SKU as (item_group_id)
• Options to add custom parameters to your product-related events with parameters to attributes mapping. Example: product_category=product_category|google_product_category=google_product_category|color=color. The format is simple param1=attribute1|param2=attribute2 Pinterest Pixel custom parameter and Magento product attribute are connected by = sign and pairs are separated by | sign.

Quote (Checkout Page - InitiateCheckout/Custom Event)

• Option to type page handles (full action names) where you want quote-related code.
• Option to select SKU you want to use for bundle products. Options: Product SKU as (id), Children SKUs as (id)s, Children SKUs as (id)s and Product SKU as (item_group_id)
• Option to select SKU you want to use for configurable products. Options: Product SKU as (id), Child SKU as (id), Child SKU as (id) and Product SKU as (item_group_id)
• Option to select SKU you want to use for downloadable products. Options: Product SKU as (id), Product SKU as (id) and Parent SKU as (item_group_id)
• Option to select SKU you want to use for grouped products. Options: Children SKUs as (id)s, Children SKUs as (id)s and Product SKU as (item_group_id)
• Option to select SKU you want to use for simple products. Options: Product SKU as (id), Product SKU as (id) and Parent SKU as (item_group_id)
• Option to select SKU you want to use for virtual products. Options: Product SKU as (id), Product SKU as (id) and Parent SKU as (item_group_id)
• Option to type parameter name if you want to use Magento quote ID.
• Options to add custom parameters to your quote-related event with parameters to attributes mapping. Example: product_category=product_category|google_product_category=google_product_category|color=color. The format is simple param1=attribute1|param2=attribute2 Pinterest Pixel custom parameter and Magento product attribute are connected by = sign and pairs are separated by | sign.

Order (Checkout Success Page - Checkout Event)

• Option to type page handles (full action names) where you want order-related code.
• Option to select SKU you want to use for bundle products. Options: Product SKU as (id), Children SKUs as (id)s, Children SKUs as (id)s and Product SKU as (item_group_id)
• Option to select SKU you want to use for configurable products. Options: Product SKU as (id), Child SKU as (id), Child SKU as (id) and Product SKU as (item_group_id)
• Option to select SKU you want to use for downloadable products. Options: Product SKU as (id), Product SKU as (id) and Parent SKU as (item_group_id)
• Option to select SKU you want to use for grouped products. Options: Children SKUs as (id)s, Children SKUs as (id)s and Product SKU as (item_group_id)
• Option to select SKU you want to use for simple products. Options: Product SKU as (id), Product SKU as (id) and Parent SKU as (item_group_id)
• Option to select SKU you want to use for virtual products. Options: Product SKU as (id), Product SKU as (id) and Parent SKU as (item_group_id)
• Option to type parameter name if you want to use Magento order ID.
• Option to type parameter name if you want to use Magento order increment ID.
• Option to type parameter name if you want to use Magento quote ID.
• Options to add custom parameters to your order-related event with parameters to attributes mapping. Example: product_category=product_category|google_product_category=google_product_category|color=color. The format is simple param1=attribute1|param2=attribute2 Pinterest Pixel custom parameter and Magento product attribute are connected by = sign and pairs are separated by | sign.

Search (Search Result Page - Search Event)

• Option to type page handles (full action names) where you want search-related code.
• Option to type the event name you want to use for search tracking.
• Option to type the parameter name you want to use for search tracking.
• Option to type request parameters you want to include for search tracking.

Miscellaneous

• Option to select Pinterest product identifier. Magento product SKU (Recommended) or Magento product ID.
• Option for Enhanced Match data mapping. Example: external_id=external_id|em=em|ph=ph. The format is simple param1=key1|param2=key2 Pinterest parameter and data key are connected by = sign and pairs are separated by | sign. Available customer data keys are: em, ph, fn, ln, ge, db, ct, st, zp, country, and external_id.
• Option to enable Limited Data Processing.
• Option to type the page event alternative. The page event does not exist in Conversions API. Alternative events are lead or custom.
• Options to connect default Magento "Cookie Restriction Mode" cookie or any third-party cookie consent extension or theme customization via the following options: Enable Cookie Consent, Consent Cookie Name, Consent Cookie Key, Consent Cookie Value, and Consent Button.

Installation Instructions (For Magento v2)

There are several ways you can install any Magento extension. Our extension is no different. We will show you three ways to install the extension, but you must not mix them. Choose one and stick to it.

If you do not know how to install an extension or you wish a professional to do it for you, we offer an additional installation service for a small fee.

Installation via file uploading
(If you purchased the extension on our site)

If you purchased the extension on our site then unpack .zip file from /Magento2/InstallByUploadingFiles/ directory inside your Magento root.
- Run following commands on Magento root directory:
php bin/magento maintenance:enable
php bin/magento module:enable --clear-static-content Apptrian_PinterestPixel
php bin/magento setup:upgrade
php bin/magento cache:flush
php bin/magento setup:static-content:deploy
php bin/magento maintenance:disable
php bin/magento cache:flush

Installation via Composer
(If you purchased the extension on our site)

If you purchased the extension on our site then copy .zip file from /Magento2/InstallWithComposer/ directory inside your MAGENTO_ROOT/vendor/apptrian/packages/ directory (create directory if does not exist).
- Run following commands on Magento root directory:
php bin/magento maintenance:enable
composer config repositories.apptrianartifacts artifact $(pwd)/vendor/apptrian/packages
composer require apptrian/pinterest-pixel
php bin/magento module:enable --clear-static-content Apptrian_PinterestPixel
php bin/magento setup:upgrade
php bin/magento cache:flush
php bin/magento setup:static-content:deploy
php bin/magento maintenance:disable
php bin/magento cache:flush

Installation via Composer
(If you purchased the extension on Magento Marketplace)

If you purchased the extension on Magento Marketplace then you must use Composer. Magento Marketplace does not allow extension downloads.
- Run following commands on Magento root directory:
php bin/magento maintenance:enable
composer require apptrian/pinterest-pixel
php bin/magento module:enable --clear-static-content Apptrian_PinterestPixel
php bin/magento setup:upgrade
php bin/magento cache:flush
php bin/magento setup:static-content:deploy
php bin/magento maintenance:disable
php bin/magento cache:flush

Please make sure your Magento public and private keys are in your Magento root auth.json file. Usually, people install Magento with one Magento Marketplace account (public and private keys) and then purchase an extension with another Magento Marketplace account (different public and private keys). Check the Magento Marketplace account you used to purchase the extension and make sure it's public and private keys are in the Magento root auth.json file. WARNING! if you already have keys there, be very careful because maybe some other extensions are purchased with another Magento Marketplace account.

Installation Instructions (For Magento v1)

- Log in to Magento Admin
- (Optional) Disable Magento Compiler if you are using it (System > Tools > Compilation)
- Go to System > Magento Connect > Magento Connect Manager
- If you purchased an extension on our site use the "Direct package file upload" section and "Upload package file". Browse to the .tgz file. Click the "Upload" button.
- If you purchased an extension on Magento Marketplace use the "Paste extension key to install" and paste Access Key you get from Magento Marketplace. Click the "Install" button. Click the "Proceed" button.
- Go back to Magento Admin
- Flush Magento Cache (System > Cache Management), then log out from Magento Admin and log back in
- (Optional) Enable Magento Compiler by clicking "Run Compilation Process" button (System > Tools > Compilation)

If you do not know how to install an extension or you wish a professional to do it for you, we offer an additional installation service for a small fee.

Configuration (For Magento v2)

Our extension works out of the box. The only thing you need to do is type your Pixel ID, Access Token, and Ad Account ID in our extension configuration. To do this, log in to your Magento Admin and go to:

Stores > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Pinterest Pixel (Client-Side Settings) > Pinterest Pixel ID

Stores > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Pinterest Conversions API (Server-Side Settings) > Pinterest Access Token

Stores > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Pinterest Conversions API (Server-Side Settings) > Pinterest Ad Account ID

See FAQ on how to get Access Token and Ad Account ID.

We recommend you to add the "product_category" attribute to your products. First, add a new Magento product attribute "product_category" from Magento Admin (Stores > Attributes > Product). Then add this attribute to all of your attribute sets (Stores > Attributes > Attribute Set). Then go to (Catalog > Products) and type the value for the "product_category" attribute for every product you have. After you are done refresh your Magento cache (System > Cache Management).

All options are self-explanatory and have comments and tooltips. Make sure you read them.

After changing options, make sure you refresh your Magento cache.

WARNING! You need to remove all other implementations of Pinterest Pixel (Pinterest Tag) and use only our extension.

• Remove all other extensions that fire Pinterest Pixel (Pinterest Tag).
• Remove all theme customizations that fire Pinterest Pixel (Pinterest Tag).
• If you are using GTM (Google Tag Manager), make sure it is not firing Pinterest Pixel (Pinterest Tag) events.

Configuration (For Magento v1)

Our extension works out of the box. The only thing you need to do is type your Pixel ID, Access Token, and Ad Account ID in our extension configuration. To do this, log in to your Magento Admin and go to:

System > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Pinterest Pixel (Client-Side Settings) > Pinterest Pixel ID

System > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Pinterest Conversions API (Server-Side Settings) > Pinterest Access Token

System > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Pinterest Conversions API (Server-Side Settings) > Pinterest Ad Account ID

See FAQ on how to get Access Token and Ad Account ID.

We recommend you to add the "product_category" attribute to your products. First, add a new Magento product attribute "product_category" from Magento Admin (Stores > Attributes > Product). Then add this attribute to all of your attribute sets (Stores > Attributes > Attribute Set). Then go to (Catalog > Products) and type the value for the "product_category" attribute for every product you have. After you are done refresh your Magento cache (System > Cache Management).

All options are self-explanatory and have comments and tooltips. Make sure you read them.

After changing options, make sure you refresh your Magento cache.

WARNING! You need to remove all other implementations of Pinterest Pixel (Pinterest Tag) and use only our extension.

• Remove all other extensions that fire Pinterest Pixel (Pinterest Tag).
• Remove all theme customizations that fire Pinterest Pixel (Pinterest Tag).
• If you are using GTM (Google Tag Manager), make sure it is not firing Pinterest Pixel (Pinterest Tag) events.

FAQ (For Magento v2)

Q: How to get Pinterest Access Token?
A: Log in to Pinterest on a business account and click on Ads > Conversions. Under "Conversions" choose "Conversion access token" and click "Generate new token". All tokens begin with the prefix "pina_".

Q: How to get Pinterest Ad Account ID?
A: Log in to Pinterest on a business account and click on Ads > Overview or Analytics > Overview. Click on the tab that says "Viewing: <your account name >" and you will see a list of the accounts you can access. Under each account name is the ad_account_id. All ad_account_id numbers are twelve-digit codes that begin with "549".

Q: Why the ViewCategory event shows an error for the Pinterest Conversions API?
A: The Pinterest Conversions API specification is strict. The event name must be view_category. No additional/custom parameters are allowed. To fix the issue set Stores > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Category (Category Page) > Event Name to view_category.
Stores > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Category (Category Page) > Category Parameters to Attributes Mapping to empty.

Q: Is it possible to add the Pinterest Pixel to other Magento pages or extension pages?
A: Yes it is. In our extension config just use the option "Add Pinterest Pixel To" and type your page handle (full action name). For example, if you want to add Pinterest Pixel to a blog page and that blog page handle is "blog_post_view", you would type this into "Add Pinterest Pixel To" at the end. Page handle depends on a particular extension this is just an example. Do not forget to Refresh your Magento Cache.

Q: When I check my product pages with the "Pinterest Tag Helper" extension for Chrome I get the "Page visit event was sent successfully with warnings. Warning - Product Category is missing"?
A: You need to add the "product_category" attribute to your products. First, add a new Magento product attribute "product_category" from Magento Admin (Stores > Attributes > Product). Then add this attribute to all of your attribute sets (Stores > Attributes > Attribute Set). Then go to (Catalog > Products) and type the value for the "product_category" attribute for every product you have. After you are done refresh your Magento cache (System > Cache Management).

Q: Why is the Enhanced Match score low?
A: Some events like PageVisit have a very low score because anyone can access Product pages. On the other hand, the Checkout event has a high score because the customer is logged in, or if it is a guest customer, the data is read from the order billing/shipping address. In short, this is normal. 1. If a customer is not logged in or it is a visitor that does not have an account on your site only IP address, browser Info, and click_id (if exists) will be sent for Enhanced Match. 2. If a customer is logged in to your Magento store beside the above-mentioned parameters all other parameters can be sent: em, ph, fn, ln, ge, db, ct, st, zp, country, external_id. Of course, all the information is read from the Magento database. If for example, the customer did not provide a phone number, the "ph" will not be sent because it is empty. Another example is if your Magento does not have a gender field enabled in Magento then the customer could not select it and subsequently, our extension cannot send it to Pinterest via Enhanced Match. Bottom line is, if information exists in your Magento database it will be sent. 3. The "Checkout" event is different. The customer does not have to be logged in or have an account. The information is read from the order billing/shipping address and everything is sent for Enhanced Match.

Q: Why Signup event does not work?
A: If you updated the extension from any previous version to version 3.0.0 or newer in our extension config option "Stores > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Pinterest Pixel (Client-Side Settings) > Add Pinterest Pixel To" replace page handle "customer_account_create" with "customer_account_index".

FAQ (For Magento v1)

Q: How to get Pinterest Access Token?
A: Log in to Pinterest on a business account and click on Ads > Conversions. Under "Conversions" choose "Conversion access token" and click "Generate new token". All tokens begin with the prefix "pina_".

Q: How to get Pinterest Ad Account ID?
A: Log in to Pinterest on a business account and click on Ads > Overview or Analytics > Overview. Click on the tab that says "Viewing: <your account name >" and you will see a list of the accounts you can access. Under each account name is the ad_account_id. All ad_account_id numbers are twelve-digit codes that begin with "549".

Q: Why the ViewCategory event shows an error for the Pinterest Conversions API?
A: The Pinterest Conversions API specification is strict. The event name must be view_category. No additional/custom parameters are allowed. To fix the issue set Stores > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Category (Category Page) > Event Name to view_category.
Stores > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Category (Category Page) > Category Parameters to Attributes Mapping to empty.

Q: Is it possible to add the Pinterest Pixel to other Magento pages or extension pages?
A: Yes it is. In our extension config just use the option "Add Pinterest Pixel To" and type your page handle (full action name). For example, if you want to add Pinterest Pixel to a blog page and that blog page handle is "blog_post_view", you would type this into "Add Pinterest Pixel To" at the end. Page handle depends on a particular extension this is just an example. Do not forget to Refresh your Magento Cache.

Q: When I check my product pages with the "Pinterest Tag Helper" extension for Chrome I get the "Page visit event was sent successfully with warnings. Warning - Product Category is missing"?
A: You need to add the "product_category" attribute to your products. First, add a new Magento product attribute "product_category" from Magento Admin (Catalog > Attributes > Manage Attributes). Then add this attribute to all of your attribute sets (Catalog > Attributes > Manage Attribute Sets). Then go to (Catalog > Manage Products) and type the value for the "product_category" attribute for every product you have. After you are done refresh your Magento cache (System > Cache Management).

Q: Why is the Enhanced Match score low?
A: Some events like PageVisit have a very low score because anyone can access Product pages. On the other hand, the Checkout event has a high score because the customer is logged in, or if it is a guest customer, the data is read from the order billing/shipping address. In short, this is normal. 1. If a customer is not logged in or it is a visitor that does not have an account on your site only IP address, browser Info, and click_id (if exists) will be sent for Enhanced Match. 2. If a customer is logged in to your Magento store beside the above-mentioned parameters all other parameters can be sent: em, ph, fn, ln, ge, db, ct, st, zp, country, external_id. Of course, all the information is read from the Magento database. If for example, the customer did not provide a phone number, the "ph" will not be sent because it is empty. Another example is if your Magento does not have a gender field enabled in Magento then the customer could not select it and subsequently, our extension cannot send it to Pinterest via Enhanced Match. Bottom line is, if information exists in your Magento database it will be sent. 3. The "Checkout" event is different. The customer does not have to be logged in or have an account. The information is read from the order billing/shipping address and everything is sent for Enhanced Match.

Q: Why Signup event does not work?
A: If you updated the extension from any previous version to version 3.0.0 or newer in our extension config option "Stores > Configuration > Apptrian Extensions > Pinterest Pixel and Conversions API > Pinterest Pixel (Client-Side Settings) > Add Pinterest Pixel To" replace page handle "customer_account_create" with "customer_account_index".