| Index: discovery/googleapis/analyticsreporting__v4.json
|
| diff --git a/discovery/googleapis/analyticsreporting__v4.json b/discovery/googleapis/analyticsreporting__v4.json
|
| index db2b874d12a3170a988d5a90997396b3441b2e19..1e668ba766762cb204dc150a2992b6bf4346ca24 100644
|
| --- a/discovery/googleapis/analyticsreporting__v4.json
|
| +++ b/discovery/googleapis/analyticsreporting__v4.json
|
| @@ -28,27 +28,6 @@
|
| "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",
|
| @@ -113,6 +92,27 @@
|
| ],
|
| "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"
|
| }
|
| },
|
| "protocol": "rest",
|
| @@ -143,6 +143,60 @@
|
| "revision": "20170705",
|
| "rootUrl": "https://analyticsreporting.googleapis.com/",
|
| "schemas": {
|
| + "DimensionFilter": {
|
| + "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"
|
| + },
|
| + "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "SegmentDimensionFilter": {
|
| "description": "Dimension filter specifies the filtering options on a dimension.",
|
| "id": "SegmentDimensionFilter",
|
| @@ -155,10 +209,6 @@
|
| "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"
|
| - },
|
| "operator": {
|
| "description": "The operator to use to match the dimension with the expressions.",
|
| "enum": [
|
| @@ -187,6 +237,10 @@
|
| ],
|
| "type": "string"
|
| },
|
| + "dimensionName": {
|
| + "description": "Name of the dimension for which the filter is being applied.",
|
| + "type": "string"
|
| + },
|
| "expressions": {
|
| "description": "The list of expressions, only the first element is used for all operators",
|
| "items": {
|
| @@ -265,13 +319,6 @@
|
| "description": "A segment sequence definition.",
|
| "id": "SegmentSequenceStep",
|
| "properties": {
|
| - "orFiltersForSegment": {
|
| - "description": "A sequence is specified with a list of Or grouped filters which are\ncombined with `AND` operator.",
|
| - "items": {
|
| - "$ref": "OrFiltersForSegment"
|
| - },
|
| - "type": "array"
|
| - },
|
| "matchType": {
|
| "description": "Specifies if the step immediately precedes or can be any time before the\nnext step.",
|
| "enum": [
|
| @@ -285,6 +332,13 @@
|
| "Operator indicates that the previous step immediately precedes the next\nstep."
|
| ],
|
| "type": "string"
|
| + },
|
| + "orFiltersForSegment": {
|
| + "description": "A sequence is specified with a list of Or grouped filters which are\ncombined with `AND` operator.",
|
| + "items": {
|
| + "$ref": "OrFiltersForSegment"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -293,6 +347,10 @@
|
| "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
|
| "id": "Metric",
|
| "properties": {
|
| + "expression": {
|
| + "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
|
| + "type": "string"
|
| + },
|
| "formattingType": {
|
| "description": "Specifies how the metric expression should be formatted, for example\n`INTEGER`.",
|
| "enum": [
|
| @@ -316,10 +374,6 @@
|
| "alias": {
|
| "description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.",
|
| "type": "string"
|
| - },
|
| - "expression": {
|
| - "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -342,6 +396,10 @@
|
| "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"
|
| @@ -349,10 +407,6 @@
|
| "data": {
|
| "$ref": "ReportData",
|
| "description": "Response data."
|
| - },
|
| - "columnHeader": {
|
| - "$ref": "ColumnHeader",
|
| - "description": "The column headers."
|
| }
|
| },
|
| "type": "object"
|
| @@ -361,17 +415,17 @@
|
| "description": "The headers for each of the pivot sections defined in the request.",
|
| "id": "PivotHeader",
|
| "properties": {
|
| + "totalPivotGroupsCount": {
|
| + "description": "The total number of groups for this pivot.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| "pivotHeaderEntries": {
|
| "description": "A single pivot section header.",
|
| "items": {
|
| "$ref": "PivotHeaderEntry"
|
| },
|
| "type": "array"
|
| - },
|
| - "totalPivotGroupsCount": {
|
| - "description": "The total number of groups for this pivot.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -380,12 +434,49 @@
|
| "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MetricFilter": {
|
| + "description": "MetricFilter specifies the filter on a metric.",
|
| + "id": "MetricFilter",
|
| + "properties": {
|
| + "comparisonValue": {
|
| + "description": "The value to compare against.",
|
| + "type": "string"
|
| },
|
| - "endDate": {
|
| - "description": "The end date for the query in the format `YYYY-MM-DD`.",
|
| + "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": [
|
| + "OPERATOR_UNSPECIFIED",
|
| + "EQUAL",
|
| + "LESS_THAN",
|
| + "GREATER_THAN",
|
| + "IS_MISSING"
|
| + ],
|
| + "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."
|
| + ],
|
| + "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"
|
| + },
|
| + "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"
|
| }
|
| },
|
| @@ -395,18 +486,6 @@
|
| "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": {
|
| @@ -458,10 +537,6 @@
|
| },
|
| "type": "array"
|
| },
|
| - "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"
|
| - },
|
| "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": {
|
| @@ -469,6 +544,10 @@
|
| },
|
| "type": "array"
|
| },
|
| + "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"
|
| + },
|
| "pivots": {
|
| "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
|
| "items": {
|
| @@ -492,49 +571,24 @@
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "hideTotals": {
|
| - "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
|
| - "type": "boolean"
|
| - },
|
| "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"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "MetricFilter": {
|
| - "description": "MetricFilter specifies the filter on a metric.",
|
| - "id": "MetricFilter",
|
| - "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.",
|
| - "enum": [
|
| - "OPERATOR_UNSPECIFIED",
|
| - "EQUAL",
|
| - "LESS_THAN",
|
| - "GREATER_THAN",
|
| - "IS_MISSING"
|
| - ],
|
| - "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."
|
| - ],
|
| - "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.",
|
| + "hideTotals": {
|
| + "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
|
| "type": "boolean"
|
| },
|
| - "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.",
|
| + "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"
|
| },
|
| - "comparisonValue": {
|
| - "description": "The value to compare against.",
|
| + "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"
|
| }
|
| },
|
| @@ -553,27 +607,8 @@
|
| "type": "array"
|
| },
|
| "name": {
|
| - "description": "Name of the dimension to fetch, for example `ga:browser`.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "DynamicSegment": {
|
| - "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
|
| - "id": "DynamicSegment",
|
| - "properties": {
|
| - "sessionSegment": {
|
| - "$ref": "SegmentDefinition",
|
| - "description": "Session Segment to select sessions to include in the segment."
|
| - },
|
| - "name": {
|
| - "description": "The name of the dynamic segment.",
|
| + "description": "Name of the dimension to fetch, for example `ga:browser`.",
|
| "type": "string"
|
| - },
|
| - "userSegment": {
|
| - "$ref": "SegmentDefinition",
|
| - "description": "User Segment to select users to include in the segment."
|
| }
|
| },
|
| "type": "object"
|
| @@ -592,6 +627,25 @@
|
| },
|
| "type": "object"
|
| },
|
| + "DynamicSegment": {
|
| + "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
|
| + "id": "DynamicSegment",
|
| + "properties": {
|
| + "userSegment": {
|
| + "$ref": "SegmentDefinition",
|
| + "description": "User Segment to select users to include in the segment."
|
| + },
|
| + "sessionSegment": {
|
| + "$ref": "SegmentDefinition",
|
| + "description": "Session Segment to select sessions to include in the segment."
|
| + },
|
| + "name": {
|
| + "description": "The name of the dynamic segment.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "ColumnHeader": {
|
| "description": "Column headers.",
|
| "id": "ColumnHeader",
|
| @@ -614,10 +668,6 @@
|
| "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"
|
| @@ -625,34 +675,31 @@
|
| "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",
|
| + "ReportRow": {
|
| + "description": "A row in the report.",
|
| + "id": "ReportRow",
|
| "properties": {
|
| - "filters": {
|
| - "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
|
| + "metrics": {
|
| + "description": "List of metrics for each requested DateRange.",
|
| "items": {
|
| - "$ref": "MetricFilter"
|
| + "$ref": "DateRangeValues"
|
| },
|
| "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"
|
| + "dimensions": {
|
| + "description": "List of requested dimensions.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -661,14 +708,6 @@
|
| "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": {
|
| - "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": [
|
| @@ -680,27 +719,42 @@
|
| "Cohorts that are selected based on first visit date."
|
| ],
|
| "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": "object"
|
| },
|
| - "ReportRow": {
|
| - "description": "A row in the report.",
|
| - "id": "ReportRow",
|
| + "MetricFilterClause": {
|
| + "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
|
| + "id": "MetricFilterClause",
|
| "properties": {
|
| - "metrics": {
|
| - "description": "List of metrics for each requested DateRange.",
|
| + "filters": {
|
| + "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
|
| "items": {
|
| - "$ref": "DateRangeValues"
|
| + "$ref": "MetricFilter"
|
| },
|
| "type": "array"
|
| },
|
| - "dimensions": {
|
| - "description": "List of requested dimensions.",
|
| - "items": {
|
| - "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"
|
| @@ -723,17 +777,17 @@
|
| "description": "The headers for the metrics.",
|
| "id": "MetricHeader",
|
| "properties": {
|
| - "metricHeaderEntries": {
|
| - "description": "Headers for the metrics in the response.",
|
| + "pivotHeaders": {
|
| + "description": "Headers for the pivots in the response.",
|
| "items": {
|
| - "$ref": "MetricHeaderEntry"
|
| + "$ref": "PivotHeader"
|
| },
|
| "type": "array"
|
| },
|
| - "pivotHeaders": {
|
| - "description": "Headers for the pivots in the response.",
|
| + "metricHeaderEntries": {
|
| + "description": "Headers for the metrics in the response.",
|
| "items": {
|
| - "$ref": "PivotHeader"
|
| + "$ref": "MetricHeaderEntry"
|
| },
|
| "type": "array"
|
| }
|
| @@ -786,16 +840,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"
|
| @@ -804,6 +858,14 @@
|
| "description": "Metric filter to be used in a segment filter clause.",
|
| "id": "SegmentMetricFilter",
|
| "properties": {
|
| + "maxComparisonValue": {
|
| + "description": "Max comparison value is only used for `BETWEEN` operator.",
|
| + "type": "string"
|
| + },
|
| + "comparisonValue": {
|
| + "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
|
| + "type": "string"
|
| + },
|
| "operator": {
|
| "description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`.",
|
| "enum": [
|
| @@ -843,14 +905,6 @@
|
| "User scope."
|
| ],
|
| "type": "string"
|
| - },
|
| - "maxComparisonValue": {
|
| - "description": "Max comparison value is only used for `BETWEEN` operator.",
|
| - "type": "string"
|
| - },
|
| - "comparisonValue": {
|
| - "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -912,6 +966,11 @@
|
| "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": {
|
| + "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"
|
| + },
|
| "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",
|
| @@ -937,11 +996,6 @@
|
| "$ref": "Dimension"
|
| },
|
| "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"
|
| @@ -1039,36 +1093,6 @@
|
| "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"
|
| @@ -1096,60 +1120,36 @@
|
| "$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.",
|
| + "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"
|
| },
|
| - "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"
|
| + "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"
|
| },
|
| - "caseSensitive": {
|
| - "description": "Should the match be case sensitive? Default is false.",
|
| - "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"
|
| + },
|
| + "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"
|
|
|
Chromium Code Reviews
Issue 3003493002:
Api-Roll 53: 2017-08-21 (Closed)
