REST Resource: forms

Resource: Form

Dokumen Google Formulir. Formulir dibuat di Drive, dan penghapusan formulir atau perubahan perlindungan aksesnya dilakukan melalui Drive API.

Representasi JSON 
{
  "formId": string,
  "info": {
    object (Info)
  },
  "settings": {
    object (FormSettings)
  },
  "items": [
    {
      object (Item)
    }
  ],
  "revisionId": string,
  "responderUri": string,
  "linkedSheetId": string
}
Kolom
formId

string

Hanya output. ID formulir.
info

object (Info)

Wajib. Judul dan deskripsi formulir.
settings

object (FormSettings)

Setelan formulir. Ini harus diperbarui dengan UpdateSettingsRequest; ini diabaikan selama forms.create dan UpdateFormInfoRequest.
items[]

object (Item)

Wajib. Daftar item formulir, yang dapat mencakup header bagian, pertanyaan, media tersemat, dll.
revisionId

string

Hanya output. ID revisi formulir. Digunakan dalam WriteControl dalam permintaan pembaruan untuk mengidentifikasi revisi yang menjadi dasar perubahan.

Format ID revisi dapat berubah dari waktu ke waktu, sehingga harus diperlakukan secara buram. ID revisi yang ditampilkan hanya dijamin valid selama 24 jam setelah ditampilkan dan tidak dapat dibagikan kepada pengguna lain. Jika ID revisi tidak berubah di antara panggilan, berarti formulir belum berubah. Sebaliknya, ID yang diubah (untuk formulir dan pengguna yang sama) biasanya berarti formulir telah diperbarui; namun, ID yang diubah juga dapat disebabkan oleh faktor internal seperti perubahan format ID.
responderUri

string

Hanya output. URI formulir yang akan dibagikan kepada responden. Tindakan ini akan membuka halaman yang memungkinkan pengguna mengirimkan respons, tetapi tidak mengedit pertanyaan.
linkedSheetId

string

Hanya output. ID Google Spreadsheet tertaut yang mengumpulkan respons dari Formulir ini (jika Spreadsheet tersebut ada).

Info

Informasi umum untuk formulir.

Representasi JSON 
{
  "title": string,
  "documentTitle": string,
  "description": string
}
Kolom
title

string

Wajib. Judul formulir yang dapat dilihat oleh responden.
documentTitle

string

Hanya output. Judul dokumen yang terlihat di Drive. Jika Info.title kosong, documentTitle dapat muncul sebagai gantinya di UI Google Formulir dan terlihat oleh responden. documentTitle dapat ditetapkan saat pembuatan, tetapi tidak dapat diubah oleh permintaan batchUpdate. Gunakan Google Drive API jika Anda perlu memperbarui documentTitle secara terprogram.
description

string

Deskripsi formulir.

FormSettings

Setelan formulir.

Representasi JSON 
{
  "quizSettings": {
    object (QuizSettings)
  }
}
Kolom
quizSettings

object (QuizSettings)

Setelan yang terkait dengan formulir dan penilaian kuis.

QuizSettings

Setelan yang terkait dengan formulir dan penilaian kuis. Nilai ini harus diperbarui dengan UpdateSettingsRequest.

Representasi JSON 
{
  "isQuiz": boolean
}
Kolom
isQuiz

boolean

Apakah formulir ini merupakan kuis atau bukan. Jika benar, respons akan dinilai berdasarkan pertanyaan Grading. Setelah disetel ke salah (false), semua Grading pertanyaan akan dihapus.

Item

Satu item formulir. kind menentukan jenis itemnya.

Representasi JSON 
{
  "itemId": string,
  "title": string,
  "description": string,

  // Union field kind can be only one of the following:
  "questionItem": {
    object (QuestionItem)
  },
  "questionGroupItem": {
    object (QuestionGroupItem)
  },
  "pageBreakItem": {
    object (PageBreakItem)
  },
  "textItem": {
    object (TextItem)
  },
  "imageItem": {
    object (ImageItem)
  },
  "videoItem": {
    object (VideoItem)
  }
  // End of list of possible types for union field kind.
}
Kolom
itemId

string

ID item.

Saat pembuatan, ID dapat diberikan, tetapi ID tidak boleh sudah digunakan dalam formulir. Jika tidak diberikan, ID baru akan ditetapkan.
title

string

Judul item.
description

string

Deskripsi item.
Kolom union kind. Wajib. Jenis item ini. kind hanya dapat berupa salah satu dari hal berikut:
questionItem

object (QuestionItem)

Mengajukan pertanyaan kepada pengguna.
questionGroupItem

object (QuestionGroupItem)

Mengajukan satu atau beberapa pertanyaan kepada pengguna dengan satu perintah utama.
pageBreakItem

object (PageBreakItem)

Memulai halaman baru dengan judul.
textItem

object (TextItem)

Menampilkan judul dan deskripsi di halaman.
imageItem

object (ImageItem)

Menampilkan gambar di halaman.
videoItem

object (VideoItem)

Menampilkan video di halaman.

QuestionItem

Item formulir yang berisi satu pertanyaan.

Representasi JSON 
{
  "question": {
    object (Question)
  },
  "image": {
    object (Image)
  }
}
Kolom
question

object (Question)

Wajib. Pertanyaan yang ditampilkan.
image

object (Image)

Gambar yang ditampilkan dalam pertanyaan.

Pertanyaan

Ada pertanyaan? Jenis pertanyaan tertentu diketahui dengan kind-nya.

Representasi JSON 
{
  "questionId": string,
  "required": boolean,
  "grading": {
    object (Grading)
  },

  // Union field kind can be only one of the following:
  "choiceQuestion": {
    object (ChoiceQuestion)
  },
  "textQuestion": {
    object (TextQuestion)
  },
  "scaleQuestion": {
    object (ScaleQuestion)
  },
  "dateQuestion": {
    object (DateQuestion)
  },
  "timeQuestion": {
    object (TimeQuestion)
  },
  "fileUploadQuestion": {
    object (FileUploadQuestion)
  },
  "rowQuestion": {
    object (RowQuestion)
  },
  "ratingQuestion": {
    object (RatingQuestion)
  }
  // End of list of possible types for union field kind.
}
Kolom
questionId

string

Hanya baca. ID pertanyaan.

Saat pembuatan, ID dapat diberikan, tetapi ID tidak boleh sudah digunakan dalam formulir. Jika tidak diberikan, ID baru akan ditetapkan.
required

boolean

Apakah pertanyaan harus dijawab agar responden dapat mengirimkan responsnya.
grading

object (Grading)

Penyiapan penilaian untuk pertanyaan.
Kolom union kind. Wajib. Jenis pertanyaan yang ditawarkan kepada responden. kind hanya dapat berupa salah satu dari berikut:
choiceQuestion

object (ChoiceQuestion)

Responden dapat memilih dari serangkaian opsi yang telah ditentukan sebelumnya.
textQuestion

object (TextQuestion)

Responden dapat memasukkan respons teks bebas.
scaleQuestion

object (ScaleQuestion)

Responden dapat memilih angka dari rentang.
dateQuestion

object (DateQuestion)

Responden dapat memasukkan tanggal.
timeQuestion

object (TimeQuestion)

Responden dapat memasukkan waktu.
fileUploadQuestion

object (FileUploadQuestion)

Responden dapat mengupload satu atau beberapa file.
rowQuestion

object (RowQuestion)

Baris QuestionGroupItem.
ratingQuestion

object (RatingQuestion)

Responden dapat memilih rating dari kumpulan ikon yang telah ditentukan sebelumnya.

ChoiceQuestion

Pertanyaan pilihan/kotak centang/dropdown.

Representasi JSON 
{
  "type": enum (ChoiceType),
  "options": [
    {
      object (Option)
    }
  ],
  "shuffle": boolean
}
Kolom
type

enum (ChoiceType)

Wajib. Jenis pertanyaan pilihan.
options[]

object (Option)

Wajib. Daftar opsi yang harus dipilih responden.
shuffle

boolean

Apakah opsi harus ditampilkan dalam urutan acak untuk instance kuis yang berbeda. Hal ini sering digunakan untuk mencegah kecurangan oleh responden yang mungkin melihat layar responden lain, atau untuk mengatasi bias dalam survei yang mungkin muncul dengan selalu menempatkan opsi yang sama di awal atau di akhir.

ChoiceType

Jenis pilihan.

Enum
CHOICE_TYPE_UNSPECIFIED Nilai default. Tidak digunakan.
RADIO Tombol pilihan: Semua pilihan ditampilkan kepada pengguna, yang hanya dapat memilih salah satunya.
CHECKBOX Kotak centang: Semua pilihan ditampilkan kepada pengguna, yang dapat memilih sejumlah pilihan.
DROP_DOWN Menu drop-down: Pilihan hanya ditampilkan kepada pengguna jika diminta, jika tidak, hanya pilihan saat ini yang ditampilkan. Hanya satu opsi yang dapat dipilih.

Opsi

Opsi untuk pertanyaan Pilihan.

Representasi JSON 
{
  "value": string,
  "image": {
    object (Image)
  },
  "isOther": boolean,

  // Union field go_to_section can be only one of the following:
  "goToAction": enum (GoToAction),
  "goToSectionId": string
  // End of list of possible types for union field go_to_section.
}
Kolom
value

string

Wajib. Pilihan yang ditampilkan kepada pengguna.
image

object (Image)

Menampilkan gambar sebagai opsi.
isOther

boolean

Apakah opsi tersebut adalah "lainnya". Saat ini hanya berlaku untuk jenis pilihan RADIO dan CHECKBOX, tetapi tidak diizinkan dalam QuestionGroupItem.
Kolom union go_to_section. Bagian yang akan dibuka jika opsi ini dipilih. Saat ini hanya berlaku untuk jenis pilihan RADIO dan SELECT, tetapi tidak diizinkan dalam QuestionGroupItem. go_to_section hanya dapat berupa salah satu dari hal berikut:
goToAction

enum (GoToAction)

Jenis navigasi bagian.
goToSectionId

string

ID item header bagian yang akan dibuka.

GoToAction

Konstanta untuk navigasi bagian.

Enum
GO_TO_ACTION_UNSPECIFIED Nilai default. Tidak digunakan.
NEXT_SECTION Buka bagian berikutnya.
RESTART_FORM Kembali ke awal formulir.
SUBMIT_FORM Kirim formulir segera.

Gambar

Data yang mewakili gambar.

Representasi JSON 
{
  "contentUri": string,
  "altText": string,
  "properties": {
    object (MediaProperties)
  },

  // Union field image_source can be only one of the following:
  "sourceUri": string
  // End of list of possible types for union field image_source.
}
Kolom
contentUri

string

Hanya output. URI tempat Anda dapat mendownload gambar; URI ini hanya valid untuk waktu yang terbatas.
altText

string

Deskripsi gambar yang ditampilkan saat diarahkan kursor dan dibaca oleh pembaca layar.
properties

object (MediaProperties)

Properti gambar.
Kolom union image_source. Jenis sumber gambar. Hanya satu kolom sumber gambar yang harus ditetapkan saat membuat gambar baru. image_source hanya dapat berupa salah satu dari berikut:
sourceUri

string

Hanya input. URI sumber adalah URI yang digunakan untuk menyisipkan gambar. URI sumber dapat kosong saat diambil.

MediaProperties

Properti media.

Representasi JSON 
{
  "alignment": enum (Alignment),
  "width": integer
}
Kolom
alignment

enum (Alignment)

Posisi media.
width

integer

Lebar media dalam piksel. Saat ditampilkan, media akan diskalakan ke nilai yang lebih kecil dari nilai ini atau lebar formulir yang ditampilkan. Rasio aspek asli media akan dipertahankan. Jika lebar tidak ditentukan saat media ditambahkan ke formulir, lebar akan ditetapkan ke lebar sumber media. Lebar harus antara 0 dan 740, inklusif. Menyetel lebar ke 0 atau tidak ditentukan hanya diizinkan saat memperbarui sumber media.

Perataan

Perataan di halaman.

Enum
ALIGNMENT_UNSPECIFIED Nilai default. Tidak digunakan.
LEFT Rata kiri.
RIGHT Rata kanan.
CENTER Tengah.

TextQuestion

Pertanyaan berbasis teks.

Representasi JSON 
{
  "paragraph": boolean
}
Kolom
paragraph

boolean

Apakah pertanyaan tersebut merupakan pertanyaan paragraf atau bukan. Jika tidak, pertanyaan tersebut adalah pertanyaan teks singkat.

ScaleQuestion

Pertanyaan skala. Pengguna memiliki rentang nilai numerik yang dapat dipilih.

Representasi JSON 
{
  "low": integer,
  "high": integer,
  "lowLabel": string,
  "highLabel": string
}
Kolom
low

integer

Wajib. Nilai terendah yang mungkin untuk skala.
high

integer

Wajib. Nilai tertinggi yang mungkin untuk skala.
lowLabel

string

Label yang akan ditampilkan yang menjelaskan titik terendah pada skala.
highLabel

string

Label yang akan ditampilkan yang menjelaskan titik tertinggi pada skala.

DateQuestion

Pertanyaan tanggal. Pertanyaan tanggal secara default hanya menampilkan bulan + hari.

Representasi JSON 
{
  "includeTime": boolean,
  "includeYear": boolean
}
Kolom
includeTime

boolean

Apakah akan menyertakan waktu sebagai bagian dari pertanyaan.
includeYear

boolean

Apakah akan menyertakan tahun sebagai bagian dari pertanyaan.

TimeQuestion

Pertanyaan waktu.

Representasi JSON 
{
  "duration": boolean
}
Kolom
duration

boolean

true jika pertanyaannya tentang waktu yang berlalu. Jika tidak, ini adalah tentang waktu.

FileUploadQuestion

Pertanyaan upload file. API saat ini tidak mendukung pembuatan pertanyaan upload file.

Representasi JSON 
{
  "folderId": string,
  "types": [
    enum (FileType)
  ],
  "maxFiles": integer,
  "maxFileSize": string
}
Kolom
folderId

string

Wajib. ID folder Drive tempat file yang diupload disimpan.
types[]

enum (FileType)

Jenis file yang diterima oleh pertanyaan ini.
maxFiles

integer

Jumlah maksimum file yang dapat diupload untuk pertanyaan ini dalam satu respons.
maxFileSize

string (int64 format)

Jumlah maksimum byte yang diizinkan untuk satu file yang diupload ke pertanyaan ini.

FileType

Jenis file yang dapat diupload ke pertanyaan upload file.

Enum
FILE_TYPE_UNSPECIFIED Nilai default. Tidak digunakan.
ANY Tidak ada batasan jenis.
DOCUMENT Dokumen Google Dokumen.
PRESENTATION Presentasi Google Slide.
SPREADSHEET Spreadsheet Google Spreadsheet.
DRAWING Gambar.
PDF PDF.
IMAGE Gambar.
VIDEO Video.
AUDIO File audio.

RowQuestion

Konfigurasi untuk pertanyaan yang merupakan bagian dari grup pertanyaan.

Representasi JSON 
{
  "title": string
}
Kolom
title

string

Wajib. Judul untuk satu baris di QuestionGroupItem.

RatingQuestion

Pertanyaan rating. Pengguna memiliki berbagai ikon yang dapat dipilih.

Representasi JSON 
{
  "ratingScaleLevel": integer,
  "iconType": enum (RatingIconType)
}
Kolom
ratingScaleLevel

integer

Wajib. Tingkat skala rating pertanyaan rating.
iconType

enum (RatingIconType)

Wajib. Jenis ikon yang akan digunakan untuk rating.

RatingIconType

Jenis ikon yang akan digunakan untuk rating.

Enum
RATING_ICON_TYPE_UNSPECIFIED Nilai default. Tidak digunakan.
STAR Ikon bintang.
HEART Ikon hati.
THUMB_UP Ikon jempol ke bawah.

Penilaian

Penilaian untuk satu pertanyaan

Representasi JSON 
{
  "pointValue": integer,
  "correctAnswers": {
    object (CorrectAnswers)
  },
  "whenRight": {
    object (Feedback)
  },
  "whenWrong": {
    object (Feedback)
  },
  "generalFeedback": {
    object (Feedback)
  }
}
Kolom
pointValue

integer

Wajib. Jumlah maksimum poin yang dapat diperoleh responden secara otomatis untuk jawaban yang benar. Nilai ini tidak boleh negatif.
correctAnswers

object (CorrectAnswers)

Wajib. Kunci jawaban untuk pertanyaan. Respons akan otomatis dinilai berdasarkan kolom ini.
whenRight

object (Feedback)

Masukan yang ditampilkan untuk respons yang benar. Masukan ini hanya dapat ditetapkan untuk pertanyaan pilihan ganda yang memiliki jawaban yang benar.
whenWrong

object (Feedback)

Masukan yang ditampilkan untuk respons yang salah. Masukan ini hanya dapat ditetapkan untuk pertanyaan pilihan ganda yang memiliki jawaban yang benar.
generalFeedback

object (Feedback)

Masukan yang ditampilkan untuk semua jawaban. Hal ini biasanya digunakan untuk pertanyaan jawaban singkat saat pemilik kuis ingin memberi responden gambaran cepat tentang apakah mereka menjawab pertanyaan dengan benar sebelum mereka memiliki kesempatan untuk menilai respons secara resmi. Umpan balik umum tidak dapat ditetapkan untuk pertanyaan pilihan ganda yang dinilai secara otomatis.

CorrectAnswers

Kunci jawaban untuk pertanyaan.

Representasi JSON 
{
  "answers": [
    {
      object (CorrectAnswer)
    }
  ]
}
Kolom
answers[]

object (CorrectAnswer)

Daftar jawaban yang benar. Respons kuis dapat dinilai secara otomatis berdasarkan jawaban ini. Untuk pertanyaan dengan nilai tunggal, respons akan ditandai benar jika cocok dengan nilai apa pun dalam daftar ini (dengan kata lain, beberapa jawaban benar dapat diterima). Untuk pertanyaan berbilang nilai (CHECKBOX), respons ditandai benar jika berisi nilai yang sama persis dengan nilai dalam daftar ini.

CorrectAnswer

Satu jawaban yang benar untuk suatu pertanyaan. Untuk pertanyaan berbilang nilai (CHECKBOX), beberapa CorrectAnswer mungkin diperlukan untuk mewakili satu opsi respons yang benar.

Representasi JSON 
{
  "value": string
}
Kolom
value

string

Wajib. Nilai jawaban yang benar. Lihat dokumentasi untuk TextAnswer.value guna mengetahui detail tentang cara berbagai jenis nilai diformat.

QuestionGroupItem

Menentukan pertanyaan yang terdiri dari beberapa pertanyaan yang dikelompokkan bersama.

Representasi JSON 
{
  "questions": [
    {
      object (Question)
    }
  ],
  "image": {
    object (Image)
  },

  // Union field kind can be only one of the following:
  "grid": {
    object (Grid)
  }
  // End of list of possible types for union field kind.
}
Kolom
questions[]

object (Question)

Wajib. Daftar pertanyaan yang termasuk dalam grup pertanyaan ini. Pertanyaan hanya boleh berada di satu grup. kind grup dapat memengaruhi jenis pertanyaan yang diizinkan.
image

object (Image)

Gambar yang ditampilkan dalam grup pertanyaan di atas pertanyaan tertentu.
Kolom union kind. Wajib. Jenis grup pertanyaan, yang menentukan jenis pertanyaan yang diizinkan dan cara pertanyaan tersebut ditampilkan. kind hanya dapat berupa salah satu dari berikut:
grid

object (Grid)

Grup pertanyaan adalah petak dengan baris pertanyaan pilihan ganda yang memiliki opsi yang sama. Jika grid ditetapkan, semua pertanyaan dalam grup harus berupa row.

Petak

Petak pilihan (kotak centang atau pilihan) dengan setiap baris yang merupakan pertanyaan terpisah. Setiap baris memiliki pilihan yang sama, yang ditampilkan sebagai kolom.

Representasi JSON 
{
  "columns": {
    object (ChoiceQuestion)
  },
  "shuffleQuestions": boolean
}
Kolom
columns

object (ChoiceQuestion)

Wajib. Pilihan yang dibagikan oleh setiap pertanyaan dalam petak. Dengan kata lain, nilai kolom. Hanya pilihan CHECK_BOX dan RADIO yang diizinkan.
shuffleQuestions

boolean

Jika true, pertanyaan akan diurutkan secara acak. Dengan kata lain, baris muncul dalam urutan yang berbeda untuk setiap responden.

PageBreakItem

Jenis ini tidak memiliki kolom.

Batas halaman. Judul dan deskripsi item ini ditampilkan di bagian atas halaman baru.

TextItem

Jenis ini tidak memiliki kolom.

Item teks.

ImageItem

Item yang berisi gambar.

Representasi JSON 
{
  "image": {
    object (Image)
  }
}
Kolom
image

object (Image)

Wajib. Gambar yang ditampilkan di item.

VideoItem

Item yang berisi video.

Representasi JSON 
{
  "video": {
    object (Video)
  },
  "caption": string
}
Kolom
video

object (Video)

Wajib. Video yang ditampilkan dalam item.
caption

string

Teks yang ditampilkan di bawah video.

Video

Data yang mewakili video.

Representasi JSON 
{
  "youtubeUri": string,
  "properties": {
    object (MediaProperties)
  }
}
Kolom
youtubeUri

string

Wajib. URI YouTube.
properties

object (MediaProperties)

Properti video.

Metode

batchUpdate

 Mengubah formulir dengan batch pembaruan.

create

 Buat formulir baru menggunakan judul yang diberikan dalam pesan formulir yang disediakan dalam permintaan.

get

 Mendapatkan formulir.