Magento Plugin

The Armanet Magento Plugin is designed to seamlessly integrate Armanet’s advanced ad tech solutions into your Magento site. It offers smart detection of installations, automatically adding conversion tracking to streamline your ecommerce operations.

With this plugin, you can efficiently manage and optimize your ad campaigns, ensuring accurate tracking of conversions and improving your overall advertising performance.

What the plugin does

The plugin is designed to streamline two critical aspects of ecommerce advertising: automatic conversion tracking via events and providing real-time inventory data for shopping ads. By embedding our SDK into the Magento system, the plugin seamlessly listens for key ecommerce events—such as checkout success, cart additions, and product views—and transmits these signals to Armanet. This enables advertisers to precisely measure Return on Ad Spend (ROAS) by tracking revenue generated from ad-driven conversions. Additionally, granular event tracking allows for a deeper understanding of user behavior, helping advertisers optimize their campaigns with more relevant and engaging ads.

Beyond conversion tracking, the Inventory Sync ensures that Armanet has real-time access to your store's product availability, enabling efficient ad placements. The plugin exposes an API endpoint that Armanet calls to fetch an up-to-date product feed, ensuring that only in-stock items are promoted. This reduces wasted ad spend on out-of-stock products and improves the customer experience by aligning ad content with actual inventory. By combining automated event tracking with dynamic inventory updates, the plugin provides a comprehensive solution to enhance ecommerce advertising efficiency. More details on the feed structure and shopping ad functionality can be found here.

Events tracked

The plugin listens for the following Magento storefront and customer events and reports them to Armanet:

purchased fires on the checkout success page.
addedToCart fires when a shopper adds a product to their cart.
removedFromCart fires when a shopper removes an item from their cart.
login fires when an existing customer logs in.
signup fires when a new customer registers an account.

Each of the login, registration, and purchase-related behaviors above can be tuned from the plugin's settings, and all events respect the customer group exclusion setting so you can keep staff or wholesale accounts out of your tracking data.

Installation Guide

Follow the steps outlined in this guide to get started and take your advertising campaigns to the next level.

Navigate to your Magento root directory, run the following command:

$ composer require armanet/magento-integration

Enable and install the module:

$ php bin/magento module:enable Armanet_Integration
$ php bin/magento setup:upgrade
$ php bin/magento cache:flush

Configure plugin settings

In the Magento admin, go to Stores > Configuration > General > Armanet Integration.
See Plugin Settings below for what each field controls and its default value.

Plugin Settings

Setting	Purpose	Default
Armanet API Key	Your Armanet API key. Required for the product feed request to authenticate.	(empty)
Enable Conversion Tracking	Turns event tracking on or off.	Yes
Enable Feed	Turns the product feed endpoint on or off.	Yes
UPC Attribute Code	The product attribute code used to populate the UPC field on events and in the feed. Change this if your store keeps UPC/GTIN in a different attribute.	`upc`
Enable Login Event	Turns the `login` event on or off.	Yes
Enable Registration Event	Turns the `signup` event on or off.	Yes
Exclude Customer Groups from Tracking	Comma-separated customer group names to exclude from all event tracking, e.g. `Wholesale`.	(empty)
Debug Mode	Logs each tracked event and its payload to the browser console. Disable in production.	No

Verify installation

To ensure the plugin is working correctly, visit your website and perform a few test actions, such as adding products to the cart and completing a purchase.
Check the Armanet dashboard to verify that the events are being tracked correctly.
For a faster check, turn on Debug Mode in the plugin settings, each event and its payload will be logged to your browser's console as you perform test actions, so you can confirm they're firing correctly without waiting on the dashboard.

Conclusion

With the Armanet Magento Plugin, integrating advanced ad tech solutions into your Magento site is a breeze. The plugin not only simplifies the process but also enhances your ecommerce tracking with its smart detection and automatic conversion tracking.

If you encounter any issues or need further assistance, please contact our support team.