REST Resource: forms

{
  "formId": string,
  "info": {
    object (Info)
  },
  "settings": {
    object (FormSettings)
  },
  "items": [
    {
      object (Item)
    }
  ],
  "revisionId": string,
  "responderUri": string,
  "linkedSheetId": string
}

string

出力のみ。フォーム ID。

object (Info)

必須。フォームのタイトルと説明。

object (FormSettings)

フォームの設定。これは UpdateSettingsRequest で更新する必要があります。forms.create と UpdateFormInfoRequest では無視されます。

object (Item)

必須。フォームのアイテムのリスト。セクション ヘッダー、質問、埋め込みメディアなどを含めることができます。

string

出力のみ。フォームのリビジョン ID。変更リクエストのベースとなるリビジョンを識別するために、更新リクエストの WriteControl で使用されます。

リビジョン ID の形式は時間の経過とともに変化する可能性があるため、不透明に扱う必要があります。返されたリビジョン ID は、返却されてから 24 時間のみ有効であることが保証され、ユーザー間で共有することはできません。呼び出し間でリビジョン ID が変更されていなければ、フォームは変更されていません。一方、ID（同じフォームとユーザー）が変更された場合、通常はフォームが更新されていますが、ID の形式の変更などの内部的な原因によって ID が変更された可能性もあります。

string

出力のみ。回答者と共有するフォームの URI。ページが開き、ユーザーは回答を送信できますが、質問を編集することはできません。

string

出力のみ。このフォームからの回答を蓄積している、リンク先の Google スプレッドシートの ID（そのようなシートが存在する場合）。

{
  "title": string,
  "documentTitle": string,
  "description": string
}

string

必須。回答者に表示されるフォームのタイトル。

string

出力のみ。ドライブに表示されるドキュメントのタイトル。Info.title が空の場合、documentTitle が Google フォームの UI に表示され、回答者に表示される場合があります。documentTitle は作成時に設定できますが、batchUpdate リクエストによって変更することはできません。プログラムで documentTitle を更新する必要がある場合は、Google Drive API を使用してください。

string

フォームの説明。

{
  "quizSettings": {
    object (QuizSettings)
  }
}

object (QuizSettings)

テストと採点に関する設定。

{
  "isQuiz": boolean
}

boolean

このフォームがテストかどうか。正の場合、回答は質問 Grading に基づいて採点されます。false に設定すると、すべての質問 Grading が削除されます。

{
  "itemId": string,
  "title": string,
  "description": string,

  // Union field kind can be only one of the following:
  "questionItem": {
    object (QuestionItem)
  },
  "questionGroupItem": {
    object (QuestionGroupItem)
  },
  "pageBreakItem": {
    object (PageBreakItem)
  },
  "textItem": {
    object (TextItem)
  },
  "imageItem": {
    object (ImageItem)
  },
  "videoItem": {
    object (VideoItem)
  }
  // End of list of possible types for union field kind.
}

string

商品アイテム ID。

作成時に ID を指定できますが、ID をフォームで使用することはできません。指定しない場合は、新しい ID が割り当てられます。

string

商品アイテムのタイトル。

string

商品アイテムの説明

object (QuestionItem)

ユーザーに質問を投げかけます。

object (QuestionGroupItem)

主要なプロンプトを 1 つにまとめて、1 つ以上の質問をユーザーに示します。

object (PageBreakItem)

タイトル付きの新しいページを開始します。

object (TextItem)

ページにタイトルと説明を表示します。

object (ImageItem)

ページに画像を表示します。

object (VideoItem)

ページに動画を表示します。

{
  "question": {
    object (Question)
  },
  "image": {
    object (Image)
  }
}

object (Question)

必須。表示される質問

object (Image)

質問内に表示される画像。

{
  "questionId": string,
  "required": boolean,
  "grading": {
    object (Grading)
  },

  // Union field kind can be only one of the following:
  "choiceQuestion": {
    object (ChoiceQuestion)
  },
  "textQuestion": {
    object (TextQuestion)
  },
  "scaleQuestion": {
    object (ScaleQuestion)
  },
  "dateQuestion": {
    object (DateQuestion)
  },
  "timeQuestion": {
    object (TimeQuestion)
  },
  "fileUploadQuestion": {
    object (FileUploadQuestion)
  },
  "rowQuestion": {
    object (RowQuestion)
  }
  // End of list of possible types for union field kind.
}

string

読み取りのみ。質問 ID。

作成時に ID を指定できますが、ID をフォームで使用することはできません。指定しない場合は、新しい ID が割り当てられます。

boolean

回答者が回答を送信できるようにするには、質問に回答する必要があるかどうか。

object (Grading)

質問の採点設定。

object (ChoiceQuestion)

回答者は、事前定義された回答群から選択できます。

object (TextQuestion)

回答者は自由回答を入力できます。

object (ScaleQuestion)

回答者は範囲から数値を選択できます。

object (DateQuestion)

回答者は日付を入力できます。

object (TimeQuestion)

回答者は時間を入力できます。

object (FileUploadQuestion)

回答者は 1 つ以上のファイルをアップロードできます。

object (RowQuestion)

QuestionGroupItem の行。

{
  "type": enum (ChoiceType),
  "options": [
    {
      object (Option)
    }
  ],
  "shuffle": boolean
}

enum (ChoiceType)

必須。選択問題のタイプ。

object (Option)

必須。回答者が選択できるオプションのリスト。

boolean

テストのさまざまなオプションをランダムに表示するかどうかを指定します。多くの場合、別の回答者の画面を見ている回答者が不正行為を防いだり、同じまたは複数の選択肢を提示したアンケートで偏見に対処したりするために使われます。

{
  "value": string,
  "image": {
    object (Image)
  },
  "isOther": boolean,

  // Union field go_to_section can be only one of the following:
  "goToAction": enum (GoToAction),
  "goToSectionId": string
  // End of list of possible types for union field go_to_section.
}

string

必須。ユーザーに表示される選択です。

object (Image)

オプションとして画像を表示します。

boolean

オプションが「その他」かどうか。現在、RADIO と CHECKBOX の選択タイプにのみ適用されますが、QuestionGroupItem では使用できません。

enum (GoToAction)

セクションのナビゲーションの種類。

string

移動するセクション ヘッダーのアイテム ID。

{
  "contentUri": string,
  "altText": string,
  "properties": {
    object (MediaProperties)
  },

  // Union field image_source can be only one of the following:
  "sourceUri": string
  // End of list of possible types for union field image_source.
}

string

出力のみ。画像をダウンロードできる URI。これは期間限定で有効です。

string

カーソルを合わせたときにスクリーンリーダーによって読み取られた画像の説明。

object (MediaProperties)

画像のプロパティ。

string

入力のみ。ソース URI は、画像の挿入に使用される URI です。取得時のソース URI は空にできます。

{
  "alignment": enum (Alignment),
  "width": integer
}

enum (Alignment)

メディアの位置。

integer

メディアの幅（ピクセル単位）です。メディアが表示されると、この値または表示されるフォームの幅のいずれかに縮小されます。メディアの元のアスペクト比は保持されます。フォームにメディアを追加する際に幅が指定されていない場合、幅はメディアソースの幅に設定されます。幅は 0 ～ 740 の範囲で指定してください。幅を 0 に設定するか、未指定にできるのは、メディアソースを更新する場合のみです。

{
  "paragraph": boolean
}

boolean

質問が段落形式かどうか。そうでない場合、質問は短いテキストの質問です。

{
  "low": integer,
  "high": integer,
  "lowLabel": string,
  "highLabel": string
}

integer

必須。スケールの最小値。

integer

必須。そのスケールでの可能な最大値。

string

スケールの最低点を示すラベル。

string

スケールの最高点を示すラベル。

{
  "includeTime": boolean,
  "includeYear": boolean
}

boolean

質問に時間を含めるかどうか

boolean

質問にその年を含めるかどうか。

{
  "duration": boolean
}

boolean

true: 質問が経過時間に関するものである場合。それ以外の場合は、時間帯が対象となります。

{
  "folderId": string,
  "types": [
    enum (FileType)
  ],
  "maxFiles": integer,
  "maxFileSize": string
}

string

必須。アップロードしたファイルが保存されているドライブ フォルダの ID。

enum (FileType)

このファイル形式で許可されるファイル形式。

integer

この質問で 1 つの回答でアップロードできるファイルの最大数。

string (int64 format)

この質問にアップロードできる、1 つのファイルの最大許容バイト数です。

{
  "title": string
}

string

必須。QuestionGroupItem 内の 1 行のタイトル。

{
  "pointValue": integer,
  "correctAnswers": {
    object (CorrectAnswers)
  },
  "whenRight": {
    object (Feedback)
  },
  "whenWrong": {
    object (Feedback)
  },
  "generalFeedback": {
    object (Feedback)
  }
}

integer

必須。回答者が正解に対して自動的に取得する最大点数。負の値は使用できません。

object (CorrectAnswers)

必須。質問の解答集です。回答は、この項目に基づいて自動的に評価されます。

object (Feedback)

正解に対し表示されるフィードバック。このフィードバックを設定できるのは、多肢選択式の問題で正解を提供している問題のみです。

object (Feedback)

不正解に対するフィードバックが表示されます。このフィードバックを設定できるのは、多肢選択式の問題で正解を提供している問題のみです。

object (Feedback)

すべての回答に対して表示されるフィードバック。正誤問題: クイズのオーナーが回答を正式に採点する前に、正解したかどうかをすぐに確認できる場合に、短い回答の質問で使用されます。自動採点式の多肢選択式問題では、一般的なフィードバックを設定することはできません。

{
  "answers": [
    {
      object (CorrectAnswer)
    }
  ]
}

object (CorrectAnswer)

正解のリスト。テストの回答を、これらの回答に基づいて自動的に採点できます。単一値の場合、リスト内の値に一致する回答に正解のマークが付きます（つまり、複数回答できる可能性があります）。複数の値を持つ（CHECKBOX）質問で、このリスト内の値を正確に含むレスポンスは正解になります。

{
  "value": string
}

string

必須。正解の値。さまざまな値の型の形式については、TextAnswer.value のドキュメントをご覧ください。

{
  "questions": [
    {
      object (Question)
    }
  ],
  "image": {
    object (Image)
  },

  // Union field kind can be only one of the following:
  "grid": {
    object (Grid)
  }
  // End of list of possible types for union field kind.
}

object (Question)

必須。この質問グループに属する質問のリスト。質問は 1 つのグループにのみ属すことができます。グループの kind は、許可される質問の種類に影響する場合があります。

object (Image)

質問グループ内で特定の質問の上に表示される画像。

object (Grid)

質問グループは複数の選択肢から成るグリッドで、選択肢は同じです。grid が設定されている場合、グループ内のすべての質問の種類が row でなければなりません。

{
  "columns": {
    object (ChoiceQuestion)
  },
  "shuffleQuestions": boolean
}

object (ChoiceQuestion)

必須。選択項目は、グリッド内の各質問で共有されます。つまり、列の値です。使用できる選択肢は、CHECK_BOX 個と RADIO 個のみです。

boolean

true の場合、質問はランダムに並べられます。つまり、回答者ごとに行の順序が変わります。

{
  "image": {
    object (Image)
  }
}

object (Image)

必須。アイテムに表示される画像。

{
  "video": {
    object (Video)
  },
  "caption": string
}

object (Video)

必須。アイテムに表示される動画。

string

動画の下に表示されるテキスト。

{
  "youtubeUri": string,
  "properties": {
    object (MediaProperties)
  }
}

string

必須。YouTube URI。

object (MediaProperties)

動画のプロパティ。