Api-roll 37: 2016-06-06

generated/googleapis/lib/analyticsreporting/v4.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.analyticsreporting.v4;
 
 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 555 matching lines @@
     }
     return _json;
   }
 }
 
 /** The batch request containing multiple report request. */
 class GetReportsRequest {
   /**
    * Requests, each request will have a separate response.
    * There can be a maximum of 5 requests. All requests should have the same
-   * `dateRange`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.
+   * `dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.
    */
   core.List<ReportRequest> reportRequests;
 
   GetReportsRequest();
 
   GetReportsRequest.fromJson(core.Map _json) {
     if (_json.containsKey("reportRequests")) {
       reportRequests = _json["reportRequests"].map((value) => new ReportRequest.fromJson(value)).toList();
     }
   }
@@ skipping 310 matching lines @@
    * `ga:browser, ga:city` is not valid.
    */
   core.String fieldName;
   /**
    * The order type. The default orderType is `VALUE`.
    * Possible string values are:
    * - "ORDER_TYPE_UNSPECIFIED" : Unspecified order type will be treated as sort
    * based on value.
    * - "VALUE" : The sort order is based on the value of the chosen column;
    * looks only at
-   * the first date range
+   * the first date range.
    * - "DELTA" : The sort order is based on the difference of the values of the
    * chosen
    * column between the first two date ranges.  Usable only if there are
    * exactly two date ranges.
    * - "SMART" : The sort order is based on weighted value of the chosen column.
    * If
    * column has n/d format, then weighted value of this ratio will
    * be `(n + totals.n)/(d + totals.d)` Usable only for metrics that
    * represent ratios.
    * - "HISTOGRAM_BUCKET" : Histogram order type is applicable only to dimension
@@ skipping 157 matching lines @@
     }
     return _json;
   }
 }
 
 /**
  * The headers for the each of the metric column corresponding to the metrics
  * requested in the pivots section of the response.
  */
 class PivotHeaderEntry {
-  /**
-   * The name of the dimensions in the pivotDimensionValues field in the
-   * response.
-   */
+  /** The name of the dimensions in the pivot response. */
   core.List<core.String> dimensionNames;
   /** The values for the dimensions in the pivot. */
   core.List<core.String> dimensionValues;
   /** The metric header for the metric in the pivot. */
   MetricHeaderEntry metric;
 
   PivotHeaderEntry();
 
   PivotHeaderEntry.fromJson(core.Map _json) {
     if (_json.containsKey("dimensionNames")) {
@@ skipping 100 matching lines @@
    * Minimum and maximum values seen over all matching rows. These are both
    * empty when `hideValueRanges` in the request is false, or when
    * rowCount is zero.
    */
   core.List<DateRangeValues> minimums;
   /** Total number of matching rows for this query. */
   core.int rowCount;
   /** There's one ReportRow for every unique combination of dimensions. */
   core.List<ReportRow> rows;
   /**
-   * If sampling was enabled, this returns the total number of samples
-   * read, one entry per date range
+   * If the results are
+   * [sampled](https://support.google.com/analytics/answer/2637192),
+   * this returns the total number of samples read, one entry per date range.
+   * If the results are not sampled this field will not be defined. See
+   * [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
+   * for details.
    */
   core.List<core.String> samplesReadCounts;
   /**
-   * If sampling was enabled, this returns the total number of samples
-   * present, one entry per date range.
+   * If the results are
+   * [sampled](https://support.google.com/analytics/answer/2637192),
+   * this returns the total number of
+   * samples present, one entry per date range. If the results are not sampled
+   * this field will not be defined. See
+   * [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
+   * for details.
    */
   core.List<core.String> samplingSpaceSizes;
   /**
    * For each requested date range, for the set of all rows that match
    * the query, every requested value format gets a total. The total
    * for a value format is computed by first totaling the metrics
    * mentioned in the value format and then evaluating the value
    * format as a scalar expression.  E.g., The "totals" for
    * `3 / (ga:sessions + 2)` we compute
    * `3 / ((sum of all relevant ga:sessions) + 2)`.
@@ skipping 57 matching lines @@
       _json["totals"] = totals.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }
 
 /** The main request class which specifies the Reporting API request. */
 class ReportRequest {
   /**
    * Cohort group associated with this request. If there is a cohort group
-   * in the request the `ga:cohort` dimension must be present. All requests
-   * should have the same cohort definitions.
+   * in the request the `ga:cohort` dimension must be present.
+   * Every [ReportRequest](#ReportRequest) within a `batchGet` method must
+   * contain the same `cohortGroup` definition.
    */
   CohortGroup cohortGroup;
   /**
    * Date ranges in the request. The request can have a maximum of 2 date
    * ranges. The response will contain a set of metric values for each
    * combination of the dimensions for each date range in the request. So, if
    * there are two date ranges, there will be two set of metric values, one for
    * the original date range and one for the second date range.
    * The `reportRequest.dateRanges` field should not be specified for cohorts
    * or Lifetime value requests.
    * If a date range is not provided, the default date range is (startDate:
-   * current date - 7 days, endDate: current date - 1 day)
+   * current date - 7 days, endDate: current date - 1 day). Every
+   * [ReportRequest](#ReportRequest) within a `batchGet` method must
+   * contain the same `dateRanges` definition.
    */
   core.List<DateRange> dateRanges;
   /**
    * The dimension filter clauses for filtering Dimension Values. They are
    * logically combined with the `AND` operator. Note that filtering occurs
    * before any dimensions are aggregated, so that the returned metrics
    * represent the total for only the relevant dimensions.
    */
   core.List<DimensionFilterClause> dimensionFilterClauses;
   /** Dimensions requested in the request. */
@@ skipping 57 matching lines @@
   /**
    * A continuation token to get the next page of the results. Adding this to
    * the request will return the rows after the pageToken. The pageToken should
    * be the value returned in the nextPageToken parameter in the response to
    * the GetReports request.
    */
   core.String pageToken;
   /** The pivot definitions. */
   core.List<Pivot> pivots;
   /**
-   * The desired sampling level. If the sampling level is not specified the
-   * DEFAULT sampling level will be used. All requests should have same
-   * `samplingLevel`.
+   * The desired report
+   * [sample](https://support.google.com/analytics/answer/2637192) size.
+   * If the the `samplingLevel` field is unspecified the `DEFAULT` sampling
+   * level is used. Every [ReportRequest](#ReportRequest) within a
+   * `batchGet` method must contain the same `samplingLevel` definition. See
+   * [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)
+   *  for details.
    * Possible string values are:
-   * - "SAMPLING_UNSPECIFIED" : If sampling level is unspecified the default
-   * sampling level is used.
+   * - "SAMPLING_UNSPECIFIED" : If the `samplingLevel` field is unspecified the
+   * `DEFAULT` sampling level
+   * is used.
    * - "DEFAULT" : Returns response with a sample size that balances speed and
    * accuracy.
    * - "SMALL" : It returns a fast response with a smaller sampling size.
    * - "LARGE" : Returns a more accurate response using a large sampling size.
    * But this
    * may result in response being slower.
    */
   core.String samplingLevel;
   /**
    * Segment the data returned for the request. A segment definition helps look
    * at a subset of the segment request. A request can contain up to four
-   * segments. All requests should have the same segment definitions. Requests
+   * segments. Every [ReportRequest](#ReportRequest) within a
+   * `batchGet` method must contain the same `segments` definition. Requests
    * with segments must have the `ga:segment` dimension.
    */
   core.List<Segment> segments;
-  /** Unique View Id for retrieving Analytics data. */
+  /**
+   * The Analytics
+   * [view ID](https://support.google.com/analytics/answer/1009618)
+   * from which to retrieve data. Every [ReportRequest](#ReportRequest)
+   * within a `batchGet` method must contain the same `viewId`.
+   */
   core.String viewId;
 
   ReportRequest();
 
   ReportRequest.fromJson(core.Map _json) {
     if (_json.containsKey("cohortGroup")) {
       cohortGroup = new CohortGroup.fromJson(_json["cohortGroup"]);
     }
     if (_json.containsKey("dateRanges")) {
       dateRanges = _json["dateRanges"].map((value) => new DateRange.fromJson(value)).toList();
@@ skipping 99 matching lines @@
       _json["viewId"] = viewId;
     }
     return _json;
   }
 }
 
 /** A row in the report. */
 class ReportRow {
   /** List of requested dimensions. */
   core.List<core.String> dimensions;
-  /** List of metrics for each requested DateRange */
+  /** List of metrics for each requested DateRange. */
   core.List<DateRangeValues> metrics;
 
   ReportRow();
 
   ReportRow.fromJson(core.Map _json) {
     if (_json.containsKey("dimensions")) {
       dimensions = _json["dimensions"];
     }
     if (_json.containsKey("metrics")) {
       metrics = _json["metrics"].map((value) => new DateRangeValues.fromJson(value)).toList();
@@ skipping 479 matching lines @@
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (orFiltersForSegment != null) {
       _json["orFiltersForSegment"] = orFiltersForSegment.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }