View Settings
Settings overridden for one view, addressed by their dotted path, plus setting_descriptors — the registry of paths that may be overridden at all.
List setting_descriptors
The registry of setting paths the platform knows about, and which of them may be overridden per view. It is read-only and it is not website-scoped: the paths come from the platform and its features, not from a tenant, which is exactly why a client cannot invent one by writing to settings.
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: path asc. Sortable: path.
filterAIP-160 subset (§8). Filterable: path, view_overridable. A field outside the list is INVALID_ARGUMENT.
List setting_descriptors › Responses
One page of setting_descriptors.
This page of setting_descriptors, 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.
List settings
One setting overridden for one view. Same shape as the website-wide collection and the same upsert rule — PATCH on a path never written for this view creates the override — with two differences: the path must be one setting_descriptors marks view_overridable, and deleting the resource removes the override rather than the setting — the view goes back to the website-wide value.
path Parameters
website_idId of the parent website.
view_idThe view this override belongs to. Fixed by the URL.
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: path asc. Sortable: create_time, path.
filterAIP-160 subset (§8). Filterable: create_time, path, view_id. A field outside the list is INVALID_ARGUMENT.
List settings › Responses
One page of settings.
This page of settings, 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.
Get setting
One setting overridden for one view. Same shape as the website-wide collection and the same upsert rule — PATCH on a path never written for this view creates the override — with two differences: the path must be one setting_descriptors marks view_overridable, and deleting the resource removes the override rather than the setting — the view goes back to the website-wide value.
path Parameters
website_idId of the parent website.
view_idThe view this override belongs to. Fixed by the URL.
pathThe setting's dotted path, which is also its id. Only a path whose setting_descriptors entry says view_overridable may be written here.
Headers
If-None-MatchA matching etag answers 304 with no body (§16).
Get setting › 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).
pathThe setting's dotted path, which is also its id. Only a path whose setting_descriptors entry says view_overridable may be written here.
view_idThe view this override belongs to. Fixed by the URL.
valueThe value this view uses instead of the website-wide one. Any JSON, whichever shape the setting is defined to hold.
Delete setting
One setting overridden for one view. Same shape as the website-wide collection and the same upsert rule — PATCH on a path never written for this view creates the override — with two differences: the path must be one setting_descriptors marks view_overridable, and deleting the resource removes the override rather than the setting — the view goes back to the website-wide value.
path Parameters
website_idId of the parent website.
view_idThe view this override belongs to. Fixed by the URL.
pathThe setting's dotted path, which is also its id. Only a path whose setting_descriptors entry says view_overridable may be written here.
Headers
If-MatchThe etag the client last read. A mismatch is ABORTED (409) with the current resource in the error details (§14).
Delete setting › Responses
Deleted. No body (§7).
Update setting
One setting overridden for one view. Same shape as the website-wide collection and the same upsert rule — PATCH on a path never written for this view creates the override — with two differences: the path must be one setting_descriptors marks view_overridable, and deleting the resource removes the override rather than the setting — the view goes back to the website-wide value.
path Parameters
website_idId of the parent website.
view_idThe view this override belongs to. Fixed by the URL.
pathThe setting's dotted path, which is also its id. Only a path whose setting_descriptors entry says view_overridable may be written here.
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 setting › Request Body
valueThe value this view uses instead of the website-wide one. Any JSON, whichever shape the setting is defined to hold.
Update setting › 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).
pathThe setting's dotted path, which is also its id. Only a path whose setting_descriptors entry says view_overridable may be written here.
view_idThe view this override belongs to. Fixed by the URL.
valueThe value this view uses instead of the website-wide one. Any JSON, whichever shape the setting is defined to hold.
Batch update (settings)
Writes many per-view overrides in one atomic call: every value lands or none does. A path that is not marked view_overridable rejects the whole request rather than being skipped.
path Parameters
website_idId of the parent website.
view_idId of the parent view.
Batch update (settings) › Request Body optional
Batch update (settings) › Responses
The affected resource, or the method’s own response object (§10).