Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details.

REST Resource: projects.locations.agents.playbooks.versions

Resource: PlaybookVersion

Playbook version is a snapshot of the playbook at certain timestamp.

JSON representation
{
 "name": string,
 "description": string,
 "playbook": {
 object (Playbook )
 },
 "examples": [
 {
 object (Example )
 }
 ],
 "updateTime": string
}
Fields
name

string

The unique identifier of the playbook version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.

description

string

Optional. The description of the playbook version.

playbook

object (Playbook )

Output only. Snapshot of the playbook when the playbook version is created.

examples[]

object (Example )

Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.

updateTime

string (Timestamp format)

Output only. Last time the playbook version was created or modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014年10月02日T15:01:23Z", "2014年10月02日T15:01:23.045123456Z" or "2014年10月02日T15:01:23+05:30".

Methods

create

Creates a version for the specified Playbook.

delete

Deletes the specified version of the Playbook.

get

Retrieves the specified version of the Playbook.

list

Lists versions for the specified Playbook.

restore

Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年08月21日 UTC.