概要

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

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

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

フォーム

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 は、セクション、質問グループ、質問、テキスト、画像、動画を含めることができる繰り返し要素です。

質問

フォーム上の 1 つの質問。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"
              }
            ]
          }
        }
      }
    }
  ]
}

次のステップ