總覽

Google Forms API 是符合 REST 樣式的介面，可用來建立及修改表單和測驗、擷取表單回覆和測驗成績、設定測驗答案鍵，並接收推播通知。這個 API 最常見的用途包括下列工作：

  • 建立表單或測驗
  • 更新表單或測驗
  • 從表單或測驗擷取回覆
  • 讀取表單內容和中繼資料
  • 設定及接收推播通知

以下是 Forms API 中採用的常見詞彙：

Form

在雲端硬碟中建立並儲存的 Google 表單文件。每個表單都以 Form 資源表示，且具有專屬的 formId 值，可包含字母、數字、連字號或底線。您可以在 Google 表單網址中找到表單 ID：

https://docs.google.com/forms/d/FORM_ID/edit

測驗

特定類型的 Google 表單文件，可根據答案鍵對表單回應評分。如要建立測驗，您只能使用 batchUpdate() 方法，將現有表單的 isQuiz 設定更新為 true。

評分
當 isQuiz 為 true 時，適用於問題的分數值、答案鍵和意見回饋。由 Grading 資源代表。
意見回饋
使用者在測驗中回應的問題時 (由 Feedback 資源表示)，
項目

形式的單一元素，以 Item 資源表示。Item 是可包含區段、問題群組、問題、文字、圖片或影片的重複元素。

問題

表單上的單一問題，以 Question 資源表示。

問題群組

一組答案都相同 (例如 1 到 5 的評分方格)。由 QuestionGroupItem 資源代表。

Section

區段是一種將表單拆成多個頁面的方法，並新增條件邏輯 (例如，根據使用者的答案只能顯示特定問題)。區段會對應至 PageBreakItem 資源。

接聽

使用者針對問題的答案，以 Answer 資源表示。包含成績資訊 (如有)、中繼資料和答案內容。

回應

使用者提交表單，以 FormResponse 資源表示。

觀看

可追蹤表單結構定義異動 (例如問題編輯) 或表單回應提交變更的觸發條件，並在發生變化時傳送推播通知。由 Watch 資源代表。

表單結構

管理表單和測驗時，瞭解指定不同欄位的做法可能很複雜，因為許多表單物件可以透過多種方式在內部彼此建立巢狀結構。如要瞭解表單的視覺化呈現方式如何對應至欄位，建議您使用 UI 建立幾個應用程式可能產生的形式範例。然後使用 forms.get() 方法擷取對應的 JSON，以便進行比較。比方說，這個測驗範例可對應至下列 JSON：

{
  "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"
              }
            ]
          }
        }
      }
    }
  ]
}

後續步驟