Method: projects.locations.userStores.userLicenses.export

Exporta todos os UserLicenses no UserStore principal como um único documento CSV. Este é o back-end da ação "Fazer o download como CSV" do Admin Console: ele reutiliza o caminho de leitura userLicenses.list para que os administradores possam classificar/filtrar off-line no Excel ou nas Planilhas Google.

A resposta carrega o CSV completo (linha de cabeçalho seguida por linhas de dados) inline em ExportUserLicensesResponse.csv_data.

Solicitação HTTP


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

Os URLs usam a sintaxe de Transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso UserStore principal, formato: projects/{project}/locations/{location}/userStores/{userStoreId}. Todos os UserLicenses em UserStore são exportados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para UserLicenseService.ExportUserLicenses.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação 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
O resultado exportado. O M1 retorna o CSV inline em csv_data. O oneof deixa espaço para uma futura variante de exportação grande (por exemplo, um URI do GCS) sem violar o contrato. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
csvData

string (bytes format)

O documento CSV completo como bytes brutos: a linha de cabeçalho seguida por uma linha por UserLicense. Contém dados de licença do usuário (por exemplo, e-mails de usuários). Uma exportação sem licenças correspondentes contém apenas a linha de cabeçalho.

Uma string codificada em base64.
Fim dos campos mutuamente exclusivos.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.userStores.listUserLicenses

Para mais informações, consulte a documentação do IAM.