Method: labels.delta

อัปเดตป้ายกำกับเดียวโดยใช้ชุดคำขออัปเดตซึ่งจะทำให้มีการแก้ไขฉบับร่างใหม่ การอัปเดตแบบกลุ่มจะอัปเดตหรือไม่ก็ได้: หากคำขออัปเดตรายการใดรายการหนึ่งไม่ถูกต้อง จะไม่มีการเปลี่ยนแปลงใดๆ โดยการแก้ไขฉบับร่างที่ได้ต้องเผยแพร่ก่อนจึงจะใช้การเปลี่ยนแปลงกับรายการในไดรฟ์ได้

คำขอ HTTP

POST https://drivelabels.googleapis.com/v2beta/{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)

การตอบกลับการอัปเดต แมปนี้เป็นแบบ 1:1 กับการอัปเดต แม้ว่าการตอบกลับคำขอบางรายการอาจว่างเปล่า
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 ประเภทของการอัปเดต ต้องระบุเพียง 1 ช่องเท่านั้น 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)

อัปเดตพร็อพเพอร์ตี้ Choice ภายในช่องการเลือก
enableSelectionChoice

object (EnableSelectionChoiceRequest)

เปิดใช้ตัวเลือกในช่องการเลือก
disableSelectionChoice

object (DisableSelectionChoiceRequest)

ปิดใช้ตัวเลือกภายในช่องการเลือก
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

ลบตัวเลือกภายในช่องการเลือก

UpdateLabelPropertiesRequest

อัปเดตพร็อพเพอร์ตี้พื้นฐานของป้ายกำกับ

การแสดง JSON 
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
ช่อง
updateMask

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง ราก 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)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง ราก 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)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รากของ 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)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง ราก 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

ส่งคำขออัปเดตพร็อพเพอร์ตี้ Choice

การแสดง JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
ช่อง
updateMask

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง ราก properties เป็นคำโดยนัยและไม่ควรระบุ คุณใช้ * รายการเดียวเป็นค่าสั้นสำหรับการอัปเดตทุกช่องได้
fieldId

string

ต้องระบุ ช่องการเลือกที่จะอัปเดต
id

string

ต้องระบุ ตัวเลือกที่ต้องการอัปเดต
properties

object (Properties)

ต้องระบุ พร็อพเพอร์ตี้ของ Choice ที่จะอัปเดต

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)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง ราก 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

คำตอบหลังจากลบตัวเลือก