Google Biểu mẫu API là một giao diện RESTful cho phép bạn tạo và sửa đổi biểu mẫu và bài kiểm tra, truy xuất câu trả lời trong biểu mẫu và điểm của bài kiểm tra, thiết lập khoá trả lời của bài kiểm tra bằng phản hồi tự động và nhận thông báo đẩy. Các cách dùng phổ biến nhất của API này bao gồm những nhiệm vụ sau:
- Tạo biểu mẫu hoặc bài kiểm tra
- Cập nhật biểu mẫu hoặc bài kiểm tra
- Truy xuất câu trả lời qua biểu mẫu hoặc bài kiểm tra
- Đọc siêu dữ liệu và nội dung biểu mẫu
- Thiết lập và nhận thông báo đẩy
Dưới đây là danh sách các thuật ngữ phổ biến trong API Biểu mẫu:
- Biểu mẫu
Một tài liệu trong Google Biểu mẫu, được tạo và lưu trữ trong Drive. Mỗi biểu mẫu được biểu thị bằng một tài nguyên
Form
và có một giá trịformId
duy nhất, chứa chữ cái, số, dấu gạch nối hoặc dấu gạch dưới. Bạn có thể tìm thấy mã biểu mẫu trong URL trên Google Biểu mẫu:https://docs.google.com/forms/d/FORM_ID/edit
- Bài kiểm tra
Một loại tài liệu cụ thể trên Google Biểu mẫu cho phép chấm điểm bài học câu trả lời dựa vào đáp án. Bạn chỉ có thể tạo bài kiểm tra bằng cách sử dụng
batchUpdate()
để cập nhật chế độ cài đặtisQuiz
trên một biểu mẫu hiện có thànhtrue
.- Item
Một phần tử trong biểu mẫu, được biểu thị bằng Tài nguyên Mặt hàng.
Item
là một phần tử lặp lại có thể chứa một phần, nhóm câu hỏi, câu hỏi văn bản, hình ảnh hoặc video.- Câu hỏi
Một câu hỏi duy nhất trên biểu mẫu, được thể hiện bằng Tài nguyên
Question
.- Nhóm câu hỏi
Một nhóm các câu hỏi có cùng một bộ câu trả lời có thể có (cho ví dụ: một lưới điểm xếp hạng từ 1 đến 5). Đại diện bởi
QuestionGroupItem
nguồn.- Section
Mục là cách chia biểu mẫu thành nhiều trang và thêm logic có điều kiện (chẳng hạn như chỉ hiển thị một số câu hỏi nhất định dựa trên cách câu trả lời của người dùng). Các phần tương ứng với
PageBreakItem
nguồn.- Trả lời
Câu trả lời của người dùng cuối cho một câu hỏi, được thể hiện bằng
Answer
nguồn. Bao gồm cả thông tin điểm (nếu có), siêu dữ liệu và nội dung của câu trả lời.- Đáp
Lượt gửi biểu mẫu của người dùng cuối, được thể hiện bằng Tài nguyên
FormResponse
.- Xem
Điều kiện kích hoạt theo dõi các thay đổi đối với một trong hai thay đổi đối với giản đồ biểu mẫu (chẳng hạn như nội dung chỉnh sửa) cho câu hỏi) hoặc gửi câu trả lời qua biểu mẫu và gửi thông báo đẩy khi thay đổi xảy ra. Đại diện bởi Tài nguyên
Watch
.
Cấu trúc biểu mẫu
Khi quản lý biểu mẫu và bài kiểm tra, việc hiểu rõ cách chỉ định các trường
có thể phức tạp, vì nhiều đối tượng biểu mẫu có thể được lồng vào bên trong
với nhau theo nhiều cách. Để xem cách trình bày trực quan một biểu mẫu
có liên kết với các trường, bạn nên sử dụng giao diện người dùng để tạo một vài ví dụ
các biểu mẫu mà ứng dụng của bạn có thể tạo ra. Sau đó, truy xuất JSON tương ứng
sử dụng phương thức forms.get()
để bạn so sánh. Ví dụ:
bài kiểm tra mẫu này tương ứng với JSON sau:
{
"formId": "FORM_ID",
"info": {
"title": "Famous Black Women",
"description": "Please complete this quiz based off of this week's readings for class.",
"documentTitle": "API Example Quiz"
},
"settings": {
"quizSettings": {
"isQuiz": true
}
},
"revisionId": "00000021",
"responderUri": "https://docs.google.com/forms/d/e/1FAIpQLSd0iBLPh4suZoGW938EU1WIxzObQv_jXto0nT2U8HH2KsI5dg/viewform",
"items": [
{
"itemId": "5d9f9786",
"imageItem": {
"image": {
"contentUri": "DIRECT_URL",
"properties": {
"alignment": "LEFT"
}
}
}
},
{
"itemId": "72b30353",
"title": "Which African American woman authored \"I Know Why the Caged Bird Sings\"?",
"questionItem": {
"question": {
"questionId": "25405d4e",
"required": true,
"grading": {
"pointValue": 2,
"correctAnswers": {
"answers": [
{
"value": "Maya Angelou"
}
]
}
},
"choiceQuestion": {
"type": "RADIO",
"options": [
{
"value": "Maya Angelou"
},
{
"value": "bell hooks"
},
{
"value": "Alice Walker"
},
{
"value": "Roxane Gay"
}
]
}
}
}
},
{
"itemId": "0a4859c8",
"title": "Who was the first Dominican-American woman elected to state office?",
"questionItem": {
"question": {
"questionId": "37fff47a",
"grading": {
"pointValue": 2,
"correctAnswers": {
"answers": [
{
"value": "Grace Diaz"
}
]
}
},
"choiceQuestion": {
"type": "RADIO",
"options": [
{
"value": "Rosa Clemente"
},
{
"value": "Grace Diaz"
},
{
"value": "Juana Matias"
},
{
"value": "Sabrina Matos"
}
]
}
}
}
}
]
}
Các bước tiếp theo
- Để tìm hiểu về cách phát triển bằng API của Google Workspace, bao gồm cả cách xử lý xác thực và uỷ quyền, hãy tham khảo Bắt đầu với vai trò là nhà phát triển Workspace.
- Để tìm hiểu cách định cấu hình và chạy một ứng dụng API Biểu mẫu đơn giản, hãy đọc Tổng quan nhanh.