Website Module
The functions of the platform a website is given one at a time — its modules — each with whether it is on for this website. Turning one on or off is an Update of enabled; a module that requires another is refused until that one is on, and the refusal names it.
List modules
The functions of the platform a website is given one at a time — its modules — with whether each is on for this website. The list is the platform's catalogue, the same modules for every website and in the same order; enabled is this website's own, and is the only thing an Update changes. Turning a module off switches its function off on the published website as well. A module your client does not recognise is one it should show rather than drop — that is what lets the platform ship a new module before your client knows about it.
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: none — this collection serves its documented order only.
filterAIP-160 subset (§8). Filterable: none. A field outside the list is INVALID_ARGUMENT.
List modules › Responses
One page of modules.
This page of modules, 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 module
The functions of the platform a website is given one at a time — its modules — with whether each is on for this website. The list is the platform's catalogue, the same modules for every website and in the same order; enabled is this website's own, and is the only thing an Update changes. Turning a module off switches its function off on the published website as well. A module your client does not recognise is one it should show rather than drop — that is what lets the platform ship a new module before your client knows about it.
path Parameters
website_idId of the parent website.
module_idId of the parent module.
Headers
If-None-MatchA matching etag answers 304 with no body (§16).
Get module › 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).
display_nameThe module's name as a person reads it, for a card on a modules page or a hint that names what has to be turned on first.
descriptionWhat the module gives a website, in a sentence or two a modules page can show under its name.
orderThe module's place in the catalogue — the order a List answers in and a modules page draws in. Smaller comes first.
enabledWhether the module is on for this website — the one field an Update writes. Turning a module on while a module it requires is off, or off while a module that requires it is on, is FAILED_PRECONDITION naming the other module. Turning one off also drops every view's own override of it.
requiresThe ids of the modules this one works on top of: it can be on only while every one of them is. Empty — and still present — for a module that needs nothing else.
Update module
Turns one module of this website on or off. enabled is the only field it writes; an update_mask naming any other field is INVALID_ARGUMENT, and so is a body without enabled — a module has no third state to clear it to.
A module that requires another can be turned on only while that one is on, and a module that others require can be turned off only after they are: either refusal is FAILED_PRECONDITION with a PRECONDITION_FAILURE of type MODULE_REQUIRED or MODULE_REQUIRED_BY whose subject is the other module's name — the one to act on first.
Turning a module off also removes every view's own override of it, so no view keeps a function the website no longer has. Sending the state the module is already in changes nothing and answers the module as it is.
path Parameters
website_idId of the parent website.
module_idId of the parent module.
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 module › Request Body
enabledWhether the module is on for this website — the one field an Update writes. Turning a module on while a module it requires is off, or off while a module that requires it is on, is FAILED_PRECONDITION naming the other module. Turning one off also drops every view's own override of it.
Update module › 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).
display_nameThe module's name as a person reads it, for a card on a modules page or a hint that names what has to be turned on first.
descriptionWhat the module gives a website, in a sentence or two a modules page can show under its name.
orderThe module's place in the catalogue — the order a List answers in and a modules page draws in. Smaller comes first.
enabledWhether the module is on for this website — the one field an Update writes. Turning a module on while a module it requires is off, or off while a module that requires it is on, is FAILED_PRECONDITION naming the other module. Turning one off also drops every view's own override of it.
requiresThe ids of the modules this one works on top of: it can be on only while every one of them is. Empty — and still present — for a module that needs nothing else.