Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 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="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"> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 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"> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 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"> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 100 | <code class="details" id="delete">delete(surveyUrlId)</code> |
| 101 | <pre>Removes a survey from view in all user GET requests. |
| 102 | |
| 103 | Args: |
| 104 | surveyUrlId: string, External URL ID for the survey. (required) |
| 105 | |
| 106 | Returns: |
| 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"> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 115 | <code class="details" id="get">get(surveyUrlId)</code> |
| 116 | <pre>Retrieves information about the specified survey. |
| 117 | |
| 118 | Args: |
| 119 | surveyUrlId: string, External URL ID for the survey. (required) |
| 120 | |
| 121 | Returns: |
| 122 | An object of the form: |
| 123 | |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 124 | { |
| 125 | "owners": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 126 | "A String", |
| 127 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 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": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 137 | "A String", |
| 138 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 139 | "populationSource": "A String", |
| 140 | "languages": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 141 | "A String", |
| 142 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 143 | "gender": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 144 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 145 | "cost": { |
| 146 | "nanos": "A String", |
| 147 | "currencyCode": "A String", |
| 148 | "costPerResponseNanos": "A String", |
| 149 | "maxCostPerResponseNanos": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 150 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 151 | "surveyUrlId": "A String", |
| 152 | "questions": [ |
| 153 | { |
| 154 | "highValueLabel": "A String", |
| 155 | "mustPickSuggestion": True or False, |
| 156 | "thresholdAnswers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 157 | "A String", |
| 158 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 159 | "sentimentText": "A String", |
| 160 | "question": "A String", |
| 161 | "numStars": "A String", |
| 162 | "lowValueLabel": "A String", |
| 163 | "videoId": "A String", |
| 164 | "answers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 165 | "A String", |
| 166 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 167 | "lastAnswerPositionPinned": True or False, |
| 168 | "hasOther": True or False, |
| 169 | "unitOfMeasurementLabel": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 170 | "images": [ |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 171 | { |
| 172 | "url": "A String", |
| 173 | "altText": "A String", |
| 174 | "data": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 175 | }, |
| 176 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 177 | "singleLineResponse": True or False, |
| 178 | "openTextSuggestions": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 179 | "A String", |
| 180 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 181 | "type": "A String", |
| 182 | "answerOrder": "A String", |
| 183 | "openTextPlaceholder": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 184 | }, |
| 185 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 186 | "wantedResponseCount": 42, |
| 187 | "rejectionReason": { |
| 188 | "explanation": "A String", |
| 189 | "type": "A String", |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 190 | }, |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 191 | }</pre> |
| 192 | </div> |
| 193 | |
| 194 | <div class="method"> |
| 195 | <code class="details" id="insert">insert(body)</code> |
| 196 | <pre>Creates a survey. |
| 197 | |
| 198 | Args: |
| 199 | body: object, The request body. (required) |
| 200 | The object takes the form of: |
| 201 | |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 202 | { |
| 203 | "owners": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 204 | "A String", |
| 205 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 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": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 215 | "A String", |
| 216 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 217 | "populationSource": "A String", |
| 218 | "languages": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 219 | "A String", |
| 220 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 221 | "gender": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 222 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 223 | "cost": { |
| 224 | "nanos": "A String", |
| 225 | "currencyCode": "A String", |
| 226 | "costPerResponseNanos": "A String", |
| 227 | "maxCostPerResponseNanos": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 228 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 229 | "surveyUrlId": "A String", |
| 230 | "questions": [ |
| 231 | { |
| 232 | "highValueLabel": "A String", |
| 233 | "mustPickSuggestion": True or False, |
| 234 | "thresholdAnswers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 235 | "A String", |
| 236 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 237 | "sentimentText": "A String", |
| 238 | "question": "A String", |
| 239 | "numStars": "A String", |
| 240 | "lowValueLabel": "A String", |
| 241 | "videoId": "A String", |
| 242 | "answers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 243 | "A String", |
| 244 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 245 | "lastAnswerPositionPinned": True or False, |
| 246 | "hasOther": True or False, |
| 247 | "unitOfMeasurementLabel": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 248 | "images": [ |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 249 | { |
| 250 | "url": "A String", |
| 251 | "altText": "A String", |
| 252 | "data": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 253 | }, |
| 254 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 255 | "singleLineResponse": True or False, |
| 256 | "openTextSuggestions": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 257 | "A String", |
| 258 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 259 | "type": "A String", |
| 260 | "answerOrder": "A String", |
| 261 | "openTextPlaceholder": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 262 | }, |
| 263 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 264 | "wantedResponseCount": 42, |
| 265 | "rejectionReason": { |
| 266 | "explanation": "A String", |
| 267 | "type": "A String", |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 268 | }, |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 269 | } |
| 270 | |
| 271 | |
| 272 | Returns: |
| 273 | An object of the form: |
| 274 | |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 275 | { |
| 276 | "owners": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 277 | "A String", |
| 278 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 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": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 288 | "A String", |
| 289 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 290 | "populationSource": "A String", |
| 291 | "languages": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 292 | "A String", |
| 293 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 294 | "gender": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 295 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 296 | "cost": { |
| 297 | "nanos": "A String", |
| 298 | "currencyCode": "A String", |
| 299 | "costPerResponseNanos": "A String", |
| 300 | "maxCostPerResponseNanos": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 301 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 302 | "surveyUrlId": "A String", |
| 303 | "questions": [ |
| 304 | { |
| 305 | "highValueLabel": "A String", |
| 306 | "mustPickSuggestion": True or False, |
| 307 | "thresholdAnswers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 308 | "A String", |
| 309 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 310 | "sentimentText": "A String", |
| 311 | "question": "A String", |
| 312 | "numStars": "A String", |
| 313 | "lowValueLabel": "A String", |
| 314 | "videoId": "A String", |
| 315 | "answers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 316 | "A String", |
| 317 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 318 | "lastAnswerPositionPinned": True or False, |
| 319 | "hasOther": True or False, |
| 320 | "unitOfMeasurementLabel": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 321 | "images": [ |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 322 | { |
| 323 | "url": "A String", |
| 324 | "altText": "A String", |
| 325 | "data": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 326 | }, |
| 327 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 328 | "singleLineResponse": True or False, |
| 329 | "openTextSuggestions": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 330 | "A String", |
| 331 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 332 | "type": "A String", |
| 333 | "answerOrder": "A String", |
| 334 | "openTextPlaceholder": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 335 | }, |
| 336 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 337 | "wantedResponseCount": 42, |
| 338 | "rejectionReason": { |
| 339 | "explanation": "A String", |
| 340 | "type": "A String", |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 341 | }, |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 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 | |
| 349 | Args: |
| 350 | startIndex: integer, A parameter |
| 351 | maxResults: integer, A parameter |
| 352 | token: string, A parameter |
| 353 | |
| 354 | Returns: |
| 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. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 368 | { |
| 369 | "owners": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 370 | "A String", |
| 371 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 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": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 381 | "A String", |
| 382 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 383 | "populationSource": "A String", |
| 384 | "languages": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 385 | "A String", |
| 386 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 387 | "gender": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 388 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 389 | "cost": { |
| 390 | "nanos": "A String", |
| 391 | "currencyCode": "A String", |
| 392 | "costPerResponseNanos": "A String", |
| 393 | "maxCostPerResponseNanos": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 394 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 395 | "surveyUrlId": "A String", |
| 396 | "questions": [ |
| 397 | { |
| 398 | "highValueLabel": "A String", |
| 399 | "mustPickSuggestion": True or False, |
| 400 | "thresholdAnswers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 401 | "A String", |
| 402 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 403 | "sentimentText": "A String", |
| 404 | "question": "A String", |
| 405 | "numStars": "A String", |
| 406 | "lowValueLabel": "A String", |
| 407 | "videoId": "A String", |
| 408 | "answers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 409 | "A String", |
| 410 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 411 | "lastAnswerPositionPinned": True or False, |
| 412 | "hasOther": True or False, |
| 413 | "unitOfMeasurementLabel": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 414 | "images": [ |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 415 | { |
| 416 | "url": "A String", |
| 417 | "altText": "A String", |
| 418 | "data": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 419 | }, |
| 420 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 421 | "singleLineResponse": True or False, |
| 422 | "openTextSuggestions": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 423 | "A String", |
| 424 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 425 | "type": "A String", |
| 426 | "answerOrder": "A String", |
| 427 | "openTextPlaceholder": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 428 | }, |
| 429 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 430 | "wantedResponseCount": 42, |
| 431 | "rejectionReason": { |
| 432 | "explanation": "A String", |
| 433 | "type": "A String", |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 434 | }, |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 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 | |
| 445 | Args: |
| 446 | resourceId: string, A parameter (required) |
| 447 | body: object, The request body. (required) |
| 448 | The object takes the form of: |
| 449 | |
| 450 | { |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 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. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 452 | } |
| 453 | |
| 454 | |
| 455 | Returns: |
| 456 | An object of the form: |
| 457 | |
| 458 | { |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 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 | |
| 467 | Args: |
| 468 | resourceId: string, A parameter (required) |
| 469 | |
| 470 | Returns: |
| 471 | An object of the form: |
| 472 | |
| 473 | { |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 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 | |
| 482 | Args: |
| 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 | |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 487 | { |
| 488 | "owners": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 489 | "A String", |
| 490 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 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": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 500 | "A String", |
| 501 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 502 | "populationSource": "A String", |
| 503 | "languages": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 504 | "A String", |
| 505 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 506 | "gender": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 507 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 508 | "cost": { |
| 509 | "nanos": "A String", |
| 510 | "currencyCode": "A String", |
| 511 | "costPerResponseNanos": "A String", |
| 512 | "maxCostPerResponseNanos": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 513 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 514 | "surveyUrlId": "A String", |
| 515 | "questions": [ |
| 516 | { |
| 517 | "highValueLabel": "A String", |
| 518 | "mustPickSuggestion": True or False, |
| 519 | "thresholdAnswers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 520 | "A String", |
| 521 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 522 | "sentimentText": "A String", |
| 523 | "question": "A String", |
| 524 | "numStars": "A String", |
| 525 | "lowValueLabel": "A String", |
| 526 | "videoId": "A String", |
| 527 | "answers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 528 | "A String", |
| 529 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 530 | "lastAnswerPositionPinned": True or False, |
| 531 | "hasOther": True or False, |
| 532 | "unitOfMeasurementLabel": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 533 | "images": [ |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 534 | { |
| 535 | "url": "A String", |
| 536 | "altText": "A String", |
| 537 | "data": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 538 | }, |
| 539 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 540 | "singleLineResponse": True or False, |
| 541 | "openTextSuggestions": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 542 | "A String", |
| 543 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 544 | "type": "A String", |
| 545 | "answerOrder": "A String", |
| 546 | "openTextPlaceholder": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 547 | }, |
| 548 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 549 | "wantedResponseCount": 42, |
| 550 | "rejectionReason": { |
| 551 | "explanation": "A String", |
| 552 | "type": "A String", |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 553 | }, |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 554 | } |
| 555 | |
| 556 | |
| 557 | Returns: |
| 558 | An object of the form: |
| 559 | |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 560 | { |
| 561 | "owners": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 562 | "A String", |
| 563 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 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": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 573 | "A String", |
| 574 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 575 | "populationSource": "A String", |
| 576 | "languages": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 577 | "A String", |
| 578 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 579 | "gender": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 580 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 581 | "cost": { |
| 582 | "nanos": "A String", |
| 583 | "currencyCode": "A String", |
| 584 | "costPerResponseNanos": "A String", |
| 585 | "maxCostPerResponseNanos": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 586 | }, |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 587 | "surveyUrlId": "A String", |
| 588 | "questions": [ |
| 589 | { |
| 590 | "highValueLabel": "A String", |
| 591 | "mustPickSuggestion": True or False, |
| 592 | "thresholdAnswers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 593 | "A String", |
| 594 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 595 | "sentimentText": "A String", |
| 596 | "question": "A String", |
| 597 | "numStars": "A String", |
| 598 | "lowValueLabel": "A String", |
| 599 | "videoId": "A String", |
| 600 | "answers": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 601 | "A String", |
| 602 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 603 | "lastAnswerPositionPinned": True or False, |
| 604 | "hasOther": True or False, |
| 605 | "unitOfMeasurementLabel": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 606 | "images": [ |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 607 | { |
| 608 | "url": "A String", |
| 609 | "altText": "A String", |
| 610 | "data": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 611 | }, |
| 612 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 613 | "singleLineResponse": True or False, |
| 614 | "openTextSuggestions": [ |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 615 | "A String", |
| 616 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 617 | "type": "A String", |
| 618 | "answerOrder": "A String", |
| 619 | "openTextPlaceholder": "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 620 | }, |
| 621 | ], |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 622 | "wantedResponseCount": 42, |
| 623 | "rejectionReason": { |
| 624 | "explanation": "A String", |
| 625 | "type": "A String", |
Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 626 | }, |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 627 | }</pre> |
| 628 | </div> |
| 629 | |
| 630 | </body></html> |