Google Form 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
に更新する必要があります。- 項目
Item リソースで表されるフォーム内の 1 つの要素。
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"
}
]
}
}
}
}
]
}
次のステップ
- 認証や認可の処理など、Google Workspace API を使用した開発については、Workspace デベロッパー向けのスタートガイドをご覧ください。
- シンプルな Form API アプリを構成して実行する方法については、クイックスタートの概要をご覧ください。