Google Tag Manager

Google Tag Manager extension for Magento

With Google Tag Manager extension for Magento you can add tags without any programming skills. This extension is designed for seamless integration of Google Tag Manager with Magento web stores. Google Tag Manager is a free tool for managing marketing activities and tracking tags on your site. You can call it 'tags', but not those which are used to tag products and blog posts. In this case, we tag website visitors.

Tags are code snippets which can be added to a web page code. They are used to collect data for further analysis by 3rd-party services like Google Analytics (Universal Analytics), Google Adwords, Facebook Pixel, Conversion Tracking for Twitter, etc. Tags can be also used for remarketing tracking transactions and so on.

A growing need to measure marketing data in more flexible way and an ability to track website modifications has formed made the tag management concept.

What is Facebook Pixel?

Facebook Pixel is a tool which is used for advertising optimization, retargeting configuration and conversion tracking.

All data is being sent to Google Tag Manager service by our extension. The rest is performed by the service (for example, include other services and send data to them). It is based on the triggers you can set up.

Compatibility with other modules

1. Google Tag Manager extension for Magento is compatible with all built-in Magento modules.
2. It is also compatible with our Full Page Cache extension. To make a compatibility with 3rd-party Full Page Cache extension you need to exclude 'po_gtm_js' block from caching.
3. There would be a necessity to make a compatibility with 3rd-party checkout extensions. Please contact our support for help. It will be free.

Extension Installation

1. We recommend you to backup your store before installation
2. Go to magento admin and disable compilation (Systems > Tools > Compilation > 'Disable' button) and flush store cache (System > Cache Management > 'Flush Magento Cache' button)
3. Download the extension package from your account and extract the downloaded archive.
4. Copy the content of extracted folder to your store's root directory 
5. Flush store cache again
6. Log out from the backend and log in again.
7. If you want to enable compilation, then you should run compilation process (Systems > Tools > Compilation > 'Run Compilation Process' button).
8. Go to extension configuration (System > Configuration > PotatoCommerce Extension > Google Tag Manager ), enable and configurethe extension
9. Flush store cache again  

FAQ

Q: After installing "EXTENSION NAME " extension my store gives error or a blank page.
A: Go to Magento Backend, Flush Store Cache (System > Cache Management> 'Flush Magento Cache' button), Logout and Login again. 

If FAQ did not help you, please, contact us with detailed information about your issue. 

User Manual

Examples of data sent to a service

Event	Description	Example of data sent to Google Tag Manager
PageView	Any page was viewed	{"event":"page_view","currency":"USD","store_name":"Main Website Store","conversion_id":"","tracking_id":"","facebook_pixel_id":"","remarketing_id":""}
ProductView	Product page was viewed	{"event":"product_view","product_id":"prod1","product_ids":["prod1"],"product_title":"prod1","product_category":"cat1","product_price":"1.0000","currency":"USD","store_name":"Main Website Store","conversion_id":"","tracking_id":"","facebook_pixel_id":"","remarketing_id":""}
SearchPage	A customer searched something	{"event":"search","search_string":"prod","product_ids":["prod1"],"currency":"USD","store_name":"Main Website Store","conversion_id":"","tracking_id":"","facebook_pixel_id":"","remarketing_id":""}
NewOrder	A customer placed an order	{"event":"new_order","order_id":"100000002","order_total":"6.0000","order_tax":"0.0000","order_shipping":"5.0000","order_items":[{"name":"prod1","sku":"prod1","category":null,"price":"1.0000","quantity":"1.0000"}],"product_ids":["prod1"],"order_items_qty":1,"transactionId":"100000002","transactionAffiliation":"Main Website Store","transactionTotal":"6.0000","transactionTax":"0.0000","transactionShipping":"5.0000","transactionProducts":[{"name":"prod1","sku":"prod1","category":null,"price":"1.0000","quantity":"1.0000"}],"currency":"USD","store_name":"Main Website Store","conversion_id":"","tracking_id":"","facebook_pixel_id":"","remarketing_id":""}
InitiateCheckout	Customer goes to checkout	{"event":"initiate_checkout","quote_total":1,"quote_items":[{"name":"prod1","sku":"prod1","category":null,"price":1,"quantity":1}],"product_ids":["prod1"],"quote_items_qty":1,"currency":"USD","store_name":"Main Website Store","conversion_id":"","tracking_id":"","facebook_pixel_id":"","remarketing_id":""}
CustomerRegistration	A new customer registered on a website	{"event":"customer_registration","currency":"USD","store_name":"Main Website Store","conversion_id":"","tracking_id":"","facebook_pixel_id":"","remarketing_id":""}
AddToWishlist	A product was added to wishlist	{"event":"add_to_wishlist","product_id":"prod1","product_ids":["prod1"],"product_title":"prod1","product_price":"1.0000","currency":"USD","store_name":"Main Website Store","conversion_id":"","tracking_id":"","facebook_pixel_id":"","remarketing_id":""}
AddToCompare	A product was added to compare	{"event":"add_to_compare","product_id":"prod1","product_ids":["prod1"],"product_title":"prod1","product_category":"cat1","product_price":"1.0000","currency":"USD","store_name":"Main Website Store","conversion_id":"","tracking_id":"","facebook_pixel_id":"","remarketing_id":""}
AddToCart	A product was added to shopping cart	{"event":"add_to_cart","product_id":"prod1","product_ids":["prod1"],"product_title":"prod1","product_category":null,"product_price":"1.0000","currency":"USD","store_name":"Main Website Store","conversion_id":"","tracking_id":"","facebook_pixel_id":"","remarketing_id":""}
AddPaymentInfo	Customer added billing information on checkout	{"event":"add_payment_info","quote_total":1,"quote_items":[{"name":"prod1","sku":"prod1","category":null,"price":1,"quantity":1}],"product_ids":["prod1"],"quote_items_qty":1,"currency":"USD","store_name":"Main Website Store","conversion_id":"","tracking_id":"","facebook_pixel_id":"","remarketing_id":""}

Configure the extension to track and transfer data to services

Events

Event Name	Event Code	Variables	Description
AddPaymentInfo	add_payment_info	Quote Total Quote Items Product Ids Quote Items Qty Currency Store Name Conversion Id Tracking Id Facebook Pixel Id Remarketing Id	Event happens when billing information is saved at checkout
AddToCart	add_to_cart	Product Id Product Ids Product Title Product Category Title Product Price Currency Store Name Conversion Id Tracking Id Facebook Pixel Id Remarketing Id	Event happens when adding product to cart
AddToCompare	add_to_compare	Product Id Product Ids Product Title Product Category Title Product Price Currency Store Name Conversion Id Tracking Id Facebook Pixel Id Remarketing Id	Event happens when adding product to compare
AddToWishlist	add_to_wishlist	Product Id Product Ids Product Title Product Category Title Product Price Currency Store Name Conversion Id Tracking Id Facebook Pixel Id Remarketing Id	Event happens when adding product to wishlist
CustomerRegistration	customer_registration	Currency Store Name Conversion Id Tracking Id Facebook Pixel Id Remarketing Id	Event happens when customer registered
InitiateCheckout	initiate_checkout	Quote Total Quote Items Product Ids Quote Items Qty Currency Store Name Conversion Id Tracking Id Facebook Pixel Id Remarketing Id	Event happens when customer reached checkout
NewOrder	new_order	Order Id Order Items Order Items Qty Order Shipping Order Tax Order Total Product Ids Currency Store Name Conversion Id Tracking Id Facebook Pixel Id Remarketing Id	Event happens when customer placed an order
ProductView	product_view	Product Id Product Ids Product Title Product Category Title Product Price Currency Store Name Conversion Id Tracking Id Facebook Pixel Id Remarketing Id	Event happens when customer visited product page
SearchPage	search	Search String Product Ids Currency Store Name Conversion Id Tracking Id Facebook Pixel Id Remarketing Id	Event happens when customer visited search page
PageView	page_view	Currency Store Name Conversion Id Tracking Id Facebook Pixel Id Remarketing Id	Event happens when customer visited any page

Variables

Variable Name	Variable Code	Description	Example
Currency	currency	currency code, string	USD
Order Id	order_id	order increment ID	10000001
Order Items	order_items	list of order products	[{ 'name' :’product name’, 'sku' :product sku, 'category' :’category name’, 'price':12.0000, 'quantity':2 }]
Order Items Qty	order_items_qty	qty of items in order	2
Order Shipping	order_shipping	shipping cost	5.0000
Order Tax	order_tax	total tax	5.0000
Order Total	order_total	order total	22.000
Product Category Title	product_category	category name	TestCategory
Product Id	product_id	product sku	product1
Product Ids	product_ids	product skus	[‘product1’, ‘product2’, ...]
Product Price	product_price	product price	12.0000
Product Title	product_title	product name	BestProduct
Quote Items Qty	quote_items_qty	number of products in cart	1
Quote Total	quote_total	cart total	22.000
Search String	search_string	search query	BestProduct
Store Name	store_name	store name	MyTestStore
Conversion Id	conversion_id	conversion ID
Tracking Id	tracking_id	Google Analytics tracking ID
Facebook Pixel Id	facebook_pixel_id	Facebook Pixel ID
Remarketing Id	remarketing_id	Remarketing conversion ID

Example of creating an event

1 Triggers->new

 

2 Trigger Configuration -> Custom Event

 

 

3 fill in the fields according to the table above (same way as it was for AddToCart event)

 

 

4 Create all needed events same way.

Example of creating a variable

1 Variables -> New

 

2 Trigger Configuration -> Data Layer Variable

 

 

3 fill in the fields according to the table above (same way as it was for Product Category Title variable)

 

 

4 Create all needed variables same way.

Creating Tags: AdWords

Remarketing AdWords

1 Tags->New

2 Tag Configuration -> AdWords Remarketing

3 Fill in the fields according to the screenshot above

Conversion ID - can be specified here or via variable

{{Remarketing Id}} - Will be set in extension settings

Conversion Label - can be specified here or via variable https://potatocommerce.com/

Custom Parameters - select Manually Specify

and specify variables as on the screenshot above

Triggering - specify ProductView

AdWords Conversion Tracking

1 Tags->New

2 Tag Configuration -> AdWords Conversion Tracking

3 Fill in the fields according to the screenshot above

Conversion ID - can be specified here or via variable/p>

{{Conversion Id}} - Will be set in extension settings

Conversion Label - can be specified here or via variable https://potatocommerce.com/

Conversion Value - specify variable {{Order Total}}

Order ID - specify variable {{Order Id}}

Currency Code - specify variable {{Order Id}}

Triggering - specify All Pages

Creating Tags: Universal Analytics

Universal Analytics

1 Tags->New

2 Tag Configuration -> Universal Analytics

3 Fill in the fields according to the screenshot above

Tracking ID - can be specified here or via variable https://potatocommerce.com/

{{Tracking Id}} - Will be set in extension settings

Track Type - specify Page View

Triggering - specify All Pages

Universal Analytics Transaction

1 Tags->New

2 Tag Configuration -> Universal Analytics

3 Fill in the fields according to the screenshot above

Tracking ID can be specified here or via variable

{{Tracking Id}} - Will be set in extension settings

Track Type - specify Transaction

Triggering - specify NewOrder

Creating Tags: Facebook Pixel

FacebookPixel BaseCode

API documentation

1 Tags->New

2 Tag Configuration -> Custom Html

3 Fill in the fields according to the screenshot above

HTML

<!-- Facebook Pixel Code -->

<script>

!function(f,b,e,v,n,t,s){if(f.fbq)return;n=f.fbq=function(){n.callMethod?

n.callMethod.apply(n,arguments):n.queue.push(arguments)};if(!f._fbq)f._fbq=n;

n.push=n;n.loaded=!0;n.version='2.0';n.queue=[];t=b.createElement(e);t.async=!0;

t.src=v;s=b.getElementsByTagName(e)[0];s.parentNode.insertBefore(t,s)}(window,

document,'script','https://connect.facebook.net/en_US/fbevents.js');

fbq('init', '{{Facebook Pixel Id}}');

fbq('track', 'PageView');

</script>

<noscript><img height="1" width="1" style="display:none"

src="https://www.facebook.com/tr?id={{Facebook Pixel Id}}&ev=PageView&noscript=1"

/></noscript>

<!-- DO NOT MODIFY -->

<!-- End Facebook Pixel Code -->

{{Facebook Pixel Id}} variable is being set in extension settings. Can be replaced with a desired ID.

Advanced Settings -> Tag firing options - specify Once per page

Triggering - specify All Pages

FacebookPixel ViewContent

1 Tags->New

2 Tag Configuration -> Custom Html

3 Fill in the fields as on the screenshot above

HTML

<script>

bq('track', 'ViewContent', {

content_type: 'product',

content_ids: {{Product Ids}},

content_name:’ {{Product Title}}’,

content_category: ‘{{Product Category Title}}’,

value: {{Product Price}},

currency:’{{Currency}}’

});

</script>

Advanced Settings -> Tag firing options - specify Once per page

Advanced Settings ->Tag Sequencing->Fire a tag before Facebook ViewContent fires - specify FacebookPixel Base Code

Triggering - specify ProductView

FacebookPixel AddToCart

1 Tags->New

2 Tag Configuration -> Custom Html

3 Fill in the fields as on the screenshot above

HTML

<script>

fbq('track', 'AddToCart', {

content_type: 'product',

content_ids: {{Product Ids}},

value: {{Product Price}},

currency: {{Currency}},

content_name: {{Product Title}}

});

</script>

Advanced Settings -> Tag firing options - specify Once per page

Advanced Settings ->Tag Sequencing->Fire a tag before Facebook ViewContent fires - specify FacebookPixel Base Code

Triggering - specify AddToCart

FacebookPixel AddPaymentInfo

1 Tags->New

2 Tag Configuration -> Custom Html

3 Fill in the fields as on the screenshot above

HTML

<script>

fbq('track', 'AddPaymentInfo', {

content_category: 'checkout',

content_ids: {{Product Ids}},

value: {{Quote Total}},

currency: {{Currency}}

});

</script>

Advanced Settings -> Tag firing options - specify Once per page

Advanced Settings ->Tag Sequencing->Fire a tag before Facebook ViewContent fires - specify FacebookPixel Base Code

Triggering - specify AddPaymentInfo

FacebookPixel CompleteRegistration

1 Tags->New

2 Tag Configuration -> Custom Html

3 Fill in the fields as on the screenshot above

HTML

<script>

fbq('track', 'CompleteRegistration');

</script>

Advanced Settings -> Tag firing options - specify Once per page

Advanced Settings ->Tag Sequencing->Fire a tag before Facebook ViewContent fires - specify FacebookPixel Base Code

Triggering - specify CompleteRegistration

FacebookPixel InitiateCheckout

1 Tags->New

2 Tag Configuration -> Custom Html

3 Fill in the fields as on the screenshot above

HTML

<script>

fbq('track', 'InitiateCheckout', {

num_items:{{Quote Items Qty}},

content_ids: {{Product Ids}},

value: {{Quote Total}},

currency: {{Currency}},

content_name: 'Checkout'

});

</script>

Advanced Settings -> Tag firing options - specify Once per page

Advanced Settings ->Tag Sequencing->Fire a tag before Facebook ViewContent fires - specify FacebookPixel Base Code

Triggering - specify InitiateCheckout

FacebookPixel Lead

1 Tags->New

2 Tag Configuration -> Custom Html

3 Fill in the fields as on the screenshot above

HTML

<script>

fbq('track', 'Lead', {

content_name: 'product',

content_category: {{Product Category Title}},

value: {{Product Price}},

currency: {{Currency}}

});

</script>

Advanced Settings -> Tag firing options - specify Once per page

Advanced Settings ->Tag Sequencing->Fire a tag before Facebook ViewContent fires - specify FacebookPixel Base Code

Triggering - specify Lead

FacebookPixel Purchase

1 Tags->New

2 Tag Configuration -> Custom Html

3 Fill in the fields as on the screenshot above

HTML

<script>

fbq('track', 'Purchase', {

num_items: '{{Order Items Qty}}',

content_ids: '{{Product Ids}}',

content_name: 'order',

content_type: 'product',

value: '{{Order Total}}',

value: '{{Order Total}}',

currency: '{{Currency}}'

});

</script>

Advanced Settings -> Tag firing options - specify Once per page

Advanced Settings ->Tag Sequencing->Fire a tag before Facebook ViewContent fires - specify FacebookPixel Base Code

Triggering - specify Purchase

FacebookPixel Search

1 Tags->New

2 Tag Configuration -> Custom Html

3 Fill in the fields as on the screenshot above

HTML

<script>

fbq('track', 'Search', {

search_string: '{{Search String}}',

content_category: 'Product Search',

content_ids: '{{Product Ids}}',

currency: '{{Currency}}'

});

</script>

Advanced Settings -> Tag firing options - specify Once per page

Advanced Settings ->Tag Sequencing->Fire a tag before Facebook ViewContent fires - specify FacebookPixel Base Code

Triggering - specify Search

FacebookPixel Wishlist

1 Tags->New

2 Tag Configuration -> Custom Html

3 Fill in the fields as on the screenshot above

HTML

<script>

fbq('track', 'AddToWishlist', {

content_type: 'product',

content_ids: {{Product Ids}},

value: {{Product Price}},

currency: '{{Currency}}',

content_name: '{{Product Title}}'

});

</script>

Advanced Settings -> Tag firing options - specify Once per page

Advanced Settings ->Tag Sequencing->Fire a tag before Facebook ViewContent fires - specify FacebookPixel Base Code

Triggering - specify AddToWishlist