Method: labels.get

קבלת תווית לפי שם המשאב שלה. מידע נוסף זמין במאמר חיפוש תוויות.

שם המשאב יכול להיות כל אחד מהערכים הבאים:

  • labels/{id} – הצגת labels/{id}@latest
  • labels/{id}@latest – אחזור של הגרסה האחרונה של התווית.
  • labels/{id}@published – אחזור הגרסה הנוכחית שפורסמה של התווית.
  • labels/{id}@{revisionId} – אחזור התווית בגרסה שצוין המזהה שלה.

בקשת HTTP

GET https://drivelabels.googleapis.com/v2/{name=labels/*}

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

פרמטרים של נתיב

פרמטרים
name

string

חובה. שם המשאב של התווית.

יכול להיות כל אחד מהערכים הבאים:

  • labels/{id} (שווה ל-labels/{id}@latest)
  • labels/{id}@latest
  • labels/{id}@published
  • labels/{id}@{revisionId}

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

פרמטרים
useAdminAccess

boolean

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

languageCode

string

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

view

enum (LabelView)

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

גוף הבקשה

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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Label.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של 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

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