Site-wide SEO tags are the meta tags that apply to every page of a site, such as site verification tags, the default social share image, and whether search engines may index the site.
A site has exactly one set of site SEO tags. Tags that belong to a single page, such as titles and descriptions, are managed with the Item SEO Tags API, and the patterns that generate them with the SEO Patterns API.
Site verification tags that were added through the site's SEO settings in the dashboard, which stores them as HTML embeds rather than as site tags.
Returned so that a read reflects every verification tag on the site. These tags are
never included in tags. Empty when the site has none, and also when they can't be
retrieved.
Site ID.
Language the tags apply to.
Site SEO tags aren't language specific: one set of tags applies to every language version of a site. Currently always empty.
Site-wide tags that apply to every page of the site.
Supported tags:
og:image: Default social share image for the site.robots with a noindex or none directive: Stops search engines indexing the site.google-site-verification, msvalidate.01,
p:domain_verify, and yandex-verification. A site supports a single tag per
verification provider.name and content pair.Every tag above is of type meta. Tag.type also lists title, script, and
link as generally supported values, but none of those are accepted here. The
whole call is rejected and no tags are changed; the error code depends on which
part of the tag is invalid:
FIELD_NOT_ALLOWED: the tag's content is fine and only its type isn't allowed
at site level. For example, a well-formed script tag carrying structured data
(JSON-LD) intended for the whole site — there's no site-wide equivalent of that
today.INVALID_TAGS: the tag's content is also invalid, so it fails the shared tag
validation that runs first. For example, a script tag whose type property
isn't application/ld+json, or one carrying malformed JSON-LD.Tags that belong to a single page, such as titles, descriptions, canonical links, and per-page structured data, aren't site-wide. Set those with the Item SEO Tags API.