Open Graph Meta Tags for Magento Adobe Commerce

Works great with Rich Snippets Schema.org JSON-LD Structured Data!

Works great with Twitter Cards Meta Tags!

The Open Graph protocol enables any web page to become a rich object in a social graph. Apptrian Open Graph extension for Magento adds Meta (Facebook) Open Graph and Pinterest Rich Pins, to product, category, home, and CMS pages. The Open Graph meta tags are also used by Pinterest, TikTok, Twitter, and many others. There are dozens of options for customization. This extension provides your Magento site not only with social improvements but also has great SEO value. All of the meta tags are generated automatically based on the data in your Magento database. Like all of our extensions, it is multistore compatible, works on any theme, it does not override nor overwrite anything. Functionality is injected via layout updates as Magento best practices recommend.

Compatible with Breeze frontend without the need for an additional compatibility module. It works out of the box.

Compatible with Hyvä frontend without the need for an additional compatibility module. It works out of the box.

Features

General Settings

• An easy way to enable or disable the extension.

Meta (Facebook) Open Graph (for the product, category, home, and cms pages)

• An easy way to enable or disable Open Graph.
• All data needed for Open Graph meta tags is parsed from Magento and tags are generated automatically.
• Multiselect option to add Open Graph for the product, category, home, and/or cms pages.
• Option to type in Facebook Administrator IDs (fb:admins).
• Option to type in Facebook App Id (fb:app_id).
• Option to type in Facebook Profile Id (article:author).
• Option to type in attribute code to use for Category page title (og:title) meta tag.
• Option to type in attribute code to use for Category page description (og:description) meta tag.
• Option to type in attribute code to use for Category image (og:image) meta tag.
• Option to type in attribute code to use for CMS page title (og:title) meta tag.
• Option to type in attribute code to use for CMS page description (og:description) meta tag.
• Option to limit the number of images on CMS pages Open Graph.
• Option to type in attribute code to use for Product page title (og:title) meta tag.
• Option to type in attribute code to use for Product page description (og:description) meta tag.
• Option to limit the number of images on Product pages Open Graph.
• Products will use a full-size primary image for (og:image) meta tag.
• Option to type the attribute code you want to use for the product:brand meta tag.
• Option to type default text for the product:brand meta tag value. (It is used if an attribute is empty.)
• Option to type the attribute code you want to use for the product:availability meta tag. (If left empty determination will be made based on the default Magento getIsInStock() method.)
• Option to match product:availability values to defined ones: in stock, out of stock, available for order, and discontinued.
• Option to type the attribute code you want to use for the product:catalog_id meta tag.
• Option to type the attribute code you want to use for the product:category meta tag.
• Option to type default category for the product:category meta tag value. (It is used if an attribute is empty.)
• Option to type the attribute code you want to use for the product:condition meta tag.
• Option to match product:condition values to defined ones: new, refurbished, and used.
• Option to type the attribute code you want to use for the product:gender meta tag.
• Option to match product:gender values to defined ones: female, male, and unisex.
• Option to type the attribute code you want to use for the product:item_group_id meta tag.
• Option to type the attribute code you want to use for the product:gtin (Global Trade Item Number) meta tag.
• Option to type the attribute code you want to use for the product:isbn (International Standard Book Number) meta tag.
• Option to type the attribute code you want to use for the product:mfr_part_no (Manufacturer Part Number) meta tag.
• Option to type the attribute code you want to use for the product:retailer_item_id meta tag.
• Option to enable the product:sale_price meta tag.
• Option to enable the product:sale_price_dates meta tag.
• Option to enable the og:price meta tag. (The product:price meta tag is already enabled by default.)
• Option to use the lowest price for the og:price meta tag.
• Option to use the price range.
• Option to use one meta tag or two meta tags for the price range.
• Option to type the meta tag for the price range.
• Option to type the meta tag for price range minimum.
• Option to type the meta tag for price range maximum.
• Option to type the price range separator sign or text.
• Options to select which product type should use product range. (Separate option for bundle, configurable, downloadable, grouped, simple, and virtual.)
• Options to use price range only if minimum and maximum prices are different. (Separate option for bundle, configurable, downloadable, grouped, simple, and virtual.)
• Option for additional meta tags to attributes mapping. Example: color=color|pattern=pattern. As you can see the format is simple tag1=attribute1|tag2=attribute2 The meta tag and Magento product attribute are connected by = sign and pairs are separated by | sign.
• Product pages are done as Product objects while Category, Home, and CMS pages are done as Article objects.

Pinterest Rich Pins (for the product, category, home, and cms pages)

• An easy way to enable or disable Pinterest Rich Pins.
• Product pages are done as Product objects while Category, Home, and CMS pages are done as Article objects.
• All data needed for Pinterest Rich Pins meta tags are parsed from Magento and tags are generated automatically.
• Pinterest Rich Pins are using Open Graph meta tags to implement their functionality, therefore Open Graph must be enabled in order for Pinterest Rich Pins to function.
• Please take a look at our genuine Pinterest Rich Pins examples.

Installation Instructions

There are several ways you can install any Magento extension. Our extension is no different. We will show you four 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 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 the .zip file from /Magento2/InstallByUploadingFiles/ directory inside your Magento root.
- Run the following commands on the Magento root directory:

php bin/magento maintenance:enable

php bin/magento module:enable --clear-static-content Apptrian_OpenGraph

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 and you want to install the extension via composer public and private keys. (To find your public and private keys, login to your Apptrian.com customer account and look at the My Downloadable Products section.)
- Run the following commands on the Magento root directory:

php bin/magento maintenance:enable

composer config --auth http-basic.packages.apptrian.com $PUBLIC_KEY $PRIVATE_KEY

composer config repositories.apptrian-open-graph composer https://packages.apptrian.com/open-graph/

composer require apptrian/open-graph

php bin/magento module:enable --clear-static-content Apptrian_OpenGraph

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 by using artifact
(If you purchased the extension on our site)

If you purchased the extension on our site then copy the .zip file from /Magento2/InstallWithComposer/ directory inside your MAGENTO_ROOT/vendor/apptrian/packages/ directory (create the directory if does not exist).
- Run the following commands on the Magento root directory:

php bin/magento maintenance:enable

composer config repositories.apptrianartifacts artifact $(pwd)/vendor/apptrian/packages

composer require apptrian/open-graph

php bin/magento module:enable --clear-static-content Apptrian_OpenGraph

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 the following commands on the Magento root directory:

php bin/magento maintenance:enable

composer require apptrian/open-graph

php bin/magento module:enable --clear-static-content Apptrian_OpenGraph

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

Configuration

Our extension works out of the box. However, there are a few things you should set for best results. Log to your Magento Admin and go to:

Stores > Configuration > Apptrian Extensions > Open Graph

In the Open Graph section:

For Facebook Administrator IDs (fb:admins) type Facebook IDs of the app's administrators as the comma-separated list. If you do not have an administrators type ID of the profile which created your Facebook page.

For Facebook Profile ID (article:author) type Facebook Profile ID of the administrator of Magento store or owner of the store.

All options are self-explanatory and have comments and tooltips for additional information.

After changing options make sure you refresh your Magento cache.