Add Video JSON-LD (#547)

garmeeh · Oct 31, 2020 · efb5f60 · efb5f60
1 parent e2e7aad
commit efb5f60
Show file tree

Hide file tree

Showing 37 changed files with 299 additions and 112 deletions.
diff --git a/README.md b/README.md
@@ -1020,7 +1020,20 @@ const Page = () => (
           'https://example.com/photos/16x9/photo.jpg',
         ],
         expires: '2019-02-05T08:00:00+08:00',
+        hasPart: {
+          '@type': 'Clip',
+          name: 'Preheat oven',
+          startOffset: 30,
+          url: 'http://www.example.com/example?t=30',
+        },
         watchCount: 2347,
+        publication: {
+          '@type': 'BroadcastEvent',
+          isLiveBroadcast: true,
+          startDate: '2020-10-24T14:00:00+00:00',
+          endDate: '2020-10-24T14:37:14+00:00',
+        },
+        regionsAllowed: ['IT', 'NL'],
       }}
     />
   </>
@@ -1432,8 +1445,8 @@ const Page = () => (
           price: '119.99',
           priceCurrency: 'USD',
           priceValidUntil: '2020-11-05',
-          itemCondition: 'http://schema.org/UsedCondition',
-          availability: 'http://schema.org/InStock',
+          itemCondition: 'https://schema.org/UsedCondition',
+          availability: 'https://schema.org/InStock',
           url: 'https://www.example.com/executive-anvil',
           seller: {
             name: 'Executive Objects',
@@ -1443,8 +1456,8 @@ const Page = () => (
           price: '139.99',
           priceCurrency: 'CAD',
           priceValidUntil: '2020-09-05',
-          itemCondition: 'http://schema.org/UsedCondition',
-          availability: 'http://schema.org/InStock',
+          itemCondition: 'https://schema.org/UsedCondition',
+          availability: 'https://schema.org/InStock',
           url: 'https://www.example.ca/executive-anvil',
           seller: {
             name: 'Executive Objects',
@@ -1580,6 +1593,67 @@ export default Page;
 
 [Google Docs for Social Profile](https://developers.google.com/search/docs/data-types/social-profile)
 
+### Video
+
+```jsx
+import { VideoJsonLd } from 'next-seo';
+
+const Page = () => (
+  <>
+    <h1>Video JSON-LD</h1>
+    <VideoJsonLd
+      name="How to make a Party Coffee Cake"
+      description="This is how you make a Party Coffee Cake."
+      contentUrl="http://www.example.com/video123.mp4"
+      embedUrl="http://www.example.com/videoplayer?video=123"
+      uploadDate="2018-02-05T08:00:00+08:00"
+      duration="PT1M33S"
+      thumbnailUrls={[
+        'https://example.com/photos/1x1/photo.jpg',
+        'https://example.com/photos/4x3/photo.jpg',
+        'https://example.com/photos/16x9/photo.jpg',
+      ]}
+      expires="2019-02-05T08:00:00+08:00"
+      hasPart={{
+        name: 'Preheat oven',
+        startOffset: 30,
+        url: 'http://www.example.com/example?t=30',
+      }}
+      watchCount={2347}
+      publication={{
+        isLiveBroadcast: true,
+        startDate: '2020-10-24T14:00:00+00:00',
+        endDate: '2020-10-24T14:37:14+00:00',
+      }}
+      regionsAllowed={['IT', 'NL']}
+    />
+  </>
+);
+
+export default Page;
+```
+
+**Required properties**
+
+| Property       | Info                                                        |
+| -------------- | ----------------------------------------------------------- |
+| `name`         | The title of the video.                                     |
+| `description`  | The description of the video. HTML tags are ignored.        |
+| `thumbnailUrl` | A URL pointing to the video thumbnail image file.           |
+| `uploadDate`   | The date the video was first published, in ISO 8601 format. |
+
+**Recommended properties**
+
+| Property               | Info                                                                                     |
+| ---------------------- | ---------------------------------------------------------------------------------------- |
+| `contentUrl`           | A URL pointing to the actual video media file, in one of the supported encoding formats. |
+| `duration`             | The duration of the video in ISO 8601 format                                             |
+| `embedUrl`             | A URL pointing to a player for the specific video.                                       |
+| `expires`              | If applicable, the date after which the video will no longer be available.               |
+| `interactionStatistic` | The number of times the video has been watched.                                          |
+| `publication`          | If your video is happening live and you want to be eligible for the LIVE badge.          |
+| `regionsAllowed`       | The regions where the video is allowed.                                                  |
+
 ### Event
 
 ```jsx

diff --git a/cypress/e2e/jsonld.spec.js b/cypress/e2e/jsonld.spec.js
@@ -38,7 +38,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[articleLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org',
+          '@context': 'https://schema.org',
           '@type': 'Article',
           mainEntityOfPage: {
             '@type': 'WebPage',
@@ -92,7 +92,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[breadcrumbLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org',
+          '@context': 'https://schema.org',
           '@type': 'BreadcrumbList',
           itemListElement: [
             {
@@ -150,7 +150,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[blogLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org',
+          '@context': 'https://schema.org',
           '@type': 'Blog',
           mainEntityOfPage: {
             '@type': 'WebPage',
@@ -190,7 +190,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[courseLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org',
+          '@context': 'https://schema.org',
           '@type': 'Course',
           name: 'Course Name',
           description: 'Course description goes right here',
@@ -220,7 +220,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[localBusinessLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org',
+          '@context': 'https://schema.org',
           '@type': 'Store',
           '@id': 'http://davesdeptstore.example.com',
           name: "Dave's Department Store",
@@ -313,7 +313,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[productLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org/',
+          '@context': 'https://schema.org/',
           '@type': 'Product',
           name: 'Executive Anvil',
           image: [
@@ -362,8 +362,8 @@ describe('Validates JSON-LD For:', () => {
               price: '119.99',
               priceCurrency: 'USD',
               priceValidUntil: '2020-11-05',
-              itemCondition: 'http://schema.org/UsedCondition',
-              availability: 'http://schema.org/InStock',
+              itemCondition: 'https://schema.org/UsedCondition',
+              availability: 'https://schema.org/InStock',
               url: 'https://www.example.com/executive-anvil',
               seller: {
                 '@type': 'Organization',
@@ -375,8 +375,8 @@ describe('Validates JSON-LD For:', () => {
               price: '139.99',
               priceCurrency: 'CAD',
               priceValidUntil: '2020-09-05',
-              itemCondition: 'http://schema.org/UsedCondition',
-              availability: 'http://schema.org/InStock',
+              itemCondition: 'https://schema.org/UsedCondition',
+              availability: 'https://schema.org/InStock',
               url: 'https://www.example.ca/executive-anvil',
               seller: {
                 '@type': 'Organization',
@@ -405,7 +405,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[socialProfileLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org',
+          '@context': 'https://schema.org',
           '@type': 'Person',
           name: 'your name',
           url: 'http://www.your-site.com',
@@ -485,7 +485,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[newsarticleLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org',
+          '@context': 'https://schema.org',
           '@type': 'NewsArticle',
           mainEntityOfPage: {
             '@type': 'WebPage',
@@ -538,7 +538,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[faqPageLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org/',
+          '@context': 'https://schema.org/',
           '@type': 'FAQPage',
           mainEntity: [
             {
@@ -579,7 +579,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[jobPostingLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org',
+          '@context': 'https://schema.org',
           '@type': 'JobPosting',
 
           baseSalary: {
@@ -641,7 +641,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[eventLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org',
+          '@context': 'https://schema.org',
           '@type': 'Event',
           name: 'My Event',
           startDate: '2020-01-23T00:00:00.000Z',
@@ -683,7 +683,7 @@ describe('Validates JSON-LD For:', () => {
       .then(tags => {
         const jsonLD = JSON.parse(tags[datasetLdJsonIndex].innerHTML);
         expect(jsonLD).to.deep.equal({
-          '@context': 'http://schema.org',
+          '@context': 'https://schema.org',
           '@type': 'Dataset',
           description:
             'The description needs to be at least 50 characters long',
@@ -780,7 +780,7 @@ describe('Validates JSON-LD For:', () => {
             duration: 'PT1M33S',
             interactionStatistic: {
               '@type': 'InteractionCounter',
-              interactionType: { '@type': 'http://schema.org/WatchAction' },
+              interactionType: { '@type': 'https://schema.org/WatchAction' },
               userInteractionCount: 2347,
             },
             expires: '2019-02-05T08:00:00+08:00',
@@ -831,7 +831,7 @@ describe('Validates JSON-LD For:', () => {
               '@type': 'ListItem',
               position: '1',
               item: {
-                '@context': 'http://schema.org',
+                '@context': 'https://schema.org',
                 '@type': 'Course',
                 url: 'http://example.com/course-1.html',
                 name: 'Course 1',
@@ -846,7 +846,7 @@ describe('Validates JSON-LD For:', () => {
               '@type': 'ListItem',
               position: '2',
               item: {
-                '@context': 'http://schema.org',
+                '@context': 'https://schema.org',
                 '@type': 'Course',
                 url: 'http://example.com/course-2.html',
                 name: 'Course 2',
@@ -878,7 +878,7 @@ describe('Validates JSON-LD For:', () => {
               '@type': 'ListItem',
               position: '1',
               item: {
-                '@context': 'http://schema.org',
+                '@context': 'https://schema.org',
                 '@type': 'Movie',
                 name: 'Movie 1',
                 url: 'http://example.com/movie-1.html',
@@ -898,7 +898,7 @@ describe('Validates JSON-LD For:', () => {
               '@type': 'ListItem',
               position: '2',
               item: {
-                '@context': 'http://schema.org',
+                '@context': 'https://schema.org',
                 '@type': 'Movie',
                 name: 'Movie 2',
                 url: 'http://example.com/movie-1.html',

diff --git a/cypress/schemas/article-schema.js b/cypress/schemas/article-schema.js
@@ -179,7 +179,7 @@ const article100 = {
     additionalProperties: false,
   },
   example: {
-    '@context': 'http://schema.org',
+    '@context': 'https://schema.org',
     '@type': 'Article',
     mainEntityOfPage: {
       '@type': 'WebPage',

diff --git a/cypress/schemas/blog-schema.js b/cypress/schemas/blog-schema.js
@@ -111,7 +111,7 @@ const blog100 = {
     additionalProperties: false,
   },
   example: {
-    '@context': 'http://schema.org',
+    '@context': 'https://schema.org',
     '@type': 'Blog',
     mainEntityOfPage: {
       '@type': 'WebPage',

diff --git a/cypress/schemas/breadcrumb-schema.js b/cypress/schemas/breadcrumb-schema.js
@@ -53,7 +53,7 @@ const breadcrumb100 = {
     additionalProperties: false,
   },
   example: {
-    '@context': 'http://schema.org',
+    '@context': 'https://schema.org',
     '@type': 'BreadcrumbList',
     itemListElement: [
       {

diff --git a/cypress/schemas/common.js b/cypress/schemas/common.js
@@ -138,8 +138,8 @@ export const offers100 = {
       priceCurrency: 'USD',
       price: '119.99',
       priceValidUntil: '2020-11-05',
-      itemCondition: 'http://schema.org/UsedCondition',
-      availability: 'http://schema.org/InStock',
+      itemCondition: 'https://schema.org/UsedCondition',
+      availability: 'https://schema.org/InStock',
       seller: {
         '@type': 'Organization',
         name: 'Executive Objects',
@@ -203,8 +203,8 @@ export const offers101 = {
       priceCurrency: 'USD',
       price: '119.99',
       priceValidUntil: '2020-11-05',
-      itemCondition: 'http://schema.org/UsedCondition',
-      availability: 'http://schema.org/InStock',
+      itemCondition: 'https://schema.org/UsedCondition',
+      availability: 'https://schema.org/InStock',
       seller: {
         '@type': 'Organization',
         name: 'Executive Objects',

diff --git a/cypress/schemas/course-schema.js b/cypress/schemas/course-schema.js
@@ -70,7 +70,7 @@ const course100 = {
     additionalProperties: false,
   },
   example: {
-    '@context': 'http://schema.org',
+    '@context': 'https://schema.org',
     '@type': 'Course',
     name: 'Course Name',
     description: 'Introductory CS course laying out the basics.',

diff --git a/cypress/schemas/dataset-schema.js b/cypress/schemas/dataset-schema.js
@@ -36,7 +36,7 @@ const dataset100 = {
     additionalProperties: false,
   },
   example: {
-    '@context': 'http://schema.org',
+    '@context': 'https://schema.org',
     '@type': 'Dataset',
     description: 'The description needs to be at least 50 characters long',
     name: 'name of the dataset',

diff --git a/cypress/schemas/event-schema.js b/cypress/schemas/event-schema.js
@@ -66,7 +66,7 @@ const event100 = {
     },
   },
   example: {
-    '@context': 'http://schema.org',
+    '@context': 'https://schema.org',
     '@type': 'Event',
     name: 'My event',
     startDate: '2020-01-23T00:00:00.000Z',

diff --git a/cypress/schemas/faq-page-schema.js b/cypress/schemas/faq-page-schema.js
@@ -54,7 +54,7 @@ const faqPage100 = {
     required: true,
   },
   example: {
-    '@context': 'http://schema.org',
+    '@context': 'https://schema.org',
     '@type': 'FAQ Page',
     mainEntity: [
       {

diff --git a/cypress/schemas/job-posting-schema.js b/cypress/schemas/job-posting-schema.js
@@ -275,7 +275,7 @@ const jobPosting100 = {
     required: true,
     additionalProperties: false,
     example: {
-      '@context': 'http://schema.org',
+      '@context': 'https://schema.org',
       '@type': 'JobPosting',
 
       baseSalary: {

diff --git a/cypress/schemas/local-business-schema.js b/cypress/schemas/local-business-schema.js
@@ -126,7 +126,7 @@ const localBusiness110 = {
     additionalProperties: false,
   },
   example: {
-    '@context': 'http://schema.org',
+    '@context': 'https://schema.org',
     '@type': 'Store',
     image: [
       'https://example.com/photos/1x1/photo.jpg',

diff --git a/cypress/schemas/logo-schema.js b/cypress/schemas/logo-schema.js
@@ -33,7 +33,7 @@ const logo100 = {
     additionalProperties: false,
   },
   example: {
-    '@context': 'http://schema.org',
+    '@context': 'https://schema.org',
     '@type': 'Organization',
     url: 'http://www.example.com',
     logo: 'http://www.example.com/images/logo.png',