Api-roll 42: 2016-11-08

generated/googleapis/lib/consumersurveys/v2.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.consumersurveys.v2;
 
 import 'dart:core' as core;
 import 'dart:async' as async;
 import 'dart:convert' as convert;
 
 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
 import 'package:http/http.dart' as http;
@@ skipping 174 matching lines @@
 
 
 class ResultsResourceApi {
   final commons.ApiRequester _requester;
 
   ResultsResourceApi(commons.ApiRequester client) : 
       _requester = client;
 
   /**
    * Retrieves any survey results that have been produced so far. Results are
-   * formatted as an Excel file.
+   * formatted as an Excel file. You must add "?alt=media" to the URL as an
+   * argument to get results.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [surveyUrlId] - External URL ID for the survey.
    *
    * [downloadOptions] - Options for downloading. A download can be either a
    * Metadata (default) or Media download. Partial Media downloads are possible
    * as well.
@@ skipping 371 matching lines @@
     if (fields != null) {
       _json["fields"] = fields.map((value) => (value).toJson()).toList();
     }
     if (id != null) {
       _json["id"] = id;
     }
     return _json;
   }
 }
 
-/**
- * Representation of an individual pre-defined panel object defining a targeted
- * audience of opinion rewards mobile app users.
- */
 class MobileAppPanel {
-  /**
-   * Country code for the country of the users that the panel contains. Uses
-   * standard ISO 3166-1 2-character language codes. For instance, 'US' for the
-   * United States, and 'GB' for the United Kingdom. Any survey created
-   * targeting this panel must also target the corresponding country.
-   */
   core.String country;
-  /** Whether or not the panel is accessible to all API users. */
   core.bool isPublicPanel;
-  /**
-   * Language code that the panel can target. For instance, 'en-US'. Uses
-   * standard BCP47 language codes. See specification. Any survey created
-   * targeting this panel must also target the corresponding language.
-   */
   core.String language;
-  /**
-   * Unique panel ID string. This corresponds to the mobile_app_panel_id used in
-   * Survey Insert requests.
-   */
   core.String mobileAppPanelId;
-  /** Human readable name of the audience panel. */
   core.String name;
-  /**
-   * List of email addresses for users who can target members of this panel.
-   * Must contain at least the address of the user making the API call for
-   * panels that are not public. This field will be empty for public panels.
-   */
   core.List<core.String> owners;
 
   MobileAppPanel();
 
   MobileAppPanel.fromJson(core.Map _json) {
     if (_json.containsKey("country")) {
       country = _json["country"];
     }
     if (_json.containsKey("isPublicPanel")) {
       isPublicPanel = _json["isPublicPanel"];
@@ skipping 156 matching lines @@
     if (fields != null) {
       _json["fields"] = fields.map((value) => (value).toJson()).toList();
     }
     if (projection != null) {
       _json["projection"] = projection;
     }
     return _json;
   }
 }
 
-/** Representation of an individual survey object. */
 class Survey {
-  /** Targeting-criteria message containing demographic information */
   SurveyAudience audience;
-  /** Cost to run the survey and collect the necessary number of responses. */
   SurveyCost cost;
-  /**
-   * 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.
-   */
   core.String customerData;
   core.List<core.int> get customerDataAsBytes {
     return convert.BASE64.decode(customerData);
   }
 
   void set customerDataAsBytes(core.List<core.int> _bytes) {
     customerData = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
   }
-  /** Text description of the survey. */
   core.String description;
-  /**
-   * List of email addresses for survey owners. Must contain at least the
-   * address of the user making the API call.
-   */
   core.List<core.String> owners;
-  /** List of questions defining the survey. */
   core.List<SurveyQuestion> questions;
-  /** State that the survey is in. */
+  SurveyRejection rejectionReason;
   core.String state;
-  /** Unique survey ID, that is viewable in the URL of the Survey Creator UI */
   core.String surveyUrlId;
-  /** Optional name that will be given to the survey. */
   core.String title;
-  /** Number of responses desired for the survey. */
   core.int wantedResponseCount;
 
   Survey();
 
   Survey.fromJson(core.Map _json) {
     if (_json.containsKey("audience")) {
       audience = new SurveyAudience.fromJson(_json["audience"]);
     }
     if (_json.containsKey("cost")) {
       cost = new SurveyCost.fromJson(_json["cost"]);
     }
     if (_json.containsKey("customerData")) {
       customerData = _json["customerData"];
     }
     if (_json.containsKey("description")) {
       description = _json["description"];
     }
     if (_json.containsKey("owners")) {
       owners = _json["owners"];
     }
     if (_json.containsKey("questions")) {
       questions = _json["questions"].map((value) => new SurveyQuestion.fromJson(value)).toList();
     }
+    if (_json.containsKey("rejectionReason")) {
+      rejectionReason = new SurveyRejection.fromJson(_json["rejectionReason"]);
+    }
     if (_json.containsKey("state")) {
       state = _json["state"];
     }
     if (_json.containsKey("surveyUrlId")) {
       surveyUrlId = _json["surveyUrlId"];
     }
     if (_json.containsKey("title")) {
       title = _json["title"];
     }
     if (_json.containsKey("wantedResponseCount")) {
@@ skipping 14 matching lines @@
     }
     if (description != null) {
       _json["description"] = description;
     }
     if (owners != null) {
       _json["owners"] = owners;
     }
     if (questions != null) {
       _json["questions"] = questions.map((value) => (value).toJson()).toList();
     }
+    if (rejectionReason != null) {
+      _json["rejectionReason"] = (rejectionReason).toJson();
+    }
     if (state != null) {
       _json["state"] = state;
     }
     if (surveyUrlId != null) {
       _json["surveyUrlId"] = surveyUrlId;
     }
     if (title != null) {
       _json["title"] = title;
     }
     if (wantedResponseCount != null) {
       _json["wantedResponseCount"] = wantedResponseCount;
     }
     return _json;
   }
 }
 
-/** Specifications for the target audience of a survey run through the API. */
 class SurveyAudience {
-  /**
-   * Optional list of age buckets to target. Supported age buckets are:
-   * ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
-   */
   core.List<core.String> ages;
-  /**
-   * 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.
-   */
   core.String country;
-  /**
-   * 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).
-   */
   core.String countrySubdivision;
-  /** Optional gender to target. */
   core.String gender;
-  /**
-   * 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.
-   */
   core.List<core.String> languages;
-  /**
-   * Key for predefined panel that causes survey to be sent to a predefined set
-   * of Opinion Rewards App users. You must set PopulationSource to
-   * ANDROID_APP_PANEL to use this field.
-   */
   core.String mobileAppPanelId;
-  /** Online population source where the respondents are sampled from. */
   core.String populationSource;
 
   SurveyAudience();
 
   SurveyAudience.fromJson(core.Map _json) {
     if (_json.containsKey("ages")) {
       ages = _json["ages"];
     }
     if (_json.containsKey("country")) {
       country = _json["country"];
@@ skipping 35 matching lines @@
     if (mobileAppPanelId != null) {
       _json["mobileAppPanelId"] = mobileAppPanelId;
     }
     if (populationSource != null) {
       _json["populationSource"] = populationSource;
     }
     return _json;
   }
 }
 
-/** Message defining the cost to run a given survey through API. */
 class SurveyCost {
-  /**
-   * 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.
-   */
   core.String costPerResponseNanos;
-  /** Currency code that the cost is given in. */
   core.String currencyCode;
-  /**
-   * Threshold to start a survey automatically if the quoted price 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 you will have to make a followup call to start the survey giving
-   * the final computed cost per response. If the survey has no
-   * threshold_answers, setting this property will return an error. By
-   * specifying this property, you indicate the max price per response you are
-   * willing to pay in advance of the incidence test. If the price turns out to
-   * be lower than the specified value, the survey will begin immediately and
-   * you will be charged at the rate determined by the incidence pricing test.
-   * If the price turns out to be greater than the specified value the survey
-   * will not be started and you will instead be notified what price was
-   * determined by the incidence test. At that point, you 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.
-   */
   core.String maxCostPerResponseNanos;
-  /**
-   * Cost of survey in nano units of the given currency. DEPRECATED in favor of
-   * cost_per_response_nanos
-   */
   core.String nanos;
 
   SurveyCost();
 
   SurveyCost.fromJson(core.Map _json) {
     if (_json.containsKey("costPerResponseNanos")) {
       costPerResponseNanos = _json["costPerResponseNanos"];
     }
     if (_json.containsKey("currencyCode")) {
       currencyCode = _json["currencyCode"];
@@ skipping 17 matching lines @@
     if (maxCostPerResponseNanos != null) {
       _json["maxCostPerResponseNanos"] = maxCostPerResponseNanos;
     }
     if (nanos != null) {
       _json["nanos"] = nanos;
     }
     return _json;
   }
 }
 
-/** Message defining the question specifications. */
 class SurveyQuestion {
-  /**
-   * The randomization option for multiple choice and multi-select questions. If
-   * not specified, this option defaults to randomize.
-   */
   core.String answerOrder;
-  /** Required list of answer options for a question. */
   core.List<core.String> answers;
-  /**
-   * 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.
-   */
   core.bool hasOther;
-  /**
-   * 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.
-   */
   core.String highValueLabel;
   core.List<SurveyQuestionImage> images;
-  /** Currently only support pinning an answer option to the last position. */
   core.bool lastAnswerPositionPinned;
-  /**
-   * 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.
-   */
   core.String lowValueLabel;
-  /**
-   * Option to force the user to pick one of the open text suggestions. This
-   * requires that suggestions are provided for this question.
-   */
   core.bool mustPickSuggestion;
-  /** Number of stars to use for ratings questions. */
   core.String numStars;
-  /** Placeholder text for an open text question. */
   core.String openTextPlaceholder;
-  /**
-   * A list of suggested answers for open text question auto-complete. This is
-   * only valid if single_line_response is true.
-   */
   core.List<core.String> openTextSuggestions;
-  /** Required question text shown to the respondent. */
   core.String question;
-  /**
-   * 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.
-   */
   core.String sentimentText;
-  /**
-   * 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.
-   */
   core.bool singleLineResponse;
-  /**
-   * 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.
-   */
   core.List<core.String> thresholdAnswers;
-  /**
-   * Required field defining the question type. For details about configuring
-   * different type of questions, consult the question configuration guide.
-   */
   core.String type;
-  /**
-   * Optional unit of measurement for display (for example: hours, people,
-   * miles).
-   */
   core.String unitOfMeasurementLabel;
-  /** The YouTube video ID to be show in video questions. */
   core.String videoId;
 
   SurveyQuestion();
 
   SurveyQuestion.fromJson(core.Map _json) {
     if (_json.containsKey("answerOrder")) {
       answerOrder = _json["answerOrder"];
     }
     if (_json.containsKey("answers")) {
       answers = _json["answers"];
@@ skipping 101 matching lines @@
     if (unitOfMeasurementLabel != null) {
       _json["unitOfMeasurementLabel"] = unitOfMeasurementLabel;
     }
     if (videoId != null) {
       _json["videoId"] = videoId;
     }
     return _json;
   }
 }
 
-/** Container object for image data and alt_text. */
 class SurveyQuestionImage {
-  /** The alt text property used in image tags is required for all images. */
   core.String altText;
-  /**
-   * Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question
-   * types.
-   */
   core.String data;
   core.List<core.int> get dataAsBytes {
     return convert.BASE64.decode(data);
   }
 
   void set dataAsBytes(core.List<core.int> _bytes) {
     data = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
   }
-  /** The read-only URL for the hosted images. */
   core.String url;
 
   SurveyQuestionImage();
 
   SurveyQuestionImage.fromJson(core.Map _json) {
     if (_json.containsKey("altText")) {
       altText = _json["altText"];
     }
     if (_json.containsKey("data")) {
       data = _json["data"];
@@ skipping 11 matching lines @@
     if (data != null) {
       _json["data"] = data;
     }
     if (url != null) {
       _json["url"] = url;
     }
     return _json;
   }
 }
 
-/** Reference to the current results for a given survey. */
+class SurveyRejection {
+  core.String explanation;
+  core.String type;
+
+  SurveyRejection();
+
+  SurveyRejection.fromJson(core.Map _json) {
+    if (_json.containsKey("explanation")) {
+      explanation = _json["explanation"];
+    }
+    if (_json.containsKey("type")) {
+      type = _json["type"];
+    }
+  }
+
+  core.Map toJson() {
+    var _json = new core.Map();
+    if (explanation != null) {
+      _json["explanation"] = explanation;
+    }
+    if (type != null) {
+      _json["type"] = type;
+    }
+    return _json;
+  }
+}
+
 class SurveyResults {
-  /** Human readable string describing the status of the request. */
   core.String status;
-  /** External survey ID as viewable by survey owners in the editor view. */
   core.String surveyUrlId;
 
   SurveyResults();
 
   SurveyResults.fromJson(core.Map _json) {
     if (_json.containsKey("status")) {
       status = _json["status"];
     }
     if (_json.containsKey("surveyUrlId")) {
       surveyUrlId = _json["surveyUrlId"];
@@ skipping 189 matching lines @@
     var _json = new core.Map();
     if (nextPageToken != null) {
       _json["nextPageToken"] = nextPageToken;
     }
     if (previousPageToken != null) {
       _json["previousPageToken"] = previousPageToken;
     }
     return _json;
   }
 }