Method: projects.locations.userStores.userLicenses.export

親 UserStore のすべての UserLicense を 1 つの CSV ドキュメントとしてエクスポートします。これは、管理コンソールの [CSV としてダウンロード] アクションのバックエンドです。userLicenses.list 読み取りパスを再利用するため、管理者は Excel またはスプレッドシートでオフラインで並べ替えやフィルタリングを行うことができます。

レスポンスには、ExportUserLicensesResponse.csv_data に CSV 全体（ヘッダー行とデータ行）がインラインで含まれます。

HTTP リクエスト


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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。親 UserStore のリソース名。形式: projects/{project}/locations/{location}/userStores/{userStoreId}。この UserStore の下のすべての UserLicense がエクスポートされます。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

UserLicenseService.ExportUserLicenses に対するレスポンス メッセージです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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.
}
フィールド
エクスポートされた結果。M1 は csv_data で CSV をインラインで返します。oneof は、契約を破ることなく、将来の大規模エクスポート バリアント（GCS URI など）に対応できるようにします。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
csvData

string (bytes format)

CSV ドキュメント全体（未加工のバイト形式）。ヘッダー行の後に UserLicense ごとに 1 行が続きます。ユーザー ライセンス データ（ユーザーのメールアドレスなど）が含まれます。一致するライセンスがないエクスポートには、ヘッダー行のみが含まれます。

Base64 でエンコードされた文字列。
相互に排他的なフィールドの終わり。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.userStores.listUserLicenses

詳細については、IAM のドキュメントをご覧ください。