Method: projects.locations.collections.engines.assistants.cannedQueries.listActiveCannedQueryUserViews

Lists the CannedQueryUserViews for all active CannedQuerys.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/cannedQueries:listActiveCannedQueryUserViews

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the parent assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Query parameters

Parameters
languageCode

string

Optional. The language code the canned queries should be returned in. If not specified here or corresponding translation is not found, the default texts will be returned.
pageSize

integer

Maximum number of CannedQueryUserViews to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
pageToken

string

A page token ListActiveCannedQueryUserViewsResponse.next_page_token, received from a previous CannedQueryService.ListActiveCannedQueryUserViews call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to CannedQueryService.ListActiveCannedQueryUserViews must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for CannedQueryService.ListActiveCannedQueryUserViews method.

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

JSON representation 
{
  "cannedQueryUserViews": [
    {
      object (CannedQueryUserView)
    }
  ],
  "nextPageToken": string
}
Fields
cannedQueryUserViews[]

object (CannedQueryUserView)

The CannedQueryUserViews that are representing active (existing, enabled and capabilities met) canned queries.
nextPageToken

string

A token that can be sent as ListActiveCannedQueryUserViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CannedQueryUserView

Limited information about a CannedQuery that is sufficient for the end users.

JSON representation 
{
  "cannedQuery": string,
  "localizedTexts": {
    object (CannedQueryTexts)
  },
  "activationBehavior": enum (ActivationBehavior),
  "icon": string
}
Fields
cannedQuery

string

The resource name of the CannedQuery this view is for. This identifies the canned query in the assist request.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}
localizedTexts

object (CannedQueryTexts)

The localized texts for the canned query.
activationBehavior

enum (ActivationBehavior)

The behaviour when this canned query is activated.
icon

string

The name of the icon from the Google Symbols library for the canned query.