Method: projects.locations.userStores.userLicenses.export

Exporta todos los UserLicenses del UserStore principal como un solo documento CSV. Este es el backend de la acción "Descargar como CSV" de la Consola del administrador: reutiliza la ruta de lectura de userLicenses.list para que los administradores puedan ordenar o filtrar sin conexión en Excel o Hojas de cálculo.

La respuesta incluye el archivo CSV completo (fila de encabezado seguida de filas de datos) de forma intercalada en ExportUserLicensesResponse.csv_data.

Solicitud HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/userStores/*}/userLicenses:export

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso principal UserStore, con el formato projects/{project}/locations/{location}/userStores/{userStoreId}. Se exportan todos los UserLicenses que se encuentran debajo de este UserStore.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para UserLicenseService.ExportUserLicenses.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "csvData": string
  // End of mutually exclusive fields.
}
Campos
Es el resultado exportado. M1 devuelve el CSV intercalado en csv_data; el elemento oneof deja espacio para una futura variante de exportación grande (p.ej., un URI de GCS) sin romper el contrato. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
csvData

string (bytes format)

Documento CSV completo como bytes sin procesar: la fila de encabezado seguida de una fila por cada UserLicense. Contiene datos de licencias de usuario (p.ej., correos electrónicos de usuarios). Una exportación sin licencias coincidentes solo contiene la fila de encabezado.

Es una cadena codificada en Base64.

Fin de los campos mutuamente excluyentes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

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

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.userStores.listUserLicenses

Para obtener más información, consulta la documentación de IAM.