Method: forms.batchUpdate

Mengubah formulir dengan sekumpulan pembaruan.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
formId

string

Wajib. ID formulir.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "includeFormInResponse": boolean,
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Kolom
includeFormInResponse

boolean

Apakah akan menampilkan versi model yang diupdate dalam respons.
requests[]

object (Request)

Wajib. Permintaan pembaruan batch ini.
writeControl

object (WriteControl)

Memberikan kontrol atas cara permintaan tulis dijalankan.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons terhadap BatchUpdateFormRequest.

Representasi JSON 
{
  "form": {
    object (Form)
  },
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Kolom
form

object (Form)

Berdasarkan kolom permintaan bool includeFormInResponse, formulir dengan semua mutasi/pembaruan yang diterapkan akan ditampilkan atau tidak. ID ini mungkin lebih lama dari ID revisi yang dibuat oleh perubahan ini.
replies[]

object (Response)

Balasan atas pembaruan. Kebijakan ini memetakan 1:1 dengan permintaan update, meskipun balasan untuk beberapa permintaan mungkin kosong.
writeControl

object (WriteControl)

Kontrol tulis yang diperbarui setelah menerapkan permintaan.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.

Permintaan

Jenis permintaan update yang dapat dibuat.

Representasi 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.
}
Kolom
Kolom union kind. Jenis permintaan. kind hanya dapat berupa salah satu dari berikut:
updateFormInfo

object (UpdateFormInfoRequest)

Perbarui Info Formulir.
updateSettings

object (UpdateSettingsRequest)

Memperbarui setelan Formulir.
createItem

object (CreateItemRequest)

Membuat item baru.
moveItem

object (MoveItemRequest)

Memindahkan item ke lokasi tertentu.
deleteItem

object (DeleteItemRequest)

Menghapus item.
updateItem

object (UpdateItemRequest)

Memperbarui item.

UpdateFormInfoRequest

Perbarui Info Formulir.

Representasi JSON 
{
  "info": {
    object (Info)
  },
  "updateMask": string
}
Kolom
info

object (Info)

Info yang akan diperbarui.
updateMask

string (FieldMask format)

Wajib. Hanya nilai yang disebutkan dalam mask ini yang diubah. Setidaknya satu kolom harus ditentukan. Akar info bersifat tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai pintasan untuk memperbarui setiap kolom.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

UpdateSettingsRequest

Perbarui FormSettings Formulir.

Representasi JSON 
{
  "settings": {
    object (FormSettings)
  },
  "updateMask": string
}
Kolom
settings

object (FormSettings)

Wajib. Setelan yang akan diperbarui.
updateMask

string (FieldMask format)

Wajib. Hanya nilai yang disebutkan dalam mask ini yang diubah. Setidaknya satu kolom harus ditentukan. Akar settings bersifat tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai pintasan untuk memperbarui setiap kolom.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

CreateItemRequest

Buat item dalam formulir.

Representasi JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  }
}
Kolom
item

object (Item)

Wajib. Item yang akan dibuat.
location

object (Location)

Wajib. Lokasi penempatan item baru.

Lokasi

Lokasi tertentu dalam formulir.

Representasi JSON 
{
  "index": integer
}
Kolom
index

integer

Indeks item dalam formulir. Ini harus berada dalam rentang

[0..N)

, dengan N adalah jumlah item dalam formulir.

MoveItemRequest

Memindahkan item dalam formulir.

Representasi JSON 
{
  "originalLocation": {
    object (Location)
  },
  "newLocation": {
    object (Location)
  }
}
Kolom
originalLocation

object (Location)

Wajib. Lokasi item yang akan dipindahkan.
newLocation

object (Location)

Wajib. Lokasi baru untuk item.

DeleteItemRequest

Menghapus item dalam formulir.

Representasi JSON 
{
  "location": {
    object (Location)
  }
}
Kolom
location

object (Location)

Wajib. Lokasi item yang akan dihapus.

UpdateItemRequest

Memperbarui item dalam formulir.

Representasi JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  },
  "updateMask": string
}
Kolom
item

object (Item)

Wajib. Nilai baru untuk item. Perhatikan bahwa ID item dan pertanyaan digunakan jika diberikan (dan berada di mask kolom). Jika ID kosong (dan di mask kolom), ID baru akan dibuat. Ini berarti Anda dapat mengubah item dengan mendapatkan formulir melalui forms.get, mengubah salinan lokal item tersebut sesuai keinginan Anda, dan menggunakan UpdateItemRequest untuk menulisnya kembali, dengan ID yang sama (atau tidak dalam mask kolom).
location

object (Location)

Wajib. Lokasi yang mengidentifikasi item yang akan diperbarui.
updateMask

string (FieldMask format)

Wajib. Hanya nilai yang disebutkan dalam mask ini yang diubah.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

WriteControl

Memberikan kontrol atas cara permintaan tulis dijalankan.

Representasi 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.
}
Kolom
Kolom union control. Menentukan revisi formulir dari mana perubahan akan diterapkan, dan bagaimana permintaan harus berperilaku jika revisi tersebut bukan revisi formulir saat ini. control hanya dapat berupa salah satu dari berikut:
requiredRevisionId

string

ID revisi formulir tempat permintaan tulis diterapkan. Jika ini bukan revisi formulir terbaru, permintaan tidak akan diproses dan menampilkan error permintaan buruk 400.
targetRevisionId

string

ID revisi target dari formulir tempat permintaan tulis diterapkan.

Jika terjadi perubahan setelah revisi ini, perubahan dalam permintaan pembaruan ini akan diubah berdasarkan perubahan tersebut. Proses ini menghasilkan revisi formulir baru yang menggabungkan perubahan dalam permintaan dan perubahan intervensi, dengan server menyelesaikan perubahan yang berkonflik.

ID revisi target hanya dapat digunakan untuk menulis formulir versi terbaru. Jika revisi target terlalu jauh dari revisi terbaru, permintaan tidak akan diproses dan menampilkan 400 (Error Permintaan Buruk). Anda dapat mencoba lagi setelah membaca formulir versi terbaru. Pada umumnya, ID revisi target tetap valid selama beberapa menit setelah dibaca, tetapi untuk formulir yang sering diedit, periode ini mungkin lebih singkat.

Respons

Satu respons dari update.

Representasi JSON 
{
  "createItem": {
    object (CreateItemResponse)
  }
}
Kolom
createItem

object (CreateItemResponse)

Hasil pembuatan item.

CreateItemResponse

Hasil pembuatan item.

Representasi JSON 
{
  "itemId": string,
  "questionId": [
    string
  ]
}
Kolom
itemId

string

ID item yang dibuat.
questionId[]

string

ID pertanyaan yang dibuat sebagai bagian dari item ini, untuk grup pertanyaan, ini mencantumkan ID semua pertanyaan yang dibuat untuk item ini.