Method: labels.delta

מעדכן תווית אחת על ידי החלת קבוצה של בקשות עדכון, שהתוצאה שלה היא טיוטה חדשה של טיוטה. עדכון בכמות גדולה הוא הכול או כלום: אם בקשה כלשהי לעדכון לא חוקית, לא יחולו שינויים. יש לפרסם את גרסת הטיוטה שהתקבלה לפני שניתן יהיה להשתמש בשינויים עם פריטים ב-Drive.

בקשת HTTP

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

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

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

פרמטרים
name

string

חובה. שם המשאב של התווית שיש לעדכן.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
שדות
writeControl

object (WriteControl)

שליטה על האופן שבו בקשות כתיבה מבוצעות.
requests[]

object (Request)

רשימה של עדכונים שיחולו על התווית. הבקשות יוחלו לפי הסדר שבו הן מפורטות.
useAdminAccess

boolean

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

enum (LabelView)

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

string

קוד השפה BCP-47 שבו יש להשתמש כדי להעריך תוויות שדות שמותאמות לשוק המקומי כשהערך של include_label_in_response הוא true.

גוף התשובה

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

תשובה לגבי עדכון התווית.

ייצוג JSON 
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
שדות
responses[]

object (Response)

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

object (Label)

התווית לאחר החלת העדכונים. היא מוגדרת רק אם [BatchUpdateLabelResponse2.include_label_in_response] הוא true ולא היו שגיאות.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

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

בקשה

סוג אחד של עדכון שניתן להחיל על תווית.

ייצוג JSON 
{

  // Union field kind can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג העדכון. רק שדה אחד הוא שדה חובה. kind יכול להיות רק אחד מהבאים:
updateLabel

object (UpdateLabelPropertiesRequest)

עדכון המאפיינים של התווית.
createField

object (CreateFieldRequest)

יצירת שדה חדש.
updateField

object (UpdateFieldPropertiesRequest)

עדכון מאפיינים בסיסיים של שדה.
updateFieldType

object (UpdateFieldTypeRequest)

עדכון האפשרויות של סוג ו/או סוג השדה.
enableField

object (EnableFieldRequest)

הפעלת השדה.
disableField

object (DisableFieldRequest)

משבית את השדה.
deleteField

object (DeleteFieldRequest)

מחיקת שדה מהתווית.
createSelectionChoice

object (CreateSelectionChoiceRequest)

יוצר בחירה בשדה 'בחירה'.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

עדכון מאפיינים של בחירה בשדה בחירה.
enableSelectionChoice

object (EnableSelectionChoiceRequest)

הפעלת בחירה בשדה בחירה.
disableSelectionChoice

object (DisableSelectionChoiceRequest)

להשבית בחירה בשדה בחירה.
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

מחיקת בחירה בשדה בחירה.

UpdateLabelPropertiesRequest

עדכון מאפיינים בסיסיים של תווית.

ייצוג JSON 
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
שדות
updateMask

string (FieldMask format)

השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש label_properties הוא משתמע ואין לציין אותו. אפשר להשתמש ב-* כקיצור דרך לעדכון כל שדה.
properties

object (Properties)

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

CreateFieldRequest

מבקשים ליצור שדה בתוך תווית.

ייצוג JSON 
{
  "field": {
    object (Field)
  }
}
שדות
field

object (Field)

חובה. שדה ליצירה.

UpdateFieldPropertiesRequest

בקשה לעדכון מאפייני שדה.

ייצוג JSON 
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
שדות
updateMask

string (FieldMask format)

השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש properties הוא משתמע ואין לציין אותו. אפשר להשתמש ב-* כקיצור דרך לעדכון כל שדה.
id

string

חובה. השדה לעדכון.
properties

object (Properties)

חובה. מאפייני שדה בסיסיים.

UpdateFieldTypeRequest

בקשה לשינוי הסוג של שדה.

ייצוג JSON 
{
  "updateMask": string,
  "id": string,

  // Union field type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
שדות
updateMask

string (FieldMask format)

השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש של type_options הוא משתמע ואין לציין אותו. אפשר להשתמש ב-* כקיצור דרך לעדכון כל שדה.
id

string

חובה. השדה לעדכון.

שדה איחוד type_options.

type_options יכול להיות רק אחד מהבאים:
textOptions

object (TextOptions)

עדכון השדה ל'טקסט'.
longTextOptions

object (LongTextOptions)

מעדכנים את השדה ל'טקסט ארוך'.
integerOptions

object (IntegerOptions)

מעדכנים את השדה ל'מספר שלם'.
dateOptions

object (DateOptions)

עדכון השדה ל'תאריך'.
selectionOptions

object (SelectionOptions)

מעדכנים את השדה ל'בחירה'.
userOptions

object (UserOptions)

עדכון השדה ל'משתמש'.

LongTextOptions

אפשרויות: סוג השדה 'טקסט ארוך'.

ייצוג JSON 
{
  "minLength": integer,
  "maxLength": integer
}
שדות
minLength

integer

פלט בלבד. האורך המינימלי החוקי של הערכים בשדה הטקסט.
maxLength

integer

פלט בלבד. האורך המקסימלי של הערכים החוקיים בשדה הטקסט.

EnableFieldRequest

צריך לשלוח בקשה להפעלת השדה.

ייצוג JSON 
{
  "id": string
}
שדות
id

string

חובה. מזהה השדה שיש להפעיל.

DisableFieldRequest

בקשה להשבית את השדה.

ייצוג JSON 
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
שדות
updateMask

string (FieldMask format)

השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש disabledPolicy הוא משתמע ואין לציין אותו. אפשר להשתמש ב-* כקיצור דרך לעדכון כל שדה.
id

string

חובה. מפתח השדה להשבתה.
disabledPolicy

object (DisabledPolicy)

חובה. מדיניות השבתת שדה.

DeleteFieldRequest

בקשה למחיקת השדה.

ייצוג JSON 
{
  "id": string
}
שדות
id

string

חובה. מזהה השדה למחיקה.

CreateSelectionChoiceRequest

יש לשלוח בקשה ליצירת אפשרות בחירה.

ייצוג JSON 
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
שדות
fieldId

string

חובה. שדה הבחירה שבו תיווצר בחירה.
choice

object (Choice)

חובה. הבחירה ליצור.

UpdateSelectionChoicePropertiesRequest

שליחת בקשה לעדכון נכסים של בחירה.

ייצוג JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
שדות
updateMask

string (FieldMask format)

השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש properties הוא משתמע ואין לציין אותו. אפשר להשתמש ב-* כקיצור דרך לעדכון כל שדה.
fieldId

string

חובה. שדה הבחירה לעדכון.
id

string

חובה. הבחירה לעדכן.
properties

object (Properties)

חובה. המאפיינים 'בחירה' לעדכון.

EnableSelectionChoiceRequest

שליחת בקשה להפעלה של אפשרות בחירה.

ייצוג JSON 
{
  "fieldId": string,
  "id": string
}
שדות
fieldId

string

חובה. שדה הבחירה שבו תופעל בחירה.
id

string

חובה. בוחרים להפעיל.

DisableSelectionChoiceRequest

שליחת בקשה להשבתה של אפשרות.

ייצוג JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
שדות
updateMask

string (FieldMask format)

השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש disabledPolicy הוא משתמע ואין לציין אותו. אפשר להשתמש ב-* כקיצור דרך לעדכון כל שדה.
fieldId

string

חובה. שדה הבחירה שבו הבחירה תושבת.
id

string

חובה. יש לבחור את האפשרות להשבית.
disabledPolicy

object (DisabledPolicy)

חובה. המדיניות המושבתת שצריך לעדכן.

DeleteSelectionChoiceRequest

שליחת בקשה למחיקה של אפשרות.

ייצוג JSON 
{
  "fieldId": string,
  "id": string
}
שדות
fieldId

string

חובה. שדה הבחירה שממנו תימחק הבחירה.
id

string

חובה. אפשרות למחוק.

תשובה

תשובה אחת מעדכון.

ייצוג JSON 
{

  // Union field response can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
  // End of list of possible types for union field response.
}
שדות
שדה איחוד response. התשובה לבקשה התואמת. response יכול להיות רק אחד מהבאים:
updateLabel

object (UpdateLabelPropertiesResponse)

מאפיינים בסיסיים של תווית עודכנו.
createField

object (CreateFieldResponse)

יצירת שדה חדש.
updateField

object (UpdateFieldPropertiesResponse)

עדכון מאפיינים בסיסיים של שדה.
updateFieldType

object (UpdateFieldTypeResponse)

עדכון האפשרויות של סוג ו/או סוג השדה.
enableField

object (EnableFieldResponse)

הפעלת שדה.
disableField

object (DisableFieldResponse)

השבתת השדה.
deleteField

object (DeleteFieldResponse)

מחיקת שדה מהתווית.
createSelectionChoice

object (CreateSelectionChoiceResponse)

יצירת אפשרות חדשה של רשימת בחירות להוספה לשדה בחירה.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesResponse)

מעדכן בחירה בשדה בחירה.
enableSelectionChoice

object (EnableSelectionChoiceResponse)

מפעיל בחירה בשדה בחירה.
disableSelectionChoice

object (DisableSelectionChoiceResponse)

משביתה בחירה בשדה בחירה.
deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

מחיקת בחירה משדה בחירה.

UpdateLabelPropertiesResponse

התשובה שהתקבלה לאחר עדכון של מאפייני תווית.

CreateFieldResponse

התקבלה תגובה בעקבות 'יצירת שדה'.

ייצוג JSON 
{
  "id": string,
  "priority": integer
}
שדות
id

string

השדה של השדה שנוצר. אם השדה יישאר ריק בבקשת יצירה, ייווצר מפתח באופן אוטומטי ואפשר יהיה לזהות אותו כאן.
priority

integer

העדיפות של השדה שנוצר. העדיפות עשויה להשתנות ממה שצוין כדי להבטיח רציפות בסדר העדיפויות בין השדות (1-n).

UpdateFieldPropertiesResponse

התשובה שהתקבלה לאחר עדכון של מאפייני שדה.

ייצוג JSON 
{
  "priority": integer
}
שדות
priority

integer

העדיפות של השדה המעודכן. העדיפות עשויה להשתנות ממה שצוין כדי להבטיח רציפות בסדר העדיפויות בין השדות (1-n).

UpdateFieldTypeResponse

התשובה שהתקבלה לאחר עדכון לסוג השדה.

EnableFieldResponse

התשובה 'הפעלת שדה'.

DisableFieldResponse

השבתה של התשובה אחרי השדה 'שדה'.

DeleteFieldResponse

התשובה שהתקבלה לאחר 'מחיקה של השדה'.

CreateSelectionChoiceResponse

התשובה שנוצרה לאחר יצירת האפשרות שנבחרה.

ייצוג JSON 
{
  "fieldId": string,
  "id": string
}
שדות
fieldId

string

המזהה של השדה שנוצר על ידי השרת.
id

string

המזהה שנוצר על ידי השרת של הבחירה שנוצרה בשדה

UpdateSelectionChoicePropertiesResponse

התשובה שתוצג אחרי עדכון המאפיינים של האפשרות שנבחרה.

ייצוג JSON 
{
  "priority": integer
}
שדות
priority

integer

העדיפות של הבחירה המעודכנת. רמת העדיפות עשויה להשתנות מהערך שהוגדר כדי להבטיח סדר עדיפויות עקבי בין האפשרויות (1-n).

EnableSelectionChoiceResponse

התשובה שאחרי האפשרות 'בחירה' מופעלת.

DisableSelectionChoiceResponse

הושבתה התשובה אחרי האפשרות 'בחירה'.

DeleteSelectionChoiceResponse

התשובה אחרי המחיקה של האפשרות שנבחרה.