概要

Google Forms API は RESTful インターフェースであり、フォームやテストの作成と変更、フォームの回答やクイズの成績の取得、自動フィードバックによるクイズの解答集の設定、プッシュ通知の受信を行うことができます。この API の一般的な用途は次のとおりです。

  • フォームやテストを作成する
  • フォームやテストを更新する
  • フォームやクイズから回答を取得する
  • フォームのコンテンツとメタデータの読み取り
  • プッシュ通知の設定と受信

Forms API で使用される一般的な用語を以下に示します。

Form

Google フォームのドキュメントを作成し、ドライブに保存する。各フォームは Form リソースによって表され、文字、数字、ハイフン、アンダースコアを含む一意の formId 値が含まれます。フォーム ID は Google フォームの URL で確認できます。

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

クイズ

フォームの回答を解答集に照らし合わせて採点できる Google フォームの特定の種類のドキュメント。テストを作成するには、batchUpdate() メソッドを使用して、既存のフォームの isQuiz 設定を true に更新します。

採点
質問の点数、解答集、フィードバック（isQuiz が true の場合）。Grading リソースで表されます。
フィードバック
クイズの質問に回答する際にエンドユーザーに与えられるレスポンス。Feedback リソースで表されます。
項目

Item リソースによって表される、フォーム内の単一の要素。Item は、セクション、質問グループ、質問、テキスト、画像、動画を含む繰り返し要素です。

質問

Question リソースによって表される、フォーム上の単一の質問。

質問グループ

同じ回答セットを共有する質問のグループです（1 ～ 5 の評価のグリッドなど）。QuestionGroupItem リソースで表されます。

セクション

セクションを使用すると、フォームを複数のページに分割して条件付きロジックを追加できます（ユーザーの回答に基づいて特定の質問のみを表示するなど）。セクションは 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"
              }
            ]
          }
        }
      }
    }
  ]
}

次のステップ