Microdata Tags

Microdata is an HTML specification used to nest metadata within existing content on webpages. Microdata uses a supporting vocabulary to describe an item and name-value pairs to assign values to its properties.

You can use microdata tags on your website to provide information about your products using a standardized format. We support these 3 formats:

  • OpenGraph — Place the microdata in the head element of your website.
  • Schema.org — Place the microdata across the product page where the products are located.
  • JSON-LD for Schema.org — Place the microdata within the script tag (see the example below).

Depending on the type of protocol you choose, the microdata needs to be in the right location on your website.

To test if your microdata tags are working, use this microdata debugger tool.

OpenGraph

Pixel-based catalogs use activity from your pixel to add products to your catalog. Before you can successfully add a product to your catalog, you first need to add required tags that include information about the product ("microdata") on its product page. See required and optional tags for OpenGraph.

Currently, only ecommerce catalogs can be created, leveraging the Facebook pixel.

Example - OpenGraph

<meta property="og:title" content="Facebook T-Shirt">
<meta property="og:description" content="Unisex Facebook T-shirt, Small">
<meta property="og:url" content="https://example.org/facebook">
<meta property="og:image" content="https://example.org/facebook.jpg">
<meta property="product:brand" content="Facebook">
<meta property="product:availability" content="in stock">
<meta property="product:condition" content="new">
<meta property="product:price:amount" content="7.99">
<meta property="product:price:currency" content="USD">
<meta property="product:retailer_item_id" content="facebook_tshirt_001">

Schema.org

See required tags for Schema.org.

Example - Schema.org

<div itemscope itemtype="http://schema.org/Product">
  <meta itemprop="brand" content="facebook">
  <meta itemprop="name" content="Facebook T-Shirt">
  <meta itemprop="description" content="Unisex Facebook T-shirt, Small">
  <meta itemprop="productID" content="facebook_tshirt_001">
  <meta itemprop="url" content="https://example.org/facebook">
  <meta itemprop="image" content="https://example.org/facebook.jpg">
  <div itemprop="offers" itemscope itemtype="http://schema.org/Offer">
    <link itemprop="availability" href="http://schema.org/InStock">
    <link itemprop="itemCondition" href="http://schema.org/NewCondition">
    <meta itemprop="price" content="7.99">
    <meta itemprop="priceCurrency" content="USD">
  </div>
</div>

JSON-LD for Schema.org

See required tags for JSON-LD for Schema.org.

Example — JSON-LD for Schema.org

{
  "@context":"https://schema.org",
  "@type":"Product",
  "productID":"facebook_tshirt_001",
  "name":"Facebook T-Shirt",
  "description":"Unisex Facebook T-shirt, Small",
  "url":"https://example.org/facebook",
  "image":"https://example.org/facebook.jpg",
  "brand":"facebook",
  "offers": [
    {
      "@type": "Offer",
      "price": "7.99",
      "priceCurrency": "USD",
      "itemCondition": "https://schema.org/NewCondition",
      "availability": "https://schema.org/InStock"
    }
  ]
}