Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / consumersurveys_v2.surveys.html
blob: a52938052649628bc3b10964abb5d6e35974a9b4 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]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="#get">get(surveyUrlId)</a></code></p>
79<p class="firstline">Retrieves information about the specified survey.</p>
80<p class="toc_element">
81 <code><a href="#insert">insert(body)</a></code></p>
82<p class="firstline">Creates a survey.</p>
83<p class="toc_element">
84 <code><a href="#list">list(startIndex=None, maxResults=None, token=None)</a></code></p>
85<p class="firstline">Lists the surveys owned by the authenticated user.</p>
86<p class="toc_element">
87 <code><a href="#start">start(resourceId, body)</a></code></p>
88<p class="firstline">Begins running a survey.</p>
89<p class="toc_element">
90 <code><a href="#stop">stop(resourceId)</a></code></p>
91<p class="firstline">Stops a running survey.</p>
92<p class="toc_element">
93 <code><a href="#update">update(surveyUrlId, body)</a></code></p>
94<p class="firstline">Updates a survey. Currently the only property that can be updated is the owners property.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="get">get(surveyUrlId)</code>
98 <pre>Retrieves information about the specified survey.
99
100Args:
101 surveyUrlId: string, External URL ID for the survey. (required)
102
103Returns:
104 An object of the form:
105
106 { # Representation of an individual survey object.
107 "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
108 "A String",
109 ],
110 "description": "A String", # Text description of the survey.
111 "title": "A String", # Optional name that will be given to the survey.
112 "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
113 "state": "A String", # State that the survey is in. Can be modified to start, stop, or pause survey.
114 "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
115 "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
116 "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. PopulationSource must be set to ANDROID_APP_PANEL to use this field.
117 "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
118 "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
119 "A String",
120 ],
121 "populationSource": "A String", # Online population source where the respondents are sampled from.
122 "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
123 "A String",
124 ],
125 "gender": "A String", # Optional gender to target.
126 },
127 "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
128 "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
129 "currencyCode": "A String", # Currency code that the cost is given in.
130 "autostartMaxCostPerResponse": "A String", # Threshold to start a survey automically if the quoted prices is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically the API consumer would have to make a followup call to start the survey given the (previously not) known cost. If the survey has no threshold_answers, setting this property will return an error. This property allows API callers to indicate the max price per response they'd be willing to pay in advance of that test. If the price turns out to be lower than the specified autostart_max, the survey should begin immediately and the user will be charged at the rate determined by the Incidence pricing test. If the price turns out to be greater than the specified autostart_max the survey will not be started and the user will instead be notified what price was determined by the incidence test. At that point they must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
131 "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
132 },
133 "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
134 "questions": [ # List of questions defining the survey.
135 { # Message defining the question specifications.
136 "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
137 "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
138 "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
139 "A String",
140 ],
141 "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
142 "question": "A String", # Required question text shown to the respondent.
143 "numStars": "A String", # Number of stars to use for ratings questions.
144 "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
145 "videoId": "A String", # The YouTube video ID to be show in video questions.
146 "answers": [ # Required list of answer options for a question.
147 "A String",
148 ],
149 "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
150 "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
151 "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
152 "images": [
153 { # Container object for image data and alt_text.
154 "url": "A String", # The read-only URL for the hosted images.
155 "altText": "A String", # The alt text property used in image tags is required for all images.
156 "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
157 },
158 ],
159 "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
160 "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
161 "A String",
162 ],
163 "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
164 "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
165 "openTextPlaceholder": "A String", # Placeholder text for an open text question.
166 },
167 ],
168 "wantedResponseCount": 42, # Number of responses desired for the survey.
169 }</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="insert">insert(body)</code>
174 <pre>Creates a survey.
175
176Args:
177 body: object, The request body. (required)
178 The object takes the form of:
179
180{ # Representation of an individual survey object.
181 "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
182 "A String",
183 ],
184 "description": "A String", # Text description of the survey.
185 "title": "A String", # Optional name that will be given to the survey.
186 "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
187 "state": "A String", # State that the survey is in. Can be modified to start, stop, or pause survey.
188 "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
189 "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
190 "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. PopulationSource must be set to ANDROID_APP_PANEL to use this field.
191 "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
192 "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
193 "A String",
194 ],
195 "populationSource": "A String", # Online population source where the respondents are sampled from.
196 "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
197 "A String",
198 ],
199 "gender": "A String", # Optional gender to target.
200 },
201 "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
202 "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
203 "currencyCode": "A String", # Currency code that the cost is given in.
204 "autostartMaxCostPerResponse": "A String", # Threshold to start a survey automically if the quoted prices is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically the API consumer would have to make a followup call to start the survey given the (previously not) known cost. If the survey has no threshold_answers, setting this property will return an error. This property allows API callers to indicate the max price per response they'd be willing to pay in advance of that test. If the price turns out to be lower than the specified autostart_max, the survey should begin immediately and the user will be charged at the rate determined by the Incidence pricing test. If the price turns out to be greater than the specified autostart_max the survey will not be started and the user will instead be notified what price was determined by the incidence test. At that point they must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
205 "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
206 },
207 "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
208 "questions": [ # List of questions defining the survey.
209 { # Message defining the question specifications.
210 "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
211 "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
212 "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
213 "A String",
214 ],
215 "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
216 "question": "A String", # Required question text shown to the respondent.
217 "numStars": "A String", # Number of stars to use for ratings questions.
218 "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
219 "videoId": "A String", # The YouTube video ID to be show in video questions.
220 "answers": [ # Required list of answer options for a question.
221 "A String",
222 ],
223 "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
224 "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
225 "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
226 "images": [
227 { # Container object for image data and alt_text.
228 "url": "A String", # The read-only URL for the hosted images.
229 "altText": "A String", # The alt text property used in image tags is required for all images.
230 "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
231 },
232 ],
233 "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
234 "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
235 "A String",
236 ],
237 "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
238 "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
239 "openTextPlaceholder": "A String", # Placeholder text for an open text question.
240 },
241 ],
242 "wantedResponseCount": 42, # Number of responses desired for the survey.
243 }
244
245
246Returns:
247 An object of the form:
248
249 { # Representation of an individual survey object.
250 "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
251 "A String",
252 ],
253 "description": "A String", # Text description of the survey.
254 "title": "A String", # Optional name that will be given to the survey.
255 "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
256 "state": "A String", # State that the survey is in. Can be modified to start, stop, or pause survey.
257 "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
258 "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
259 "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. PopulationSource must be set to ANDROID_APP_PANEL to use this field.
260 "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
261 "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
262 "A String",
263 ],
264 "populationSource": "A String", # Online population source where the respondents are sampled from.
265 "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
266 "A String",
267 ],
268 "gender": "A String", # Optional gender to target.
269 },
270 "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
271 "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
272 "currencyCode": "A String", # Currency code that the cost is given in.
273 "autostartMaxCostPerResponse": "A String", # Threshold to start a survey automically if the quoted prices is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically the API consumer would have to make a followup call to start the survey given the (previously not) known cost. If the survey has no threshold_answers, setting this property will return an error. This property allows API callers to indicate the max price per response they'd be willing to pay in advance of that test. If the price turns out to be lower than the specified autostart_max, the survey should begin immediately and the user will be charged at the rate determined by the Incidence pricing test. If the price turns out to be greater than the specified autostart_max the survey will not be started and the user will instead be notified what price was determined by the incidence test. At that point they must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
274 "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
275 },
276 "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
277 "questions": [ # List of questions defining the survey.
278 { # Message defining the question specifications.
279 "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
280 "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
281 "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
282 "A String",
283 ],
284 "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
285 "question": "A String", # Required question text shown to the respondent.
286 "numStars": "A String", # Number of stars to use for ratings questions.
287 "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
288 "videoId": "A String", # The YouTube video ID to be show in video questions.
289 "answers": [ # Required list of answer options for a question.
290 "A String",
291 ],
292 "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
293 "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
294 "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
295 "images": [
296 { # Container object for image data and alt_text.
297 "url": "A String", # The read-only URL for the hosted images.
298 "altText": "A String", # The alt text property used in image tags is required for all images.
299 "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
300 },
301 ],
302 "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
303 "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
304 "A String",
305 ],
306 "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
307 "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
308 "openTextPlaceholder": "A String", # Placeholder text for an open text question.
309 },
310 ],
311 "wantedResponseCount": 42, # Number of responses desired for the survey.
312 }</pre>
313</div>
314
315<div class="method">
316 <code class="details" id="list">list(startIndex=None, maxResults=None, token=None)</code>
317 <pre>Lists the surveys owned by the authenticated user.
318
319Args:
320 startIndex: integer, A parameter
321 maxResults: integer, A parameter
322 token: string, A parameter
323
324Returns:
325 An object of the form:
326
327 {
328 "tokenPagination": {
329 "nextPageToken": "A String",
330 "previousPageToken": "A String",
331 },
332 "pageInfo": {
333 "totalResults": 42,
334 "startIndex": 42,
335 "resultPerPage": 42,
336 },
337 "resources": [ # An individual survey resource.
338 { # Representation of an individual survey object.
339 "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
340 "A String",
341 ],
342 "description": "A String", # Text description of the survey.
343 "title": "A String", # Optional name that will be given to the survey.
344 "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
345 "state": "A String", # State that the survey is in. Can be modified to start, stop, or pause survey.
346 "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
347 "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
348 "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. PopulationSource must be set to ANDROID_APP_PANEL to use this field.
349 "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
350 "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
351 "A String",
352 ],
353 "populationSource": "A String", # Online population source where the respondents are sampled from.
354 "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
355 "A String",
356 ],
357 "gender": "A String", # Optional gender to target.
358 },
359 "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
360 "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
361 "currencyCode": "A String", # Currency code that the cost is given in.
362 "autostartMaxCostPerResponse": "A String", # Threshold to start a survey automically if the quoted prices is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically the API consumer would have to make a followup call to start the survey given the (previously not) known cost. If the survey has no threshold_answers, setting this property will return an error. This property allows API callers to indicate the max price per response they'd be willing to pay in advance of that test. If the price turns out to be lower than the specified autostart_max, the survey should begin immediately and the user will be charged at the rate determined by the Incidence pricing test. If the price turns out to be greater than the specified autostart_max the survey will not be started and the user will instead be notified what price was determined by the incidence test. At that point they must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
363 "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
364 },
365 "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
366 "questions": [ # List of questions defining the survey.
367 { # Message defining the question specifications.
368 "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
369 "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
370 "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
371 "A String",
372 ],
373 "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
374 "question": "A String", # Required question text shown to the respondent.
375 "numStars": "A String", # Number of stars to use for ratings questions.
376 "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
377 "videoId": "A String", # The YouTube video ID to be show in video questions.
378 "answers": [ # Required list of answer options for a question.
379 "A String",
380 ],
381 "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
382 "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
383 "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
384 "images": [
385 { # Container object for image data and alt_text.
386 "url": "A String", # The read-only URL for the hosted images.
387 "altText": "A String", # The alt text property used in image tags is required for all images.
388 "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
389 },
390 ],
391 "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
392 "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
393 "A String",
394 ],
395 "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
396 "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
397 "openTextPlaceholder": "A String", # Placeholder text for an open text question.
398 },
399 ],
400 "wantedResponseCount": 42, # Number of responses desired for the survey.
401 },
402 ],
403 "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
404 }</pre>
405</div>
406
407<div class="method">
408 <code class="details" id="start">start(resourceId, body)</code>
409 <pre>Begins running a survey.
410
411Args:
412 resourceId: string, A parameter (required)
413 body: object, The request body. (required)
414 The object takes the form of:
415
416{
417 "autostartMaxCostPerResponse": "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.
418 }
419
420
421Returns:
422 An object of the form:
423
424 {
425 "resource": { # Representation of an individual survey object. # Survey object containing the specification of the started Survey.
426 "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
427 "A String",
428 ],
429 "description": "A String", # Text description of the survey.
430 "title": "A String", # Optional name that will be given to the survey.
431 "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
432 "state": "A String", # State that the survey is in. Can be modified to start, stop, or pause survey.
433 "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
434 "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
435 "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. PopulationSource must be set to ANDROID_APP_PANEL to use this field.
436 "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
437 "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
438 "A String",
439 ],
440 "populationSource": "A String", # Online population source where the respondents are sampled from.
441 "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
442 "A String",
443 ],
444 "gender": "A String", # Optional gender to target.
445 },
446 "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
447 "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
448 "currencyCode": "A String", # Currency code that the cost is given in.
449 "autostartMaxCostPerResponse": "A String", # Threshold to start a survey automically if the quoted prices is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically the API consumer would have to make a followup call to start the survey given the (previously not) known cost. If the survey has no threshold_answers, setting this property will return an error. This property allows API callers to indicate the max price per response they'd be willing to pay in advance of that test. If the price turns out to be lower than the specified autostart_max, the survey should begin immediately and the user will be charged at the rate determined by the Incidence pricing test. If the price turns out to be greater than the specified autostart_max the survey will not be started and the user will instead be notified what price was determined by the incidence test. At that point they must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
450 "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
451 },
452 "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
453 "questions": [ # List of questions defining the survey.
454 { # Message defining the question specifications.
455 "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
456 "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
457 "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
458 "A String",
459 ],
460 "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
461 "question": "A String", # Required question text shown to the respondent.
462 "numStars": "A String", # Number of stars to use for ratings questions.
463 "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
464 "videoId": "A String", # The YouTube video ID to be show in video questions.
465 "answers": [ # Required list of answer options for a question.
466 "A String",
467 ],
468 "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
469 "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
470 "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
471 "images": [
472 { # Container object for image data and alt_text.
473 "url": "A String", # The read-only URL for the hosted images.
474 "altText": "A String", # The alt text property used in image tags is required for all images.
475 "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
476 },
477 ],
478 "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
479 "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
480 "A String",
481 ],
482 "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
483 "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
484 "openTextPlaceholder": "A String", # Placeholder text for an open text question.
485 },
486 ],
487 "wantedResponseCount": 42, # Number of responses desired for the survey.
488 },
489 "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
490 }</pre>
491</div>
492
493<div class="method">
494 <code class="details" id="stop">stop(resourceId)</code>
495 <pre>Stops a running survey.
496
497Args:
498 resourceId: string, A parameter (required)
499
500Returns:
501 An object of the form:
502
503 {
504 "resource": { # Representation of an individual survey object. # Survey object containing the specification of the stopped Survey.
505 "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
506 "A String",
507 ],
508 "description": "A String", # Text description of the survey.
509 "title": "A String", # Optional name that will be given to the survey.
510 "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
511 "state": "A String", # State that the survey is in. Can be modified to start, stop, or pause survey.
512 "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
513 "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
514 "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. PopulationSource must be set to ANDROID_APP_PANEL to use this field.
515 "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
516 "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
517 "A String",
518 ],
519 "populationSource": "A String", # Online population source where the respondents are sampled from.
520 "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
521 "A String",
522 ],
523 "gender": "A String", # Optional gender to target.
524 },
525 "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
526 "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
527 "currencyCode": "A String", # Currency code that the cost is given in.
528 "autostartMaxCostPerResponse": "A String", # Threshold to start a survey automically if the quoted prices is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically the API consumer would have to make a followup call to start the survey given the (previously not) known cost. If the survey has no threshold_answers, setting this property will return an error. This property allows API callers to indicate the max price per response they'd be willing to pay in advance of that test. If the price turns out to be lower than the specified autostart_max, the survey should begin immediately and the user will be charged at the rate determined by the Incidence pricing test. If the price turns out to be greater than the specified autostart_max the survey will not be started and the user will instead be notified what price was determined by the incidence test. At that point they must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
529 "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
530 },
531 "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
532 "questions": [ # List of questions defining the survey.
533 { # Message defining the question specifications.
534 "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
535 "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
536 "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
537 "A String",
538 ],
539 "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
540 "question": "A String", # Required question text shown to the respondent.
541 "numStars": "A String", # Number of stars to use for ratings questions.
542 "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
543 "videoId": "A String", # The YouTube video ID to be show in video questions.
544 "answers": [ # Required list of answer options for a question.
545 "A String",
546 ],
547 "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
548 "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
549 "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
550 "images": [
551 { # Container object for image data and alt_text.
552 "url": "A String", # The read-only URL for the hosted images.
553 "altText": "A String", # The alt text property used in image tags is required for all images.
554 "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
555 },
556 ],
557 "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
558 "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
559 "A String",
560 ],
561 "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
562 "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
563 "openTextPlaceholder": "A String", # Placeholder text for an open text question.
564 },
565 ],
566 "wantedResponseCount": 42, # Number of responses desired for the survey.
567 },
568 "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
569 }</pre>
570</div>
571
572<div class="method">
573 <code class="details" id="update">update(surveyUrlId, body)</code>
574 <pre>Updates a survey. Currently the only property that can be updated is the owners property.
575
576Args:
577 surveyUrlId: string, External URL ID for the survey. (required)
578 body: object, The request body. (required)
579 The object takes the form of:
580
581{ # Representation of an individual survey object.
582 "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
583 "A String",
584 ],
585 "description": "A String", # Text description of the survey.
586 "title": "A String", # Optional name that will be given to the survey.
587 "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
588 "state": "A String", # State that the survey is in. Can be modified to start, stop, or pause survey.
589 "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
590 "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
591 "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. PopulationSource must be set to ANDROID_APP_PANEL to use this field.
592 "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
593 "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
594 "A String",
595 ],
596 "populationSource": "A String", # Online population source where the respondents are sampled from.
597 "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
598 "A String",
599 ],
600 "gender": "A String", # Optional gender to target.
601 },
602 "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
603 "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
604 "currencyCode": "A String", # Currency code that the cost is given in.
605 "autostartMaxCostPerResponse": "A String", # Threshold to start a survey automically if the quoted prices is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically the API consumer would have to make a followup call to start the survey given the (previously not) known cost. If the survey has no threshold_answers, setting this property will return an error. This property allows API callers to indicate the max price per response they'd be willing to pay in advance of that test. If the price turns out to be lower than the specified autostart_max, the survey should begin immediately and the user will be charged at the rate determined by the Incidence pricing test. If the price turns out to be greater than the specified autostart_max the survey will not be started and the user will instead be notified what price was determined by the incidence test. At that point they must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
606 "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
607 },
608 "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
609 "questions": [ # List of questions defining the survey.
610 { # Message defining the question specifications.
611 "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
612 "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
613 "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
614 "A String",
615 ],
616 "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
617 "question": "A String", # Required question text shown to the respondent.
618 "numStars": "A String", # Number of stars to use for ratings questions.
619 "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
620 "videoId": "A String", # The YouTube video ID to be show in video questions.
621 "answers": [ # Required list of answer options for a question.
622 "A String",
623 ],
624 "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
625 "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
626 "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
627 "images": [
628 { # Container object for image data and alt_text.
629 "url": "A String", # The read-only URL for the hosted images.
630 "altText": "A String", # The alt text property used in image tags is required for all images.
631 "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
632 },
633 ],
634 "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
635 "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
636 "A String",
637 ],
638 "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
639 "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
640 "openTextPlaceholder": "A String", # Placeholder text for an open text question.
641 },
642 ],
643 "wantedResponseCount": 42, # Number of responses desired for the survey.
644 }
645
646
647Returns:
648 An object of the form:
649
650 { # Representation of an individual survey object.
651 "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
652 "A String",
653 ],
654 "description": "A String", # Text description of the survey.
655 "title": "A String", # Optional name that will be given to the survey.
656 "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
657 "state": "A String", # State that the survey is in. Can be modified to start, stop, or pause survey.
658 "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
659 "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
660 "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. PopulationSource must be set to ANDROID_APP_PANEL to use this field.
661 "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
662 "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
663 "A String",
664 ],
665 "populationSource": "A String", # Online population source where the respondents are sampled from.
666 "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
667 "A String",
668 ],
669 "gender": "A String", # Optional gender to target.
670 },
671 "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
672 "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
673 "currencyCode": "A String", # Currency code that the cost is given in.
674 "autostartMaxCostPerResponse": "A String", # Threshold to start a survey automically if the quoted prices is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically the API consumer would have to make a followup call to start the survey given the (previously not) known cost. If the survey has no threshold_answers, setting this property will return an error. This property allows API callers to indicate the max price per response they'd be willing to pay in advance of that test. If the price turns out to be lower than the specified autostart_max, the survey should begin immediately and the user will be charged at the rate determined by the Incidence pricing test. If the price turns out to be greater than the specified autostart_max the survey will not be started and the user will instead be notified what price was determined by the incidence test. At that point they must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
675 "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
676 },
677 "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
678 "questions": [ # List of questions defining the survey.
679 { # Message defining the question specifications.
680 "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
681 "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
682 "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
683 "A String",
684 ],
685 "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
686 "question": "A String", # Required question text shown to the respondent.
687 "numStars": "A String", # Number of stars to use for ratings questions.
688 "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
689 "videoId": "A String", # The YouTube video ID to be show in video questions.
690 "answers": [ # Required list of answer options for a question.
691 "A String",
692 ],
693 "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
694 "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
695 "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
696 "images": [
697 { # Container object for image data and alt_text.
698 "url": "A String", # The read-only URL for the hosted images.
699 "altText": "A String", # The alt text property used in image tags is required for all images.
700 "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
701 },
702 ],
703 "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
704 "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
705 "A String",
706 ],
707 "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
708 "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
709 "openTextPlaceholder": "A String", # Placeholder text for an open text question.
710 },
711 ],
712 "wantedResponseCount": 42, # Number of responses desired for the survey.
713 }</pre>
714</div>
715
716</body></html>