Method: forms.batchUpdate

เปลี่ยนแบบฟอร์มเป็นกลุ่มการอัปเดต

คำขอ HTTP

POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate

URL ใช้ไวยากรณ์ gRPC Transcoding

พารามิเตอร์เส้นทาง

พารามิเตอร์
formId

string

ต้องระบุ รหัสแบบฟอร์ม

เนื้อหาของคำขอ

เนื้อหาของคําขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "includeFormInResponse": boolean,
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
ช่อง
includeFormInResponse

boolean

ต้องการส่งคืนเวอร์ชันที่อัปเดตแล้วของโมเดลในการตอบกลับหรือไม่
requests[]

object (Request)

ต้องระบุ คําขอการอัปเดตของกลุ่มนี้
writeControl

object (WriteControl)

ให้การควบคุมวิธีการเรียกใช้คําขอเขียน

เนื้อหาการตอบกลับ

การตอบกลับ BatchUpdateFormRequest

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "form": {
    object (Form)
  },
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
ช่อง
form

object (Form)

จากแบบฟอร์มคําขอบูลีน includeFormInResponse ระบบจะส่งแบบฟอร์มที่มีการเปลี่ยนแปลง/การอัปเดตที่นําไปใช้ทั้งหมดหรือไม่ ซึ่งอาจช้ากว่ารหัสการแก้ไขที่สร้างขึ้นโดยการเปลี่ยนแปลงเหล่านี้
replies[]

object (Response)

การตอบกลับการอัปเดต การดําเนินการนี้จะจับคู่คําขอแบบ 1:1 กับคําขออัปเดต แม้ว่าการตอบกลับคําขอบางรายการอาจว่างเปล่า
writeControl

object (WriteControl)

การควบคุมการเขียนที่อัปเดตหลังจากใช้คําขอ

ขอบเขตการให้สิทธิ์

ต้องการขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/forms.body

สําหรับข้อมูลเพิ่มเติม โปรดดูคู่มือการให้สิทธิ์

ส่งคำขอ

ประเภทคําขออัปเดตที่ทําได้

การแสดง JSON 
{

  // Union field kind can be only one of the following:
  "updateFormInfo": {
    object (UpdateFormInfoRequest)
  },
  "updateSettings": {
    object (UpdateSettingsRequest)
  },
  "createItem": {
    object (CreateItemRequest)
  },
  "moveItem": {
    object (MoveItemRequest)
  },
  "deleteItem": {
    object (DeleteItemRequest)
  },
  "updateItem": {
    object (UpdateItemRequest)
  }
  // End of list of possible types for union field kind.
}
ช่อง
ช่อง Union kind ชนิดของคําขอ kind ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
updateFormInfo

object (UpdateFormInfoRequest)

อัปเดตข้อมูลของแบบฟอร์ม
updateSettings

object (UpdateSettingsRequest)

อัปเดตการตั้งค่าของแบบฟอร์ม
createItem

object (CreateItemRequest)

สร้างรายการใหม่
moveItem

object (MoveItemRequest)

ย้ายรายการไปยังตําแหน่งที่ระบุ
deleteItem

object (DeleteItemRequest)

ลบรายการ
updateItem

object (UpdateItemRequest)

อัปเดตรายการ

UpdateFormInfoRequest

อัปเดตข้อมูลของแบบฟอร์ม

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

object (Info)

ข้อมูลที่จะอัปเดต
updateMask

string (FieldMask format)

ต้องระบุ มีเฉพาะค่าที่มีชื่อในการมาสก์นี้เท่านั้นที่จะเปลี่ยนแปลง ต้องระบุอย่างน้อย 1 ช่อง รูท info โดยนัยโดยนัยและไม่ควรระบุไว้ สามารถใช้ "*" เดียวสําหรับการอัปเดตทุกๆ ชี่

ซึ่งเป็นรายการช่องชื่อที่ครบถ้วนสมบูรณ์โดยคั่นด้วยเครื่องหมายจุลภาค ตัวอย่าง: "user.displayName,photo"

คําขออัปเดตการตั้งค่า

อัปเดต FormSettings ของแบบฟอร์ม

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

object (FormSettings)

ต้องระบุ การตั้งค่าที่จะอัปเดต
updateMask

string (FieldMask format)

ต้องระบุ มีเฉพาะค่าที่มีชื่อในการมาสก์นี้เท่านั้นที่จะเปลี่ยนแปลง ต้องระบุอย่างน้อย 1 ช่อง รูท settings โดยนัยโดยนัยและไม่ควรระบุไว้ สามารถใช้ "*" เดียวสําหรับการอัปเดตทุกๆ ชี่

ซึ่งเป็นรายการช่องชื่อที่ครบถ้วนสมบูรณ์โดยคั่นด้วยเครื่องหมายจุลภาค ตัวอย่าง: "user.displayName,photo"

สร้าง ItemItem

สร้างรายการในแบบฟอร์ม

การแสดง JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  }
}
ช่อง
item

object (Item)

ต้องระบุ รายการที่จะสร้าง
location

object (Location)

ต้องระบุ ควรวางรายการใหม่ไว้ที่ใด

ตำแหน่ง

ตําแหน่งเฉพาะเจาะจงในแบบฟอร์ม

การแสดง JSON 
{

  // Union field where can be only one of the following:
  "index": integer
  // End of list of possible types for union field where.
}
ช่อง
ช่อง Union where ต้องระบุ ระบุสถานที่ในแบบฟอร์ม where ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
index

integer

ดัชนีของรายการในแบบฟอร์ม ต้องอยู่ในช่วง

[0..N)

โดยที่ N คือจํานวนรายการในแบบฟอร์ม

ย้ายรายการ

ย้ายรายการในแบบฟอร์ม

การแสดง JSON 
{
  "originalLocation": {
    object (Location)
  },
  "newLocation": {
    object (Location)
  }
}
ช่อง
originalLocation

object (Location)

ต้องระบุ ตําแหน่งของรายการที่จะย้าย
newLocation

object (Location)

ต้องระบุ ตําแหน่งใหม่สําหรับรายการ

ลบรายการคําขอ

ลบรายการในแบบฟอร์ม

การแสดง JSON 
{
  "location": {
    object (Location)
  }
}
ช่อง
location

object (Location)

ต้องระบุ ตําแหน่งของรายการที่จะลบ

อัปเดตคําขอรายการ

อัปเดตรายการในแบบฟอร์ม

การแสดง JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  },
  "updateMask": string
}
ช่อง
item

object (Item)

ต้องระบุ ค่าใหม่ของรายการ โปรดทราบว่ารหัสรายการและคําถามจะใช้หากได้ระบุไว้ (และอยู่ในมาสก์ของช่อง) หากรหัสว่างเปล่า (และในช่องมาสก์) ระบบจะสร้างรหัสใหม่ หมายความว่าคุณสามารถแก้ไขรายการได้โดยรับแบบฟอร์มผ่าน forms.get แก้ไขสําเนาในเครื่องของรายการนั้นให้เป็นแบบที่คุณต้องการ และใช้ UpdateItemRequest เพื่อเขียนกลับมา โดยรหัสจะเหมือนกัน (หรือไม่ได้อยู่ในมาสก์ของช่อง)
location

object (Location)

ต้องระบุ ตําแหน่งที่ระบุรายการเพื่ออัปเดต
updateMask

string (FieldMask format)

ต้องระบุ มีเฉพาะค่าที่มีชื่อในการมาสก์นี้เท่านั้นที่จะเปลี่ยนแปลง

ซึ่งเป็นรายการช่องชื่อที่ครบถ้วนสมบูรณ์โดยคั่นด้วยเครื่องหมายจุลภาค ตัวอย่าง: "user.displayName,photo"

การควบคุมการเขียน

ให้การควบคุมวิธีการเรียกใช้คําขอเขียน

การแสดง JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
ช่อง
ช่อง Union control กําหนดการแก้ไขของแบบฟอร์มที่จะนําการเปลี่ยนแปลงไปใช้ และวิธีที่คําขอควรทํางานในกรณีที่การแก้ไขนั้นไม่ใช่การแก้ไขปัจจุบันของฟอร์ม control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
requiredRevisionId

string

รหัสการแก้ไขของแบบฟอร์มที่ใช้กับคําขอเขียน หากนี่ไม่ใช่การแก้ไขครั้งล่าสุดของแบบฟอร์ม คําขอจะไม่ได้รับการดําเนินการและแสดงข้อผิดพลาด 400 ที่ไม่ถูกต้อง
targetRevisionId

string

รหัสการแก้ไขเป้าหมายของแบบฟอร์มที่ใช้กับคําขอเขียน

หากการเปลี่ยนแปลงเกิดขึ้นหลังจากการแก้ไขนี้ การเปลี่ยนแปลงในคําขออัปเดตนี้จะเปลี่ยนแปลงไปตามการเปลี่ยนแปลงเหล่านั้น ซึ่งจะส่งผลให้มีการแก้ไขแบบฟอร์มใหม่ ซึ่งรวมทั้งการเปลี่ยนแปลงในคําขอและการเปลี่ยนแปลงที่จะมีผล เนื่องจากเซิร์ฟเวอร์มีการแก้ไขการเปลี่ยนแปลงที่ขัดแย้งกัน

รหัสการแก้ไขเป้าหมายจะเขียนในแบบฟอร์มเวอร์ชันล่าสุดเท่านั้น หากการแก้ไขเป้าหมายอยู่ไกลกว่าการแก้ไขล่าสุดมาก ระบบจะไม่ประมวลผลคําขอและจะส่งกลับ 400 (ข้อผิดพลาดคําขอผิดพลาด) เราอาจลองส่งคําขออีกครั้งหลังจากอ่านแบบฟอร์มเวอร์ชันล่าสุดแล้ว ในกรณีส่วนใหญ่ รหัสการแก้ไขเป้าหมายจะยังใช้ได้หลายนาทีหลังจากอ่านแล้ว แต่สําหรับฟอร์มที่แก้ไขบ่อย หน้าต่างนี้อาจสั้นลง

คำตอบ

คําตอบเดียวจากการอัปเดต

การแสดง JSON 
{

  // Union field kind can be only one of the following:
  "createItem": {
    object (CreateItemResponse)
  }
  // End of list of possible types for union field kind.
}
ช่อง
ช่อง Union kind ชนิดของคําตอบ kind ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
createItem

object (CreateItemResponse)

ผลลัพธ์ของการสร้างรายการ

สร้างการตอบกลับของรายการ

ผลลัพธ์ของการสร้างรายการ

การแสดง JSON 
{
  "itemId": string,
  "questionId": [
    string
  ]
}
ช่อง
itemId

string

รหัสของรายการที่สร้างขึ้น
questionId[]

string

รหัสของคําถามที่สร้างขึ้นรายการนี้ สําหรับกลุ่มคําถาม จะแสดงรหัสของคําถามทั้งหมดที่สร้างขึ้นสําหรับรายการ