Method: projects.locations.userStores.userLicenses.export

Exporte tous les UserLicense sous le UserStore parent dans un seul document CSV. Il s'agit du backend de l'action "Télécharger au format CSV" de la console d'administration. Il réutilise le chemin de lecture userLicenses.list afin que les administrateurs puissent trier/filtrer les données hors connexion dans Excel ou Sheets.

La réponse contient l'intégralité du fichier CSV (ligne d'en-tête suivie des lignes de données) en ligne dans ExportUserLicensesResponse.csv_data.

Requête HTTP


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

Les URL utilisent la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource UserStore parent, au format projects/{project}/locations/{location}/userStores/{userStoreId}. Tous les UserLicense de ce UserStore sont exportés.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour UserLicenseService.ExportUserLicenses.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation 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.
}
Champs
Résultat exporté. M1 renvoie le fichier CSV intégré dans csv_data. Le "oneof" laisse la place à une future variante d'exportation volumineuse (par exemple, un URI GCS) sans rompre le contrat. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
csvData

string (bytes format)

Document CSV complet sous forme d'octets bruts : ligne d'en-tête suivie d'une ligne par UserLicense. Contient des données sur les licences utilisateur (par exemple, les adresses e-mail des utilisateurs). Une exportation sans licence correspondante ne contient que la ligne d'en-tête.

Chaîne encodée en base64.
Fin des champs qui s'excluent mutuellement.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.userStores.listUserLicenses

Pour en savoir plus, consultez la documentation IAM.