Class FormResponse

FormResponse

フォーム全体に対する回答。FormResponse には、回答者が送信した回答にアクセスする方法（getItemResponses() を参照）、プログラムで回答をフォームに送信する方法（withItemResponse(response) と submit() を参照）、提供された回答を使用してフィールドを事前入力するフォームの URL を生成する方法の 3 つがあります。FormResponse は Form から作成またはアクセスできます。 

// Open a form by ID and log the responses to each question.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var formResponses = form.getResponses();
for (var i = 0; i < formResponses.length; i++) {
  var formResponse = formResponses[i];
  var itemResponses = formResponse.getItemResponses();
  for (var j = 0; j < itemResponses.length; j++) {
    var itemResponse = itemResponses[j];
    Logger.log('Response #%s to the question "%s" was "%s"',
        (i + 1).toString(),
        itemResponse.getItem().getTitle(),
        itemResponse.getResponse());
  }
}

Methods

メソッド戻り値の型概要
getEditResponseUrl()String送信済みの回答を編集する際に使用できる URL を生成します。
getGradableItemResponses()ItemResponse[]フォームの回答に含まれるすべての項目の回答を、フォームに表示されるのと同じ順序で取得します。
getGradableResponseForItem(item)ItemResponse指定されたアイテムに対するフォームの回答に含まれるアイテム レスポンスを取得します。
getId()Stringフォームの回答の ID を取得します。
getItemResponses()ItemResponse[]フォームの回答に含まれるすべての項目の回答を、フォームに表示されるのと同じ順序で取得します。
getRespondentEmail()StringForm.setCollectEmail(collect) 設定が有効になっている場合、回答を送信したユーザーのメールアドレスを取得します。
getResponseForItem(item)ItemResponse指定されたアイテムについて、このフォームの回答に含まれるアイテム レスポンスを取得します。
getTimestamp()Dateフォームの回答送信時のタイムスタンプを取得します。
submit()FormResponseレスポンスを送信します。
toPrefilledUrl()Stringこのフォーム レスポンス内の回答に基づいて回答が事前入力されるフォームの URL を生成します。
withItemGrade(gradedResponse)FormResponse指定した項目の回答の成績をフォームの回答に追加します。
withItemResponse(response)FormResponse指定された項目の回答をフォームの回答に追加します。

詳細なドキュメント

getEditResponseUrl()

送信済みの回答を編集する際に使用できる URL を生成します。Form.setAllowResponseEdits(enabled) 設定が無効になっている場合は、フォームの回答の編集が無効になっていることを説明するページが表示されます。リンクを訪れたユーザーなら誰でもレスポンスを編集できますが、Form.setRequireLogin(requireLogin) 設定が有効になっている場合は、フォームにアクセスできるアカウントが必要です。Form.setCollectEmail(collect) 設定が有効になっている場合、フォームに、元の回答者のメールアドレスではなく、回答を編集したユーザーのメールアドレスが記録されます。

スクリプトが作成したが、まだ送信されていないフォームのレスポンスの場合、このメソッドは null を返します。 

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Gets the first form response.
const formResponse = form.getResponses()[0];

// Gets the edit URL for the first form response and logs it to the console.
const editUrl = formResponse.getEditResponseUrl();
console.log(editUrl);

リターン

String - 送信されたレスポンスを変更する URL。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getGradableItemResponses()

フォームの回答に含まれるすべての項目の回答を、フォームに表示されるのと同じ順序で取得します。このメソッドは getItemResponses() と似ていますが、未提出の回答を採点するために、対応する Item を採点できる（点数がある場合）は、実際の回答がない場合でも ItemResponse を返します。ただし、Item がグラデーション可能でない場合、このメソッドは返される配列からそのアイテムを除外します。 

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Gets an array of the form's responses.
const formResponses = form.getResponses();

// Gets the item responses contained in each form response.
for (const formResponse of formResponses){
  const gradableItemsResponses = formResponse.getGradableItemResponses();

  // Logs the title and score for each item response to the console.
  for (const gradableItemsResponse of gradableItemsResponses) {
    console.log(`${gradableItemsResponse.getItem().getTitle()}
       score ${gradableItemsResponse.getScore()}`);
  }
}

リターン

ItemResponse[] - フォーム内の各質問項目に対する回答の配列で、回答者がスコアを受け取ることができるもの。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getGradableResponseForItem(item)

指定されたアイテムに対するフォームの回答に含まれるアイテム レスポンスを取得します。このメソッドは getResponseForItem(item) に似ていますが、未提出の回答を採点するために、対応する Item を採点できる（点数がある場合）は、実際の回答がない場合でも ItemResponse を返します。ただし、Item がグラデーション可能でない場合、このメソッドは null を返します。

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Gets an array of the form's responses.
const formResponses = form.getResponses();

// Gets the item responses contained in a form response.
for (const formResponse of formResponses) {
  const formItemResponses = formResponse.getGradableItemResponses();

  // Logs the title and score for responses to the first item of the form.
  const itemResponse = formResponse.getGradableResponseForItem(formItemResponses[0].getItem());
  console.log(`${itemResponse.getItem().getTitle()} score ${itemResponse.getScore()}`);
}

パラメータ

名前型説明
itemItem

リターン

ItemResponse - 特定のアイテムに対する回答。またはアイテムが採点されていない場合には null になります。

getId()

フォームの回答の ID を取得します。このメソッドは、フォームのレスポンスが送信されていない場合、null を返します。

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Gets an array of the form's responses.
const formResponses = form.getResponses();

// Loops through the form responses and logs the ID for each form response to the console.
for (const formResponse of formResponses) {
  console.log(`Response ID: ${formResponse.getId()}`);
}

リターン

String - フォームの回答の ID。フォームの回答が送信されていない場合は null。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getItemResponses()

フォームの回答に含まれるすべての項目の回答を、フォームに表示されるのと同じ順序で取得します。フォームのレスポンスに、特定の TextItem、DateItem、TimeItem、または ParagraphTextItem に対するレスポンスが含まれていない場合、そのアイテムに対して返される ItemResponse には、レスポンスとして空の文字列が含まれます。フォームのレスポンスで他のアイテムタイプのレスポンスが省略されている場合、このメソッドは、返される配列からそのアイテムを除外します。

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Gets the responses to the form.
const formResponses = form.getResponses();

// Iterates over the responses.
for (const formResponse of formResponses) {

  // Gets the item responses from each form response.
  const itemResponses = formResponse.getItemResponses();

  // Iterates over the item responses.
  for (const itemResponse of itemResponses) {

    // Logs the items' questions and responses to the console.
    console.log(`Response to the question '${itemResponse.getItem().getTitle()}' was
      '${itemResponse.getResponse()}'`);
  }
}

リターン

ItemResponse[] - 回答者が回答したフォーム内のすべての質問項目に対する回答の配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getRespondentEmail()

Form.setCollectEmail(collect) 設定が有効になっている場合、回答を送信したユーザーのメールアドレスを取得します。

スクリプトが作成したが、まだ送信されていないフォームのレスポンスの場合、このメソッドは null を返します。 

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Gets an array of the form's responses.
const formResponses = form.getResponses();

// Loops through the responses and logs each respondent's email to the console.
// To collect respondent emails, ensure that Form.setCollectEmail(collect) is set to true.
for (const formResponse of formResponses) {
  console.log(`Respondent Email: ${formResponse.getRespondentEmail()}`);
}

リターン

String - この回答を送信した個人のメールアドレス（存在する場合）。または、スクリプトによって作成されたが未送信の場合は null。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getResponseForItem(item)

指定されたアイテムについて、このフォームの回答に含まれるアイテム レスポンスを取得します。 

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Gets the first item on the form.
const item = form.getItems()[0];

// Gets an array of the form's responses.
const formResponses = form.getResponses();

// Loops through the responses and logs each response to the first item to the console.
for (const formResponse of formResponses) {
  const itemResponse = formResponse.getResponseForItem(item);
  console.log(itemResponse.getResponse());
}

パラメータ

名前型説明
itemItem

リターン

ItemResponse - 特定のアイテムに対するレスポンス。存在しない場合は null。

getTimestamp()

フォームの回答送信時のタイムスタンプを取得します。

スクリプトが作成したが、まだ送信されていないフォームのレスポンスの場合、このメソッドは null を返します。 

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Gets an array of the form's responses.
const formResponses = form.getResponses();

// Loops through the responses and logs the timestamp of each response to the console.
for (const formResponse of formResponses) {
  console.log(`Timestamp: ${formResponse.getTimestamp()}`);
}

リターン

Date - このレスポンスが送信された時点のタイムスタンプ。スクリプトによってこのレスポンスが作成されていても、まだ送信されていない場合は null。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

submit()

レスポンスを送信します。レスポンスがすでに送信されている場合は、スクリプト例外をスローします。 

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Creates an empty response for the form.
const formResponse = form.createResponse();

// Submits an empty response.
formResponse.submit();

リターン

FormResponse - 新しく作成された回答がフォームの回答ストアに保存されます。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

toPrefilledUrl()

このフォームの回答に基づいて回答が事前入力されるフォームの URL を生成します。 

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Gets the first form response.
const formResponse = form.getResponses()[0];

// Generates and logs the URL of a pre-filled form response based on the answers
// of the first form response.
const prefilledUrl = formResponse.toPrefilledUrl();
console.log(prefilledUrl);

リターン

String - 回答が事前入力されたフォームの URL。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

withItemGrade(gradedResponse)

指定した項目の回答の成績をフォームの回答に追加します。このメソッドは、すでに送信されているフォームの回答にのみ適用され、送信後に保存される成績にのみ影響します。また、このメソッドはアイテム レスポンスの成績のみを更新します。レスポンスはすでに送信されているため、実際のレスポンスには影響しません。このメソッドが同じアイテムに対して複数回呼び出された場合は、最後の成績のみが保持されます。ItemResponse に成績が含まれていない場合、このメソッドはアイテムの採点を削除します。 

// Programmatically award partial credit for a given response
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var formResponses = form.getResponses();
var formItems = form.getItems();
for (var i = 0; i < formResponses.length; i++) {
  var formResponse = formResponses[i];
  for (var j = 0; j < formItems.length; j++) {
    var item = formItems[j];
    var points = item.asMultipleChoiceItem().getPoints();
    var itemResponse = formResponse.getGradableResponseForItem(item);
    Logger.log('Award half credit for answers containing the word "Kennedy"');
    var answer = itemResponse.getResponse();
    if (answer != null && answer.includes('Kennedy')) {
      itemResponse.setScore(points / 2);
      formResponse.withItemGrade(itemResponse);
    }
  }
}
form.submitGrades(formResponses);

パラメータ

名前型説明
gradedResponseItemResponse

リターン

FormResponse - この FormResponse（チェーン用）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

withItemResponse(response)

指定された項目の回答をフォームの回答に追加します。このメソッドは、スクリプトが作成したものの、まだ送信されていないフォーム レスポンスにのみ適用されます。保存されているレスポンスには影響しません。このメソッドが同じアイテムに対して複数回呼び出された場合、最後のアイテム レスポンスのみが保持されます。

// Opens the Forms file by its ID.
// If you created your script from within a Google Forms file, you can
// use FormApp.getActiveForm() instead.
// TODO(developer): Replace the ID with your own.
const form = FormApp.openById('abc123456');

// Creates a response for the form.
const formResponse = form.createResponse();

// Appends a checkbox item to the form.
const item = form.addCheckboxItem();

// Sets the title of the item to 'Which items are ice cream flavors?'
item.setTitle('Which items are ice cream flavors?');

// Sets choices for the item.
item.setChoices([
item.createChoice('Vanilla'),
item.createChoice('Strawberry'),
item.createChoice('Brick')
]);

// Creates a response for the item.
const response = item.createResponse(['Vanilla', 'Strawberry']);

// Adds the item response to the form response.
formResponse.withItemResponse(response);

// Submits the form response.
formResponse.submit();

パラメータ

名前型説明
responseItemResponse

リターン

FormResponse - この FormResponse（チェーン用）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms