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 ประเภทของการอัปเดต ต้องระบุเพียง 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)

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

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

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