• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, 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
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, 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="consumersurveys_v2.html">Consumer Surveys API</a> . <a href="consumersurveys_v2.surveys.html">surveys</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(surveyUrlId)</a></code></p>
79<p class="firstline">Removes a survey from view in all user GET requests.</p>
80<p class="toc_element">
81  <code><a href="#get">get(surveyUrlId)</a></code></p>
82<p class="firstline">Retrieves information about the specified survey.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(body)</a></code></p>
85<p class="firstline">Creates a survey.</p>
86<p class="toc_element">
87  <code><a href="#list">list(startIndex=None, maxResults=None, token=None)</a></code></p>
88<p class="firstline">Lists the surveys owned by the authenticated user.</p>
89<p class="toc_element">
90  <code><a href="#start">start(resourceId, body)</a></code></p>
91<p class="firstline">Begins running a survey.</p>
92<p class="toc_element">
93  <code><a href="#stop">stop(resourceId)</a></code></p>
94<p class="firstline">Stops a running survey.</p>
95<p class="toc_element">
96  <code><a href="#update">update(surveyUrlId, body)</a></code></p>
97<p class="firstline">Updates a survey. Currently the only property that can be updated is the owners property.</p>
98<h3>Method Details</h3>
99<div class="method">
100    <code class="details" id="delete">delete(surveyUrlId)</code>
101  <pre>Removes a survey from view in all user GET requests.
102
103Args:
104  surveyUrlId: string, External URL ID for the survey. (required)
105
106Returns:
107  An object of the form:
108
109    {
110    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
111  }</pre>
112</div>
113
114<div class="method">
115    <code class="details" id="get">get(surveyUrlId)</code>
116  <pre>Retrieves information about the specified survey.
117
118Args:
119  surveyUrlId: string, External URL ID for the survey. (required)
120
121Returns:
122  An object of the form:
123
124    {
125      "owners": [
126        "A String",
127      ],
128      "description": "A String",
129      "title": "A String",
130      "customerData": "A String",
131      "state": "A String",
132      "audience": {
133        "countrySubdivision": "A String",
134        "mobileAppPanelId": "A String",
135        "country": "A String",
136        "ages": [
137          "A String",
138        ],
139        "populationSource": "A String",
140        "languages": [
141          "A String",
142        ],
143        "gender": "A String",
144      },
145      "cost": {
146        "nanos": "A String",
147        "currencyCode": "A String",
148        "costPerResponseNanos": "A String",
149        "maxCostPerResponseNanos": "A String",
150      },
151      "surveyUrlId": "A String",
152      "questions": [
153        {
154          "highValueLabel": "A String",
155          "mustPickSuggestion": True or False,
156          "thresholdAnswers": [
157            "A String",
158          ],
159          "sentimentText": "A String",
160          "question": "A String",
161          "numStars": "A String",
162          "lowValueLabel": "A String",
163          "videoId": "A String",
164          "answers": [
165            "A String",
166          ],
167          "lastAnswerPositionPinned": True or False,
168          "hasOther": True or False,
169          "unitOfMeasurementLabel": "A String",
170          "images": [
171            {
172              "url": "A String",
173              "altText": "A String",
174              "data": "A String",
175            },
176          ],
177          "singleLineResponse": True or False,
178          "openTextSuggestions": [
179            "A String",
180          ],
181          "type": "A String",
182          "answerOrder": "A String",
183          "openTextPlaceholder": "A String",
184        },
185      ],
186      "wantedResponseCount": 42,
187      "rejectionReason": {
188        "explanation": "A String",
189        "type": "A String",
190      },
191    }</pre>
192</div>
193
194<div class="method">
195    <code class="details" id="insert">insert(body)</code>
196  <pre>Creates a survey.
197
198Args:
199  body: object, The request body. (required)
200    The object takes the form of:
201
202{
203    "owners": [
204      "A String",
205    ],
206    "description": "A String",
207    "title": "A String",
208    "customerData": "A String",
209    "state": "A String",
210    "audience": {
211      "countrySubdivision": "A String",
212      "mobileAppPanelId": "A String",
213      "country": "A String",
214      "ages": [
215        "A String",
216      ],
217      "populationSource": "A String",
218      "languages": [
219        "A String",
220      ],
221      "gender": "A String",
222    },
223    "cost": {
224      "nanos": "A String",
225      "currencyCode": "A String",
226      "costPerResponseNanos": "A String",
227      "maxCostPerResponseNanos": "A String",
228    },
229    "surveyUrlId": "A String",
230    "questions": [
231      {
232        "highValueLabel": "A String",
233        "mustPickSuggestion": True or False,
234        "thresholdAnswers": [
235          "A String",
236        ],
237        "sentimentText": "A String",
238        "question": "A String",
239        "numStars": "A String",
240        "lowValueLabel": "A String",
241        "videoId": "A String",
242        "answers": [
243          "A String",
244        ],
245        "lastAnswerPositionPinned": True or False,
246        "hasOther": True or False,
247        "unitOfMeasurementLabel": "A String",
248        "images": [
249          {
250            "url": "A String",
251            "altText": "A String",
252            "data": "A String",
253          },
254        ],
255        "singleLineResponse": True or False,
256        "openTextSuggestions": [
257          "A String",
258        ],
259        "type": "A String",
260        "answerOrder": "A String",
261        "openTextPlaceholder": "A String",
262      },
263    ],
264    "wantedResponseCount": 42,
265    "rejectionReason": {
266      "explanation": "A String",
267      "type": "A String",
268    },
269  }
270
271
272Returns:
273  An object of the form:
274
275    {
276      "owners": [
277        "A String",
278      ],
279      "description": "A String",
280      "title": "A String",
281      "customerData": "A String",
282      "state": "A String",
283      "audience": {
284        "countrySubdivision": "A String",
285        "mobileAppPanelId": "A String",
286        "country": "A String",
287        "ages": [
288          "A String",
289        ],
290        "populationSource": "A String",
291        "languages": [
292          "A String",
293        ],
294        "gender": "A String",
295      },
296      "cost": {
297        "nanos": "A String",
298        "currencyCode": "A String",
299        "costPerResponseNanos": "A String",
300        "maxCostPerResponseNanos": "A String",
301      },
302      "surveyUrlId": "A String",
303      "questions": [
304        {
305          "highValueLabel": "A String",
306          "mustPickSuggestion": True or False,
307          "thresholdAnswers": [
308            "A String",
309          ],
310          "sentimentText": "A String",
311          "question": "A String",
312          "numStars": "A String",
313          "lowValueLabel": "A String",
314          "videoId": "A String",
315          "answers": [
316            "A String",
317          ],
318          "lastAnswerPositionPinned": True or False,
319          "hasOther": True or False,
320          "unitOfMeasurementLabel": "A String",
321          "images": [
322            {
323              "url": "A String",
324              "altText": "A String",
325              "data": "A String",
326            },
327          ],
328          "singleLineResponse": True or False,
329          "openTextSuggestions": [
330            "A String",
331          ],
332          "type": "A String",
333          "answerOrder": "A String",
334          "openTextPlaceholder": "A String",
335        },
336      ],
337      "wantedResponseCount": 42,
338      "rejectionReason": {
339        "explanation": "A String",
340        "type": "A String",
341      },
342    }</pre>
343</div>
344
345<div class="method">
346    <code class="details" id="list">list(startIndex=None, maxResults=None, token=None)</code>
347  <pre>Lists the surveys owned by the authenticated user.
348
349Args:
350  startIndex: integer, A parameter
351  maxResults: integer, A parameter
352  token: string, A parameter
353
354Returns:
355  An object of the form:
356
357    {
358    "tokenPagination": {
359      "nextPageToken": "A String",
360      "previousPageToken": "A String",
361    },
362    "pageInfo": {
363      "totalResults": 42,
364      "startIndex": 42,
365      "resultPerPage": 42,
366    },
367    "resources": [ # An individual survey resource.
368      {
369          "owners": [
370            "A String",
371          ],
372          "description": "A String",
373          "title": "A String",
374          "customerData": "A String",
375          "state": "A String",
376          "audience": {
377            "countrySubdivision": "A String",
378            "mobileAppPanelId": "A String",
379            "country": "A String",
380            "ages": [
381              "A String",
382            ],
383            "populationSource": "A String",
384            "languages": [
385              "A String",
386            ],
387            "gender": "A String",
388          },
389          "cost": {
390            "nanos": "A String",
391            "currencyCode": "A String",
392            "costPerResponseNanos": "A String",
393            "maxCostPerResponseNanos": "A String",
394          },
395          "surveyUrlId": "A String",
396          "questions": [
397            {
398              "highValueLabel": "A String",
399              "mustPickSuggestion": True or False,
400              "thresholdAnswers": [
401                "A String",
402              ],
403              "sentimentText": "A String",
404              "question": "A String",
405              "numStars": "A String",
406              "lowValueLabel": "A String",
407              "videoId": "A String",
408              "answers": [
409                "A String",
410              ],
411              "lastAnswerPositionPinned": True or False,
412              "hasOther": True or False,
413              "unitOfMeasurementLabel": "A String",
414              "images": [
415                {
416                  "url": "A String",
417                  "altText": "A String",
418                  "data": "A String",
419                },
420              ],
421              "singleLineResponse": True or False,
422              "openTextSuggestions": [
423                "A String",
424              ],
425              "type": "A String",
426              "answerOrder": "A String",
427              "openTextPlaceholder": "A String",
428            },
429          ],
430          "wantedResponseCount": 42,
431          "rejectionReason": {
432            "explanation": "A String",
433            "type": "A String",
434          },
435        },
436    ],
437    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
438  }</pre>
439</div>
440
441<div class="method">
442    <code class="details" id="start">start(resourceId, body)</code>
443  <pre>Begins running a survey.
444
445Args:
446  resourceId: string, A parameter (required)
447  body: object, The request body. (required)
448    The object takes the form of:
449
450{
451    "maxCostPerResponseNanos": "A String", # Threshold to start a survey automically if the quoted prices is less than or equal to this value. See Survey.Cost for more details.
452  }
453
454
455Returns:
456  An object of the form:
457
458    {
459    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
460  }</pre>
461</div>
462
463<div class="method">
464    <code class="details" id="stop">stop(resourceId)</code>
465  <pre>Stops a running survey.
466
467Args:
468  resourceId: string, A parameter (required)
469
470Returns:
471  An object of the form:
472
473    {
474    "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
475  }</pre>
476</div>
477
478<div class="method">
479    <code class="details" id="update">update(surveyUrlId, body)</code>
480  <pre>Updates a survey. Currently the only property that can be updated is the owners property.
481
482Args:
483  surveyUrlId: string, External URL ID for the survey. (required)
484  body: object, The request body. (required)
485    The object takes the form of:
486
487{
488    "owners": [
489      "A String",
490    ],
491    "description": "A String",
492    "title": "A String",
493    "customerData": "A String",
494    "state": "A String",
495    "audience": {
496      "countrySubdivision": "A String",
497      "mobileAppPanelId": "A String",
498      "country": "A String",
499      "ages": [
500        "A String",
501      ],
502      "populationSource": "A String",
503      "languages": [
504        "A String",
505      ],
506      "gender": "A String",
507    },
508    "cost": {
509      "nanos": "A String",
510      "currencyCode": "A String",
511      "costPerResponseNanos": "A String",
512      "maxCostPerResponseNanos": "A String",
513    },
514    "surveyUrlId": "A String",
515    "questions": [
516      {
517        "highValueLabel": "A String",
518        "mustPickSuggestion": True or False,
519        "thresholdAnswers": [
520          "A String",
521        ],
522        "sentimentText": "A String",
523        "question": "A String",
524        "numStars": "A String",
525        "lowValueLabel": "A String",
526        "videoId": "A String",
527        "answers": [
528          "A String",
529        ],
530        "lastAnswerPositionPinned": True or False,
531        "hasOther": True or False,
532        "unitOfMeasurementLabel": "A String",
533        "images": [
534          {
535            "url": "A String",
536            "altText": "A String",
537            "data": "A String",
538          },
539        ],
540        "singleLineResponse": True or False,
541        "openTextSuggestions": [
542          "A String",
543        ],
544        "type": "A String",
545        "answerOrder": "A String",
546        "openTextPlaceholder": "A String",
547      },
548    ],
549    "wantedResponseCount": 42,
550    "rejectionReason": {
551      "explanation": "A String",
552      "type": "A String",
553    },
554  }
555
556
557Returns:
558  An object of the form:
559
560    {
561      "owners": [
562        "A String",
563      ],
564      "description": "A String",
565      "title": "A String",
566      "customerData": "A String",
567      "state": "A String",
568      "audience": {
569        "countrySubdivision": "A String",
570        "mobileAppPanelId": "A String",
571        "country": "A String",
572        "ages": [
573          "A String",
574        ],
575        "populationSource": "A String",
576        "languages": [
577          "A String",
578        ],
579        "gender": "A String",
580      },
581      "cost": {
582        "nanos": "A String",
583        "currencyCode": "A String",
584        "costPerResponseNanos": "A String",
585        "maxCostPerResponseNanos": "A String",
586      },
587      "surveyUrlId": "A String",
588      "questions": [
589        {
590          "highValueLabel": "A String",
591          "mustPickSuggestion": True or False,
592          "thresholdAnswers": [
593            "A String",
594          ],
595          "sentimentText": "A String",
596          "question": "A String",
597          "numStars": "A String",
598          "lowValueLabel": "A String",
599          "videoId": "A String",
600          "answers": [
601            "A String",
602          ],
603          "lastAnswerPositionPinned": True or False,
604          "hasOther": True or False,
605          "unitOfMeasurementLabel": "A String",
606          "images": [
607            {
608              "url": "A String",
609              "altText": "A String",
610              "data": "A String",
611            },
612          ],
613          "singleLineResponse": True or False,
614          "openTextSuggestions": [
615            "A String",
616          ],
617          "type": "A String",
618          "answerOrder": "A String",
619          "openTextPlaceholder": "A String",
620        },
621      ],
622      "wantedResponseCount": 42,
623      "rejectionReason": {
624        "explanation": "A String",
625        "type": "A String",
626      },
627    }</pre>
628</div>
629
630</body></html>