- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- ModifyLabelsRequest
- LabelModification
- FieldModification
- רוצים לנסות?
שינוי של קבוצת התוויות שהוחלו על קובץ. מחזירה רשימה של תוויות שנוספו או שונו.
בקשת HTTP
POST https://www.googleapis.com/drive/v2/files/{fileId}/modifyLabels
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
fileId |
מזהה הקובץ שאליו שייכות התוויות. |
גוף הבקשה
גוף הבקשה מכיל מופע של ModifyLabelsRequest
.
גוף התגובה
תגובה לבקשה מסוג files.modifyLabels. הערך הזה מכיל רק את התוויות שנוספו או עודכנו על ידי הבקשה.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"modifiedLabels": [
{
object ( |
שדות | |
---|---|
modifiedLabels[] |
רשימת התוויות שנוספו או עודכנו על ידי הבקשה. |
kind |
הערך הוא תמיד |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של 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 ( |
שדות | |
---|---|
labelModifications[] |
רשימת השינויים שיש להחיל על התוויות בקובץ. |
kind |
הערך הוא תמיד |
LabelModification
שינוי בתווית בקובץ. אפשר להשתמש ב-LabelModify כדי להחיל תווית על קובץ, לעדכן תווית קיימת בקובץ או להסיר תווית מקובץ.
ייצוג JSON |
---|
{
"labelId": string,
"fieldModifications": [
{
object ( |
שדות | |
---|---|
labelId |
מזהה התווית שרוצים לשנות. |
fieldModifications[] |
רשימת השינויים בשדות של התווית הזו. |
removeLabel |
אם הערך הוא True, התווית תוסר מהקובץ. |
kind |
הערך הוא תמיד |
FieldModification
שינוי בשדה של תווית.
ייצוג JSON |
---|
{ "fieldId": string, "kind": string, "setDateValues": [ string ], "setTextValues": [ string ], "setSelectionValues": [ string ], "setIntegerValues": [ string ], "setUserValues": [ string ], "unsetValues": boolean } |
שדות | |
---|---|
fieldId |
מזהה השדה שצריך לשנות. |
kind |
הערך הוא תמיד |
setDateValues[] |
הפונקציה מחליפה את הערך של השדה |
setTextValues[] |
מגדיר את הערך של שדה |
setSelectionValues[] |
הפונקציה מחליפה את השדה |
setIntegerValues[] |
הפונקציה מחליפה את הערך של השדה |
setUserValues[] |
הפונקציה מחליפה את השדה |
unsetValues |
ביטול ההגדרה של הערכים בשדה הזה. |