A view is one presentation of a website — its locale, its URL prefix and its fallback. Content carries a per-view overlay, and settings can be overridden per view.
List views
One presentation of the website — in practice, one language: its locale, its URL prefix, its place in the switcher and its fallback. A view is not a copy of the site: content stays one resource and carries a per-view overlay, and settings can be overridden per view. Everything a visitor sees is decided by the view their URL resolved to.
path Parameters
website_idId of the parent website.
query Parameters
page_sizeRows per page. Over the maximum is clamped, not rejected.
page_tokenOpaque token from a previous next_page_token. A token minted under a different order_by/filter is rejected.
skipRows to skip before the page (AIP-158). skip + page_size is capped at 10000; beyond that is OUT_OF_RANGE.
order_byComma-separated field [asc|desc], at most 3 keys. Default: create_time desc. Sortable: code, create_time.
filterAIP-160 subset (§8). Filterable: code, create_time, fallback_view_id, is_active, locale, path_prefix. A field outside the list is INVALID_ARGUMENT.
List views › Responses
One page of views.
This page of views, in the requested order.
next_page_tokenOpaque. Absent or empty means this was the last page.
total_sizeRows in the whole filtered collection, not in this page.
Create view
One presentation of the website — in practice, one language: its locale, its URL prefix, its place in the switcher and its fallback. A view is not a copy of the site: content stays one resource and carries a per-view overlay, and settings can be overridden per view. Everything a visitor sees is decided by the view their URL resolved to.
path Parameters
website_idId of the parent website.
Create view › Request Body
codeThe view's handle, unique on the website. Content overlays and view-scoped settings are addressed by the view, so this is the name a person uses for it.
is_activeWhether the view is served. Switching it off takes one language off the site without deleting anything written for it.
display_nameThe label the visitor-facing language switcher shows — the language's own name ("Deutsch"), not a translation of it.
localeThe language this view renders in, as a BCP 47 tag. It picks the interface translations and the date and number formats.
path_prefixThe first URL segment that routes to this view (/de/...). Empty means this view answers at the bare root — at most one view per website may.
sort_orderThe view's position in the language switcher.
fallback_view_idThe view to fall back to when this one has nothing of its own to show for a page.
Create view › Responses
The created resource.
nameThe resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
create_timeWhen the resource was created (RFC 3339, UTC).
update_timeWhen the resource last changed (RFC 3339, UTC).
etagVersion of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).
codeThe view's handle, unique on the website. Content overlays and view-scoped settings are addressed by the view, so this is the name a person uses for it.
display_nameThe label the visitor-facing language switcher shows — the language's own name ("Deutsch"), not a translation of it.
is_activeWhether the view is served. Switching it off takes one language off the site without deleting anything written for it.
localeThe language this view renders in, as a BCP 47 tag. It picks the interface translations and the date and number formats.
path_prefixThe first URL segment that routes to this view (/de/...). Empty means this view answers at the bare root — at most one view per website may.
sort_orderThe view's position in the language switcher.
fallback_view_idThe view to fall back to when this one has nothing of its own to show for a page.
Get view
One presentation of the website — in practice, one language: its locale, its URL prefix, its place in the switcher and its fallback. A view is not a copy of the site: content stays one resource and carries a per-view overlay, and settings can be overridden per view. Everything a visitor sees is decided by the view their URL resolved to.
path Parameters
website_idId of the parent website.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
Headers
If-None-MatchA matching etag answers 304 with no body (§16).
Get view › Responses
The resource.
nameThe resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
create_timeWhen the resource was created (RFC 3339, UTC).
update_timeWhen the resource last changed (RFC 3339, UTC).
etagVersion of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).
codeThe view's handle, unique on the website. Content overlays and view-scoped settings are addressed by the view, so this is the name a person uses for it.
display_nameThe label the visitor-facing language switcher shows — the language's own name ("Deutsch"), not a translation of it.
is_activeWhether the view is served. Switching it off takes one language off the site without deleting anything written for it.
localeThe language this view renders in, as a BCP 47 tag. It picks the interface translations and the date and number formats.
path_prefixThe first URL segment that routes to this view (/de/...). Empty means this view answers at the bare root — at most one view per website may.
sort_orderThe view's position in the language switcher.
fallback_view_idThe view to fall back to when this one has nothing of its own to show for a page.
Delete view
One presentation of the website — in practice, one language: its locale, its URL prefix, its place in the switcher and its fallback. A view is not a copy of the site: content stays one resource and carries a per-view overlay, and settings can be overridden per view. Everything a visitor sees is decided by the view their URL resolved to.
path Parameters
website_idId of the parent website.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
Headers
If-MatchThe etag the client last read. A mismatch is ABORTED (409) with the current resource in the error details (§14).
Delete view › Responses
Deleted. No body (§7).
Update view
One presentation of the website — in practice, one language: its locale, its URL prefix, its place in the switcher and its fallback. A view is not a copy of the site: content stays one resource and carries a per-view overlay, and settings can be overridden per view. Everything a visitor sees is decided by the view their URL resolved to.
path Parameters
website_idId of the parent website.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
query Parameters
update_maskComma-separated field paths to merge. A field named here and sent as null is cleared; without the mask a null is dropped (§7, §11).
Headers
If-MatchThe etag the client last read. A mismatch is ABORTED (409) with the current resource in the error details (§14).
Update view › Request Body
codeThe view's handle, unique on the website. Content overlays and view-scoped settings are addressed by the view, so this is the name a person uses for it.
display_nameThe label the visitor-facing language switcher shows — the language's own name ("Deutsch"), not a translation of it.
is_activeWhether the view is served. Switching it off takes one language off the site without deleting anything written for it.
localeThe language this view renders in, as a BCP 47 tag. It picks the interface translations and the date and number formats.
path_prefixThe first URL segment that routes to this view (/de/...). Empty means this view answers at the bare root — at most one view per website may.
sort_orderThe view's position in the language switcher.
fallback_view_idThe view to fall back to when this one has nothing of its own to show for a page.
Update view › Responses
The updated resource.
nameThe resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
create_timeWhen the resource was created (RFC 3339, UTC).
update_timeWhen the resource last changed (RFC 3339, UTC).
etagVersion of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).
codeThe view's handle, unique on the website. Content overlays and view-scoped settings are addressed by the view, so this is the name a person uses for it.
display_nameThe label the visitor-facing language switcher shows — the language's own name ("Deutsch"), not a translation of it.
is_activeWhether the view is served. Switching it off takes one language off the site without deleting anything written for it.
localeThe language this view renders in, as a BCP 47 tag. It picks the interface translations and the date and number formats.
path_prefixThe first URL segment that routes to this view (/de/...). Empty means this view answers at the bare root — at most one view per website may.
sort_orderThe view's position in the language switcher.
fallback_view_idThe view to fall back to when this one has nothing of its own to show for a page.