Google Forms API . forms . responses

Instance Methods

close()

Close httplib2 connections.

get(formId, responseId, x__xgafv=None)

Get one response from the form.

list(formId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

List a form's responses.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(formId, responseId, x__xgafv=None)
Get one response from the form.

Args:
  formId: string, Required. The form ID. (required)
  responseId: string, Required. The response ID within the form. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A form response.
  "answers": { # Output only. The actual answers to the questions, keyed by question_id.
    "a_key": { # The submitted answer for a question.
      "fileUploadAnswers": { # All submitted files for a FileUpload question. # Output only. The answers to a file upload question.
        "answers": [ # Output only. All submitted files for a FileUpload question.
          { # Info for a single file submitted to a file upload question.
            "fileId": "A String", # Output only. The ID of the Google Drive file.
            "fileName": "A String", # Output only. The file name, as stored in Google Drive on upload.
            "mimeType": "A String", # Output only. The MIME type of the file, as stored in Google Drive on upload.
          },
        ],
      },
      "grade": { # Grade information associated with a respondent's answer to a question. # Output only. The grade for the answer if the form was a quiz.
        "correct": True or False, # Output only. Whether the question was answered correctly or not. A zero-point score is not enough to infer incorrectness, since a correctly answered question could be worth zero points.
        "feedback": { # Feedback for a respondent about their response to a question. # Output only. Additional feedback given for an answer.
          "material": [ # Additional information provided as part of the feedback, often used to point the respondent to more reading and resources.
            { # Supplementary material to the feedback.
              "link": { # Link for text. # Text feedback.
                "displayText": "A String", # Required. Display text for the URI.
                "uri": "A String", # Required. The URI.
              },
              "video": { # Link to a video. # Video feedback.
                "displayText": "A String", # Required. The display text for the link.
                "youtubeUri": "A String", # The URI of a YouTube video.
              },
            },
          ],
          "text": "A String", # Required. The main text of the feedback.
        },
        "score": 3.14, # Output only. The numeric score awarded for the answer.
      },
      "questionId": "A String", # Output only. The question's ID. See also Question.question_id.
      "textAnswers": { # A question's answers as text. # Output only. The specific answers as text.
        "answers": [ # Output only. Answers to a question. For multiple-value ChoiceQuestions, each answer is a separate value.
          { # An answer to a question represented as text.
            "value": "A String", # Output only. The answer value. Formatting used for different kinds of question: * ChoiceQuestion * `RADIO` or `DROP_DOWN`: A single string corresponding to the option that was selected. * `CHECKBOX`: Multiple strings corresponding to each option that was selected. * TextQuestion: The text that the user entered. * ScaleQuestion: A string containing the number that was selected. * DateQuestion * Without time or year: MM-DD e.g. "05-19" * With year: YYYY-MM-DD e.g. "1986-05-19" * With time: MM-DD HH:MM e.g. "05-19 14:51" * With year and time: YYYY-MM-DD HH:MM e.g. "1986-05-19 14:51" * TimeQuestion: String with time or duration in HH:MM format e.g. "14:51" * RowQuestion within QuestionGroupItem: The answer for each row of a QuestionGroupItem is represented as a separate Answer. Each will contain one string for `RADIO`-type choices or multiple strings for `CHECKBOX` choices.
          },
        ],
      },
    },
  },
  "createTime": "A String", # Output only. Timestamp for the first time the response was submitted.
  "formId": "A String", # Output only. The form ID.
  "lastSubmittedTime": "A String", # Output only. Timestamp for the most recent time the response was submitted. Does not track changes to grades.
  "respondentEmail": "A String", # Output only. The email address (if collected) for the respondent.
  "responseId": "A String", # Output only. The response ID.
  "totalScore": 3.14, # Output only. The total number of points the respondent received for their submission Only set if the form was a quiz and the response was graded. This includes points automatically awarded via autograding adjusted by any manual corrections entered by the form owner.
}
list(formId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List a form's responses.

Args:
  formId: string, Required. ID of the Form whose responses to list. (required)
  filter: string, Which form responses to return. Currently, the only supported filters are: * timestamp > *N* which means to get all form responses submitted after (but not at) timestamp *N*. * timestamp >= *N* which means to get all form responses submitted at and after timestamp *N*. For both supported filters, timestamp must be formatted in RFC3339 UTC "Zulu" format. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
  pageSize: integer, The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses are returned.
  pageToken: string, A page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the original request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to a ListFormResponsesRequest.
  "nextPageToken": "A String", # If set, there are more responses. To get the next page of responses, provide this as `page_token` in a future request.
  "responses": [ # The returned form responses. Note: The `formId` field is not returned in the `FormResponse` object for list requests.
    { # A form response.
      "answers": { # Output only. The actual answers to the questions, keyed by question_id.
        "a_key": { # The submitted answer for a question.
          "fileUploadAnswers": { # All submitted files for a FileUpload question. # Output only. The answers to a file upload question.
            "answers": [ # Output only. All submitted files for a FileUpload question.
              { # Info for a single file submitted to a file upload question.
                "fileId": "A String", # Output only. The ID of the Google Drive file.
                "fileName": "A String", # Output only. The file name, as stored in Google Drive on upload.
                "mimeType": "A String", # Output only. The MIME type of the file, as stored in Google Drive on upload.
              },
            ],
          },
          "grade": { # Grade information associated with a respondent's answer to a question. # Output only. The grade for the answer if the form was a quiz.
            "correct": True or False, # Output only. Whether the question was answered correctly or not. A zero-point score is not enough to infer incorrectness, since a correctly answered question could be worth zero points.
            "feedback": { # Feedback for a respondent about their response to a question. # Output only. Additional feedback given for an answer.
              "material": [ # Additional information provided as part of the feedback, often used to point the respondent to more reading and resources.
                { # Supplementary material to the feedback.
                  "link": { # Link for text. # Text feedback.
                    "displayText": "A String", # Required. Display text for the URI.
                    "uri": "A String", # Required. The URI.
                  },
                  "video": { # Link to a video. # Video feedback.
                    "displayText": "A String", # Required. The display text for the link.
                    "youtubeUri": "A String", # The URI of a YouTube video.
                  },
                },
              ],
              "text": "A String", # Required. The main text of the feedback.
            },
            "score": 3.14, # Output only. The numeric score awarded for the answer.
          },
          "questionId": "A String", # Output only. The question's ID. See also Question.question_id.
          "textAnswers": { # A question's answers as text. # Output only. The specific answers as text.
            "answers": [ # Output only. Answers to a question. For multiple-value ChoiceQuestions, each answer is a separate value.
              { # An answer to a question represented as text.
                "value": "A String", # Output only. The answer value. Formatting used for different kinds of question: * ChoiceQuestion * `RADIO` or `DROP_DOWN`: A single string corresponding to the option that was selected. * `CHECKBOX`: Multiple strings corresponding to each option that was selected. * TextQuestion: The text that the user entered. * ScaleQuestion: A string containing the number that was selected. * DateQuestion * Without time or year: MM-DD e.g. "05-19" * With year: YYYY-MM-DD e.g. "1986-05-19" * With time: MM-DD HH:MM e.g. "05-19 14:51" * With year and time: YYYY-MM-DD HH:MM e.g. "1986-05-19 14:51" * TimeQuestion: String with time or duration in HH:MM format e.g. "14:51" * RowQuestion within QuestionGroupItem: The answer for each row of a QuestionGroupItem is represented as a separate Answer. Each will contain one string for `RADIO`-type choices or multiple strings for `CHECKBOX` choices.
              },
            ],
          },
        },
      },
      "createTime": "A String", # Output only. Timestamp for the first time the response was submitted.
      "formId": "A String", # Output only. The form ID.
      "lastSubmittedTime": "A String", # Output only. Timestamp for the most recent time the response was submitted. Does not track changes to grades.
      "respondentEmail": "A String", # Output only. The email address (if collected) for the respondent.
      "responseId": "A String", # Output only. The response ID.
      "totalScore": 3.14, # Output only. The total number of points the respondent received for their submission Only set if the form was a quiz and the response was graded. This includes points automatically awarded via autograding adjusted by any manual corrections entered by the form owner.
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.