rhenshaw56
commented
4 years ago To achieve this, we would need to make slight modifications to the media player metadata helper.
Basically, a single metadata object for each piece of matching audio/video content on a page would need to be returned from that helper, assuming there are multiple audio/video contents.
For each metadata object returned, we also need to set a property of '@context': 'http://schema.org', to ensure that it is picked up as a valid schema.org schema (see more...), since it will be a single JSON-LD object.
Returning a valid AudioObject/VideoObject ensures we don't have to set the @listContent property like we currently do as these gets aggregated and distinguished by the validation tool.
In a nut shell, the change to the helper would be like the snippet below:
const mediaPlayerMetadata = blocks => {
const aresMediaBlocks = pathOr(null, ['model', 'blocks'], blocks);
if (!aresMediaBlocks || aresMediaBlocks.length < 1) {
return null;
}
const aresMetadataBlocks = aresMediaBlocks.filter(
block => block.type === 'aresMediaMetadata',
);
const metadataBlock = aresMetadataBlocks[0];
const format = pathOr(null, ['model', 'format'], metadataBlock);
const type = format === 'audio' ? 'AudioObject' : 'VideoObject';
const metadata = {
'@context': 'http://schema.org',
'@type': type,
name: pathOr(null, ['model', 'title'], metadataBlock),
description: pathOr(null, ['model', 'synopses', 'short'], metadataBlock),
duration: pathOr(
null,
['model', 'versions', [0], 'duration'],
metadataBlock,
),
thumbnailUrl: getThumbnailUri(metadataBlock),
uploadDate: pathOr(
null,
['model', 'versions', [0], 'availableFrom'],
metadataBlock,
),
};
return metadata;
};making this change and using the tool to validate this page (http://localhost:7080/news/articles/c3wmq4d1y3wo), should give something that looks like this
We also need to make changes to most of the properties we're setting, as you can see, warnings/errors are shown when viewing the data for a VideoObject
Unfortunately, the duration and uploadDate properties from the aresmetadata data are given as numbers in seconds and would have to use a valid ISO 8601 date format which is in model.versions[0].durationISO8601.
Additional properties that would need to be added like contentURL and embedURL, we would need to pass the value of the embedSource generated here as a prop down to the Metadata component
jamesdonoh
simonsinclair
HarveyPeachey
12
Is your feature request related to a problem? Please describe. With the introduction of AV to the article page, we want to introduce video and audio-specific schema.org data in a attempt to make the metadata of these pages richer. This involves including VideoObject and AudioObject schema for article pages.
Describe the solution you'd like An article page with a media block should contain schema.org metadata that specifies the audio and/or video objects present on the page. If possible, we would like to distinguish between audio object and video object.
See Jira ticket/ask @lizcameron for more examples of the correct implementation of video object structured data.
Video object detail:
Audio object detail:
Following investigation, create issues to implement schema.org for video and audio player.
We will also want to identify testing requirements and any technical issues that we'll need to overcome to be able to implement AV structured data as described within this issue.
Off the back of this investigation, a developer will sit with business and a tester to discuss an appropriate way forward.
Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.
Testing notes
Additional context Add any other context or screenshots about the feature request here.