Method: projects.locations.userStores.userLicenses.export

מייצא את כל UserLicenses שמתחת ל-UserStore הראשי כמסמך CSV אחד. זהו ה-backend של הפעולה 'הורדה כקובץ CSV' במסוף Admin: הוא משתמש מחדש בנתיב הקריאה userLicenses.list כדי שאדמינים יוכלו למיין או לסנן אופליין ב-Excel או ב-Sheets.

התשובה מכילה את קובץ ה-CSV המלא (שורת כותרת ואחריה שורות נתונים) בתוך ExportUserLicensesResponse.csv_data.

בקשת 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}. כל UserLicenses מתחת ל-UserStore הזה מיוצאים.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

הודעת תגובה ל-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 בשורה ב-csv_data. האפשרות oneof מאפשרת להוסיף בעתיד גרסה של ייצוא גדול (למשל, URI של GCS) בלי לשבור את החוזה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
csvData

string (bytes format)

מסמך ה-CSV המלא כבייטים גולמיים: שורת הכותרת ואחריה שורה אחת לכל UserLicense. מכיל נתונים של רישיונות משתמשים (למשל, כתובות אימייל של משתמשים). ייצוא שלא כולל רישיונות תואמים מכיל רק את שורת הכותרת.

מחרוזת בקידוד 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

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.userStores.listUserLicenses

מידע נוסף מופיע במאמרי העזרה בנושא IAM.