Class FormResponse

FormResponse

Es una respuesta al formulario en su totalidad. Un objeto FormResponse se puede usar de tres maneras: para acceder a las respuestas enviadas por un encuestado (consulta getItemResponses()), para enviar una respuesta al formulario de forma programática (consulta withItemResponse(response) y submit()) y para generar una URL para el formulario que complete previamente los campos con las respuestas proporcionadas. Los objetos FormResponse se pueden crear o acceder desde un objeto Form.

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
getEditResponseUrl()StringGenera una URL que se puede usar para editar una respuesta que ya se envió.
getGradableItemResponses()ItemResponse[]Obtiene todas las respuestas de elementos que se incluyen en una respuesta del formulario, en el mismo orden en que aparecen los elementos en el formulario.
getGradableResponseForItem(item)ItemResponseObtiene la respuesta del elemento que se incluye en la respuesta del formulario para un elemento determinado.
getId()StringObtiene el ID de la respuesta del formulario.
getItemResponses()ItemResponse[]Obtiene todas las respuestas de elementos que se incluyen en una respuesta del formulario, en el mismo orden en que aparecen los elementos en el formulario.
getRespondentEmail()StringObtiene la dirección de correo electrónico de la persona que envió una respuesta, si el parámetro de configuración Form.setCollectEmail(collect) está habilitado.
getResponseForItem(item)ItemResponseObtiene la respuesta del elemento que se incluye en esta respuesta del formulario para un elemento determinado.
getTimestamp()DateObtiene la marca de tiempo del envío de una respuesta del formulario.
submit()FormResponseEnvía la respuesta.
toPrefilledUrl()StringGenera una URL para el formulario en el que las respuestas se completan previamente según las respuestas de esta respuesta del formulario.
withItemGrade(gradedResponse)FormResponseAgrega las calificaciones de la respuesta del elemento determinada a una respuesta del formulario.
withItemResponse(response)FormResponseAgrega la respuesta del elemento proporcionada a una respuesta del formulario.

Documentación detallada

getEditResponseUrl()

Genera una URL que se puede usar para editar una respuesta que ya se envió. Si el parámetro de configuración Form.setAllowResponseEdits(enabled) está inhabilitado, el vínculo dirige a una página en la que se explica que se inhabilitó la edición de respuestas del formulario. Cualquier persona que visite el vínculo puede editar la respuesta, aunque necesita una cuenta con acceso al formulario si el parámetro de configuración Form.setRequireLogin(requireLogin) está habilitado. Si el parámetro de configuración Form.setCollectEmail(collect) está habilitado, el formulario registra la dirección de correo electrónico del usuario que editó la respuesta en lugar de la dirección de correo electrónico del encuestado original.

En el caso de una respuesta de formulario que la secuencia de comandos creó, pero aún no envió, este método devuelve 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);

Volver

String: Es la URL para cambiar una respuesta enviada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getGradableItemResponses()

Obtiene todas las respuestas de elementos que se incluyen en una respuesta del formulario, en el mismo orden en que aparecen los elementos en el formulario. Este método funciona de manera similar a getItemResponses(), pero, para permitir la calificación de una respuesta faltante, aún devuelve un ItemResponse si el Item correspondiente se puede calificar (es decir, tiene un valor de puntos), incluso si no hay una respuesta real. Sin embargo, si el Item no se puede calificar, este método excluye ese elemento del array que muestra.

// 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()}`);
  }
}

Volver

ItemResponse[]: Es un array de respuestas a cada elemento de pregunta del formulario para el que el encuestado podría recibir una puntuación.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getGradableResponseForItem(item)

Obtiene la respuesta del elemento que se incluye en la respuesta del formulario para un elemento determinado. Este método funciona de manera similar a getResponseForItem(item), pero, para permitir la calificación de una respuesta faltante, aún devuelve un ItemResponse si el Item correspondiente se puede calificar (es decir, tiene un valor de puntos), incluso si no hay una respuesta real. Sin embargo, si el Item no se puede calificar, este método devuelve 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()}`,
  );
}

Parámetros

NombreTipoDescripción
itemItem

Volver

ItemResponse: Es la respuesta para un elemento determinado o null si no existe ninguna y el elemento no está calificado.


getId()

Obtiene el ID de la respuesta del formulario. Este método devuelve null si no se envió la respuesta del formulario.

// 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()}`);
}

Volver

String: Es el ID de la respuesta del formulario o null si no se envió la respuesta del formulario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getItemResponses()

Obtiene todas las respuestas de elementos que se incluyen en una respuesta del formulario, en el mismo orden en que aparecen los elementos en el formulario. Si la respuesta del formulario no contiene una respuesta para un TextItem, DateItem, TimeItem o ParagraphTextItem determinado, el ItemResponse que se devuelve para ese elemento tendrá una cadena vacía como respuesta. Si la respuesta del formulario omite una respuesta para cualquier otro tipo de elemento, este método excluye ese elemento de su array devuelto.

// 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()}'`);
  }
}

Volver

ItemResponse[]: Es un array de respuestas a cada elemento de pregunta del formulario para el que el encuestado proporcionó una respuesta.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getRespondentEmail()

Obtiene la dirección de correo electrónico de la persona que envió una respuesta, si el parámetro de configuración Form.setCollectEmail(collect) está habilitado.

En el caso de una respuesta de formulario que la secuencia de comandos creó, pero aún no envió, este método devuelve 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()}`);
}

Volver

String: Es la dirección de correo electrónico de la persona que envió esta respuesta, si está disponible, o null si la secuencia de comandos creó esta respuesta, pero aún no la envió.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getResponseForItem(item)

Obtiene la respuesta del elemento que se incluye en esta respuesta del formulario para un elemento determinado.

// 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());
}

Parámetros

NombreTipoDescripción
itemItem

Volver

ItemResponse: Es la respuesta para un elemento determinado o null si no existe ninguna.


getTimestamp()

Obtiene la marca de tiempo del envío de una respuesta del formulario.

En el caso de una respuesta de formulario que la secuencia de comandos creó, pero aún no envió, este método devuelve 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()}`);
}

Volver

Date: Es la marca de tiempo en la que se envió esta respuesta o null si la secuencia de comandos creó esta respuesta, pero aún no la envió.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

submit()

Envía la respuesta. Arroja una excepción de secuencia de comandos si ya se envió la respuesta.

// 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();

Volver

FormResponse: Es una respuesta recién creada que se guardó en el almacén de respuestas del formulario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

toPrefilledUrl()

Genera una URL para el formulario en el que las respuestas se completan previamente según las respuestas de esta respuesta del formulario.

// 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);

Volver

String: Es la URL de un formulario con respuestas ya completadas.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

withItemGrade(gradedResponse)

Agrega las calificaciones de la respuesta del elemento determinada a una respuesta del formulario. Este método solo se aplica a las respuestas de formularios que ya se enviaron y solo afecta las calificaciones almacenadas una vez que se envían. Este método también solo actualiza las calificaciones de la respuesta del elemento; no afecta la respuesta real (ya que la respuesta ya se envió). Si se llama a este método varias veces para el mismo elemento, solo se conservará la última calificación. Si ItemResponse no contiene calificaciones, este método quita las calificaciones del elemento.

// Programmatically award partial credit for a given response
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const formResponses = form.getResponses();
const formItems = form.getItems();
for (const formResponse of formResponses) {
  for (const item of formItems) {
    const points = item.asMultipleChoiceItem().getPoints();
    const itemResponse = formResponse.getGradableResponseForItem(item);
    Logger.log('Award half credit for answers containing the word "Kennedy"');
    const answer = itemResponse.getResponse();

    if (answer?.includes('Kennedy')) {
      itemResponse.setScore(points / 2);
      formResponse.withItemGrade(itemResponse);
    }
  }
}
form.submitGrades(formResponses);

Parámetros

NombreTipoDescripción
gradedResponseItemResponse

Volver

FormResponse: Este FormResponse, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

withItemResponse(response)

Agrega la respuesta del elemento proporcionada a una respuesta del formulario. Este método solo se aplica a las respuestas de formularios que la secuencia de comandos creó, pero que aún no se enviaron. No puede afectar las respuestas almacenadas. Si se llama a este método varias veces para el mismo elemento, solo se conservará la última respuesta del elemento.

// 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();

Parámetros

NombreTipoDescripción
responseItemResponse

Volver

FormResponse: Este FormResponse, para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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