Powered by Adobe Commerce 2.4.6

apptrian-pinterest-pixel-icon.jpg

Pinterest Pixel & Conversions API

This is an Integration with a Third Party Service. Other charges and fees may be required to use this extension on your Store
PRODUCT:
0
TOTAL:

Overview

Back to top

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.

FAQ

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

Technical Specifications

Back to top

Seller profile

Apptrian LLC

Seller contact

E-mail

Integrator

Pinterest Pixel

Current Version

3.0.0

Adobe Commerce platform compatibility

Open Source (CE): 2.4 (current), 2.1 (obsolete), 2.2 (obsolete), 2.3 (obsolete)

Commerce on prem (EE): 2.4 (current), 2.2 (obsolete), 2.3 (obsolete)

Commerce on Cloud (ECE): 2.4 (current), 2.2 (obsolete), 2.3 (obsolete)

Type

Stable Build

Updated

03 February, 2023

Categories

Extensions, Marketing, Marketing Automation, Advertising

Quality Report

Back to top

Installation & Varnish Tests

Passed

Coding Standard

Passed

Plagiarism Check

Passed

Malware Check

Passed

Marketing Review

Passed

Manual Testing

Passed

All tests were conducted on the latest versions of Adobe Commerce that existed for the compatible release lines at the moment of the extension submission. Latest versions of all other software were used, as applicable.

Release Notes

Back to top

3.0.0:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    + Added Pinterest API for Conversions (Pinterest Conversions API / Pinterest Server-Side API)
    + Added option for page event alternative since API does not have it
    + Added option for Limited Data Processing
    * Signup event dependency on button/theme removed
    * Template fix regarding cached ajax calls

2.3.3:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    * Fixed a small bug with the price and number_format function

2.3.2:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    * Fixed compatibility with PHP 8.1

2.3.1:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    * Improved compatibility with older versions of Magento and PHP
    * Fixed validation regex for ConsentButton to allow space

2.3.0:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    + Added Cookie Consent options: Enable Cookie Consent, Consent Cookie Name, Consent Cookie Key, Consent Cookie Value, and Consent Button
    + Added Enhanced Match Mapping option with granular control and the following data keys: em, ph, fn, ln, ge, db, ct, st, zp, country, and external_id
    - Removed Enable Customer external_id option and functionality is merged with Enhanced Match Mapping option

2.2.1:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    * The latest EQP Magento Coding Standard improvements

2.2.0:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    + Added option to choose Pinterest product identifier (Magento Product SKU or Magento Product ID)
    + Added option to enable or disable customer external_id (Magento Customer ID)
    * Fixed search event

2.1.3:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    * Fixed Code Sniffer warning Line exceeds 120 characters

2.1.2:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    * Fixed small JavaScript bug in the template regarding customer data retrieval

2.1.1:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    * Improved Enhanced Match for Checkout event and guest checkout
    * CSP whitelist improvement
    * Small configuration visual improvement

2.1.0:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    + Added system message to remind user to provide Pinterest Pixel ID
    + Added option to enable/disable Pinterest Pixel base code
    + Added option to enable/disable Pinterest Pixel noscript tag
    + Added option to enable/disable Pinterest Pixel first-party cookies
    + Added option to enable/disable Pinterest Pixel metadata enrichment
    + Added options to enable/disable AddToCart, AddToWishlist, Signup, InitiateCheckout, Page, Checkout, Search, and PageVisit events
    + Added option to enable/disable Page event to fire with other events
    * Extension now uses Magento private content for customer info
    * Extension does not use deprecated Magento Registry class anymore
    * Small code EQP improvement

2.0.1:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3 2.4
  • Compatible with Commerce on prem (EE) : 2.2 2.3 2.4
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3 2.4
  • Stability: Stable Build
  • Description:

    * Compatibility with CSP (Content Security Policies)

2.0.0:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3
  • Compatible with Commerce on prem (EE) : 2.2 2.3
  • Compatible with Commerce on Cloud (ECE) : 2.2 2.3
  • Stability: Stable Build
  • Description:

    * Complete rewrite
    + Track with multiple Pinterest Pixels
    + Add Pinterest Pixel to any page via Magento admin without coding
    + Option to choose a category event name
    + Option to map Magento category attributes to custom parameters
    + Option to select SKU you want to use for bundle products (Product SKU, Children SKUs, or Both) (For Product, Quote, and Order)
    + Option to detect selected SKUs for bundle products
    + Option to select SKU you want to use for configurable products (Product SKU, Child SKUs, or Both) (For Product, Quote, and Order)
    + Option to detect selected SKU for configurable products
    + Option to select SKU you want to use for downloadable products (Product SKU, or Product SKU and Parent SKU) (For Product, Quote, and Order)
    + Option to select SKU you want to use for grouped products (Product SKU, Children SKUs, or Both) (For Product, Quote, and Order)
    + Option to detect selected SKUs for grouped products
    + Option to select SKU you want to use for simple products (Product SKU, or Product SKU and Parent SKU) (For Product, Quote, and Order)
    + Option to select SKU you want to use for virtual products (Product SKU, or Product SKU and Parent SKU) (For Product, Quote, and Order)
    + Option to map Magento product attributes to custom parameters
    + Options to type parameter name if you want to use Magento order ID, order increment ID, quote ID
    + Options to type event and parameter name you want to use for search tracking
    + Option to type request parameters you want to include for search tracking
    + Added external_id that maps to customer ID for Enhanced Match

1.0.0:

  • Compatible with Open Source (CE) : 2.1 2.2 2.3
  • Stability: Stable Build
  • Description:

    Initial release.

Support

Back to top

The best place to start if you need help with a specific extension is to contact the developer. All Adobe Commerce developers have both a contact email and a support email listed.

Contact Vendor

Q & A

Back to top

Reviews

Back to top