| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, h1, h2, h3, div, span, p, pre, a { |
| 5 |
margin: 0; |
| 6 |
padding: 0; |
| 7 |
border: 0; |
| 8 |
font-weight: inherit; |
| 9 |
font-style: inherit; |
| 10 |
font-size: 100%; |
| 11 |
font-family: inherit; |
| 12 |
vertical-align: baseline; |
| 13 |
} |
| 14 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, h2, h3 { |
| 50 |
border-bottom: solid #CCC 1px; |
| 51 |
} |
| 52 |
|
| 53 |
.toc_element { |
| 54 |
margin-top: 0.5em; |
| 55 |
} |
| 56 |
|
| 57 |
.firstline { |
| 58 |
margin-left: 2 em; |
| 59 |
} |
| 60 |
|
| 61 |
.method { |
| 62 |
margin-top: 1em; |
| 63 |
border: solid 1px #CCC; |
| 64 |
padding: 1em; |
| 65 |
background: #EEE; |
| 66 |
} |
| 67 |
|
| 68 |
.details { |
| 69 |
font-weight: bold; |
| 70 |
font-size: 14px; |
| 71 |
} |
| 72 |
|
| 73 |
</style> |
| 74 |
|
| 75 |
<h1><a href="forms_v1.html">Google Forms API</a> . <a href="forms_v1.forms.html">forms</a> . <a href="forms_v1.forms.responses.html">responses</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#get">get(formId, responseId, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Get one response from the form.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#list">list(formId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">List a form's responses.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#list_next">list_next()</a></code></p> |
| 88 |
<p class="firstline">Retrieves the next page of results.</p> |
| 89 |
<h3>Method Details</h3> |
| 90 |
<div class="method"> |
| 91 |
<code class="details" id="close">close()</code> |
| 92 |
<pre>Close httplib2 connections.</pre> |
| 93 |
</div> |
| 94 |
|
| 95 |
<div class="method"> |
| 96 |
<code class="details" id="get">get(formId, responseId, x__xgafv=None)</code> |
| 97 |
<pre>Get one response from the form. |
| 98 |
|
| 99 |
Args: |
| 100 |
formId: string, Required. The form ID. (required) |
| 101 |
responseId: string, Required. The response ID within the form. (required) |
| 102 |
x__xgafv: string, V1 error format. |
| 103 |
Allowed values |
| 104 |
1 - v1 error format |
| 105 |
2 - v2 error format |
| 106 |
|
| 107 |
Returns: |
| 108 |
An object of the form: |
| 109 |
|
| 110 |
{ # A form response. |
| 111 |
"answers": { # Output only. The actual answers to the questions, keyed by question_id. |
| 112 |
"a_key": { # The submitted answer for a question. |
| 113 |
"fileUploadAnswers": { # All submitted files for a FileUpload question. # Output only. The answers to a file upload question. |
| 114 |
"answers": [ # Output only. All submitted files for a FileUpload question. |
| 115 |
{ # Info for a single file submitted to a file upload question. |
| 116 |
"fileId": "A String", # Output only. The ID of the Google Drive file. |
| 117 |
"fileName": "A String", # Output only. The file name, as stored in Google Drive on upload. |
| 118 |
"mimeType": "A String", # Output only. The MIME type of the file, as stored in Google Drive on upload. |
| 119 |
}, |
| 120 |
], |
| 121 |
}, |
| 122 |
"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. |
| 123 |
"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. |
| 124 |
"feedback": { # Feedback for a respondent about their response to a question. # Output only. Additional feedback given for an answer. |
| 125 |
"material": [ # Additional information provided as part of the feedback, often used to point the respondent to more reading and resources. |
| 126 |
{ # Supplementary material to the feedback. |
| 127 |
"link": { # Link for text. # Text feedback. |
| 128 |
"displayText": "A String", # Required. Display text for the URI. |
| 129 |
"uri": "A String", # Required. The URI. |
| 130 |
}, |
| 131 |
"video": { # Link to a video. # Video feedback. |
| 132 |
"displayText": "A String", # Required. The display text for the link. |
| 133 |
"youtubeUri": "A String", # The URI of a YouTube video. |
| 134 |
}, |
| 135 |
}, |
| 136 |
], |
| 137 |
"text": "A String", # Required. The main text of the feedback. |
| 138 |
}, |
| 139 |
"score": 3.14, # Output only. The numeric score awarded for the answer. |
| 140 |
}, |
| 141 |
"questionId": "A String", # Output only. The question's ID. See also Question.question_id. |
| 142 |
"textAnswers": { # A question's answers as text. # Output only. The specific answers as text. |
| 143 |
"answers": [ # Output only. Answers to a question. For multiple-value ChoiceQuestions, each answer is a separate value. |
| 144 |
{ # An answer to a question represented as text. |
| 145 |
"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. |
| 146 |
}, |
| 147 |
], |
| 148 |
}, |
| 149 |
}, |
| 150 |
}, |
| 151 |
"createTime": "A String", # Output only. Timestamp for the first time the response was submitted. |
| 152 |
"formId": "A String", # Output only. The form ID. |
| 153 |
"lastSubmittedTime": "A String", # Output only. Timestamp for the most recent time the response was submitted. Does not track changes to grades. |
| 154 |
"respondentEmail": "A String", # Output only. The email address (if collected) for the respondent. |
| 155 |
"responseId": "A String", # Output only. The response ID. |
| 156 |
"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. |
| 157 |
}</pre> |
| 158 |
</div> |
| 159 |
|
| 160 |
<div class="method"> |
| 161 |
<code class="details" id="list">list(formId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 162 |
<pre>List a form's responses. |
| 163 |
|
| 164 |
Args: |
| 165 |
formId: string, Required. ID of the Form whose responses to list. (required) |
| 166 |
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". |
| 167 |
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. |
| 168 |
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. |
| 169 |
x__xgafv: string, V1 error format. |
| 170 |
Allowed values |
| 171 |
1 - v1 error format |
| 172 |
2 - v2 error format |
| 173 |
|
| 174 |
Returns: |
| 175 |
An object of the form: |
| 176 |
|
| 177 |
{ # Response to a ListFormResponsesRequest. |
| 178 |
"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. |
| 179 |
"responses": [ # The returned form responses. Note: The `formId` field is not returned in the `FormResponse` object for list requests. |
| 180 |
{ # A form response. |
| 181 |
"answers": { # Output only. The actual answers to the questions, keyed by question_id. |
| 182 |
"a_key": { # The submitted answer for a question. |
| 183 |
"fileUploadAnswers": { # All submitted files for a FileUpload question. # Output only. The answers to a file upload question. |
| 184 |
"answers": [ # Output only. All submitted files for a FileUpload question. |
| 185 |
{ # Info for a single file submitted to a file upload question. |
| 186 |
"fileId": "A String", # Output only. The ID of the Google Drive file. |
| 187 |
"fileName": "A String", # Output only. The file name, as stored in Google Drive on upload. |
| 188 |
"mimeType": "A String", # Output only. The MIME type of the file, as stored in Google Drive on upload. |
| 189 |
}, |
| 190 |
], |
| 191 |
}, |
| 192 |
"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. |
| 193 |
"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. |
| 194 |
"feedback": { # Feedback for a respondent about their response to a question. # Output only. Additional feedback given for an answer. |
| 195 |
"material": [ # Additional information provided as part of the feedback, often used to point the respondent to more reading and resources. |
| 196 |
{ # Supplementary material to the feedback. |
| 197 |
"link": { # Link for text. # Text feedback. |
| 198 |
"displayText": "A String", # Required. Display text for the URI. |
| 199 |
"uri": "A String", # Required. The URI. |
| 200 |
}, |
| 201 |
"video": { # Link to a video. # Video feedback. |
| 202 |
"displayText": "A String", # Required. The display text for the link. |
| 203 |
"youtubeUri": "A String", # The URI of a YouTube video. |
| 204 |
}, |
| 205 |
}, |
| 206 |
], |
| 207 |
"text": "A String", # Required. The main text of the feedback. |
| 208 |
}, |
| 209 |
"score": 3.14, # Output only. The numeric score awarded for the answer. |
| 210 |
}, |
| 211 |
"questionId": "A String", # Output only. The question's ID. See also Question.question_id. |
| 212 |
"textAnswers": { # A question's answers as text. # Output only. The specific answers as text. |
| 213 |
"answers": [ # Output only. Answers to a question. For multiple-value ChoiceQuestions, each answer is a separate value. |
| 214 |
{ # An answer to a question represented as text. |
| 215 |
"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. |
| 216 |
}, |
| 217 |
], |
| 218 |
}, |
| 219 |
}, |
| 220 |
}, |
| 221 |
"createTime": "A String", # Output only. Timestamp for the first time the response was submitted. |
| 222 |
"formId": "A String", # Output only. The form ID. |
| 223 |
"lastSubmittedTime": "A String", # Output only. Timestamp for the most recent time the response was submitted. Does not track changes to grades. |
| 224 |
"respondentEmail": "A String", # Output only. The email address (if collected) for the respondent. |
| 225 |
"responseId": "A String", # Output only. The response ID. |
| 226 |
"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. |
| 227 |
}, |
| 228 |
], |
| 229 |
}</pre> |
| 230 |
</div> |
| 231 |
|
| 232 |
<div class="method"> |
| 233 |
<code class="details" id="list_next">list_next()</code> |
| 234 |
<pre>Retrieves the next page of results. |
| 235 |
|
| 236 |
Args: |
| 237 |
previous_request: The request for the previous page. (required) |
| 238 |
previous_response: The response from the request for the previous page. (required) |
| 239 |
|
| 240 |
Returns: |
| 241 |
A request object that you can call 'execute()' on to request the next |
| 242 |
page. Returns None if there are no more items in the collection. |
| 243 |
</pre> |
| 244 |
</div> |
| 245 |
|
| 246 |
</body></html> |