Method: labels.delta

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

คำขอ 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)

การตอบกลับการอัปเดต ซึ่งจะเชื่อมโยงกับข้อมูลอัปเดตแบบ 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 ประเภทการอัปเดต ต้องมีฟิลด์เดียวเท่านั้น 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)
  },
  "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)

อัปเดตช่องเป็นข้อความ

integerOptions

object (IntegerOptions)

อัปเดตช่องเป็นจำนวนเต็ม

dateOptions

object (DateOptions)

อัปเดตช่องเป็น "วันที่"

selectionOptions

object (SelectionOptions)

อัปเดตช่องเป็น "การเลือก"

userOptions

object (UserOptions)

อัปเดตช่องเป็นผู้ใช้

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

คำขออัปเดตพร็อพเพอร์ตี้ทางเลือก

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

string (FieldMask format)

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

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

ประเภทนี้ไม่มีช่อง

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