Method: projects.locations.agents.playbooks.export

Exports the specified playbook to a binary file.

Note that resources (e.g. examples, tools) that the playbook references will also be exported.

HTTP request

POST https://{endpoint}/v3/{name=projects/*/locations/*/agents/*/playbooks/*}:export

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the playbook to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.playbooks.get

Request body

The request body contains data with the following structure:

JSON representation 
{
  "playbookUri": string,
  "dataFormat": enum (DataFormat)
}
Fields
playbookUri

string

Optional. The Google Cloud Storage URI to export the playbook to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized playbook is returned inline.

Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.
dataFormat

enum (DataFormat)

Optional. The data format of the exported agent. If not specified, BLOB is assumed.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DataFormat

Data format of the exported playbook.

Enums
DATA_FORMAT_UNSPECIFIED Unspecified format.
BLOB Flow content will be exported as raw bytes.
JSON Flow content will be exported in JSON format.