Open Graph Required Tags Check

Finds missing Open Graph basic metadata properties in supplied parallel property and content vectors. Requires nonempty content; it does not fetch images or validate URLs.

Description

Open Graph metadata describes content for consumers such as link previews.

Open Graph metadata describes content for consumers such as link previews. The basic property set identifies the title, object type, image and canonical URL.1

Finds missing Open Graph basic metadata properties in supplied parallel property and content vectors. Requires nonempty content; it does not fetch images or validate URLs.

When to use Open Graph Required Tags Check

Use this for the following task: Finds missing Open Graph basic metadata properties in supplied parallel property and content vectors. Requires nonempty content; it does not fetch images or validate URLs.

Prepare the parsed attribute values, element states or ordered local lists requested below. Keep attribute presence separate from value.

How to use Open Graph Required Tags Check and understand its results

  1. Prepare the parsed attribute values, element states or ordered local lists requested below. Keep attribute presence separate from value.
  2. Enter properties, contents using the field table, then run the tool.
  3. Read missing, complete. Interpret flags, units, ordering and placeholder values using the rules below.
  4. Review any reported issue or failed check, correct the supplied values when appropriate, and verify the result in its intended context.
Input fieldMeaningValue type and boundsRequirement
propertiesPropertieslist of string; minimum entries 0; maximum entries 10000; each entry: string; maximum text length 10000Required
contentsContentslist of string; minimum entries 0; maximum entries 10000; each entry: string; maximum text length 10000Required

Supply parallel property/content lists. Match exact og:title, og:type, og:image and og:url names, accepting a property when at least one paired content value is nonblank after trimming.2

missing = required properties without any nonblank paired content

This summarizes the declared operation. Units, indexing, inclusivity and exceptional cases are explained in the surrounding text.

Output fieldMeaningValue type
missingMissinglist of string
completeCompleteboolean
json
{
  "input": {
    "properties": [
      "og:title",
      "og:type",
      "og:url"
    ],
    "contents": [
      "Field notes",
      "article",
      "https://example.org/notes"
    ]
  },
  "output": {
    "missing": [
      "og:image"
    ],
    "complete": false
  }
}

Limitations and assumptions

Complete indicates presence only. URLs, images, duplicate values and consumer-specific requirements are not validated.

This evaluates supplied local information; it does not fetch a page or run a browser. Malformed requests produce input errors. A successfully evaluated request can still contain false flags, empty result lists or a result outside the supplied threshold; those outcomes have the meanings stated above.

Alternative or Complementary methods

Choose base href Single Instance Warning for this operation: Reports multiple base elements with href attributes and the first such href in document order. Include empty href attributes in the vector. This checks cardinality and selection only, without URL resolution or base target attributes. For a complementary task, use img alt Presence Checker for this operation: Checks whether a parsed img has an alt attribute and whether its value is empty. Empty alternative text can be appropriate for decorative images; this is a presence check only.

Further background: HTML / accessibility reference: Open Graph Required Tags Check.

References

  1. HTML / accessibility reference: Open Graph Required Tags Check — Open Graph protocol

  2. Open Graph Required Tags Check — tool.io

Similar or alternative tools

  • base href Single Instance Warning

    Reports multiple base elements with href attributes and the first such href in document order. Include empty href attributes in the vector. This checks cardinality and selection only, without URL resolution or base target attributes.

  • img alt Presence Checker

    Checks whether a parsed img has an alt attribute and whether its value is empty. Empty alternative text can be appropriate for decorative images; this is a presence check only.

Don't forget to set a bookmark for tool.io!
Privacy | Imprint | Cookies