Method: files.modifyLabels

משנה את קבוצת התוויות שמוחלות על קובץ. למידע נוסף, אפשר לקרוא את המאמר בנושא הגדרת שדה תווית בקובץ.

מחזירה רשימה של התוויות שנוספו או שונו.

בקשת HTTP

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

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

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

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

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

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

object (FieldModification)

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

string

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

boolean

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

string

הנתיב הזה תמיד "drive#labelModification".

FieldModification

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

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

string

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

string

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

string

מחליף את השדה selection בערכים החדשים האלה.
setIntegerValues[]

string (int64 format)

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

string

מחליף את השדה user בערכים החדשים האלה. הערכים חייבים להיות כתובות אימייל תקינות.
fieldId

string

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

string

הנתיב הזה תמיד "drive#labelFieldModification".
unsetValues

boolean

מבטל את ההגדרה של הערכים בשדה הזה.