Website Settings
Website-wide settings, addressed by their dotted path. :batch_update writes many of them atomically.
List settings
One website-wide setting, addressed by its dotted path. Two things about this collection are worth knowing before you write to it: the id is the path, and there is no Create — the platform decides which paths exist, so PATCH on a path never written before creates it. :batch_update writes many at once, which is what a settings screen should send instead of a burst of single writes.
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: 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 website-wide setting, addressed by its dotted path. Two things about this collection are worth knowing before you write to it: the id is the path, and there is no Create — the platform decides which paths exist, so PATCH on a path never written before creates it. :batch_update writes many at once, which is what a settings screen should send instead of a burst of single writes.
path Parameters
website_idId of the parent website.
pathThe setting's dotted path, which is also its id — general.info.site_name, appearance.theme.default_theme. Which paths exist is decided by the platform, so a write cannot invent one and cannot move one.
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 — general.info.site_name, appearance.theme.default_theme. Which paths exist is decided by the platform, so a write cannot invent one and cannot move one.
view_idEmpty on this collection: these are the website-wide values. A value overridden for one view is a resource of websites/{website}/views/{view}/settings, and carries that view there.
valueThe setting's value — any JSON: a string, a number, a boolean, an object or an array, whichever the setting is defined to hold.
Delete setting
One website-wide setting, addressed by its dotted path. Two things about this collection are worth knowing before you write to it: the id is the path, and there is no Create — the platform decides which paths exist, so PATCH on a path never written before creates it. :batch_update writes many at once, which is what a settings screen should send instead of a burst of single writes.
path Parameters
website_idId of the parent website.
pathThe setting's dotted path, which is also its id — general.info.site_name, appearance.theme.default_theme. Which paths exist is decided by the platform, so a write cannot invent one and cannot move one.
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 website-wide setting, addressed by its dotted path. Two things about this collection are worth knowing before you write to it: the id is the path, and there is no Create — the platform decides which paths exist, so PATCH on a path never written before creates it. :batch_update writes many at once, which is what a settings screen should send instead of a burst of single writes.
path Parameters
website_idId of the parent website.
pathThe setting's dotted path, which is also its id — general.info.site_name, appearance.theme.default_theme. Which paths exist is decided by the platform, so a write cannot invent one and cannot move one.
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 setting's value — any JSON: a string, a number, a boolean, an object or an array, whichever 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 — general.info.site_name, appearance.theme.default_theme. Which paths exist is decided by the platform, so a write cannot invent one and cannot move one.
view_idEmpty on this collection: these are the website-wide values. A value overridden for one view is a resource of websites/{website}/views/{view}/settings, and carries that view there.
valueThe setting's value — any JSON: a string, a number, a boolean, an object or an array, whichever the setting is defined to hold.
Batch update (settings)
Writes many settings in one atomic call: every value lands or none does. This is what a settings screen should send instead of a burst of single PATCHes — a half-applied screen is a site configured in a state nobody chose.
path Parameters
website_idId of the parent website.
Batch update (settings) › Request Body optional
Batch update (settings) › Responses
The affected resource, or the method’s own response object (§10).