- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- คำขอ
- UpdateLabelPropertiesRequest
- CreateFieldRequest
- UpdateFieldPropertiesRequest
- UpdateFieldTypeRequest
- LongTextOptions
- 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 ประเภทของการอัปเดต ต้องระบุเพียง 1 ช่องเท่านั้น 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 |
อัปเดตช่องเป็นข้อความ |
longTextOptions |
อัปเดตช่องเป็นข้อความยาว |
integerOptions |
อัปเดตช่องเป็นจำนวนเต็ม |
dateOptions |
อัปเดตช่องเป็น "วันที่" |
selectionOptions |
อัปเดตช่องเป็น "การเลือก" |
userOptions |
อัปเดตช่องเป็นผู้ใช้ |
LongTextOptions
ตัวเลือกประเภทฟิลด์ข้อความแบบยาว
การแสดง JSON |
---|
{ "minLength": integer, "maxLength": integer } |
ช่อง | |
---|---|
minLength |
เอาต์พุตเท่านั้น ความยาวขั้นต่ำที่ถูกต้องของค่าสำหรับช่องข้อความ |
maxLength |
เอาต์พุตเท่านั้น ความยาวสูงสุดของค่าสำหรับช่องข้อความ |
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
ส่งคำขออัปเดตพร็อพเพอร์ตี้ Choice
การแสดง JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
ช่อง | |
---|---|
updateMask |
ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง ราก |
fieldId |
ต้องระบุ ช่องการเลือกที่จะอัปเดต |
id |
ต้องระบุ ตัวเลือกที่ต้องการอัปเดต |
properties |
ต้องระบุ พร็อพเพอร์ตี้ของ Choice ที่จะอัปเดต |
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
คำตอบหลังจากลบตัวเลือก