docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/analyticsdata_v1alpha.properties.html b/docs/dyn/analyticsdata_v1alpha.properties.html
index 36fbcf3..3b46373 100644
--- a/docs/dyn/analyticsdata_v1alpha.properties.html
+++ b/docs/dyn/analyticsdata_v1alpha.properties.html
@@ -106,29 +106,29 @@
{ # The dimensions and metrics currently accepted in reporting methods.
"dimensions": [ # The dimension descriptions.
{ # Explains a dimension.
- "apiName": "A String", # This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`.
"deprecatedApiNames": [ # Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension will be available only by `apiName`.
"A String",
],
- "description": "A String", # Description of how this dimension is used and calculated.
- "uiName": "A String", # This dimension's name within the Google Analytics user interface. For example, `Event name`.
"customDefinition": True or False, # True if the dimension is a custom dimension for this property.
+ "description": "A String", # Description of how this dimension is used and calculated.
+ "apiName": "A String", # This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`.
+ "uiName": "A String", # This dimension's name within the Google Analytics user interface. For example, `Event name`.
},
],
- "name": "A String", # Resource name of this metadata.
"metrics": [ # The metric descriptions.
{ # Explains a metric.
- "customDefinition": True or False, # True if the metric is a custom metric for this property.
- "expression": "A String", # The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.
+ "apiName": "A String", # A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.
+ "uiName": "A String", # This metric's name within the Google Analytics user interface. For example, `Event count`.
+ "type": "A String", # The type of this metric.
"description": "A String", # Description of how this metric is used and calculated.
"deprecatedApiNames": [ # Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`.
"A String",
],
- "type": "A String", # The type of this metric.
- "apiName": "A String", # A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.
- "uiName": "A String", # This metric's name within the Google Analytics user interface. For example, `Event count`.
+ "expression": "A String", # The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.
+ "customDefinition": True or False, # True if the metric is a custom metric for this property.
},
],
+ "name": "A String", # Resource name of this metadata.
}</pre>
</div>
@@ -142,89 +142,44 @@
The object takes the form of:
{ # The request to generate a realtime report.
- "metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # 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.
- "notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.
- "orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.
- "expressions": [ # A list of filter expressions.
- # Object with schema name: FilterExpression
- ],
- },
- "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.
- "inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.
- "caseSensitive": True or False, # If true, the string value is case sensitive.
- "values": [ # The list of string values. Must be non-empty.
- "A String",
- ],
- },
- "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
- "toValue": { # To represent a number. # Ends with this number.
- "int64Value": "A String", # Integer value
- "doubleValue": 3.14, # Double value
- },
- "fromValue": { # To represent a number. # Begins with this number.
- "int64Value": "A String", # Integer value
- "doubleValue": 3.14, # Double value
- },
- },
- "stringFilter": { # The filter for string # Strings related filter.
- "value": "A String", # The string value used for the matching.
- "matchType": "A String", # The match type for this filter.
- "caseSensitive": True or False, # If true, the string value is case sensitive.
- },
- "fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.
- "numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.
- "operation": "A String", # The operation type for this filter.
- "value": { # To represent a number. # A numeric value or a date value.
- "int64Value": "A String", # Integer value
- "doubleValue": 3.14, # Double value
- },
- },
- "nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.
- },
- "andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.
- "expressions": [ # A list of filter expressions.
- # Object with schema name: FilterExpression
- ],
- },
- },
"dimensionFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
"notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.
- "orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.
- "expressions": [ # A list of filter expressions.
- # Object with schema name: FilterExpression
- ],
- },
"filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.
+ "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
+ "fromValue": { # To represent a number. # Begins with this number.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ "toValue": { # To represent a number. # Ends with this number.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ },
+ "numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.
+ "value": { # To represent a number. # A numeric value or a date value.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ "operation": "A String", # The operation type for this filter.
+ },
+ "nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.
+ "stringFilter": { # The filter for string # Strings related filter.
+ "caseSensitive": True or False, # If true, the string value is case sensitive.
+ "value": "A String", # The string value used for the matching.
+ "matchType": "A String", # The match type for this filter.
+ },
"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.
"caseSensitive": True or False, # If true, the string value is case sensitive.
"values": [ # The list of string values. Must be non-empty.
"A String",
],
},
- "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
- "toValue": { # To represent a number. # Ends with this number.
- "int64Value": "A String", # Integer value
- "doubleValue": 3.14, # Double value
- },
- "fromValue": { # To represent a number. # Begins with this number.
- "int64Value": "A String", # Integer value
- "doubleValue": 3.14, # Double value
- },
- },
- "stringFilter": { # The filter for string # Strings related filter.
- "value": "A String", # The string value used for the matching.
- "matchType": "A String", # The match type for this filter.
- "caseSensitive": True or False, # If true, the string value is case sensitive.
- },
"fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.
- "numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.
- "operation": "A String", # The operation type for this filter.
- "value": { # To represent a number. # A numeric value or a date value.
- "int64Value": "A String", # Integer value
- "doubleValue": 3.14, # Double value
- },
- },
- "nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.
+ },
+ "orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.
+ "expressions": [ # A list of filter expressions.
+ # Object with schema name: FilterExpression
+ ],
},
"andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.
"expressions": [ # A list of filter expressions.
@@ -232,28 +187,41 @@
],
},
},
+ "dimensions": [ # The dimensions requested and displayed.
+ { # 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.
+ "name": "A String", # The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/trusted-testing/analytics-data/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.
+ "dimensionExpression": { # 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). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).
+ "lowerCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to lower case.
+ "dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.
+ },
+ "upperCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to upper case.
+ "dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.
+ },
+ "concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city).
+ "dimensionNames": [ # Names of dimensions. The names must refer back to names in the dimensions field of the request.
+ "A String",
+ ],
+ "delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP".
+ },
+ },
+ },
+ ],
+ "metrics": [ # The metrics requested and displayed.
+ { # The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.
+ "name": "A String", # The name of the metric. See the [API Metrics](https://developers.google.com/analytics/trusted-testing/analytics-data/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.
+ "expression": "A String", # A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.
+ "invisible": True or False, # Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.
+ },
+ ],
"metricAggregations": [ # Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
"A String",
],
"returnPropertyQuota": True or False, # Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
- "metrics": [ # The metrics requested and displayed.
- { # The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.
- "expression": "A String", # A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.
- "name": "A String", # The name of the metric. See the [API Metrics](https://developers.google.com/analytics/trusted-testing/analytics-data/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.
- "invisible": True or False, # Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.
- },
- ],
- "limit": "A String", # The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.
"orderBys": [ # Specifies how rows are ordered in the response.
{ # The sort options.
"metric": { # Sorts by metric values. # Sorts results by a metric's values.
"metricName": "A String", # A metric name in the request to order by.
},
- "desc": True or False, # If true, sorts by descending order.
- "dimension": { # Sorts by dimension values. # Sorts results by a dimension's values.
- "orderType": "A String", # Controls the rule for dimension value ordering.
- "dimensionName": "A String", # A dimension name in the request to order by.
- },
"pivot": { # Sorts by a pivot column group. # Sorts results by a metric's values within a pivot column group.
"metricName": "A String", # In the response to order by, order rows by this column. Must be a metric name from the request.
"pivotSelections": [ # Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.
@@ -263,27 +231,59 @@
},
],
},
- },
- ],
- "dimensions": [ # The dimensions requested and displayed.
- { # 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.
- "name": "A String", # The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/trusted-testing/analytics-data/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.
- "dimensionExpression": { # 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). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).
- "concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city).
- "dimensionNames": [ # Names of dimensions. The names must refer back to names in the dimensions field of the request.
- "A String",
- ],
- "delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP".
- },
- "lowerCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to lower case.
- "dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.
- },
- "upperCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to upper case.
- "dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.
- },
+ "desc": True or False, # If true, sorts by descending order.
+ "dimension": { # Sorts by dimension values. # Sorts results by a dimension's values.
+ "dimensionName": "A String", # A dimension name in the request to order by.
+ "orderType": "A String", # Controls the rule for dimension value ordering.
},
},
],
+ "metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # 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.
+ "notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.
+ "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.
+ "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
+ "fromValue": { # To represent a number. # Begins with this number.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ "toValue": { # To represent a number. # Ends with this number.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ },
+ "numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.
+ "value": { # To represent a number. # A numeric value or a date value.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ "operation": "A String", # The operation type for this filter.
+ },
+ "nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.
+ "stringFilter": { # The filter for string # Strings related filter.
+ "caseSensitive": True or False, # If true, the string value is case sensitive.
+ "value": "A String", # The string value used for the matching.
+ "matchType": "A String", # The match type for this filter.
+ },
+ "inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.
+ "caseSensitive": True or False, # If true, the string value is case sensitive.
+ "values": [ # The list of string values. Must be non-empty.
+ "A String",
+ ],
+ },
+ "fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.
+ },
+ "orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.
+ "expressions": [ # A list of filter expressions.
+ # Object with schema name: FilterExpression
+ ],
+ },
+ "andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.
+ "expressions": [ # A list of filter expressions.
+ # Object with schema name: FilterExpression
+ ],
+ },
+ },
+ "limit": "A String", # The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.
}
x__xgafv: string, V1 error format.
@@ -295,60 +295,17 @@
An object of the form:
{ # The response realtime report table corresponding to a request.
- "rowCount": 42, # The total number of rows in the query result, regardless of the number of rows returned in the response. For example if a query returns 175 rows and includes limit = 50 in the API request, the response will contain row_count = 175 but only 50 rows.
- "minimums": [ # If requested, the minimum values of metrics.
- { # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```
- "dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
- { # The value of a dimension.
- "value": "A String", # Value as a string if the dimension type is a string.
- },
- ],
- "metricValues": [ # List of requested visible metric values.
- { # The value of a metric.
- "value": "A String", # Measurement value. See MetricHeader for type.
- },
- ],
- },
- ],
- "rows": [ # Rows of dimension value combinations and metric values in the report.
- { # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```
- "dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
- { # The value of a dimension.
- "value": "A String", # Value as a string if the dimension type is a string.
- },
- ],
- "metricValues": [ # List of requested visible metric values.
- { # The value of a metric.
- "value": "A String", # Measurement value. See MetricHeader for type.
- },
- ],
- },
- ],
"dimensionHeaders": [ # Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
{ # Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.
"name": "A String", # The dimension's name.
},
],
- "maximums": [ # If requested, the maximum values of metrics.
- { # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```
- "dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
- { # The value of a dimension.
- "value": "A String", # Value as a string if the dimension type is a string.
- },
- ],
- "metricValues": [ # List of requested visible metric values.
- { # The value of a metric.
- "value": "A String", # Measurement value. See MetricHeader for type.
- },
- ],
- },
- ],
"propertyQuota": { # Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. # This Analytics Property's Realtime quota state including this request.
"tokensPerHour": { # Current state for a particular quota group. # Standard Analytics Properties can use up to 5,000 tokens per day; Analytics 360 Properties can use 50,000 tokens per day. An API request consumes a single number of tokens, and that number is deducted from both the hourly and daily quotas.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
- "tokensPerDay": { # Current state for a particular quota group. # Standard Analytics Properties can use up to 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.
+ "concurrentRequests": { # Current state for a particular quota group. # Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
@@ -356,29 +313,72 @@
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
- "concurrentRequests": { # Current state for a particular quota group. # Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests.
+ "tokensPerDay": { # Current state for a particular quota group. # Standard Analytics Properties can use up to 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
},
- "totals": [ # If requested, the totaled values of metrics.
+ "rows": [ # Rows of dimension value combinations and metric values in the report.
{ # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```
- "dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
- { # The value of a dimension.
- "value": "A String", # Value as a string if the dimension type is a string.
- },
- ],
"metricValues": [ # List of requested visible metric values.
{ # The value of a metric.
"value": "A String", # Measurement value. See MetricHeader for type.
},
],
+ "dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
+ { # The value of a dimension.
+ "value": "A String", # Value as a string if the dimension type is a string.
+ },
+ ],
},
],
+ "minimums": [ # If requested, the minimum values of metrics.
+ { # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```
+ "metricValues": [ # List of requested visible metric values.
+ { # The value of a metric.
+ "value": "A String", # Measurement value. See MetricHeader for type.
+ },
+ ],
+ "dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
+ { # The value of a dimension.
+ "value": "A String", # Value as a string if the dimension type is a string.
+ },
+ ],
+ },
+ ],
+ "rowCount": 42, # The total number of rows in the query result, regardless of the number of rows returned in the response. For example if a query returns 175 rows and includes limit = 50 in the API request, the response will contain row_count = 175 but only 50 rows.
"metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
{ # 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.
- "type": "A String", # The metric's data type.
"name": "A String", # The metric's name.
+ "type": "A String", # The metric's data type.
+ },
+ ],
+ "totals": [ # If requested, the totaled values of metrics.
+ { # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```
+ "metricValues": [ # List of requested visible metric values.
+ { # The value of a metric.
+ "value": "A String", # Measurement value. See MetricHeader for type.
+ },
+ ],
+ "dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
+ { # The value of a dimension.
+ "value": "A String", # Value as a string if the dimension type is a string.
+ },
+ ],
+ },
+ ],
+ "maximums": [ # If requested, the maximum values of metrics.
+ { # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```
+ "metricValues": [ # List of requested visible metric values.
+ { # The value of a metric.
+ "value": "A String", # Measurement value. See MetricHeader for type.
+ },
+ ],
+ "dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.
+ { # The value of a dimension.
+ "value": "A String", # Value as a string if the dimension type is a string.
+ },
+ ],
},
],
}</pre>