Method: labels.list

תוויות של רשימות.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
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

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