| Index: discovery/googleapis/analyticsreporting__v4.json
|
| diff --git a/discovery/googleapis/analyticsreporting__v4.json b/discovery/googleapis/analyticsreporting__v4.json
|
| index aebe655135e2bc6d64c31dc3a267c4e743cd19a2..d86b09dd7361408686aaf0f41afc9409a72e717b 100644
|
| --- a/discovery/googleapis/analyticsreporting__v4.json
|
| +++ b/discovery/googleapis/analyticsreporting__v4.json
|
| @@ -28,6 +28,45 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| + "upload_protocol": {
|
| + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "prettyPrint": {
|
| + "default": "true",
|
| + "description": "Returns response with indentations and line breaks.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "fields": {
|
| + "description": "Selector specifying which fields to include in a partial response.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "uploadType": {
|
| + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "$.xgafv": {
|
| + "description": "V1 error format.",
|
| + "enum": [
|
| + "1",
|
| + "2"
|
| + ],
|
| + "enumDescriptions": [
|
| + "v1 error format",
|
| + "v2 error format"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "callback": {
|
| + "description": "JSONP",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "alt": {
|
| "default": "json",
|
| "description": "Data format for response.",
|
| @@ -44,13 +83,13 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "key": {
|
| - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| + "key": {
|
| + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -74,45 +113,6 @@
|
| "description": "OAuth 2.0 token for the current user.",
|
| "location": "query",
|
| "type": "string"
|
| - },
|
| - "upload_protocol": {
|
| - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "prettyPrint": {
|
| - "default": "true",
|
| - "description": "Returns response with indentations and line breaks.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "fields": {
|
| - "description": "Selector specifying which fields to include in a partial response.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "callback": {
|
| - "description": "JSONP",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "$.xgafv": {
|
| - "description": "V1 error format.",
|
| - "enum": [
|
| - "1",
|
| - "2"
|
| - ],
|
| - "enumDescriptions": [
|
| - "v1 error format",
|
| - "v2 error format"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "protocol": "rest",
|
| @@ -140,9 +140,53 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170531",
|
| + "revision": "20170705",
|
| "rootUrl": "https://analyticsreporting.googleapis.com/",
|
| "schemas": {
|
| + "PivotHeaderEntry": {
|
| + "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
|
| + "id": "PivotHeaderEntry",
|
| + "properties": {
|
| + "dimensionValues": {
|
| + "description": "The values for the dimensions in the pivot.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "metric": {
|
| + "$ref": "MetricHeaderEntry",
|
| + "description": "The metric header for the metric in the pivot."
|
| + },
|
| + "dimensionNames": {
|
| + "description": "The name of the dimensions in the pivot response.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "SegmentFilter": {
|
| + "description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.",
|
| + "id": "SegmentFilter",
|
| + "properties": {
|
| + "sequenceSegment": {
|
| + "$ref": "SequenceSegment",
|
| + "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators."
|
| + },
|
| + "not": {
|
| + "description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
|
| + "type": "boolean"
|
| + },
|
| + "simpleSegment": {
|
| + "$ref": "SimpleSegment",
|
| + "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "SegmentDefinition": {
|
| "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
|
| "id": "SegmentDefinition",
|
| @@ -192,14 +236,18 @@
|
| "description": "The data part of the report.",
|
| "id": "ReportData",
|
| "properties": {
|
| - "isDataGolden": {
|
| - "description": "Indicates if response to this request is golden or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
|
| - "type": "boolean"
|
| + "totals": {
|
| + "description": "For each requested date range, for the set of all rows that match\nthe query, every requested value format gets a total. The total\nfor a value format is computed by first totaling the metrics\nmentioned in the value format and then evaluating the value\nformat as a scalar expression. E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of all relevant ga:sessions) + 2)`.\nTotals are computed before pagination.",
|
| + "items": {
|
| + "$ref": "DateRangeValues"
|
| + },
|
| + "type": "array"
|
| },
|
| - "rows": {
|
| - "description": "There's one ReportRow for every unique combination of dimensions.",
|
| + "samplesReadCounts": {
|
| + "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of samples read, one entry per date range.\nIf the results are not sampled this field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
|
| "items": {
|
| - "$ref": "ReportRow"
|
| + "format": "int64",
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| @@ -208,6 +256,17 @@
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| + "rows": {
|
| + "description": "There's one ReportRow for every unique combination of dimensions.",
|
| + "items": {
|
| + "$ref": "ReportRow"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "isDataGolden": {
|
| + "description": "Indicates if response to this request is golden or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
|
| + "type": "boolean"
|
| + },
|
| "dataLastRefreshed": {
|
| "description": "The last time the data in the report was refreshed. All the hits received\nbefore this timestamp are included in the calculation of the report.",
|
| "format": "google-datetime",
|
| @@ -234,21 +293,6 @@
|
| "type": "string"
|
| },
|
| "type": "array"
|
| - },
|
| - "totals": {
|
| - "description": "For each requested date range, for the set of all rows that match\nthe query, every requested value format gets a total. The total\nfor a value format is computed by first totaling the metrics\nmentioned in the value format and then evaluating the value\nformat as a scalar expression. E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of all relevant ga:sessions) + 2)`.\nTotals are computed before pagination.",
|
| - "items": {
|
| - "$ref": "DateRangeValues"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "samplesReadCounts": {
|
| - "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of samples read, one entry per date range.\nIf the results are not sampled this field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
|
| - "items": {
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -257,14 +301,6 @@
|
| "description": "Dimension filter specifies the filtering options on a dimension.",
|
| "id": "DimensionFilter",
|
| "properties": {
|
| - "caseSensitive": {
|
| - "description": "Should the match be case sensitive? Default is false.",
|
| - "type": "boolean"
|
| - },
|
| - "dimensionName": {
|
| - "description": "The dimension to filter on. A DimensionFilter must contain a dimension.",
|
| - "type": "string"
|
| - },
|
| "operator": {
|
| "description": "How to match the dimension to the expression. The default is REGEXP.",
|
| "enum": [
|
| @@ -293,9 +329,9 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "not": {
|
| - "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\ndimension values will be excluded in the report. The default is false.",
|
| - "type": "boolean"
|
| + "dimensionName": {
|
| + "description": "The dimension to filter on. A DimensionFilter must contain a dimension.",
|
| + "type": "string"
|
| },
|
| "expressions": {
|
| "description": "Strings or regular expression to match against. Only the first value of\nthe list is used for comparison unless the operator is `IN_LIST`.\nIf `IN_LIST` operator, then the entire list is used to filter the\ndimensions as explained in the description of the `IN_LIST` operator.",
|
| @@ -303,66 +339,14 @@
|
| "type": "string"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "OrderBy": {
|
| - "description": "Specifies the sorting options.",
|
| - "id": "OrderBy",
|
| - "properties": {
|
| - "sortOrder": {
|
| - "description": "The sorting order for the field.",
|
| - "enum": [
|
| - "SORT_ORDER_UNSPECIFIED",
|
| - "ASCENDING",
|
| - "DESCENDING"
|
| - ],
|
| - "enumDescriptions": [
|
| - "If the sort order is unspecified, the default is ascending.",
|
| - "Ascending sort. The field will be sorted in an ascending manner.",
|
| - "Descending sort. The field will be sorted in a descending manner."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "fieldName": {
|
| - "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
|
| - "type": "string"
|
| },
|
| - "orderType": {
|
| - "description": "The order type. The default orderType is `VALUE`.",
|
| - "enum": [
|
| - "ORDER_TYPE_UNSPECIFIED",
|
| - "VALUE",
|
| - "DELTA",
|
| - "SMART",
|
| - "HISTOGRAM_BUCKET",
|
| - "DIMENSION_AS_INTEGER"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unspecified order type will be treated as sort based on value.",
|
| - "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
|
| - "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
|
| - "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
|
| - "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
|
| - "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
|
| - ],
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Segment": {
|
| - "description": "The segment definition, if the report needs to be segmented.\nA Segment is a subset of the Analytics data. For example, of the entire\nset of users, one Segment might be users from a particular country or city.",
|
| - "id": "Segment",
|
| - "properties": {
|
| - "dynamicSegment": {
|
| - "$ref": "DynamicSegment",
|
| - "description": "A dynamic segment definition in the request."
|
| + "not": {
|
| + "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\ndimension values will be excluded in the report. The default is false.",
|
| + "type": "boolean"
|
| },
|
| - "segmentId": {
|
| - "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
|
| - "type": "string"
|
| + "caseSensitive": {
|
| + "description": "Should the match be case sensitive? Default is false.",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -371,6 +355,18 @@
|
| "description": "Dimension filter specifies the filtering options on a dimension.",
|
| "id": "SegmentDimensionFilter",
|
| "properties": {
|
| + "caseSensitive": {
|
| + "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
|
| + "type": "boolean"
|
| + },
|
| + "minComparisonValue": {
|
| + "description": "Minimum comparison values for `BETWEEN` match type.",
|
| + "type": "string"
|
| + },
|
| + "maxComparisonValue": {
|
| + "description": "Maximum comparison values for `BETWEEN` match type.",
|
| + "type": "string"
|
| + },
|
| "dimensionName": {
|
| "description": "Name of the dimension for which the filter is being applied.",
|
| "type": "string"
|
| @@ -409,17 +405,65 @@
|
| "type": "string"
|
| },
|
| "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "OrderBy": {
|
| + "description": "Specifies the sorting options.",
|
| + "id": "OrderBy",
|
| + "properties": {
|
| + "orderType": {
|
| + "description": "The order type. The default orderType is `VALUE`.",
|
| + "enum": [
|
| + "ORDER_TYPE_UNSPECIFIED",
|
| + "VALUE",
|
| + "DELTA",
|
| + "SMART",
|
| + "HISTOGRAM_BUCKET",
|
| + "DIMENSION_AS_INTEGER"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unspecified order type will be treated as sort based on value.",
|
| + "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
|
| + "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
|
| + "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
|
| + "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
|
| + "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
|
| + ],
|
| + "type": "string"
|
| },
|
| - "caseSensitive": {
|
| - "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
|
| - "type": "boolean"
|
| + "fieldName": {
|
| + "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
|
| + "type": "string"
|
| },
|
| - "minComparisonValue": {
|
| - "description": "Minimum comparison values for `BETWEEN` match type.",
|
| + "sortOrder": {
|
| + "description": "The sorting order for the field.",
|
| + "enum": [
|
| + "SORT_ORDER_UNSPECIFIED",
|
| + "ASCENDING",
|
| + "DESCENDING"
|
| + ],
|
| + "enumDescriptions": [
|
| + "If the sort order is unspecified, the default is ascending.",
|
| + "Ascending sort. The field will be sorted in an ascending manner.",
|
| + "Descending sort. The field will be sorted in a descending manner."
|
| + ],
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Segment": {
|
| + "description": "The segment definition, if the report needs to be segmented.\nA Segment is a subset of the Analytics data. For example, of the entire\nset of users, one Segment might be users from a particular country or city.",
|
| + "id": "Segment",
|
| + "properties": {
|
| + "dynamicSegment": {
|
| + "$ref": "DynamicSegment",
|
| + "description": "A dynamic segment definition in the request."
|
| },
|
| - "maxComparisonValue": {
|
| - "description": "Maximum comparison values for `BETWEEN` match type.",
|
| + "segmentId": {
|
| + "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
|
| "type": "string"
|
| }
|
| },
|
| @@ -510,13 +554,13 @@
|
| "$ref": "ColumnHeader",
|
| "description": "The column headers."
|
| },
|
| - "data": {
|
| - "$ref": "ReportData",
|
| - "description": "Response data."
|
| - },
|
| "nextPageToken": {
|
| "description": "Page token to retrieve the next page of results in the list.",
|
| "type": "string"
|
| + },
|
| + "data": {
|
| + "$ref": "ReportData",
|
| + "description": "Response data."
|
| }
|
| },
|
| "type": "object"
|
| @@ -544,58 +588,80 @@
|
| "description": "A contiguous set of days: startDate, startDate + 1 day, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.",
|
| "id": "DateRange",
|
| "properties": {
|
| - "startDate": {
|
| - "description": "The start date for the query in the format `YYYY-MM-DD`.",
|
| - "type": "string"
|
| - },
|
| "endDate": {
|
| "description": "The end date for the query in the format `YYYY-MM-DD`.",
|
| "type": "string"
|
| + },
|
| + "startDate": {
|
| + "description": "The start date for the query in the format `YYYY-MM-DD`.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MetricFilter": {
|
| - "description": "MetricFilter specifies the filter on a metric.",
|
| - "id": "MetricFilter",
|
| + "ReportRequest": {
|
| + "description": "The main request class which specifies the Reporting API request.",
|
| + "id": "ReportRequest",
|
| "properties": {
|
| - "operator": {
|
| - "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
|
| + "orderBys": {
|
| + "description": "Sort order on output rows. To compare two rows, the elements of the\nfollowing are applied in order until a difference is found. All date\nranges in the output get the same row order.",
|
| + "items": {
|
| + "$ref": "OrderBy"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "segments": {
|
| + "description": "Segment the data returned for the request. A segment definition helps look\nat a subset of the segment request. A request can contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `segments` definition. Requests\nwith segments must have the `ga:segment` dimension.",
|
| + "items": {
|
| + "$ref": "Segment"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "samplingLevel": {
|
| + "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.",
|
| "enum": [
|
| - "OPERATOR_UNSPECIFIED",
|
| - "EQUAL",
|
| - "LESS_THAN",
|
| - "GREATER_THAN",
|
| - "IS_MISSING"
|
| + "SAMPLING_UNSPECIFIED",
|
| + "DEFAULT",
|
| + "SMALL",
|
| + "LARGE"
|
| ],
|
| "enumDescriptions": [
|
| - "If the operator is not specified, it is treated as `EQUAL`.",
|
| - "Should the value of the metric be exactly equal to the comparison value.",
|
| - "Should the value of the metric be less than to the comparison value.",
|
| - "Should the value of the metric be greater than to the comparison value.",
|
| - "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
|
| + "If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.",
|
| + "Returns response with a sample size that balances speed and\naccuracy.",
|
| + "It returns a fast response with a smaller sampling size.",
|
| + "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower."
|
| ],
|
| "type": "string"
|
| },
|
| - "not": {
|
| - "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
|
| - "type": "boolean"
|
| + "dimensions": {
|
| + "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
|
| + "items": {
|
| + "$ref": "Dimension"
|
| + },
|
| + "type": "array"
|
| },
|
| - "metricName": {
|
| - "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
|
| + "pageToken": {
|
| + "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
|
| "type": "string"
|
| },
|
| - "comparisonValue": {
|
| - "description": "The value to compare against.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ReportRequest": {
|
| - "description": "The main request class which specifies the Reporting API request.",
|
| - "id": "ReportRequest",
|
| - "properties": {
|
| + "dateRanges": {
|
| + "description": "Date ranges in the request. The request can have a maximum of 2 date\nranges. The response will contain a set of metric values for each\ncombination of the dimensions for each date range in the request. So, if\nthere are two date ranges, there will be two set of metric values, one for\nthe original date range and one for the second date range.\nThe `reportRequest.dateRanges` field should not be specified for cohorts\nor Lifetime value requests.\nIf a date range is not provided, the default date range is (startDate:\ncurrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `dateRanges` definition.",
|
| + "items": {
|
| + "$ref": "DateRange"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "pivots": {
|
| + "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
|
| + "items": {
|
| + "$ref": "Pivot"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "includeEmptyRows": {
|
| + "description": "If set to false, the response does not include rows if all the retrieved\nmetrics are equal to zero. The default is false which will exclude these\nrows.",
|
| + "type": "boolean"
|
| + },
|
| "metricFilterClauses": {
|
| "description": "The metric filter clauses. They are logically combined with the `AND`\noperator. Metric filters look at only the first date range and not the\ncomparing date range. Note that filtering on metrics occurs after the\nmetrics are aggregated.",
|
| "items": {
|
| @@ -641,65 +707,43 @@
|
| "$ref": "DimensionFilterClause"
|
| },
|
| "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MetricFilter": {
|
| + "description": "MetricFilter specifies the filter on a metric.",
|
| + "id": "MetricFilter",
|
| + "properties": {
|
| + "comparisonValue": {
|
| + "description": "The value to compare against.",
|
| + "type": "string"
|
| },
|
| - "orderBys": {
|
| - "description": "Sort order on output rows. To compare two rows, the elements of the\nfollowing are applied in order until a difference is found. All date\nranges in the output get the same row order.",
|
| - "items": {
|
| - "$ref": "OrderBy"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "segments": {
|
| - "description": "Segment the data returned for the request. A segment definition helps look\nat a subset of the segment request. A request can contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `segments` definition. Requests\nwith segments must have the `ga:segment` dimension.",
|
| - "items": {
|
| - "$ref": "Segment"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "samplingLevel": {
|
| - "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.",
|
| + "operator": {
|
| + "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
|
| "enum": [
|
| - "SAMPLING_UNSPECIFIED",
|
| - "DEFAULT",
|
| - "SMALL",
|
| - "LARGE"
|
| + "OPERATOR_UNSPECIFIED",
|
| + "EQUAL",
|
| + "LESS_THAN",
|
| + "GREATER_THAN",
|
| + "IS_MISSING"
|
| ],
|
| "enumDescriptions": [
|
| - "If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.",
|
| - "Returns response with a sample size that balances speed and\naccuracy.",
|
| - "It returns a fast response with a smaller sampling size.",
|
| - "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower."
|
| + "If the operator is not specified, it is treated as `EQUAL`.",
|
| + "Should the value of the metric be exactly equal to the comparison value.",
|
| + "Should the value of the metric be less than to the comparison value.",
|
| + "Should the value of the metric be greater than to the comparison value.",
|
| + "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
|
| ],
|
| "type": "string"
|
| },
|
| - "dimensions": {
|
| - "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
|
| - "items": {
|
| - "$ref": "Dimension"
|
| - },
|
| - "type": "array"
|
| + "not": {
|
| + "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
|
| + "type": "boolean"
|
| },
|
| - "pageToken": {
|
| - "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
|
| + "metricName": {
|
| + "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
|
| "type": "string"
|
| - },
|
| - "dateRanges": {
|
| - "description": "Date ranges in the request. The request can have a maximum of 2 date\nranges. The response will contain a set of metric values for each\ncombination of the dimensions for each date range in the request. So, if\nthere are two date ranges, there will be two set of metric values, one for\nthe original date range and one for the second date range.\nThe `reportRequest.dateRanges` field should not be specified for cohorts\nor Lifetime value requests.\nIf a date range is not provided, the default date range is (startDate:\ncurrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `dateRanges` definition.",
|
| - "items": {
|
| - "$ref": "DateRange"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "pivots": {
|
| - "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
|
| - "items": {
|
| - "$ref": "Pivot"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "includeEmptyRows": {
|
| - "description": "If set to false, the response does not include rows if all the retrieved\nmetrics are equal to zero. The default is false which will exclude these\nrows.",
|
| - "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -778,6 +822,10 @@
|
| "description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
|
| "id": "SegmentFilterClause",
|
| "properties": {
|
| + "metricFilter": {
|
| + "$ref": "SegmentMetricFilter",
|
| + "description": "Metric Filter for the segment definition."
|
| + },
|
| "not": {
|
| "description": "Matches the complement (`!`) of the filter.",
|
| "type": "boolean"
|
| @@ -785,38 +833,6 @@
|
| "dimensionFilter": {
|
| "$ref": "SegmentDimensionFilter",
|
| "description": "Dimension Filter for the segment definition."
|
| - },
|
| - "metricFilter": {
|
| - "$ref": "SegmentMetricFilter",
|
| - "description": "Metric Filter for the segment definition."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "MetricFilterClause": {
|
| - "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
|
| - "id": "MetricFilterClause",
|
| - "properties": {
|
| - "operator": {
|
| - "description": "The operator for combining multiple metric filters. If unspecified, it is\ntreated as an `OR`.",
|
| - "enum": [
|
| - "OPERATOR_UNSPECIFIED",
|
| - "OR",
|
| - "AND"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unspecified operator. It is treated as an `OR`.",
|
| - "The logical `OR` operator.",
|
| - "The logical `AND` operator."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "filters": {
|
| - "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
|
| - "items": {
|
| - "$ref": "MetricFilter"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -825,14 +841,14 @@
|
| "description": "Defines a cohort. A cohort is a group of users who share a common\ncharacteristic. For example, all users with the same acquisition date\nbelong to the same cohort.",
|
| "id": "Cohort",
|
| "properties": {
|
| - "name": {
|
| - "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
|
| - "type": "string"
|
| - },
|
| "dateRange": {
|
| "$ref": "DateRange",
|
| "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field."
|
| },
|
| + "name": {
|
| + "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
|
| + "type": "string"
|
| + },
|
| "type": {
|
| "description": "Type of the cohort. The only supported type as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated\nas `FIRST_VISIT_DATE` type cohort.",
|
| "enum": [
|
| @@ -852,19 +868,47 @@
|
| "description": "A row in the report.",
|
| "id": "ReportRow",
|
| "properties": {
|
| + "metrics": {
|
| + "description": "List of metrics for each requested DateRange.",
|
| + "items": {
|
| + "$ref": "DateRangeValues"
|
| + },
|
| + "type": "array"
|
| + },
|
| "dimensions": {
|
| "description": "List of requested dimensions.",
|
| "items": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| - },
|
| - "metrics": {
|
| - "description": "List of metrics for each requested DateRange.",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MetricFilterClause": {
|
| + "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
|
| + "id": "MetricFilterClause",
|
| + "properties": {
|
| + "filters": {
|
| + "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
|
| "items": {
|
| - "$ref": "DateRangeValues"
|
| + "$ref": "MetricFilter"
|
| },
|
| "type": "array"
|
| + },
|
| + "operator": {
|
| + "description": "The operator for combining multiple metric filters. If unspecified, it is\ntreated as an `OR`.",
|
| + "enum": [
|
| + "OPERATOR_UNSPECIFIED",
|
| + "OR",
|
| + "AND"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unspecified operator. It is treated as an `OR`.",
|
| + "The logical `OR` operator.",
|
| + "The logical `AND` operator."
|
| + ],
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -908,6 +952,13 @@
|
| "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
|
| "id": "DimensionFilterClause",
|
| "properties": {
|
| + "filters": {
|
| + "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
|
| + "items": {
|
| + "$ref": "DimensionFilter"
|
| + },
|
| + "type": "array"
|
| + },
|
| "operator": {
|
| "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
|
| "enum": [
|
| @@ -921,13 +972,6 @@
|
| "The logical `AND` operator."
|
| ],
|
| "type": "string"
|
| - },
|
| - "filters": {
|
| - "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
|
| - "items": {
|
| - "$ref": "DimensionFilter"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1023,17 +1067,17 @@
|
| "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
|
| "id": "DateRangeValues",
|
| "properties": {
|
| - "values": {
|
| - "description": "Each value corresponds to each Metric in the request.",
|
| + "pivotValueRegions": {
|
| + "description": "The values of each pivot region.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "PivotValueRegion"
|
| },
|
| "type": "array"
|
| },
|
| - "pivotValueRegions": {
|
| - "description": "The values of each pivot region.",
|
| + "values": {
|
| + "description": "Each value corresponds to each Metric in the request.",
|
| "items": {
|
| - "$ref": "PivotValueRegion"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| }
|
| @@ -1044,16 +1088,16 @@
|
| "description": "Defines a cohort group.\nFor example:\n\n \"cohortGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"type\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }",
|
| "id": "CohortGroup",
|
| "properties": {
|
| - "lifetimeValue": {
|
| - "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
|
| - "type": "boolean"
|
| - },
|
| "cohorts": {
|
| "description": "The definition for the cohort.",
|
| "items": {
|
| "$ref": "Cohort"
|
| },
|
| "type": "array"
|
| + },
|
| + "lifetimeValue": {
|
| + "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1076,15 +1120,10 @@
|
| "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
|
| "id": "Pivot",
|
| "properties": {
|
| - "startGroup": {
|
| - "description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "metrics": {
|
| - "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
|
| + "dimensionFilterClauses": {
|
| + "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
|
| "items": {
|
| - "$ref": "Metric"
|
| + "$ref": "DimensionFilterClause"
|
| },
|
| "type": "array"
|
| },
|
| @@ -1095,64 +1134,25 @@
|
| },
|
| "type": "array"
|
| },
|
| - "dimensionFilterClauses": {
|
| - "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
|
| - "items": {
|
| - "$ref": "DimensionFilterClause"
|
| - },
|
| - "type": "array"
|
| - },
|
| "maxGroupCount": {
|
| "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
|
| "format": "int32",
|
| "type": "integer"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "PivotHeaderEntry": {
|
| - "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
|
| - "id": "PivotHeaderEntry",
|
| - "properties": {
|
| - "dimensionNames": {
|
| - "description": "The name of the dimensions in the pivot response.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| },
|
| - "metric": {
|
| - "$ref": "MetricHeaderEntry",
|
| - "description": "The metric header for the metric in the pivot."
|
| + "startGroup": {
|
| + "description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "dimensionValues": {
|
| - "description": "The values for the dimensions in the pivot.",
|
| + "metrics": {
|
| + "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "Metric"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| - },
|
| - "SegmentFilter": {
|
| - "description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.",
|
| - "id": "SegmentFilter",
|
| - "properties": {
|
| - "sequenceSegment": {
|
| - "$ref": "SequenceSegment",
|
| - "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators."
|
| - },
|
| - "not": {
|
| - "description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
|
| - "type": "boolean"
|
| - },
|
| - "simpleSegment": {
|
| - "$ref": "SimpleSegment",
|
| - "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
|
| - }
|
| - },
|
| - "type": "object"
|
| }
|
| },
|
| "servicePath": "",
|
|
|
Chromium Code Reviews
Issue 2973303002:
Api-Roll 51: 2017-07-10 (Closed)
