1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(formId, responseId, x__xgafv=None)</a></code></p>
<p class="firstline">Get one response from the form.</p>
<p class="toc_element">
<code><a href="#list">list(formId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List a form's responses.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(formId, responseId, x__xgafv=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(formId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>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.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>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.
</pre>
</div>
</body></html>
|
