CMS Page Group
The versions of one page for customer groups: what a signed-in customer of the group reads instead of the page — a price, a condition, a hero. The group with the highest priority wins; everybody else reads the page.
List group_versions
What the customers of one group see of a page instead of the page itself: its text, its title, its hero — a price or a condition meant for them. A signed-in customer in several groups that each have a version sees the version of the group with the highest priority; everybody else, the page. A version is the same on every view, and never changes where the page lives or who may read it.
path Parameters
website_idId of the parent website.
page_idId of the parent page.
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: create_time.
filterAIP-160 subset (§8). Filterable: create_time, customer_group_id. A field outside the list is INVALID_ARGUMENT.
List group_versions › Responses
One page of group_versions.
This page of group_versions, 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 group_version
Adds a version of the page for one customer group of the website. customer_group_id is required and must name a group of the same website; a group that already has a version of the page answers ALREADY_EXISTS. Each name in overridden must be one of the fields a version can override.
path Parameters
website_idId of the parent website.
page_idId of the parent page.
Create group_version › Request Body
customer_group_idThe customer group this version is for — a group of the same website, one version per group on a page. Required on create and fixed afterwards.
overriddenThe names of the page fields this version replaces, out of title, content, meta_title, meta_description, meta_keywords, background_media_id and background_position. A field not listed here is the page's own.
titleThe group's title for the page. Not blank while title is overridden.
contentThe group's rich-text body for the page.
meta_titleThe group's <title> for the page.
meta_descriptionThe group's meta description for the page.
meta_keywordsThe group's meta keywords for the page.
background_media_idThe group's hero image for the page.
background_positionThe group's anchor for the hero image.
Create group_version › 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).
cms_page_idThe page this is a version of. Fixed by the URL.
customer_group_idThe customer group this version is for — a group of the same website, one version per group on a page. Required on create and fixed afterwards.
overriddenThe names of the page fields this version replaces, out of title, content, meta_title, meta_description, meta_keywords, background_media_id and background_position. A field not listed here is the page's own.
titleThe group's title for the page. Not blank while title is overridden.
contentThe group's rich-text body for the page.
meta_titleThe group's <title> for the page.
meta_descriptionThe group's meta description for the page.
meta_keywordsThe group's meta keywords for the page.
background_media_idThe group's hero image for the page.
background_positionThe group's anchor for the hero image.
Get group_version
What the customers of one group see of a page instead of the page itself: its text, its title, its hero — a price or a condition meant for them. A signed-in customer in several groups that each have a version sees the version of the group with the highest priority; everybody else, the page. A version is the same on every view, and never changes where the page lives or who may read it.
path Parameters
website_idId of the parent website.
page_idId of the parent page.
version_idId of the parent version.
Headers
If-None-MatchA matching etag answers 304 with no body (§16).
Get group_version › 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).
cms_page_idThe page this is a version of. Fixed by the URL.
customer_group_idThe customer group this version is for — a group of the same website, one version per group on a page. Required on create and fixed afterwards.
overriddenThe names of the page fields this version replaces, out of title, content, meta_title, meta_description, meta_keywords, background_media_id and background_position. A field not listed here is the page's own.
titleThe group's title for the page. Not blank while title is overridden.
contentThe group's rich-text body for the page.
meta_titleThe group's <title> for the page.
meta_descriptionThe group's meta description for the page.
meta_keywordsThe group's meta keywords for the page.
background_media_idThe group's hero image for the page.
background_positionThe group's anchor for the hero image.
Delete group_version
Deletes a version: the customers of its group see the page itself again.
path Parameters
website_idId of the parent website.
page_idId of the parent page.
version_idId of the parent version.
Headers
If-MatchThe etag the client last read. A mismatch is ABORTED (409) with the current resource in the error details (§14).
Delete group_version › Responses
Deleted. No body (§7).
Update group_version
Changes a version. customer_group_id is fixed and refused here; a version for another group is a new version.
path Parameters
website_idId of the parent website.
page_idId of the parent page.
version_idId of the parent version.
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 group_version › Request Body
overriddenThe names of the page fields this version replaces, out of title, content, meta_title, meta_description, meta_keywords, background_media_id and background_position. A field not listed here is the page's own.
titleThe group's title for the page. Not blank while title is overridden.
contentThe group's rich-text body for the page.
meta_titleThe group's <title> for the page.
meta_descriptionThe group's meta description for the page.
meta_keywordsThe group's meta keywords for the page.
background_media_idThe group's hero image for the page.
background_positionThe group's anchor for the hero image.
Update group_version › 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).
cms_page_idThe page this is a version of. Fixed by the URL.
customer_group_idThe customer group this version is for — a group of the same website, one version per group on a page. Required on create and fixed afterwards.
overriddenThe names of the page fields this version replaces, out of title, content, meta_title, meta_description, meta_keywords, background_media_id and background_position. A field not listed here is the page's own.
titleThe group's title for the page. Not blank while title is overridden.
contentThe group's rich-text body for the page.
meta_titleThe group's <title> for the page.
meta_descriptionThe group's meta description for the page.
meta_keywordsThe group's meta keywords for the page.
background_media_idThe group's hero image for the page.
background_positionThe group's anchor for the hero image.