Method: projects.locations.agents.playbooks.examples.list

Returns a list of examples in the specified playbook.

HTTP request

GET https://{endpoint}/v3beta1/{parent=projects/*/locations/*/agents/*/playbooks/*}/examples

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The playbook to list the examples from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

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

  • dialogflow.examples.list

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken

string

Optional. The [nextPageToken][ListExampleResponse.next_page_token] value returned from a previous list request.
languageCode

string

Optional. The language to list examples for. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.

Request body

The request body must be empty.

Response body

The response message for Examples.ListExamples.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "examples": [
    {
      object (Example)
    }
  ],
  "nextPageToken": string
}
Fields
examples[]

object (Example)

The list of examples. There will be a maximum number of items returned based on the pageSize field in the request.
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

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.