Previews for your Website
This article describes how to use the Open Graph Protocol and structured data (JSON-LD) to allow messengers, other websites and search-engines to preview elements of your website.
The Open Graph Protocol (OGP)
OGP is used for most small previews in many instant messengers like Telegram or Whatsapp, but also on Facebook and Twitter. It’s very easy to use and the official documentation actually tells you everything you need to know, but there are some potential pitfalls. Every page on your website must have a correct segment in it’s header. Here is the minimalist’s code for a basic web page:
<html lang="en-us" prefix="og: http://ogp.me/ns#">
<meta property="og:type" content="website" />
<meta property="og:title" content="Title" />
<meta property="og:description" content="A description" />
<meta property="og:url" content="url_of_current_page" />
<meta property="og:image" content="http://example.de/preview_picture">
- The prefix in the
<html ..>definition is a RDFa extension, annotating the use of additional semantic vocabularies. Most applications will preview your web pages fine without this information. In my tests, only Telegram seems to actually require it.
- The usage of both
og:descriptionseems to be application dependent, some applications will prefer the normal meta-fields "title" or "description" if they exist. Most unfortunately, some will also show an empty description once you added a single
og:tag but no
og:description- even if
<meta name=description ...>exists. Therefore I would suggest always using the same content in both
<meta type=description ..>and the OGP-tag.
- Some applications require
og:urlto be set and will not display an image or expand the link if it isn't.
og:image: While most applications will accept both a relative link (if
og:urlwas provided) and an absolute link (including protocol and domain), using a fully qualified absolute link, seems to be the universally accpeted format. You may define multiple pictures and resolutions here, but I found that most applications re-render the picture anyway so you will be fine with just one moderately sized picture (~1000-1600px). The extension of the picture doesn't matter and you don't have to give an image type, as long as your server sends the correct MIME-type. Some formats won't work with some applications, most notably webp and svg are not widely supported.
Note that some applications and websites may impose additional restrictions or requirements, for example LinkedIn requires pictures to be at least 1200x627px. The instant-messenger Telegram will display the above code structure like this:
Instead of posting your links into the application or website of your choice, you may also use opengraphcheck.com to check your OGP-tags.
Structured data in the form of JSON-LD is also used by some applications and websites to generate extended previews of web pages, most notably by Google for it’s Rich Cards.
Every page need’s it’s own structured data section in the HTML header in the form of a
<script type=application/json+ld> tag. There are different types of so called "entities" which represent different constructs of structured data and require different information. There are many well known types, but applications can also define/expect their own types. You can find a list of interesting entity-types on the Google-Docs or schema.org.
In other words, write something like this into your
"name": "Your Name",
The above specifically is the “social” Rich Card. You can have multiple entities after another i.e. like this:
"author: "Your Name",
"headline": "A title or headline",
"description": "A description",
This second entity is documented on schema.org. The parameters used in the example are the ones most often required in my experience, but, like with the OGP, applications and websites will treat these information very differently — i.e. yet again failing to default to meta-fields or straight out ignoring either thumbnailUrl or image and using one of them regardless of the size of the respectively linked image. As unfortunate as it is, I found that using the same image resolution for thumbnailUrl and image produces way more consistent results, than using a lower resolution image for thumnailUrl.
A testing tool for structured data can be found here.
Cover-Picture selfmade, licensed CC0
Originally published at https://blog.atlantishq.de.