Skip to Content
The new glomex player is released! 🎉View upgrade guide

oEmbed Integration

The glomex Video Player supports oEmbed  integration through our JSON endpoint at https://embed.mes.glomex.cloud/oembed.json.

đź’ˇ

If you use WordPress as your CMS, you can use our WordPress glomex oEmbed plugin .

đź’ˇ

Need to generate embed code with your specific Integration ID and Playlist ID? Use our Embed Code Generator tool, which utilizes the oEmbed service to create ready-to-use embed codes.

Overview

The oEmbed response contains everything needed to generate glomex player embed codes for both HTML5 and AMP.

đź’ˇ

SEO Metadata: The new glomex player can automatically add structured data (JSON-LD) to your page for better SEO. This can be enabled via the player configuration settings.

Request Parameters

To generate proper embed codes, you need to provide the following query parameters:

ParameterTypeDescription
urlmandatoryURL-encoded URL matching a supported embed scheme (see Supported Schema)
integrationIdmandatory only if not in urlIf the url parameter doesn’t include the integrationId, it can be supplied with this parameter. This overrides any integrationId provided in the url parameter.

Supported Schema

Currently, only the following URL schema is supported:

https://exchange.glomex.com/[video|videos|playlist|playlists]/VIDEO_OR_PLAYLIST_ID?integrationId=INTEGRATION_ID

If the URL schema does not contain an integrationId, it must be passed as a separate parameter (see Request Parameters).

Response Structure

The service responds with a JSON object containing the following fields. View an example response .

Core Fields

FieldTypeDescriptionExample
versionStringoEmbed response version1.0
typeStringType of embed (always video)video
provider_nameStringoEmbed provider name (always glomex)glomex
provider_urlStringoEmbed provider URL (always https://www.glomex.com)https://www.glomex.com
cache_ageNumberSuggested cache lifetime for this resource, in seconds600
widthNumberMinimum pixel width required for the player embed300
heightNumberMinimum pixel height required for the player embed180
integration_idStringThe glomex integrationId40599v14k373ncc1
playlist_idStringThe glomex playlistIdcl-bbq3dnwtac01

Embed Code Fields

FieldTypeDescription
htmlStringHTML code needed to embed the glomex player, including the <script> tag
html_headStringAdditional resources that should be added to the HTML document’s <head>. Not present if no dependencies need to be added.
amphtmlStringAMPHTML code needed to embed the glomex player.
amphtml_headStringAdditional resources that should be added to the AMP document’s <head>. Note: Since AMP component dependencies must be declared in the <head>, these are mandatory if not already included.
scripthtmlStringHTML code using <script> tags for loading the integration. Used for ad server integrations and allows passback/ready function names.

Metadata Fields

FieldTypeDescriptionExample
titleStringVideo titleHerbstschuh-Trends 2021: Die Must-Haves der Saison
descriptionStringVideo descriptionOb Disco Boots, Chunky Loafers oder Cowboystiefel - wir zeigen euch, auf welche Schuhmodelle wir dieses Jahr nicht verzichten können und verraten euch, zu welchem Outfit man sie am besten kombiniert.
upload_dateStringUnix timestamp in milliseconds when this content was uploaded1634224066000
expiresStringUnix timestamp in milliseconds (absolute) after which this content will not be available9999999999000
durationNumberLength of the content in milliseconds72206
thumbnail_urlStringURL for the teaser/poster image. Note: Please link to this URL rather than downloading the image.https://i1thumbs.glomex.com/...
thumbnail_widthNumberWidth of the poster image in pixels960
thumbnail_heightNumberHeight of the poster image in pixels540
regions_allowedStringComma-separated ISO country codes where this content can be shown. Not present if there are no geo restrictions.DE,AT,CH
metadata_statusStringOptional. If looking up metadata times out or fails, this field is populated with a status message indicating the possible reason.timeout

Live Example

For a complete example response, visit:

https://embed.mes.glomex.cloud/oembed.json?url=https://exchange.glomex.com/videos/v-cf3gu8bjc361?integrationId=40599v14k373ncc1 

Last updated on