Method: files.modifyLabels

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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

ייצוג ב-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

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