Collect the ID, URL, and name of your content

AI-generated Key Takeaways

Catalog entities require @id, url, and name properties.
The @id property must be a globally unique, static, and URI formatted identifier.
The url property is a canonical URL used by Google to reconcile content and must be globally unique and crawlable.
It is recommended to use an entity's url as its @id.

All the entities in your catalog require the following properties:

@id: A global identifier for the content.
url: A canonical URL for the content.
name: The name of the content.

Example of @id, url, and name:

"@id": "http://www.example.com/episode/video/432432432",
"url": "http://www.example.com/episode/video/432432432",
"name": "My example episode",

Identifier

An identifier (@id) must meet the following requirements:

Globally unique across your catalog
- For instance, don't use the same @id for a TVSeries and a TVSeason.
Static
- You cannot change @id later.
In the form of Unified Resource Identifier (URI)
- If your content's local identifier (ID) is not in a URI format, prepend your domain to the ID to satisfy this requirement; for example, if your content's ID is 1234abc and your domain is https://example.com, @id can be https://example.com/1234abc.
- @id does not have to be a working URL; it only needs to be in a URI format.
- The domain used in @id (for example, https://example.com) must be owned by your organization.

Because an entity's url meets all the requirements as an identifier (that is, globally unique, static, and in the form of a URI), we recommend you use an entity's url as @id.

Canonical URL

A canonical URL (url) helps Google accurately reconcile the content in your catalog with the content in Google's databases.

"A canonical URL is the URL of the page that Google thinks is most representative from a set of duplicate pages on your site. For example, if you have URLs for the same page (for example: example.com?dress=1234 and example.com/dresses/1234), Google chooses one as canonical." (Source: Consolidate duplicate URLs)

The following are the requirements for the canonical URL:

url must be globally unique.
url must contain a working canonical URL that Google can crawl.
(Listen Actions only) url needs to point to a content description page that is not blocked by a paywall.