Method: files.modifyLabels

שינוי של קבוצת התוויות שהוחלו על קובץ. מחזירה רשימה של התוויות שנוספו או שונו.

בקשת HTTP

POST https://www.googleapis.com/drive/v2/files/{fileId}/modifyLabels

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

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

פרמטרים
fileId

string

מזהה הקובץ שאליו שייכות התוויות.

גוף הבקשה

גוף הבקשה מכיל מופע של ModifyLabelsRequest.

גוף התשובה

תגובה לבקשה של files.modifyLabels. בשדה הזה יופיעו רק התוויות שנוספו או עודכנו בעקבות הבקשה.

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

ייצוג JSON 
{
  "modifiedLabels": [
    {
      object (Label)
    }
  ],
  "kind": string
}
שדות
modifiedLabels[]

object (Label)

רשימת התוויות שנוספו או עודכנו בעקבות הבקשה.
kind

string

תמיד מדובר בdrive#modifyLabelsResponse

היקפי ההרשאות

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

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata

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

ModifyLabelsRequest

בקשה לשינוי קבוצת התוויות בקובץ. הבקשה הזו עשויה להכיל שינויים רבים שיכשלו או ייכשלו באופן אטומי.

ייצוג JSON 
{
  "labelModifications": [
    {
      object (LabelModification)
    }
  ],
  "kind": string
}
שדות
labelModifications[]

object (LabelModification)

רשימת השינויים שצריך להחיל על התוויות בקובץ.
kind

string

הערך הוא תמיד drive#modifyLabelsRequest.

LabelModification

שינוי בתווית בקובץ. אפשר להשתמש ב-Labelשינוי כדי להחיל תווית על קובץ, לעדכן תווית קיימת בקובץ או להסיר תווית מקובץ.

ייצוג JSON 
{
  "labelId": string,
  "fieldModifications": [
    {
      object (FieldModification)
    }
  ],
  "removeLabel": boolean,
  "kind": string
}
שדות
labelId

string

מזהה התווית שרוצים לשנות.
fieldModifications[]

object (FieldModification)

רשימת השינויים בשדות של התווית הזו.
removeLabel

boolean

אם הערך הוא True, התווית תוסר מהקובץ.
kind

string

הערך הוא תמיד drive#labelModification.

FieldModification

שינוי בשדה של תווית.

ייצוג JSON 
{
  "fieldId": string,
  "kind": string,
  "setDateValues": [
    string
  ],
  "setTextValues": [
    string
  ],
  "setSelectionValues": [
    string
  ],
  "setIntegerValues": [
    string
  ],
  "setUserValues": [
    string
  ],
  "unsetValues": boolean
}
שדות
fieldId

string

המזהה של השדה שרוצים לשנות.
kind

string

הערך הוא תמיד drive#labelFieldModification.
setDateValues[]

string

הפונקציה מחליפה את הערך של השדה date בערכים החדשים. המחרוזת חייבת להיות בפורמט תאריך מלא RFC 3339: YYYY-MM-DD.
setTextValues[]

string

מגדיר את הערך של השדה text.
setSelectionValues[]

string

הפונקציה מחליפה את השדה selection בערכים החדשים האלה.
setIntegerValues[]

string (int64 format)

הפונקציה מחליפה את הערך של השדה integer בערכים החדשים.
setUserValues[]

string

הפונקציה מחליפה את השדה user בערכים החדשים האלה. הערכים חייבים להיות כתובות אימייל חוקיות.
unsetValues

boolean

ביטול ההגדרה של ערכי השדה הזה.