This preview documentation is deprecated.

Discovery for Media has been renamed to media recommendations. It is now part of Vertex AI Search, and you can manage it using the Search and Conversation console. We recommend that you use the Search and Conversation console. After March 31, 2024, the Discovery Engine console will no longer be available.

For information about what's changing, see Switch from Discovery for Media to media recommendations. For more information about recommendations in Vertex AI Search, see About recommendations.

Method: projects.locations.dataStores.branches.documents.list

HTTP request
Path parameters
Query parameters
Request body
Response body
Authorization scopes
IAM Permissions
Try it!

Gets a list of Documents.

HTTP request

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`parent`	`string` Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list `Document`s under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.

parent

string

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Use default_branch as the branch ID, to list documents under the default branch.

If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Query parameters

Parameters

Parameters
`pageSize`	`integer` Maximum number of `Document`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
`pageToken`	`string` A page token `ListDocumentsResponse.next_page_token`, received from a previous `DocumentService.ListDocuments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `DocumentService.ListDocuments` must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.

pageSize

integer

Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

pageToken

string

A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

discoveryengine.documents.list

For more information, see the IAM documentation.