CMS Block View
The per-view overlay of one block: its content in that view.
List views
What one view says instead of the master block. A block has one field worth translating, so this is the smallest overlay in the API — but it works exactly like the others: optional fields, a fallback to the master, and overridden deciding which of them this view claims.
path Parameters
website_idId of the parent website.
block_idId of the parent block.
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: none — this collection serves its documented order only.
filterAIP-160 subset (§8). Filterable: none. 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
What one view says instead of the master block. A block has one field worth translating, so this is the smallest overlay in the API — but it works exactly like the others: optional fields, a fallback to the master, and overridden deciding which of them this view claims.
path Parameters
website_idId of the parent website.
block_idId of the parent block.
Create view › Request Body
overriddenThe names of the fields this view actually overrides — here, at most content. A field not listed falls back to the block.
contentThis view's rich-text body for the block.
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).
uidThe overlay's own storage id, kept for clients that stored it before the overlay had a resource name.
cms_block_idThe block this overlay belongs to. Fixed by the URL.
view_idThe view this overlay speaks for. Fixed by the URL.
overriddenThe names of the fields this view actually overrides — here, at most content. A field not listed falls back to the block.
contentThis view's rich-text body for the block.
Get view
What one view says instead of the master block. A block has one field worth translating, so this is the smallest overlay in the API — but it works exactly like the others: optional fields, a fallback to the master, and overridden deciding which of them this view claims.
path Parameters
website_idId of the parent website.
block_idId of the parent block.
view_idThe view this overlay speaks for. Fixed by the URL.
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).
uidThe overlay's own storage id, kept for clients that stored it before the overlay had a resource name.
cms_block_idThe block this overlay belongs to. Fixed by the URL.
view_idThe view this overlay speaks for. Fixed by the URL.
overriddenThe names of the fields this view actually overrides — here, at most content. A field not listed falls back to the block.
contentThis view's rich-text body for the block.
Delete view
What one view says instead of the master block. A block has one field worth translating, so this is the smallest overlay in the API — but it works exactly like the others: optional fields, a fallback to the master, and overridden deciding which of them this view claims.
path Parameters
website_idId of the parent website.
block_idId of the parent block.
view_idThe view this overlay speaks for. Fixed by the URL.
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
What one view says instead of the master block. A block has one field worth translating, so this is the smallest overlay in the API — but it works exactly like the others: optional fields, a fallback to the master, and overridden deciding which of them this view claims.
path Parameters
website_idId of the parent website.
block_idId of the parent block.
view_idThe view this overlay speaks for. Fixed by the URL.
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
overriddenThe names of the fields this view actually overrides — here, at most content. A field not listed falls back to the block.
contentThis view's rich-text body for the block.
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).
uidThe overlay's own storage id, kept for clients that stored it before the overlay had a resource name.
cms_block_idThe block this overlay belongs to. Fixed by the URL.
view_idThe view this overlay speaks for. Fixed by the URL.
overriddenThe names of the fields this view actually overrides — here, at most content. A field not listed falls back to the block.
contentThis view's rich-text body for the block.