Using @IDs to Merge Editor Markup with Markup from Other Sources

A URI is a string of characters that identifies a resource. It provides a consistent way to identify resources across different systems and protocols. All data items generated by Schema App have a URI so that they can be easily referenced and incorporated into a knowledge graph.

You can use this feature to your advantage to author and nest highly precise Editor markup with scalable tools such as the Highlighter, Shopify, and possibly other sources of schema markup. This support document describes how to author an Editor data item and merge it with another block of Schema Markup. 

TABLE OF CONTENTS

• How to Nest an Editor Data Item Within Another Block of JSON-LD
  • Test the live URL in the Validator to capture information about the parent entity
  • Create a data item in the Editor with the same Type and URI as the parent entity
  • Remove the "name" property and leave it blank.
  • Navigate to the property you'll be using to nest your Editor data item within the parent entity
  • Create the Data Item you want to nest 

How to Nest an Editor Data Item Within Another Block of JSON-LD

This section describes how to create a data item that will nest within another block of JSON-LD. An example of where this might be useful is adding entity linking, or specifying the shipping policy for auto-generated Product markup.

Test the live URL in the Validator to capture information about the parent entity

The parent entity is the one that we will nest the Editor data item within. It is important to capture the following information:

1. The Type of the parent entity
2. The URI or @id of the parent entity

Create a data item in the Editor with the same Type and URI as the parent entity

To create the data item you will need to select a name but you will be removing it in the following step to ensure mapping happens successfully.

Remove the "name" property and leave it blank.

This is done because all attributes need to match for the data items to merge correctly. Rather than copying the Parent Entity name, and hoping it doesn't change, we can simply omit this information for improved flexibility and future proofing.

Navigate to the property you'll be using to nest your Editor data item within the parent entity

In this example, we want to add an entity to an Article using "mentions" property.

Create the Data Item you want to nest 

Follow the typical process for adding a Data Item and fill out all the relevant fields.

Note: If the Data Item already exists, you can simply link it. However, be aware of the 3 Hops Rule. If the URI of the data item does not match the URL of the page, it may not be pulled in if the connection is nested more than 3 levels deep.

Review the live URL to confirm that the Editor Data Item is being nested appropriately

Use strategies described in this support document to avoid caching.