feat(jsonld): adds keywords for SoftwareApp schema (#1290)

garmeeh · Oct 28, 2023 · e5e571c · e5e571c
1 parent d403076
commit e5e571c
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -3114,6 +3114,7 @@ export default () => (
       aggregateRating={{ ratingValue: '4.6', reviewCount: '8864' }}
       operatingSystem="ANDROID"
       applicationCategory="GameApplication"
+      keywords="angrybirds, arcade, slingshot"
     />
   </>
 );
@@ -3139,7 +3140,13 @@ export default () => (
 | `operatingSystem`     | The operating System supported by the game it self. |
 | `applicationCategory` | Desktop Software or Video Game...                   |
 
-For reference and more info check [Google docs for Software App](https://developers.google.com/search/docs/data-types/software-app)
+**Data other properties**
+
+| Property   | Info                                                                                                                   |
+| ---------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `keywords` | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
+
+For reference and more info check [Google docs for Software App](https://developers.google.com/search/docs/data-types/software-app) and [Schema.org docs](https://schema.org/SoftwareApplication)
 
 ### Organization
 

diff --git a/cypress/e2e/softwareApp.spec.js b/cypress/e2e/softwareApp.spec.js
@@ -30,6 +30,7 @@ describe('SoftwareApp JSON-LD', () => {
           price: '1.00',
           priceCurrency: 'USD',
         },
+        keywords: 'angrybirds, arcade, slingshot',
       });
     });
   });

diff --git a/cypress/schemas/software-app-schema.js b/cypress/schemas/software-app-schema.js
@@ -52,6 +52,9 @@ const softwareApp100 = {
           },
         },
       },
+      keywords: {
+        type: 'string',
+      },
     },
   },
   example: {
@@ -70,6 +73,7 @@ const softwareApp100 = {
       price: '1.00',
       priceCurrency: 'USD',
     },
+    keywords: 'angrybirds, arcade, slingshot',
   },
 };
 

diff --git a/e2e/pages/jsonld/softwareApp.tsx b/e2e/pages/jsonld/softwareApp.tsx
@@ -12,6 +12,7 @@ function SoftwareApp() {
         aggregateRating={{ ratingValue: '4.6', ratingCount: '8864' }}
         operatingSystem="ANDROID"
         applicationCategory="GameApplication"
+        keywords="angrybirds, arcade, slingshot"
       />
     </>
   );

diff --git a/src/jsonld/softwareApp.tsx b/src/jsonld/softwareApp.tsx
@@ -13,6 +13,7 @@ export interface SoftwareAppJsonLdProps extends JsonLdProps {
   operatingSystem?: string;
   review?: Review;
   aggregateRating?: AggregateRating;
+  keywords?: string;
 }
 
 function SoftwareAppJsonLd({
@@ -22,6 +23,7 @@ function SoftwareAppJsonLd({
   price,
   aggregateRating,
   review,
+  keywords,
   ...rest
 }: SoftwareAppJsonLdProps) {
   const data = {
@@ -33,6 +35,7 @@ function SoftwareAppJsonLd({
     },
     aggregateRating: setAggregateRating(aggregateRating),
     review: setReviews(review),
+    keywords,
   };
   return (
     <JsonLd