Method: labels.list

הצגת רשימת התוויות. מידע נוסף זמין במאמר חיפוש תוויות.

בקשת HTTP

GET https://drivelabels.googleapis.com/v2/labels

כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים
publishedOnly

boolean

האם לכלול בתוצאות רק תוויות שפורסמו.

  • כשמזינים את true, מוחזרות רק הגרסאות הנוכחיות של התוויות שפורסמו. התוויות המושבתות נכללות. שמות המשאבים של התוויות שמוחזרים מתייחסים לגרסה שפורסמה (labels/{id}/{revisionId}).
  • כשמגדירים את הערך false, מוחזרות הגרסאות הנוכחיות של התווית, שיכול להיות שלא פורסמו. שמות המשאבים של התוויות שמוחזרים לא מפנים לגרסה ספציפית (labels/{id}).
customer

string

הלקוח שאליו רוצים לצמצם את הבקשה הזו. לדוגמה: customers/abcd1234 אם לא מוגדר, יוחזרו כל התוויות בלקוח הנוכחי.
languageCode

string

קוד השפה מסוג BCP-47 שמשמש להערכת תוויות של שדות שעברו לוקליזציה. אם לא מציינים שפה, המערכת משתמשת בערכים בשפה שהוגדרה כברירת מחדל.
pageSize

integer

המספר המקסימלי של תוויות שיוחזרו בכל דף. ברירת מחדל: 50. מקסימום: 200.
pageToken

string

האסימון של הדף שיוחזר.
view

enum (LabelView)

אם מציינים שדות, רק שדות מסוימים ששייכים לתצוגה שצוינה מוחזרים.

פרמטר של איחוד access.

הערך access יכול להיות רק אחד מהבאים:
useAdminAccess

boolean

הערך שמוגדר הוא true כדי להשתמש בפרטי הכניסה של האדמין של המשתמש. הפעולה הזו תחזיר את כל התוויות של הלקוח.
minimumRole

enum (LabelRole)

מציינת את רמת הגישה שצריכה להיות למשתמש בתוויות שהוחזרו. התפקיד המינימלי שמשתמש צריך לקבל בתווית. ברירת המחדל היא READER.

גוף הבקשה

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

גוף התשובה

תגובה להצגת תוויות של כרטיסי מוצר.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
שדות
labels[]

object (Label)

תוויות
nextPageToken

string

הטוקן של הדף הבא בתשובה.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

מידע נוסף זמין במדריך ההרשאות.