- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- คำขอ
- UpdateLabelPropertiesRequest
- CreateFieldRequest
- UpdateFieldPropertiesRequest
- UpdateFieldTypeRequest
- EnableFieldRequest
- DisableFieldRequest
- DeleteFieldRequest
- CreateSelectionChoiceRequest
- UpdateSelectionChoicePropertiesRequest
- EnableSelectionChoiceRequest
- DisableSelectionChoiceRequest
- DeleteSelectionChoiceRequest
- การตอบกลับ
- UpdateLabelPropertiesResponse
- CreateFieldResponse
- UpdateFieldPropertiesResponse
- UpdateFieldTypeResponse
- EnableFieldResponse
- DisableFieldResponse
- DeleteFieldResponse
- CreateSelectionChoiceResponse
- UpdateSelectionChoicePropertiesResponse
- EnableSelectionChoiceResponse
- DisableSelectionChoiceResponse
- DeleteSelectionChoiceResponse
- ลองใช้งาน
อัปเดตป้ายกำกับรายการเดียวโดยใช้ชุดคำขออัปเดตซึ่งจะส่งผลให้มีฉบับร่างการแก้ไขใหม่ การอัปเดตแบบเป็นกลุ่มเป็นแบบทั้งหมดหรือไม่มีเลย หากคำขออัปเดตใดไม่ถูกต้อง ระบบจะไม่ใช้การเปลี่ยนแปลง คุณต้องเผยแพร่ฉบับร่างฉบับแก้ไขที่เป็นผลลัพธ์ก่อนจึงจะใช้การเปลี่ยนแปลงกับรายการในไดรฟ์ได้
คำขอ HTTP
POST https://drivelabels.googleapis.com/v2/{name=labels/*}:delta
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของป้ายกำกับที่จะอัปเดต |
เนื้อความของคำขอ
เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "writeControl": { object ( |
ช่อง | |
---|---|
writeControl |
ควบคุมวิธีดำเนินการกับคำขอเขียน |
requests[] |
รายการอัปเดตที่จะใช้กับป้ายกำกับ โดยระบบจะใช้คำขอตามลำดับที่ระบุ |
useAdminAccess |
ตั้งค่าเป็น |
view |
เมื่อระบุแล้ว ระบบจะแสดงเฉพาะบางช่องของมุมมองที่ระบุเท่านั้น |
languageCode |
รหัสภาษา BCP-47 ที่จะใช้ในการประเมินป้ายกํากับช่องที่แปลแล้วเมื่อ |
เนื้อหาการตอบกลับ
การตอบกลับสําหรับการอัปเดตป้ายกํากับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "responses": [ { object ( |
ช่อง | |
---|---|
responses[] |
การตอบกลับการอัปเดต ซึ่งจะเชื่อมโยงกับข้อมูลอัปเดตแบบ 1:1 แม้ว่าการตอบกลับคําขอบางรายการอาจว่างเปล่า |
updatedLabel |
ป้ายกํากับหลังจากใช้การอัปเดต ระบบจะตั้งค่านี้เฉพาะในกรณีที่ [BatchUpdateLabelResponse2.include_label_in_response] เป็น |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/drive.labels
https://www.googleapis.com/auth/drive.admin.labels
ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
ส่งคำขอ
การอัปเดตประเภทเดียวที่จะใช้กับป้ายกำกับ
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์สหภาพ kind ประเภทการอัปเดต ต้องมีฟิลด์เดียวเท่านั้น kind ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
updateLabel |
อัปเดตพร็อพเพอร์ตี้ป้ายกำกับ |
createField |
สร้างช่องใหม่ |
updateField |
อัปเดตพร็อพเพอร์ตี้พื้นฐานของช่อง |
updateFieldType |
อัปเดตประเภทฟิลด์และ/หรือตัวเลือกประเภท |
enableField |
เปิดใช้ช่อง |
disableField |
ปิดใช้ช่อง |
deleteField |
ลบช่องออกจากป้ายกำกับ |
createSelectionChoice |
สร้างตัวเลือกภายในช่องการเลือก |
updateSelectionChoiceProperties |
อัปเดตพร็อพเพอร์ตี้ Choice ภายในช่องการเลือก |
enableSelectionChoice |
เปิดใช้ตัวเลือกภายในช่องการเลือก |
disableSelectionChoice |
ปิดใช้ตัวเลือกในช่องการเลือก |
deleteSelectionChoice |
ลบตัวเลือกในช่องการเลือก |
UpdateLabelPropertiesRequest
อัปเดตพร็อพเพอร์ตี้พื้นฐานของป้ายกำกับ
การแสดง JSON |
---|
{
"updateMask": string,
"properties": {
object ( |
ช่อง | |
---|---|
updateMask |
ฟิลด์ที่ควรอัปเดต ต้องระบุฟิลด์อย่างน้อย 1 ช่อง ระบบจะนํา |
properties |
ต้องระบุ พร็อพเพอร์ตี้ป้ายกำกับที่จะอัปเดต |
CreateFieldRequest
คำขอสร้างช่องภายในป้ายกำกับ
การแสดง JSON |
---|
{
"field": {
object ( |
ช่อง | |
---|---|
field |
ต้องระบุ ฟิลด์ที่จะสร้าง |
UpdateFieldPropertiesRequest
ส่งคำขออัปเดตพร็อพเพอร์ตี้ฟิลด์
การแสดง JSON |
---|
{
"updateMask": string,
"id": string,
"properties": {
object ( |
ช่อง | |
---|---|
updateMask |
ฟิลด์ที่ควรอัปเดต ต้องระบุฟิลด์อย่างน้อย 1 ช่อง ระบบจะนํา |
id |
ต้องระบุ ฟิลด์ที่จะอัปเดต |
properties |
ต้องระบุ พร็อพเพอร์ตี้พื้นฐานของช่อง |
UpdateFieldTypeRequest
คำขอเปลี่ยนประเภทของฟิลด์
การแสดง JSON |
---|
{ "updateMask": string, "id": string, // Union field |
ช่อง | |
---|---|
updateMask |
ฟิลด์ที่ควรอัปเดต ต้องระบุฟิลด์อย่างน้อย 1 ช่อง ระบบจะนํารากของ |
id |
ต้องระบุ ฟิลด์ที่จะอัปเดต |
ฟิลด์สหภาพ
|
|
textOptions |
อัปเดตช่องเป็นข้อความ |
integerOptions |
อัปเดตช่องเป็นจำนวนเต็ม |
dateOptions |
อัปเดตช่องเป็น "วันที่" |
selectionOptions |
อัปเดตช่องเป็น "การเลือก" |
userOptions |
อัปเดตช่องเป็นผู้ใช้ |
EnableFieldRequest
คำขอเปิดใช้ช่อง
การแสดง JSON |
---|
{ "id": string } |
ช่อง | |
---|---|
id |
ต้องระบุ รหัสของช่องที่จะเปิดใช้ |
DisableFieldRequest
คำขอปิดใช้ช่อง
การแสดง JSON |
---|
{
"updateMask": string,
"id": string,
"disabledPolicy": {
object ( |
ช่อง | |
---|---|
updateMask |
ฟิลด์ที่ควรอัปเดต ต้องระบุฟิลด์อย่างน้อย 1 ช่อง ระบบจะนํา |
id |
ต้องระบุ คีย์ของช่องที่จะปิดใช้ |
disabledPolicy |
ต้องระบุ นโยบายปิดใช้ช่อง |
DeleteFieldRequest
คำขอให้ลบช่อง
การแสดง JSON |
---|
{ "id": string } |
ช่อง | |
---|---|
id |
ต้องระบุ รหัสของช่องที่จะลบ |
CreateSelectionChoiceRequest
คำขอสร้างตัวเลือกการเลือก
การแสดง JSON |
---|
{
"fieldId": string,
"choice": {
object ( |
ช่อง | |
---|---|
fieldId |
ต้องระบุ ช่องการเลือกที่จะสร้างตัวเลือก |
choice |
ต้องระบุ ทางเลือกในการสร้าง |
UpdateSelectionChoicePropertiesRequest
คำขออัปเดตพร็อพเพอร์ตี้ทางเลือก
การแสดง JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
ช่อง | |
---|---|
updateMask |
ฟิลด์ที่ควรอัปเดต ต้องระบุฟิลด์อย่างน้อย 1 ช่อง ระบบจะนํา |
fieldId |
ต้องระบุ ช่องการเลือกที่จะอัปเดต |
id |
ต้องระบุ ตัวเลือกในการอัปเดต |
properties |
ต้องระบุ พร็อพเพอร์ตี้ทางเลือกที่จะอัปเดต |
EnableSelectionChoiceRequest
คำขอเปิดใช้ทางเลือก
การแสดง JSON |
---|
{ "fieldId": string, "id": string } |
ช่อง | |
---|---|
fieldId |
ต้องระบุ ฟิลด์การเลือกที่จะเปิดใช้ตัวเลือก |
id |
ต้องระบุ ตัวเลือกในการเปิดใช้ |
DisableSelectionChoiceRequest
คำขอให้ปิดใช้ทางเลือก
การแสดง JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"disabledPolicy": {
object ( |
ช่อง | |
---|---|
updateMask |
ฟิลด์ที่ควรอัปเดต ต้องระบุฟิลด์อย่างน้อย 1 ช่อง ระบบจะนํา |
fieldId |
ต้องระบุ ช่องการเลือกที่จะปิดใช้ตัวเลือก |
id |
ต้องระบุ ตัวเลือกในการปิดใช้ |
disabledPolicy |
ต้องระบุ นโยบายที่ปิดใช้ที่จะอัปเดต |
DeleteSelectionChoiceRequest
คำขอให้ลบทางเลือก
การแสดง JSON |
---|
{ "fieldId": string, "id": string } |
ช่อง | |
---|---|
fieldId |
ต้องระบุ ฟิลด์การเลือกที่จะลบตัวเลือก |
id |
ต้องระบุ ตัวเลือกในการลบ |
การตอบกลับ
การตอบกลับรายการเดียวจากการอัปเดต
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์สหภาพ response การตอบกลับสําหรับคําขอที่เกี่ยวข้อง response ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
updateLabel |
อัปเดตพร็อพเพอร์ตี้พื้นฐานของป้ายกำกับ |
createField |
สร้างช่องใหม่ |
updateField |
อัปเดตพร็อพเพอร์ตี้พื้นฐานของช่อง |
updateFieldType |
อัปเดตประเภทฟิลด์และ/หรือตัวเลือกประเภท |
enableField |
เปิดใช้ฟิลด์ |
disableField |
ปิดใช้ช่อง |
deleteField |
ลบช่องออกจากป้ายกำกับ |
createSelectionChoice |
สร้างตัวเลือกรายการตัวเลือกใหม่เพื่อเพิ่มลงในช่องการเลือก |
updateSelectionChoiceProperties |
อัปเดตตัวเลือกภายในช่องการเลือก |
enableSelectionChoice |
เปิดใช้ตัวเลือกภายในช่องการเลือก |
disableSelectionChoice |
ปิดใช้ตัวเลือกในช่องการเลือก |
deleteSelectionChoice |
ลบตัวเลือกออกจากฟิลด์ตัวเลือก |
UpdateLabelPropertiesResponse
ประเภทนี้ไม่มีช่อง
การตอบกลับหลังจากอัปเดตพร็อพเพอร์ตี้ป้ายกำกับ
CreateFieldResponse
การตอบกลับหลังจากสร้างช่อง
การแสดง JSON |
---|
{ "id": string, "priority": integer } |
ช่อง | |
---|---|
id |
ฟิลด์ของฟิลด์ที่สร้าง หากปล่อยว่างไว้ในคำขอสร้าง ระบบจะสร้างคีย์ให้โดยอัตโนมัติและระบุคีย์ได้ที่นี่ |
priority |
ลําดับความสําคัญของช่องที่สร้าง ลําดับความสําคัญอาจเปลี่ยนแปลงจากสิ่งที่ระบุไว้เพื่อให้ลําดับความสําคัญต่อเนื่องกันระหว่างช่อง (1-n) |
UpdateFieldPropertiesResponse
การตอบกลับหลังจากอัปเดตพร็อพเพอร์ตี้ฟิลด์
การแสดง JSON |
---|
{ "priority": integer } |
ช่อง | |
---|---|
priority |
ลําดับความสําคัญของช่องที่อัปเดต ลําดับความสําคัญอาจเปลี่ยนแปลงจากสิ่งที่ระบุไว้เพื่อให้ลําดับความสําคัญต่อเนื่องกันระหว่างช่อง (1-n) |
UpdateFieldTypeResponse
ประเภทนี้ไม่มีช่อง
การตอบกลับหลังจากอัปเดตประเภทฟิลด์
EnableFieldResponse
ประเภทนี้ไม่มีช่อง
เปิดใช้ช่องคำตอบต่อ
DisableFieldResponse
ประเภทนี้ไม่มีช่อง
การตอบสนองหลังจากปิดใช้ฟิลด์
DeleteFieldResponse
ประเภทนี้ไม่มีช่อง
การตอบสนองหลังจากการลบช่อง
CreateSelectionChoiceResponse
การตอบสนองหลังจากสร้างตัวเลือกการเลือก
การแสดง JSON |
---|
{ "fieldId": string, "id": string } |
ช่อง | |
---|---|
fieldId |
รหัสที่เซิร์ฟเวอร์สร้างขึ้นของช่อง |
id |
รหัสที่เซิร์ฟเวอร์สร้างขึ้นของตัวเลือกที่สร้างภายในช่อง |
UpdateSelectionChoicePropertiesResponse
การตอบสนองหลังจากอัปเดตพร็อพเพอร์ตี้ตัวเลือกการเลือก
การแสดง JSON |
---|
{ "priority": integer } |
ช่อง | |
---|---|
priority |
ลำดับความสำคัญของตัวเลือกที่อัปเดต ลําดับความสําคัญอาจเปลี่ยนแปลงจากสิ่งที่ระบุไว้เพื่อให้ลําดับความสําคัญของตัวเลือก (1-n) ต่อเนื่องกัน |
EnableSelectionChoiceResponse
ประเภทนี้ไม่มีช่อง
เปิดใช้คำตอบตามตัวเลือก
DisableSelectionChoiceResponse
ประเภทนี้ไม่มีช่อง
การปิดใช้คําตอบตามตัวเลือก
DeleteSelectionChoiceResponse
ประเภทนี้ไม่มีช่อง
การตอบกลับหลังจากลบตัวเลือก