Skip to content

Page metadata: theme data reference

Reading the data tables. Presence varies by page and state; this is not a requirement to populate every field.

Field Type Meaning Availability
viewModel.page object Page data; check child fields before use. When the parent is provided; check optional fields.
viewModel.page.alternateLinks array Prepared alternate links collection; may be empty. When the parent is provided; check optional fields.
viewModel.page.alternateLinks[].hreflang string Hreflang value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.alternateLinks[].isDefault boolean Whether default applies; use for display only. For each existing item; optional child fields depend on item type.
viewModel.page.alternateLinks[].url string Prepared url URL; use unchanged. For each existing item; optional child fields depend on item type.
viewModel.page.bodyClass string Body class value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.canonicalUrl string Prepared canonical URL; use unchanged. When the parent is provided; check optional fields.
viewModel.page.favicons array Prepared favicons collection; may be empty. When the parent is provided; check optional fields.
viewModel.page.favicons[].href string Href value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.favicons[].rel string Rel value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.favicons[].sizes string Sizes value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.favicons[].type string Type value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.languageIsoCode string Language iso code value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.metaDescription string Meta description value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.openGraph object Open graph data; check child fields before use. When the parent is provided; check optional fields.
viewModel.page.openGraph.alternateLocales array Prepared alternate locales collection; may be empty. When the parent is provided; check optional fields.
viewModel.page.openGraph.image object Image data; check child fields before use. When the parent is provided; check optional fields.
viewModel.page.openGraph.image.alt string Alt value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.openGraph.image.height number Height numeric value. When the parent is provided; check optional fields.
viewModel.page.openGraph.image.url string Prepared url URL; use unchanged. When the parent is provided; check optional fields.
viewModel.page.openGraph.image.width number Width numeric value. When the parent is provided; check optional fields.
viewModel.page.openGraph.locale string Locale value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.openGraph.siteName string Site name value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.openGraph.title string Title value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.openGraph.type string Type value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.openGraph.url string Prepared url URL; use unchanged. When the parent is provided; check optional fields.
viewModel.page.robotsDirective string Robots directive value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.structuredData array Prepared structured data collection; may be empty. When the parent is provided; check optional fields.
viewModel.page.structuredData[].@context string @context value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].@type string @type value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].brand object Brand data; check child fields before use. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].brand.@type string @type value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].brand.name string Name value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].description string Description value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].image array Prepared image collection; may be empty. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].itemListElement array Prepared item list element collection; may be empty. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].itemListElement[].@type string @type value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].itemListElement[].item string Item value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].itemListElement[].name string Name value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].itemListElement[].position number Position numeric value. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].name string Name value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].offers object Offers data; check child fields before use. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].offers.@type string @type value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].offers.availability string Availability value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].offers.itemCondition string Item condition value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].offers.price string Price value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].offers.priceCurrency string Price currency value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].offers.url string Prepared url URL; use unchanged. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].potentialaction object Potentialaction data; check child fields before use. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].potentialaction.@type string @type value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].potentialaction.query-input string Query-input value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].potentialaction.target string Target value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].sku string Sku value supplied for this context. For each existing item; optional child fields depend on item type.
viewModel.page.structuredData[].url string Prepared url URL; use unchanged. For each existing item; optional child fields depend on item type.
viewModel.page.title string Title value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.twitterCard object Twitter card data; check child fields before use. When the parent is provided; check optional fields.
viewModel.page.twitterCard.card string Card value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.twitterCard.image string Image value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.twitterCard.imageAlt string Image alt value supplied for this context. When the parent is provided; check optional fields.
viewModel.page.twitterCard.title string Title value supplied for this context. When the parent is provided; check optional fields.