| Index: discovery/googleapis/analyticsreporting__v4.json
|
| diff --git a/discovery/googleapis/analyticsreporting__v4.json b/discovery/googleapis/analyticsreporting__v4.json
|
| index d86b09dd7361408686aaf0f41afc9409a72e717b..db2b874d12a3170a988d5a90997396b3441b2e19 100644
|
| --- a/discovery/googleapis/analyticsreporting__v4.json
|
| +++ b/discovery/googleapis/analyticsreporting__v4.json
|
| @@ -28,6 +28,37 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| + "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.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "quotaUser": {
|
| + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pp": {
|
| + "default": "true",
|
| + "description": "Pretty-print response.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "bearer_token": {
|
| + "description": "OAuth bearer token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "oauth_token": {
|
| + "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",
|
| @@ -39,13 +70,13 @@
|
| "location": "query",
|
| "type": "boolean"
|
| },
|
| - "fields": {
|
| - "description": "Selector specifying which fields to include in a partial response.",
|
| + "uploadType": {
|
| + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| + "fields": {
|
| + "description": "Selector specifying which fields to include in a partial response.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -82,37 +113,6 @@
|
| ],
|
| "location": "query",
|
| "type": "string"
|
| - },
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| - "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.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "quotaUser": {
|
| - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pp": {
|
| - "default": "true",
|
| - "description": "Pretty-print response.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "bearer_token": {
|
| - "description": "OAuth bearer token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "oauth_token": {
|
| - "description": "OAuth 2.0 token for the current user.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "protocol": "rest",
|
| @@ -143,222 +143,10 @@
|
| "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",
|
| - "properties": {
|
| - "segmentFilters": {
|
| - "description": "A segment is defined by a set of segment filters which are combined\ntogether with a logical `AND` operation.",
|
| - "items": {
|
| - "$ref": "SegmentFilter"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "MetricHeaderEntry": {
|
| - "description": "Header for the metrics.",
|
| - "id": "MetricHeaderEntry",
|
| - "properties": {
|
| - "name": {
|
| - "description": "The name of the header.",
|
| - "type": "string"
|
| - },
|
| - "type": {
|
| - "description": "The type of the metric, for example `INTEGER`.",
|
| - "enum": [
|
| - "METRIC_TYPE_UNSPECIFIED",
|
| - "INTEGER",
|
| - "FLOAT",
|
| - "CURRENCY",
|
| - "PERCENT",
|
| - "TIME"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Metric type is unspecified.",
|
| - "Integer metric.",
|
| - "Float metric.",
|
| - "Currency metric.",
|
| - "Percentage metric.",
|
| - "Time metric in `HH:MM:SS` format."
|
| - ],
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ReportData": {
|
| - "description": "The data part of the report.",
|
| - "id": "ReportData",
|
| - "properties": {
|
| - "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"
|
| - },
|
| - "rowCount": {
|
| - "description": "Total number of matching rows for this query.",
|
| - "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",
|
| - "type": "string"
|
| - },
|
| - "maximums": {
|
| - "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
|
| - "items": {
|
| - "$ref": "DateRangeValues"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "minimums": {
|
| - "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
|
| - "items": {
|
| - "$ref": "DateRangeValues"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "samplingSpaceSizes": {
|
| - "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of\nsamples present, one entry per date range. If the results are not sampled\nthis 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"
|
| - },
|
| - "DimensionFilter": {
|
| - "description": "Dimension filter specifies the filtering options on a dimension.",
|
| - "id": "DimensionFilter",
|
| - "properties": {
|
| - "operator": {
|
| - "description": "How to match the dimension to the expression. The default is REGEXP.",
|
| - "enum": [
|
| - "OPERATOR_UNSPECIFIED",
|
| - "REGEXP",
|
| - "BEGINS_WITH",
|
| - "ENDS_WITH",
|
| - "PARTIAL",
|
| - "EXACT",
|
| - "NUMERIC_EQUAL",
|
| - "NUMERIC_GREATER_THAN",
|
| - "NUMERIC_LESS_THAN",
|
| - "IN_LIST"
|
| - ],
|
| - "enumDescriptions": [
|
| - "If the match type is unspecified, it is treated as a `REGEXP`.",
|
| - "The match expression is treated as a regular expression. All match types\nare not treated as regular expressions.",
|
| - "Matches the value which begin with the match expression provided.",
|
| - "Matches the values which end with the match expression provided.",
|
| - "Substring match.",
|
| - "The value should match the match expression entirely.",
|
| - "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- If expression is not a valid int64, the client should expect\n an error.\n- Input dimensions that are not valid int64 values will never match the\n filter.",
|
| - "Checks if the dimension is numerically greater than the match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions.",
|
| - "Checks if the dimension is numerically less than the match expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.",
|
| - "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "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.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "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"
|
| - },
|
| - "caseSensitive": {
|
| - "description": "Should the match be case sensitive? Default is false.",
|
| - "type": "boolean"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "SegmentDimensionFilter": {
|
| "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"
|
| @@ -405,6 +193,10 @@
|
| "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "caseSensitive": {
|
| + "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -550,10 +342,6 @@
|
| "description": "The data response corresponding to the request.",
|
| "id": "Report",
|
| "properties": {
|
| - "columnHeader": {
|
| - "$ref": "ColumnHeader",
|
| - "description": "The column headers."
|
| - },
|
| "nextPageToken": {
|
| "description": "Page token to retrieve the next page of results in the list.",
|
| "type": "string"
|
| @@ -561,6 +349,10 @@
|
| "data": {
|
| "$ref": "ReportData",
|
| "description": "Response data."
|
| + },
|
| + "columnHeader": {
|
| + "$ref": "ColumnHeader",
|
| + "description": "The column headers."
|
| }
|
| },
|
| "type": "object"
|
| @@ -588,13 +380,13 @@
|
| "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": {
|
| - "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"
|
| + },
|
| + "endDate": {
|
| + "description": "The end date for the query in the format `YYYY-MM-DD`.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -603,6 +395,32 @@
|
| "description": "The main request class which specifies the Reporting API request.",
|
| "id": "ReportRequest",
|
| "properties": {
|
| + "cohortGroup": {
|
| + "$ref": "CohortGroup",
|
| + "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition."
|
| + },
|
| + "filtersExpression": {
|
| + "description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
|
| + "type": "string"
|
| + },
|
| + "viewId": {
|
| + "description": "The Analytics\n[view ID](https://support.google.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportRequest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`.",
|
| + "type": "string"
|
| + },
|
| + "metrics": {
|
| + "description": "The metrics requested.\nRequests must specify at least one metric. Requests can have a\ntotal of 10 metrics.",
|
| + "items": {
|
| + "$ref": "Metric"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "dimensionFilterClauses": {
|
| + "description": "The dimension filter clauses for filtering Dimension Values. They are\nlogically combined with the `AND` operator. Note that filtering occurs\nbefore any dimensions are aggregated, so that the returned metrics\nrepresent the total for only the relevant dimensions.",
|
| + "items": {
|
| + "$ref": "DimensionFilterClause"
|
| + },
|
| + "type": "array"
|
| + },
|
| "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": {
|
| @@ -681,32 +499,6 @@
|
| "hideValueRanges": {
|
| "description": "If set to true, hides the minimum and maximum across all matching rows.\nThe default is false and the value ranges are returned.",
|
| "type": "boolean"
|
| - },
|
| - "filtersExpression": {
|
| - "description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
|
| - "type": "string"
|
| - },
|
| - "cohortGroup": {
|
| - "$ref": "CohortGroup",
|
| - "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition."
|
| - },
|
| - "viewId": {
|
| - "description": "The Analytics\n[view ID](https://support.google.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportRequest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`.",
|
| - "type": "string"
|
| - },
|
| - "metrics": {
|
| - "description": "The metrics requested.\nRequests must specify at least one metric. Requests can have a\ntotal of 10 metrics.",
|
| - "items": {
|
| - "$ref": "Metric"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "dimensionFilterClauses": {
|
| - "description": "The dimension filter clauses for filtering Dimension Values. They are\nlogically combined with the `AND` operator. Note that filtering occurs\nbefore any dimensions are aggregated, so that the returned metrics\nrepresent the total for only the relevant dimensions.",
|
| - "items": {
|
| - "$ref": "DimensionFilterClause"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -715,10 +507,6 @@
|
| "description": "MetricFilter specifies the filter on a metric.",
|
| "id": "MetricFilter",
|
| "properties": {
|
| - "comparisonValue": {
|
| - "description": "The value to compare against.",
|
| - "type": "string"
|
| - },
|
| "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": [
|
| @@ -744,6 +532,10 @@
|
| "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"
|
| + },
|
| + "comparisonValue": {
|
| + "description": "The value to compare against.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -767,20 +559,6 @@
|
| },
|
| "type": "object"
|
| },
|
| - "SimpleSegment": {
|
| - "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.",
|
| - "id": "SimpleSegment",
|
| - "properties": {
|
| - "orFiltersForSegment": {
|
| - "description": "A list of segment filters groups which are combined with logical `AND`\noperator.",
|
| - "items": {
|
| - "$ref": "OrFiltersForSegment"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "DynamicSegment": {
|
| "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
|
| "id": "DynamicSegment",
|
| @@ -800,6 +578,20 @@
|
| },
|
| "type": "object"
|
| },
|
| + "SimpleSegment": {
|
| + "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.",
|
| + "id": "SimpleSegment",
|
| + "properties": {
|
| + "orFiltersForSegment": {
|
| + "description": "A list of segment filters groups which are combined with logical `AND`\noperator.",
|
| + "items": {
|
| + "$ref": "OrFiltersForSegment"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "ColumnHeader": {
|
| "description": "Column headers.",
|
| "id": "ColumnHeader",
|
| @@ -837,6 +629,34 @@
|
| },
|
| "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": "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"
|
| + },
|
| "Cohort": {
|
| "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",
|
| @@ -875,40 +695,12 @@
|
| },
|
| "type": "array"
|
| },
|
| - "dimensions": {
|
| - "description": "List of requested dimensions.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "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.",
|
| + "dimensions": {
|
| + "description": "List of requested dimensions.",
|
| "items": {
|
| - "$ref": "MetricFilter"
|
| + "type": "string"
|
| },
|
| "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"
|
| @@ -994,16 +786,16 @@
|
| "description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.",
|
| "id": "SequenceSegment",
|
| "properties": {
|
| + "firstStepShouldMatchFirstHit": {
|
| + "description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).",
|
| + "type": "boolean"
|
| + },
|
| "segmentSequenceSteps": {
|
| "description": "The list of steps in the sequence.",
|
| "items": {
|
| "$ref": "SegmentSequenceStep"
|
| },
|
| "type": "array"
|
| - },
|
| - "firstStepShouldMatchFirstHit": {
|
| - "description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).",
|
| - "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1067,17 +859,17 @@
|
| "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
|
| "id": "DateRangeValues",
|
| "properties": {
|
| - "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"
|
| },
|
| - "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"
|
| }
|
| @@ -1120,6 +912,18 @@
|
| "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.",
|
| + "items": {
|
| + "$ref": "Metric"
|
| + },
|
| + "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": {
|
| @@ -1138,18 +942,214 @@
|
| "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": {
|
| + "dimensionValues": {
|
| + "description": "The values for the dimensions in the pivot.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| },
|
| - "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.",
|
| + "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": {
|
| + "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"
|
| + },
|
| + "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."
|
| + }
|
| + },
|
| + "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",
|
| + "properties": {
|
| + "segmentFilters": {
|
| + "description": "A segment is defined by a set of segment filters which are combined\ntogether with a logical `AND` operation.",
|
| + "items": {
|
| + "$ref": "SegmentFilter"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MetricHeaderEntry": {
|
| + "description": "Header for the metrics.",
|
| + "id": "MetricHeaderEntry",
|
| + "properties": {
|
| + "name": {
|
| + "description": "The name of the header.",
|
| + "type": "string"
|
| + },
|
| + "type": {
|
| + "description": "The type of the metric, for example `INTEGER`.",
|
| + "enum": [
|
| + "METRIC_TYPE_UNSPECIFIED",
|
| + "INTEGER",
|
| + "FLOAT",
|
| + "CURRENCY",
|
| + "PERCENT",
|
| + "TIME"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Metric type is unspecified.",
|
| + "Integer metric.",
|
| + "Float metric.",
|
| + "Currency metric.",
|
| + "Percentage metric.",
|
| + "Time metric in `HH:MM:SS` format."
|
| + ],
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ReportData": {
|
| + "description": "The data part of the report.",
|
| + "id": "ReportData",
|
| + "properties": {
|
| + "samplingSpaceSizes": {
|
| + "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of\nsamples present, one entry per date range. If the results are not sampled\nthis 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"
|
| + },
|
| + "minimums": {
|
| + "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
|
| + "items": {
|
| + "$ref": "DateRangeValues"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "rows": {
|
| + "description": "There's one ReportRow for every unique combination of dimensions.",
|
| + "items": {
|
| + "$ref": "ReportRow"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "rowCount": {
|
| + "description": "Total number of matching rows for this query.",
|
| "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.",
|
| + "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",
|
| + "type": "string"
|
| + },
|
| + "maximums": {
|
| + "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
|
| "items": {
|
| - "$ref": "Metric"
|
| + "$ref": "DateRangeValues"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "DimensionFilter": {
|
| + "description": "Dimension filter specifies the filtering options on a dimension.",
|
| + "id": "DimensionFilter",
|
| + "properties": {
|
| + "operator": {
|
| + "description": "How to match the dimension to the expression. The default is REGEXP.",
|
| + "enum": [
|
| + "OPERATOR_UNSPECIFIED",
|
| + "REGEXP",
|
| + "BEGINS_WITH",
|
| + "ENDS_WITH",
|
| + "PARTIAL",
|
| + "EXACT",
|
| + "NUMERIC_EQUAL",
|
| + "NUMERIC_GREATER_THAN",
|
| + "NUMERIC_LESS_THAN",
|
| + "IN_LIST"
|
| + ],
|
| + "enumDescriptions": [
|
| + "If the match type is unspecified, it is treated as a `REGEXP`.",
|
| + "The match expression is treated as a regular expression. All match types\nare not treated as regular expressions.",
|
| + "Matches the value which begin with the match expression provided.",
|
| + "Matches the values which end with the match expression provided.",
|
| + "Substring match.",
|
| + "The value should match the match expression entirely.",
|
| + "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- If expression is not a valid int64, the client should expect\n an error.\n- Input dimensions that are not valid int64 values will never match the\n filter.",
|
| + "Checks if the dimension is numerically greater than the match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions.",
|
| + "Checks if the dimension is numerically less than the match expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.",
|
| + "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "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.",
|
| + "items": {
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "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"
|
| + },
|
| + "caseSensitive": {
|
| + "description": "Should the match be case sensitive? Default is false.",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
|
|
Chromium Code Reviews
Issue 2987103002:
Api-Roll 52: 2017-07-31 (Closed)
