Method: forms.batchUpdate

Mengubah formulir dengan batch pembaruan.

Permintaan HTTP

POST https://forms.googleapis.com/v1/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 diperbarui dalam respons.
requests[]

object (Request)

Wajib. Permintaan update batch ini.
writeControl

object (WriteControl)

Memberikan kontrol atas cara permintaan tulis dieksekusi.

Isi respons

Respons terhadap BatchUpdateFormRequest.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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 baru dari ID revisi yang dibuat oleh perubahan ini.
replies[]

object (Response)

Balasan pembaruan. Hal ini dipetakan 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 mengetahui informasi selengkapnya, lihat Panduan otorisasi.

Permintaan

Jenis permintaan pembaruan 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 yang ditentukan.
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. info root tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk memperbarui setiap kolom.

Ini adalah daftar dipisahkan koma yang berisi nama-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. settings root tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk memperbarui setiap kolom.

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

CreateItemRequest

Membuat item dalam formulir.

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

object (Item)

Wajib. Item yang akan dibuat.
location

object (Location)

Wajib. Tempat untuk menempatkan item baru.

Lokasi

Lokasi tertentu dalam formulir.

Representasi JSON 
{

  // Union field where can be only one of the following:
  "index": integer
  // End of list of possible types for union field where.
}
Kolom
Kolom union where. Wajib. Tentukan lokasi dalam formulir. where hanya dapat berupa salah satu dari berikut:
index

integer

Indeks item dalam formulir. Nilai ini harus 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 disediakan (dan ada dalam mask kolom). Jika ID kosong (dan dalam mask kolom), ID baru akan dibuat. Artinya, 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 dipisahkan koma yang berisi nama-nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

WriteControl

Memberikan kontrol atas cara permintaan tulis dieksekusi.

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 tempat perubahan akan diterapkan, dan perilaku permintaan 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 terbaru formulir, permintaan tidak akan diproses dan menampilkan error permintaan tidak valid 400.
targetRevisionId

string

ID revisi target formulir tempat permintaan tulis diterapkan.

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

ID revisi target hanya dapat digunakan untuk menulis ke versi terbaru formulir. Jika revisi target terlalu jauh di belakang revisi terbaru, permintaan tidak akan diproses dan menampilkan 400 (Bad Request Error). Permintaan dapat dicoba lagi setelah membaca versi terbaru formulir. 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 
{

  // Union field kind can be only one of the following:
  "createItem": {
    object (CreateItemResponse)
  }
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Jenis respons. kind hanya dapat berupa salah satu dari berikut:
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, ID semua pertanyaan yang dibuat untuk item ini akan dicantumkan.