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

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