OLD | NEW |
1 // This is a generated file (see the discoveryapis_generator project). | 1 // This is a generated file (see the discoveryapis_generator project). |
2 | 2 |
3 library googleapis.consumersurveys.v2; | 3 library googleapis.surveys.v2; |
4 | 4 |
5 import 'dart:core' as core; | 5 import 'dart:core' as core; |
6 import 'dart:async' as async; | 6 import 'dart:async' as async; |
7 import 'dart:convert' as convert; | 7 import 'dart:convert' as convert; |
8 | 8 |
9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; | 9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
10 import 'package:http/http.dart' as http; | 10 import 'package:http/http.dart' as http; |
11 | 11 |
12 export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show | 12 export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show |
13 ApiRequestError, DetailedApiRequestError, Media, UploadOptions, | 13 ApiRequestError, DetailedApiRequestError, Media, UploadOptions, |
14 ResumableUploadOptions, DownloadOptions, PartialDownloadOptions, | 14 ResumableUploadOptions, DownloadOptions, PartialDownloadOptions, |
15 ByteRange; | 15 ByteRange; |
16 | 16 |
17 const core.String USER_AGENT = 'dart-api-client consumersurveys/v2'; | 17 const core.String USER_AGENT = 'dart-api-client surveys/v2'; |
18 | 18 |
19 /** | 19 /** |
20 * Creates and conducts surveys, lists the surveys that an authenticated user | 20 * Creates and conducts surveys, lists the surveys that an authenticated user |
21 * owns, and retrieves survey results and information about specified surveys. | 21 * owns, and retrieves survey results and information about specified surveys. |
22 */ | 22 */ |
23 class ConsumersurveysApi { | 23 class SurveysApi { |
24 /** View and edit your surveys and results */ | 24 /** View and manage your surveys and results */ |
25 static const ConsumersurveysScope = "https://www.googleapis.com/auth/consumers
urveys"; | 25 static const SurveysScope = "https://www.googleapis.com/auth/surveys"; |
26 | 26 |
27 /** View the results for your surveys */ | 27 /** View your surveys and survey results */ |
28 static const ConsumersurveysReadonlyScope = "https://www.googleapis.com/auth/c
onsumersurveys.readonly"; | 28 static const SurveysReadonlyScope = "https://www.googleapis.com/auth/surveys.r
eadonly"; |
29 | 29 |
30 /** View your email address */ | 30 /** View your email address */ |
31 static const UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.em
ail"; | 31 static const UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.em
ail"; |
32 | 32 |
33 | 33 |
34 final commons.ApiRequester _requester; | 34 final commons.ApiRequester _requester; |
35 | 35 |
36 MobileapppanelsResourceApi get mobileapppanels => new MobileapppanelsResourceA
pi(_requester); | 36 MobileapppanelsResourceApi get mobileapppanels => new MobileapppanelsResourceA
pi(_requester); |
37 ResultsResourceApi get results => new ResultsResourceApi(_requester); | 37 ResultsResourceApi get results => new ResultsResourceApi(_requester); |
38 SurveysResourceApi get surveys => new SurveysResourceApi(_requester); | 38 SurveysResourceApi get surveys => new SurveysResourceApi(_requester); |
39 | 39 |
40 ConsumersurveysApi(http.Client client, {core.String rootUrl: "https://www.goog
leapis.com/", core.String servicePath: "consumersurveys/v2/"}) : | 40 SurveysApi(http.Client client, {core.String rootUrl: "https://www.googleapis.c
om/", core.String servicePath: "surveys/v2/"}) : |
41 _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_A
GENT); | 41 _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_A
GENT); |
42 } | 42 } |
43 | 43 |
44 | 44 |
45 class MobileapppanelsResourceApi { | 45 class MobileapppanelsResourceApi { |
46 final commons.ApiRequester _requester; | 46 final commons.ApiRequester _requester; |
47 | 47 |
48 MobileapppanelsResourceApi(commons.ApiRequester client) : | 48 MobileapppanelsResourceApi(commons.ApiRequester client) : |
49 _requester = client; | 49 _requester = client; |
50 | 50 |
(...skipping 134 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
185 | 185 |
186 | 186 |
187 class ResultsResourceApi { | 187 class ResultsResourceApi { |
188 final commons.ApiRequester _requester; | 188 final commons.ApiRequester _requester; |
189 | 189 |
190 ResultsResourceApi(commons.ApiRequester client) : | 190 ResultsResourceApi(commons.ApiRequester client) : |
191 _requester = client; | 191 _requester = client; |
192 | 192 |
193 /** | 193 /** |
194 * Retrieves any survey results that have been produced so far. Results are | 194 * Retrieves any survey results that have been produced so far. Results are |
195 * formatted as an Excel file. | 195 * formatted as an Excel file. You must add "?alt=media" to the URL as an |
| 196 * argument to get results. |
196 * | 197 * |
197 * [request] - The metadata request object. | 198 * [request] - The metadata request object. |
198 * | 199 * |
199 * Request parameters: | 200 * Request parameters: |
200 * | 201 * |
201 * [surveyUrlId] - External URL ID for the survey. | 202 * [surveyUrlId] - External URL ID for the survey. |
202 * | 203 * |
203 * [downloadOptions] - Options for downloading. A download can be either a | 204 * [downloadOptions] - Options for downloading. A download can be either a |
204 * Metadata (default) or Media download. Partial Media downloads are possible | 205 * Metadata (default) or Media download. Partial Media downloads are possible |
205 * as well. | 206 * as well. |
(...skipping 607 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
813 } | 814 } |
814 /** Text description of the survey. */ | 815 /** Text description of the survey. */ |
815 core.String description; | 816 core.String description; |
816 /** | 817 /** |
817 * List of email addresses for survey owners. Must contain at least the | 818 * List of email addresses for survey owners. Must contain at least the |
818 * address of the user making the API call. | 819 * address of the user making the API call. |
819 */ | 820 */ |
820 core.List<core.String> owners; | 821 core.List<core.String> owners; |
821 /** List of questions defining the survey. */ | 822 /** List of questions defining the survey. */ |
822 core.List<SurveyQuestion> questions; | 823 core.List<SurveyQuestion> questions; |
| 824 /** |
| 825 * Reason for the survey being rejected. Only present if the survey state is |
| 826 * rejected. |
| 827 */ |
| 828 SurveyRejection rejectionReason; |
823 /** State that the survey is in. */ | 829 /** State that the survey is in. */ |
824 core.String state; | 830 core.String state; |
825 /** Unique survey ID, that is viewable in the URL of the Survey Creator UI */ | 831 /** Unique survey ID, that is viewable in the URL of the Survey Creator UI */ |
826 core.String surveyUrlId; | 832 core.String surveyUrlId; |
827 /** Optional name that will be given to the survey. */ | 833 /** Optional name that will be given to the survey. */ |
828 core.String title; | 834 core.String title; |
829 /** Number of responses desired for the survey. */ | 835 /** Number of responses desired for the survey. */ |
830 core.int wantedResponseCount; | 836 core.int wantedResponseCount; |
831 | 837 |
832 Survey(); | 838 Survey(); |
(...skipping 10 matching lines...) Expand all Loading... |
843 } | 849 } |
844 if (_json.containsKey("description")) { | 850 if (_json.containsKey("description")) { |
845 description = _json["description"]; | 851 description = _json["description"]; |
846 } | 852 } |
847 if (_json.containsKey("owners")) { | 853 if (_json.containsKey("owners")) { |
848 owners = _json["owners"]; | 854 owners = _json["owners"]; |
849 } | 855 } |
850 if (_json.containsKey("questions")) { | 856 if (_json.containsKey("questions")) { |
851 questions = _json["questions"].map((value) => new SurveyQuestion.fromJson(
value)).toList(); | 857 questions = _json["questions"].map((value) => new SurveyQuestion.fromJson(
value)).toList(); |
852 } | 858 } |
| 859 if (_json.containsKey("rejectionReason")) { |
| 860 rejectionReason = new SurveyRejection.fromJson(_json["rejectionReason"]); |
| 861 } |
853 if (_json.containsKey("state")) { | 862 if (_json.containsKey("state")) { |
854 state = _json["state"]; | 863 state = _json["state"]; |
855 } | 864 } |
856 if (_json.containsKey("surveyUrlId")) { | 865 if (_json.containsKey("surveyUrlId")) { |
857 surveyUrlId = _json["surveyUrlId"]; | 866 surveyUrlId = _json["surveyUrlId"]; |
858 } | 867 } |
859 if (_json.containsKey("title")) { | 868 if (_json.containsKey("title")) { |
860 title = _json["title"]; | 869 title = _json["title"]; |
861 } | 870 } |
862 if (_json.containsKey("wantedResponseCount")) { | 871 if (_json.containsKey("wantedResponseCount")) { |
(...skipping 14 matching lines...) Expand all Loading... |
877 } | 886 } |
878 if (description != null) { | 887 if (description != null) { |
879 _json["description"] = description; | 888 _json["description"] = description; |
880 } | 889 } |
881 if (owners != null) { | 890 if (owners != null) { |
882 _json["owners"] = owners; | 891 _json["owners"] = owners; |
883 } | 892 } |
884 if (questions != null) { | 893 if (questions != null) { |
885 _json["questions"] = questions.map((value) => (value).toJson()).toList(); | 894 _json["questions"] = questions.map((value) => (value).toJson()).toList(); |
886 } | 895 } |
| 896 if (rejectionReason != null) { |
| 897 _json["rejectionReason"] = (rejectionReason).toJson(); |
| 898 } |
887 if (state != null) { | 899 if (state != null) { |
888 _json["state"] = state; | 900 _json["state"] = state; |
889 } | 901 } |
890 if (surveyUrlId != null) { | 902 if (surveyUrlId != null) { |
891 _json["surveyUrlId"] = surveyUrlId; | 903 _json["surveyUrlId"] = surveyUrlId; |
892 } | 904 } |
893 if (title != null) { | 905 if (title != null) { |
894 _json["title"] = title; | 906 _json["title"] = title; |
895 } | 907 } |
896 if (wantedResponseCount != null) { | 908 if (wantedResponseCount != null) { |
(...skipping 403 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1300 if (data != null) { | 1312 if (data != null) { |
1301 _json["data"] = data; | 1313 _json["data"] = data; |
1302 } | 1314 } |
1303 if (url != null) { | 1315 if (url != null) { |
1304 _json["url"] = url; | 1316 _json["url"] = url; |
1305 } | 1317 } |
1306 return _json; | 1318 return _json; |
1307 } | 1319 } |
1308 } | 1320 } |
1309 | 1321 |
| 1322 /** Message representing why the survey was rejected from review, if it was. */ |
| 1323 class SurveyRejection { |
| 1324 /** A human-readable explanation of what was wrong with the survey. */ |
| 1325 core.String explanation; |
| 1326 /** |
| 1327 * Which category of rejection this was. See the Google Surveys Help Center |
| 1328 * for additional details on each category. |
| 1329 */ |
| 1330 core.String type; |
| 1331 |
| 1332 SurveyRejection(); |
| 1333 |
| 1334 SurveyRejection.fromJson(core.Map _json) { |
| 1335 if (_json.containsKey("explanation")) { |
| 1336 explanation = _json["explanation"]; |
| 1337 } |
| 1338 if (_json.containsKey("type")) { |
| 1339 type = _json["type"]; |
| 1340 } |
| 1341 } |
| 1342 |
| 1343 core.Map toJson() { |
| 1344 var _json = new core.Map(); |
| 1345 if (explanation != null) { |
| 1346 _json["explanation"] = explanation; |
| 1347 } |
| 1348 if (type != null) { |
| 1349 _json["type"] = type; |
| 1350 } |
| 1351 return _json; |
| 1352 } |
| 1353 } |
| 1354 |
1310 /** Reference to the current results for a given survey. */ | 1355 /** Reference to the current results for a given survey. */ |
1311 class SurveyResults { | 1356 class SurveyResults { |
1312 /** Human readable string describing the status of the request. */ | 1357 /** Human readable string describing the status of the request. */ |
1313 core.String status; | 1358 core.String status; |
1314 /** External survey ID as viewable by survey owners in the editor view. */ | 1359 /** External survey ID as viewable by survey owners in the editor view. */ |
1315 core.String surveyUrlId; | 1360 core.String surveyUrlId; |
1316 | 1361 |
1317 SurveyResults(); | 1362 SurveyResults(); |
1318 | 1363 |
1319 SurveyResults.fromJson(core.Map _json) { | 1364 SurveyResults.fromJson(core.Map _json) { |
(...skipping 194 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1514 var _json = new core.Map(); | 1559 var _json = new core.Map(); |
1515 if (nextPageToken != null) { | 1560 if (nextPageToken != null) { |
1516 _json["nextPageToken"] = nextPageToken; | 1561 _json["nextPageToken"] = nextPageToken; |
1517 } | 1562 } |
1518 if (previousPageToken != null) { | 1563 if (previousPageToken != null) { |
1519 _json["previousPageToken"] = previousPageToken; | 1564 _json["previousPageToken"] = previousPageToken; |
1520 } | 1565 } |
1521 return _json; | 1566 return _json; |
1522 } | 1567 } |
1523 } | 1568 } |
OLD | NEW |