mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-07 03:56:42 +01:00
Update all json files; make some fixes to make it work at all
This commit is contained in:
Sebastian Thiel
@@ -168,6 +168,35 @@
|
||||
"https://www.googleapis.com/auth/analytics.readonly"
|
||||
]
|
||||
},
|
||||
"checkCompatibility": {
|
||||
"description": "This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.",
|
||||
"flatPath": "v1beta/properties/{propertiesId}:checkCompatibility",
|
||||
"httpMethod": "POST",
|
||||
"id": "analyticsdata.properties.checkCompatibility",
|
||||
"parameterOrder": [
|
||||
"property"
|
||||
],
|
||||
"parameters": {
|
||||
"property": {
|
||||
"description": "A Google Analytics GA4 property identifier whose events are tracked. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). `property` should be the same value as in your `runReport` request. Example: properties/1234 Set the Property ID to 0 for compatibility checking on dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.",
|
||||
"location": "path",
|
||||
"pattern": "^properties/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta/{+property}:checkCompatibility",
|
||||
"request": {
|
||||
"$ref": "CheckCompatibilityRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "CheckCompatibilityResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/analytics",
|
||||
"https://www.googleapis.com/auth/analytics.readonly"
|
||||
]
|
||||
},
|
||||
"getMetadata": {
|
||||
"description": "Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.",
|
||||
"flatPath": "v1beta/properties/{propertiesId}/metadata",
|
||||
@@ -284,9 +313,37 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20210329",
|
||||
"revision": "20220303",
|
||||
"rootUrl": "https://analyticsdata.googleapis.com/",
|
||||
"schemas": {
|
||||
"ActiveMetricRestriction": {
|
||||
"description": "A metric actively restricted in creating the report.",
|
||||
"id": "ActiveMetricRestriction",
|
||||
"properties": {
|
||||
"metricName": {
|
||||
"description": "The name of the restricted metric.",
|
||||
"type": "string"
|
||||
},
|
||||
"restrictedMetricTypes": {
|
||||
"description": "The reason for this metric's restriction.",
|
||||
"items": {
|
||||
"enum": [
|
||||
"RESTRICTED_METRIC_TYPE_UNSPECIFIED",
|
||||
"COST_DATA",
|
||||
"REVENUE_DATA"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified type.",
|
||||
"Cost metrics such as `adCost`.",
|
||||
"Revenue metrics such as `purchaseRevenue`."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"BatchRunPivotReportsRequest": {
|
||||
"description": "The batch request containing multiple pivot report requests.",
|
||||
"id": "BatchRunPivotReportsRequest",
|
||||
@@ -377,6 +434,70 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CheckCompatibilityRequest": {
|
||||
"description": "The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the `runReport` request should be the same values as in your `runReport` request.",
|
||||
"id": "CheckCompatibilityRequest",
|
||||
"properties": {
|
||||
"compatibilityFilter": {
|
||||
"description": "Filters the dimensions and metrics in the response to just this compatibility. Commonly used as `\u201dcompatibilityFilter\u201d: \u201cCOMPATIBLE\u201d` to only return compatible dimensions & metrics.",
|
||||
"enum": [
|
||||
"COMPATIBILITY_UNSPECIFIED",
|
||||
"COMPATIBLE",
|
||||
"INCOMPATIBLE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified compatibility.",
|
||||
"The dimension or metric is compatible. This dimension or metric can be successfully added to a report.",
|
||||
"The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"dimensionFilter": {
|
||||
"$ref": "FilterExpression",
|
||||
"description": "The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request."
|
||||
},
|
||||
"dimensions": {
|
||||
"description": "The dimensions in this report. `dimensions` should be the same value as in your `runReport` request.",
|
||||
"items": {
|
||||
"$ref": "Dimension"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"metricFilter": {
|
||||
"$ref": "FilterExpression",
|
||||
"description": "The filter clause of metrics. `metricFilter` should be the same value as in your `runReport` request"
|
||||
},
|
||||
"metrics": {
|
||||
"description": "The metrics in this report. `metrics` should be the same value as in your `runReport` request.",
|
||||
"items": {
|
||||
"$ref": "Metric"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CheckCompatibilityResponse": {
|
||||
"description": "The compatibility response with the compatibility of each dimension & metric.",
|
||||
"id": "CheckCompatibilityResponse",
|
||||
"properties": {
|
||||
"dimensionCompatibilities": {
|
||||
"description": "The compatibility of each dimension.",
|
||||
"items": {
|
||||
"$ref": "DimensionCompatibility"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"metricCompatibilities": {
|
||||
"description": "The compatibility of each metric.",
|
||||
"items": {
|
||||
"$ref": "MetricCompatibility"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Cohort": {
|
||||
"description": "Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same `firstSessionDate` belong to the same cohort.",
|
||||
"id": "Cohort",
|
||||
@@ -500,7 +621,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Dimension": {
|
||||
"description": "Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be \"Paris\" or \"New York\". Requests are allowed up to 8 dimensions.",
|
||||
"description": "Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be \"Paris\" or \"New York\". Requests are allowed up to 9 dimensions.",
|
||||
"id": "Dimension",
|
||||
"properties": {
|
||||
"dimensionExpression": {
|
||||
@@ -508,12 +629,37 @@
|
||||
"description": "One dimension can be the result of an expression of multiple dimensions. For example, dimension \"country, city\": concatenate(country, \", \", city)."
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression \"^[a-zA-Z0-9_]$\". Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.",
|
||||
"description": "The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DimensionCompatibility": {
|
||||
"description": "The compatibility for a single dimension.",
|
||||
"id": "DimensionCompatibility",
|
||||
"properties": {
|
||||
"compatibility": {
|
||||
"description": "The compatibility of this dimension. If the compatibility is COMPATIBLE, this dimension can be successfully added to the report.",
|
||||
"enum": [
|
||||
"COMPATIBILITY_UNSPECIFIED",
|
||||
"COMPATIBLE",
|
||||
"INCOMPATIBLE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified compatibility.",
|
||||
"The dimension or metric is compatible. This dimension or metric can be successfully added to a report.",
|
||||
"The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"dimensionMetadata": {
|
||||
"$ref": "DimensionMetadata",
|
||||
"description": "The dimension metadata contains the API name for this compatibility information. The dimension metadata also contains other helpful information like the UI name and description."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DimensionExpression": {
|
||||
"description": "Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2).",
|
||||
"id": "DimensionExpression",
|
||||
@@ -552,6 +698,10 @@
|
||||
"description": "This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`.",
|
||||
"type": "string"
|
||||
},
|
||||
"category": {
|
||||
"description": "The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.",
|
||||
"type": "string"
|
||||
},
|
||||
"customDefinition": {
|
||||
"description": "True if the dimension is a custom dimension for this property.",
|
||||
"type": "boolean"
|
||||
@@ -649,7 +799,7 @@
|
||||
},
|
||||
"filter": {
|
||||
"$ref": "Filter",
|
||||
"description": "A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics."
|
||||
"description": "A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics."
|
||||
},
|
||||
"notExpression": {
|
||||
"$ref": "FilterExpression",
|
||||
@@ -732,12 +882,37 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression \"^[a-zA-Z0-9_]$\". Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.",
|
||||
"description": "The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MetricCompatibility": {
|
||||
"description": "The compatibility for a single metric.",
|
||||
"id": "MetricCompatibility",
|
||||
"properties": {
|
||||
"compatibility": {
|
||||
"description": "The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added to the report.",
|
||||
"enum": [
|
||||
"COMPATIBILITY_UNSPECIFIED",
|
||||
"COMPATIBLE",
|
||||
"INCOMPATIBLE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified compatibility.",
|
||||
"The dimension or metric is compatible. This dimension or metric can be successfully added to a report.",
|
||||
"The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"metricMetadata": {
|
||||
"$ref": "MetricMetadata",
|
||||
"description": "The metric metadata contains the API name for this compatibility information. The metric metadata also contains other helpful information like the UI name and description."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MetricHeader": {
|
||||
"description": "Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.",
|
||||
"id": "MetricHeader",
|
||||
@@ -791,6 +966,27 @@
|
||||
"description": "A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.",
|
||||
"type": "string"
|
||||
},
|
||||
"blockedReasons": {
|
||||
"description": "If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).",
|
||||
"items": {
|
||||
"enum": [
|
||||
"BLOCKED_REASON_UNSPECIFIED",
|
||||
"NO_REVENUE_METRICS",
|
||||
"NO_COST_METRICS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Will never be specified in API response.",
|
||||
"If present, your access is blocked to revenue related metrics for this property, and this metric is revenue related.",
|
||||
"If present, your access is blocked to cost related metrics for this property, and this metric is cost related."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"category": {
|
||||
"description": "The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.",
|
||||
"type": "string"
|
||||
},
|
||||
"customDefinition": {
|
||||
"description": "True if the metric is a custom metric for this property.",
|
||||
"type": "boolean"
|
||||
@@ -873,6 +1069,27 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MinuteRange": {
|
||||
"description": "A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Requests are allowed up to 2 minute ranges.",
|
||||
"id": "MinuteRange",
|
||||
"properties": {
|
||||
"endMinutesAgo": {
|
||||
"description": "The inclusive end minute for the query as a number of minutes before now. Cannot be before `startMinutesAgo`. For example, `\"endMinutesAgo\": 15` specifies the report should include event data from prior to 15 minutes ago. If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics properties can request any minute in the last 30 minutes of event data (`endMinutesAgo <= 29`), and 360 Analytics properties can request any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"name": {
|
||||
"description": "Assigns a name to this minute range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, minute ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.",
|
||||
"type": "string"
|
||||
},
|
||||
"startMinutesAgo": {
|
||||
"description": "The inclusive start minute for the query as a number of minutes before now. For example, `\"startMinutesAgo\": 29` specifies the report should include event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics properties can request up to the last 30 minutes of event data (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to the last 60 minutes of event data (`startMinutesAgo <= 59`).",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"NumericFilter": {
|
||||
"description": "Filters for numeric or date values.",
|
||||
"id": "NumericFilter",
|
||||
@@ -1110,9 +1327,29 @@
|
||||
"description": "Response's metadata carrying additional information about the report content.",
|
||||
"id": "ResponseMetaData",
|
||||
"properties": {
|
||||
"currencyCode": {
|
||||
"description": "The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example \"USD\", \"EUR\", \"JPY\". To learn more, see https://support.google.com/analytics/answer/9796179.",
|
||||
"type": "string"
|
||||
},
|
||||
"dataLossFromOtherRow": {
|
||||
"description": "If true, indicates some buckets of dimension combinations are rolled into \"(other)\" row. This can happen for high cardinality reports.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"emptyReason": {
|
||||
"description": "If empty reason is specified, the report is empty for this reason.",
|
||||
"type": "string"
|
||||
},
|
||||
"schemaRestrictionResponse": {
|
||||
"$ref": "SchemaRestrictionResponse",
|
||||
"description": "Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388)."
|
||||
},
|
||||
"subjectToThresholding": {
|
||||
"description": "If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357).",
|
||||
"type": "boolean"
|
||||
},
|
||||
"timeZone": {
|
||||
"description": "The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example \"America/New_York\" or \"Asia/Tokyo\".",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1307,6 +1544,13 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"minuteRanges": {
|
||||
"description": "The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.",
|
||||
"items": {
|
||||
"$ref": "MinuteRange"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"orderBys": {
|
||||
"description": "Specifies how rows are ordered in the response.",
|
||||
"items": {
|
||||
@@ -1404,7 +1648,7 @@
|
||||
},
|
||||
"dimensionFilter": {
|
||||
"$ref": "FilterExpression",
|
||||
"description": "The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter."
|
||||
"description": "Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter."
|
||||
},
|
||||
"dimensions": {
|
||||
"description": "The dimensions requested and displayed.",
|
||||
@@ -1445,7 +1689,7 @@
|
||||
},
|
||||
"metricFilter": {
|
||||
"$ref": "FilterExpression",
|
||||
"description": "The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter."
|
||||
"description": "The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter."
|
||||
},
|
||||
"metrics": {
|
||||
"description": "The metrics requested and displayed.",
|
||||
@@ -1543,6 +1787,20 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SchemaRestrictionResponse": {
|
||||
"description": "The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).",
|
||||
"id": "SchemaRestrictionResponse",
|
||||
"properties": {
|
||||
"activeMetricRestrictions": {
|
||||
"description": "All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this active response restriction is only populated if the user's custom role disallows access to `REVENUE_DATA`.",
|
||||
"items": {
|
||||
"$ref": "ActiveMetricRestriction"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"StringFilter": {
|
||||
"description": "The filter for string",
|
||||
"id": "StringFilter",
|
||||
@@ -1568,8 +1826,8 @@
|
||||
"Begins with the string value.",
|
||||
"Ends with the string value.",
|
||||
"Contains the string value.",
|
||||
"Full regular expression match with the string value.",
|
||||
"Partial regular expression match with the string value."
|
||||
"Full match for the regular expression with the string value.",
|
||||
"Partial match for the regular expression with the string value."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user