1{
2 "kind": "discovery#restDescription",
3 "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/e7DEYLH6SdmU14auNlU-9VK4HgU\"",
4 "discoveryVersion": "v1",
5 "id": "consumersurveys:v2",
6 "name": "consumersurveys",
7 "canonicalName": "Consumer Surveys",
8 "version": "v2",
9 "revision": "20170407",
10 "title": "Consumer Surveys API",
11 "description": "Creates and conducts surveys, lists the surveys that an authenticated user owns, and retrieves survey results and information about specified surveys.",
12 "ownerDomain": "google.com",
13 "ownerName": "Google",
14 "icons": {
15 "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
16 "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
17 },
18 "protocol": "rest",
19 "baseUrl": "https://www.googleapis.com/consumersurveys/v2/",
20 "basePath": "/consumersurveys/v2/",
21 "rootUrl": "https://www.googleapis.com/",
22 "servicePath": "consumersurveys/v2/",
23 "batchPath": "batch/consumersurveys/v2",
24 "parameters": {
25 "alt": {
26 "type": "string",
27 "description": "Data format for the response.",
28 "default": "json",
29 "enum": [
30 "json"
31 ],
32 "enumDescriptions": [
33 "Responses with Content-Type of application/json"
34 ],
35 "location": "query"
36 },
37 "fields": {
38 "type": "string",
39 "description": "Selector specifying which fields to include in a partial response.",
40 "location": "query"
41 },
42 "key": {
43 "type": "string",
44 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
45 "location": "query"
46 },
47 "oauth_token": {
48 "type": "string",
49 "description": "OAuth 2.0 token for the current user.",
50 "location": "query"
51 },
52 "prettyPrint": {
53 "type": "boolean",
54 "description": "Returns response with indentations and line breaks.",
55 "default": "true",
56 "location": "query"
57 },
58 "quotaUser": {
59 "type": "string",
60 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
61 "location": "query"
62 },
63 "userIp": {
64 "type": "string",
65 "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
66 "location": "query"
67 }
68 },
69 "auth": {
70 "oauth2": {
71 "scopes": {
72 "https://www.googleapis.com/auth/consumersurveys": {
73 "description": "View and edit your surveys and results"
74 },
75 "https://www.googleapis.com/auth/consumersurveys.readonly": {
76 "description": "View the results for your surveys"
77 },
78 "https://www.googleapis.com/auth/userinfo.email": {
79 "description": "View your email address"
80 }
81 }
82 }
83 },
84 "schemas": {
85 "FieldMask": {
86 "id": "FieldMask",
87 "type": "object",
88 "properties": {
89 "fields": {
90 "type": "array",
91 "items": {
92 "$ref": "FieldMask"
93 }
94 },
95 "id": {
96 "type": "integer",
97 "format": "int32"
98 }
99 }
100 },
101 "MobileAppPanel": {
102 "id": "MobileAppPanel",
103 "type": "object",
104 "properties": {
105 "country": {
106 "type": "string"
107 },
108 "isPublicPanel": {
109 "type": "boolean"
110 },
111 "language": {
112 "type": "string"
113 },
114 "mobileAppPanelId": {
115 "type": "string"
116 },
117 "name": {
118 "type": "string"
119 },
120 "owners": {
121 "type": "array",
122 "items": {
123 "type": "string"
124 }
125 }
126 }
127 },
128 "MobileAppPanelsListResponse": {
129 "id": "MobileAppPanelsListResponse",
130 "type": "object",
131 "properties": {
132 "pageInfo": {
133 "$ref": "PageInfo"
134 },
135 "requestId": {
136 "type": "string",
137 "description": "Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests."
138 },
139 "resources": {
140 "type": "array",
141 "description": "An individual predefined panel of Opinion Rewards mobile users.",
142 "items": {
143 "$ref": "MobileAppPanel"
144 }
145 },
146 "tokenPagination": {
147 "$ref": "TokenPagination"
148 }
149 }
150 },
151 "PageInfo": {
152 "id": "PageInfo",
153 "type": "object",
154 "properties": {
155 "resultPerPage": {
156 "type": "integer",
157 "format": "int32"
158 },
159 "startIndex": {
160 "type": "integer",
161 "format": "int32"
162 },
163 "totalResults": {
164 "type": "integer",
165 "format": "int32"
166 }
167 }
168 },
169 "ResultsGetRequest": {
170 "id": "ResultsGetRequest",
171 "type": "object",
172 "properties": {
173 "resultMask": {
174 "$ref": "ResultsMask"
175 }
176 }
177 },
178 "ResultsMask": {
179 "id": "ResultsMask",
180 "type": "object",
181 "properties": {
182 "fields": {
183 "type": "array",
184 "items": {
185 "$ref": "FieldMask"
186 }
187 },
188 "projection": {
189 "type": "string"
190 }
191 }
192 },
193 "Survey": {
194 "id": "Survey",
195 "type": "object",
196 "properties": {
197 "audience": {
198 "$ref": "SurveyAudience"
199 },
200 "cost": {
201 "$ref": "SurveyCost"
202 },
203 "customerData": {
204 "type": "string",
205 "format": "byte"
206 },
207 "description": {
208 "type": "string"
209 },
210 "owners": {
211 "type": "array",
212 "items": {
213 "type": "string"
214 }
215 },
216 "questions": {
217 "type": "array",
218 "items": {
219 "$ref": "SurveyQuestion"
220 }
221 },
222 "rejectionReason": {
223 "$ref": "SurveyRejection"
224 },
225 "state": {
226 "type": "string"
227 },
228 "surveyUrlId": {
229 "type": "string"
230 },
231 "title": {
232 "type": "string"
233 },
234 "wantedResponseCount": {
235 "type": "integer",
236 "format": "int32"
237 }
238 }
239 },
240 "SurveyAudience": {
241 "id": "SurveyAudience",
242 "type": "object",
243 "properties": {
244 "ages": {
245 "type": "array",
246 "items": {
247 "type": "string"
248 }
249 },
250 "country": {
251 "type": "string"
252 },
253 "countrySubdivision": {
254 "type": "string"
255 },
256 "gender": {
257 "type": "string"
258 },
259 "languages": {
260 "type": "array",
261 "items": {
262 "type": "string"
263 }
264 },
265 "mobileAppPanelId": {
266 "type": "string"
267 },
268 "populationSource": {
269 "type": "string"
270 }
271 }
272 },
273 "SurveyCost": {
274 "id": "SurveyCost",
275 "type": "object",
276 "properties": {
277 "costPerResponseNanos": {
278 "type": "string",
279 "format": "int64"
280 },
281 "currencyCode": {
282 "type": "string"
283 },
284 "maxCostPerResponseNanos": {
285 "type": "string",
286 "format": "int64"
287 },
288 "nanos": {
289 "type": "string",
290 "format": "int64"
291 }
292 }
293 },
294 "SurveyQuestion": {
295 "id": "SurveyQuestion",
296 "type": "object",
297 "properties": {
298 "answerOrder": {
299 "type": "string"
300 },
301 "answers": {
302 "type": "array",
303 "items": {
304 "type": "string"
305 }
306 },
307 "hasOther": {
308 "type": "boolean"
309 },
310 "highValueLabel": {
311 "type": "string"
312 },
313 "images": {
314 "type": "array",
315 "items": {
316 "$ref": "SurveyQuestionImage"
317 }
318 },
319 "lastAnswerPositionPinned": {
320 "type": "boolean"
321 },
322 "lowValueLabel": {
323 "type": "string"
324 },
325 "mustPickSuggestion": {
326 "type": "boolean"
327 },
328 "numStars": {
329 "type": "string"
330 },
331 "openTextPlaceholder": {
332 "type": "string"
333 },
334 "openTextSuggestions": {
335 "type": "array",
336 "items": {
337 "type": "string"
338 }
339 },
340 "question": {
341 "type": "string"
342 },
343 "sentimentText": {
344 "type": "string"
345 },
346 "singleLineResponse": {
347 "type": "boolean"
348 },
349 "thresholdAnswers": {
350 "type": "array",
351 "items": {
352 "type": "string"
353 }
354 },
355 "type": {
356 "type": "string"
357 },
358 "unitOfMeasurementLabel": {
359 "type": "string"
360 },
361 "videoId": {
362 "type": "string"
363 }
364 }
365 },
366 "SurveyQuestionImage": {
367 "id": "SurveyQuestionImage",
368 "type": "object",
369 "properties": {
370 "altText": {
371 "type": "string"
372 },
373 "data": {
374 "type": "string",
375 "format": "byte"
376 },
377 "url": {
378 "type": "string"
379 }
380 }
381 },
382 "SurveyRejection": {
383 "id": "SurveyRejection",
384 "type": "object",
385 "properties": {
386 "explanation": {
387 "type": "string"
388 },
389 "type": {
390 "type": "string"
391 }
392 }
393 },
394 "SurveyResults": {
395 "id": "SurveyResults",
396 "type": "object",
397 "properties": {
398 "status": {
399 "type": "string"
400 },
401 "surveyUrlId": {
402 "type": "string"
403 }
404 }
405 },
406 "SurveysDeleteResponse": {
407 "id": "SurveysDeleteResponse",
408 "type": "object",
409 "properties": {
410 "requestId": {
411 "type": "string",
412 "description": "Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests."
413 }
414 }
415 },
416 "SurveysListResponse": {
417 "id": "SurveysListResponse",
418 "type": "object",
419 "properties": {
420 "pageInfo": {
421 "$ref": "PageInfo"
422 },
423 "requestId": {
424 "type": "string",
425 "description": "Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests."
426 },
427 "resources": {
428 "type": "array",
429 "description": "An individual survey resource.",
430 "items": {
431 "$ref": "Survey"
432 }
433 },
434 "tokenPagination": {
435 "$ref": "TokenPagination"
436 }
437 }
438 },
439 "SurveysStartRequest": {
440 "id": "SurveysStartRequest",
441 "type": "object",
442 "properties": {
443 "maxCostPerResponseNanos": {
444 "type": "string",
445 "description": "Threshold to start a survey automically if the quoted prices is less than or equal to this value. See Survey.Cost for more details.",
446 "format": "int64"
447 }
448 }
449 },
450 "SurveysStartResponse": {
451 "id": "SurveysStartResponse",
452 "type": "object",
453 "properties": {
454 "requestId": {
455 "type": "string",
456 "description": "Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests."
457 }
458 }
459 },
460 "SurveysStopResponse": {
461 "id": "SurveysStopResponse",
462 "type": "object",
463 "properties": {
464 "requestId": {
465 "type": "string",
466 "description": "Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests."
467 }
468 }
469 },
470 "TokenPagination": {
471 "id": "TokenPagination",
472 "type": "object",
473 "properties": {
474 "nextPageToken": {
475 "type": "string"
476 },
477 "previousPageToken": {
478 "type": "string"
479 }
480 }
481 }
482 },
483 "resources": {
484 "mobileapppanels": {
485 "methods": {
486 "get": {
487 "id": "consumersurveys.mobileapppanels.get",
488 "path": "mobileAppPanels/{panelId}",
489 "httpMethod": "GET",
490 "description": "Retrieves a MobileAppPanel that is available to the authenticated user.",
491 "parameters": {
492 "panelId": {
493 "type": "string",
494 "description": "External URL ID for the panel.",
495 "required": true,
496 "location": "path"
497 }
498 },
499 "parameterOrder": [
500 "panelId"
501 ],
502 "response": {
503 "$ref": "MobileAppPanel"
504 },
505 "scopes": [
506 "https://www.googleapis.com/auth/consumersurveys",
507 "https://www.googleapis.com/auth/consumersurveys.readonly",
508 "https://www.googleapis.com/auth/userinfo.email"
509 ]
510 },
511 "list": {
512 "id": "consumersurveys.mobileapppanels.list",
513 "path": "mobileAppPanels",
514 "httpMethod": "GET",
515 "description": "Lists the MobileAppPanels available to the authenticated user.",
516 "parameters": {
517 "maxResults": {
518 "type": "integer",
519 "format": "uint32",
520 "location": "query"
521 },
522 "startIndex": {
523 "type": "integer",
524 "format": "uint32",
525 "location": "query"
526 },
527 "token": {
528 "type": "string",
529 "location": "query"
530 }
531 },
532 "response": {
533 "$ref": "MobileAppPanelsListResponse"
534 },
535 "scopes": [
536 "https://www.googleapis.com/auth/consumersurveys",
537 "https://www.googleapis.com/auth/consumersurveys.readonly",
538 "https://www.googleapis.com/auth/userinfo.email"
539 ]
540 },
541 "update": {
542 "id": "consumersurveys.mobileapppanels.update",
543 "path": "mobileAppPanels/{panelId}",
544 "httpMethod": "PUT",
545 "description": "Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.",
546 "parameters": {
547 "panelId": {
548 "type": "string",
549 "description": "External URL ID for the panel.",
550 "required": true,
551 "location": "path"
552 }
553 },
554 "parameterOrder": [
555 "panelId"
556 ],
557 "request": {
558 "$ref": "MobileAppPanel"
559 },
560 "response": {
561 "$ref": "MobileAppPanel"
562 },
563 "scopes": [
564 "https://www.googleapis.com/auth/consumersurveys",
565 "https://www.googleapis.com/auth/userinfo.email"
566 ]
567 }
568 }
569 },
570 "results": {
571 "methods": {
572 "get": {
573 "id": "consumersurveys.results.get",
574 "path": "surveys/{surveyUrlId}/results",
575 "httpMethod": "GET",
576 "description": "Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add \"?alt=media\" to the URL as an argument to get results.",
577 "parameters": {
578 "surveyUrlId": {
579 "type": "string",
580 "description": "External URL ID for the survey.",
581 "required": true,
582 "location": "path"
583 }
584 },
585 "parameterOrder": [
586 "surveyUrlId"
587 ],
588 "request": {
589 "$ref": "ResultsGetRequest"
590 },
591 "response": {
592 "$ref": "SurveyResults"
593 },
594 "scopes": [
595 "https://www.googleapis.com/auth/consumersurveys",
596 "https://www.googleapis.com/auth/consumersurveys.readonly",
597 "https://www.googleapis.com/auth/userinfo.email"
598 ],
599 "supportsMediaDownload": true
600 }
601 }
602 },
603 "surveys": {
604 "methods": {
605 "delete": {
606 "id": "consumersurveys.surveys.delete",
607 "path": "surveys/{surveyUrlId}",
608 "httpMethod": "DELETE",
609 "description": "Removes a survey from view in all user GET requests.",
610 "parameters": {
611 "surveyUrlId": {
612 "type": "string",
613 "description": "External URL ID for the survey.",
614 "required": true,
615 "location": "path"
616 }
617 },
618 "parameterOrder": [
619 "surveyUrlId"
620 ],
621 "response": {
622 "$ref": "SurveysDeleteResponse"
623 },
624 "scopes": [
625 "https://www.googleapis.com/auth/consumersurveys",
626 "https://www.googleapis.com/auth/userinfo.email"
627 ]
628 },
629 "get": {
630 "id": "consumersurveys.surveys.get",
631 "path": "surveys/{surveyUrlId}",
632 "httpMethod": "GET",
633 "description": "Retrieves information about the specified survey.",
634 "parameters": {
635 "surveyUrlId": {
636 "type": "string",
637 "description": "External URL ID for the survey.",
638 "required": true,
639 "location": "path"
640 }
641 },
642 "parameterOrder": [
643 "surveyUrlId"
644 ],
645 "response": {
646 "$ref": "Survey"
647 },
648 "scopes": [
649 "https://www.googleapis.com/auth/consumersurveys",
650 "https://www.googleapis.com/auth/consumersurveys.readonly",
651 "https://www.googleapis.com/auth/userinfo.email"
652 ]
653 },
654 "insert": {
655 "id": "consumersurveys.surveys.insert",
656 "path": "surveys",
657 "httpMethod": "POST",
658 "description": "Creates a survey.",
659 "request": {
660 "$ref": "Survey"
661 },
662 "response": {
663 "$ref": "Survey"
664 },
665 "scopes": [
666 "https://www.googleapis.com/auth/consumersurveys",
667 "https://www.googleapis.com/auth/userinfo.email"
668 ]
669 },
670 "list": {
671 "id": "consumersurveys.surveys.list",
672 "path": "surveys",
673 "httpMethod": "GET",
674 "description": "Lists the surveys owned by the authenticated user.",
675 "parameters": {
676 "maxResults": {
677 "type": "integer",
678 "format": "uint32",
679 "location": "query"
680 },
681 "startIndex": {
682 "type": "integer",
683 "format": "uint32",
684 "location": "query"
685 },
686 "token": {
687 "type": "string",
688 "location": "query"
689 }
690 },
691 "response": {
692 "$ref": "SurveysListResponse"
693 },
694 "scopes": [
695 "https://www.googleapis.com/auth/consumersurveys",
696 "https://www.googleapis.com/auth/consumersurveys.readonly",
697 "https://www.googleapis.com/auth/userinfo.email"
698 ]
699 },
700 "start": {
701 "id": "consumersurveys.surveys.start",
702 "path": "surveys/{resourceId}/start",
703 "httpMethod": "POST",
704 "description": "Begins running a survey.",
705 "parameters": {
706 "resourceId": {
707 "type": "string",
708 "required": true,
709 "location": "path"
710 }
711 },
712 "parameterOrder": [
713 "resourceId"
714 ],
715 "request": {
716 "$ref": "SurveysStartRequest"
717 },
718 "response": {
719 "$ref": "SurveysStartResponse"
720 },
721 "scopes": [
722 "https://www.googleapis.com/auth/consumersurveys",
723 "https://www.googleapis.com/auth/userinfo.email"
724 ]
725 },
726 "stop": {
727 "id": "consumersurveys.surveys.stop",
728 "path": "surveys/{resourceId}/stop",
729 "httpMethod": "POST",
730 "description": "Stops a running survey.",
731 "parameters": {
732 "resourceId": {
733 "type": "string",
734 "required": true,
735 "location": "path"
736 }
737 },
738 "parameterOrder": [
739 "resourceId"
740 ],
741 "response": {
742 "$ref": "SurveysStopResponse"
743 },
744 "scopes": [
745 "https://www.googleapis.com/auth/consumersurveys",
746 "https://www.googleapis.com/auth/userinfo.email"
747 ]
748 },
749 "update": {
750 "id": "consumersurveys.surveys.update",
751 "path": "surveys/{surveyUrlId}",
752 "httpMethod": "PUT",
753 "description": "Updates a survey. Currently the only property that can be updated is the owners property.",
754 "parameters": {
755 "surveyUrlId": {
756 "type": "string",
757 "description": "External URL ID for the survey.",
758 "required": true,
759 "location": "path"
760 }
761 },
762 "parameterOrder": [
763 "surveyUrlId"
764 ],
765 "request": {
766 "$ref": "Survey"
767 },
768 "response": {
769 "$ref": "Survey"
770 },
771 "scopes": [
772 "https://www.googleapis.com/auth/consumersurveys",
773 "https://www.googleapis.com/auth/userinfo.email"
774 ]
775 }
776 }
777 }
778 }
779}
View as plain text