Method: projects.locations.collections.list

Obtiene una lista de Collections.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre del recurso del almacén de datos superior, con el formato projects/{project}/locations/{location}.

Los parámetros de consulta

Parámetros
pageSize

integer

Número máximo de Collections que se devolverán. Es posible que el servicio devuelva un número inferior a este valor.

Si no se especifica, se devolverán 100 Collections como máximo.

El valor máximo es 1000; los valores superiores a este límite se convertirán a 1000.
pageToken

string

Token de página recibido de una llamada CollectionService.ListCollections anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a CollectionService.ListCollections deben ser los mismos que aparecen en la llamada que proporcionó el token de la página.
filter

string

Filtra las colecciones devueltas por las fuentes de datos del conector de datos asociado. Por ejemplo: filter = 'dataSource:jira confluence'. Si el filtro está vacío, devolvemos todas las colecciones de un proyecto y una ubicación.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta del método CollectionService.ListCollections.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

Representación JSON 
{
  "collections": [
    {
      object (Collection)
    }
  ],
  "nextPageToken": string
}
Campos
collections[]

object (Collection)

Los Collection.
nextPageToken

string

Token que se puede enviar como ListCollectionsRequest.page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.collections.list

Para obtener más información, consulta la documentación de gestión de identidades y accesos.