Google Forms API は、フォームの作成と変更を可能にする RESTful インターフェースです フォームの回答とテストの成績の取得、テストの解答キーの設定 プッシュ通知を受信できます。最も一般的な用途 この API には、次のタスクが含まれます。
- フォームやテストを作成する
- フォームやテストを更新する
- フォームやクイズから回答を取得する
- フォームのコンテンツとメタデータを読み取る
- プッシュ通知を設定して受信する
Forms API で使用される一般的な用語を以下に示します。
- フォーム
Google ドライブに作成して保存された Google フォームのドキュメント。各フォームは
Form
リソースで表され、文字、数字、ハイフン、アンダースコアを含む一意のformId
値を持ちます。フォーム ID は、Google フォームの URL で確認できます。https://docs.google.com/forms/d/FORM_ID/edit
- クイズ
解答集と照らし合わせてフォームの回答を採点できる、特定のタイプの Google フォーム ドキュメント。クイズを作成できるのは、
batchUpdate()
メソッドを使用して、既存のフォームのisQuiz
設定をtrue
に更新した場合のみです。- 項目
「.」で表される、フォーム内の単一の要素。 Item リソース。
Item
は、セクション、質問グループ、質問、テキスト、画像、動画を含めることができる繰り返し要素です。- 質問
フォームの 1 つの質問。
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"
}
]
}
}
}
}
]
}
次のステップ
- 認証と認可の処理など、Google Workspace API を使用した開発の詳細については、Workspace デベロッパーのスタートガイドをご覧ください。
- シンプルな Forms API アプリを構成して実行する方法については、 クイックスタートの概要