feat(analyticsdata): update the API

#### analyticsdata:v1alpha The following keys were added: - resources.properties.methods.runRealtimeReport.description - resources.properties.methods.runRealtimeReport.flatPath - resources.properties.methods.runRealtimeReport.httpMethod - resources.properties.methods.runRealtimeReport.id - resources.properties.methods.runRealtimeReport.parameterOrder - resources.properties.methods.runRealtimeReport.parameters.property.description - resources.properties.methods.runRealtimeReport.parameters.property.location - resources.properties.methods.runRealtimeReport.parameters.property.pattern - resources.properties.methods.runRealtimeReport.parameters.property.required - resources.properties.methods.runRealtimeReport.parameters.property.type - resources.properties.methods.runRealtimeReport.path - resources.properties.methods.runRealtimeReport.request.$ref - resources.properties.methods.runRealtimeReport.response.$ref - resources.properties.methods.runRealtimeReport.scopes - schemas.RunRealtimeReportRequest.description - schemas.RunRealtimeReportRequest.id - schemas.RunRealtimeReportRequest.properties.dimensionFilter.$ref - schemas.RunRealtimeReportRequest.properties.dimensionFilter.description - schemas.RunRealtimeReportRequest.properties.dimensions.description - schemas.RunRealtimeReportRequest.properties.dimensions.items.$ref - schemas.RunRealtimeReportRequest.properties.dimensions.type - schemas.RunRealtimeReportRequest.properties.limit.description - schemas.RunRealtimeReportRequest.properties.limit.format - schemas.RunRealtimeReportRequest.properties.limit.type - schemas.RunRealtimeReportRequest.properties.metricAggregations.description - schemas.RunRealtimeReportRequest.properties.metricAggregations.items.enum - schemas.RunRealtimeReportRequest.properties.metricAggregations.items.enumDescriptions - schemas.RunRealtimeReportRequest.properties.metricAggregations.items.type - schemas.RunRealtimeReportRequest.properties.metricAggregations.type - schemas.RunRealtimeReportRequest.properties.metricFilter.$ref - schemas.RunRealtimeReportRequest.properties.metricFilter.description - schemas.RunRealtimeReportRequest.properties.metrics.description - schemas.RunRealtimeReportRequest.properties.metrics.items.$ref - schemas.RunRealtimeReportRequest.properties.metrics.type - schemas.RunRealtimeReportRequest.properties.orderBys.description - schemas.RunRealtimeReportRequest.properties.orderBys.items.$ref - schemas.RunRealtimeReportRequest.properties.orderBys.type - schemas.RunRealtimeReportRequest.properties.returnPropertyQuota.description - schemas.RunRealtimeReportRequest.properties.returnPropertyQuota.type - schemas.RunRealtimeReportRequest.type - schemas.RunRealtimeReportResponse.description - schemas.RunRealtimeReportResponse.id - schemas.RunRealtimeReportResponse.properties.dimensionHeaders.description - schemas.RunRealtimeReportResponse.properties.dimensionHeaders.items.$ref - schemas.RunRealtimeReportResponse.properties.dimensionHeaders.type - schemas.RunRealtimeReportResponse.properties.maximums.description - schemas.RunRealtimeReportResponse.properties.maximums.items.$ref - schemas.RunRealtimeReportResponse.properties.maximums.type - schemas.RunRealtimeReportResponse.properties.metricHeaders.description - schemas.RunRealtimeReportResponse.properties.metricHeaders.items.$ref - schemas.RunRealtimeReportResponse.properties.metricHeaders.type - schemas.RunRealtimeReportResponse.properties.minimums.description - schemas.RunRealtimeReportResponse.properties.minimums.items.$ref - schemas.RunRealtimeReportResponse.properties.minimums.type - schemas.RunRealtimeReportResponse.properties.propertyQuota.$ref - schemas.RunRealtimeReportResponse.properties.propertyQuota.description - schemas.RunRealtimeReportResponse.properties.rowCount.description - schemas.RunRealtimeReportResponse.properties.rowCount.format - schemas.RunRealtimeReportResponse.properties.rowCount.type - schemas.RunRealtimeReportResponse.properties.rows.description - schemas.RunRealtimeReportResponse.properties.rows.items.$ref - schemas.RunRealtimeReportResponse.properties.rows.type - schemas.RunRealtimeReportResponse.properties.totals.description - schemas.RunRealtimeReportResponse.properties.totals.items.$ref - schemas.RunRealtimeReportResponse.properties.totals.type - schemas.RunRealtimeReportResponse.type The following keys were changed: - schemas.Filter.properties.nullFilter.description - schemas.PropertyQuota.properties.concurrentRequests.description - schemas.PropertyQuota.properties.serverErrorsPerProjectPerHour.description - schemas.PropertyQuota.properties.tokensPerDay.description - schemas.PropertyQuota.properties.tokensPerHour.description - schemas.Row.description
googleapis · Nov 3, 2020 · ed11aea · ed11aea
1 parent 4dcabfe
commit ed11aea
Show file tree

Hide file tree

Showing 2 changed files with 414 additions and 13 deletions.
diff --git a/discovery/analyticsdata-v1alpha.json b/discovery/analyticsdata-v1alpha.json
@@ -135,6 +135,35 @@
             "https://www.googleapis.com/auth/analytics",
             "https://www.googleapis.com/auth/analytics.readonly"
           ]
+        },
+        "runRealtimeReport": {
+          "description": "The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.",
+          "flatPath": "v1alpha/properties/{propertiesId}:runRealtimeReport",
+          "httpMethod": "POST",
+          "id": "analyticsdata.properties.runRealtimeReport",
+          "parameterOrder": [
+            "property"
+          ],
+          "parameters": {
+            "property": {
+              "description": "A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id). Example: properties/1234",
+              "location": "path",
+              "pattern": "^properties/[^/]+$",
+              "required": true,
+              "type": "string"
+            }
+          },
+          "path": "v1alpha/{+property}:runRealtimeReport",
+          "request": {
+            "$ref": "RunRealtimeReportRequest"
+          },
+          "response": {
+            "$ref": "RunRealtimeReportResponse"
+          },
+          "scopes": [
+            "https://www.googleapis.com/auth/analytics",
+            "https://www.googleapis.com/auth/analytics.readonly"
+          ]
         }
       }
     },
@@ -235,7 +264,7 @@
       }
     }
   },
-  "revision": "20201024",
+  "revision": "20201030",
   "rootUrl": "https://analyticsdata.googleapis.com/",
   "schemas": {
     "BatchRunPivotReportsRequest": {
@@ -587,7 +616,7 @@
           "description": "A filter for in list values."
         },
         "nullFilter": {
-          "description": "A filter for null values.",
+          "description": "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.",
           "type": "boolean"
         },
         "numericFilter": {
@@ -1026,19 +1055,19 @@
       "properties": {
         "concurrentRequests": {
           "$ref": "QuotaStatus",
-          "description": "Analytics Properties can send up to 10 concurrent requests."
+          "description": "Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests."
         },
         "serverErrorsPerProjectPerHour": {
           "$ref": "QuotaStatus",
-          "description": "Analytics Properties and cloud project pairs can have up to 10 server errors per hour."
+          "description": "Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics 360 Properties and cloud project pairs can have up to 50 server errors per hour."
         },
         "tokensPerDay": {
           "$ref": "QuotaStatus",
-          "description": "Analytics Properties can use up to 25,000 tokens per day. Most requests consume fewer than 10 tokens."
+          "description": "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."
         },
         "tokensPerHour": {
           "$ref": "QuotaStatus",
-          "description": "Analytics Properties can use up to 5,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."
+          "description": "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."
         }
       },
       "type": "object"
@@ -1072,7 +1101,7 @@
       "type": "object"
     },
     "Row": {
-      "description": "Report data for each row. For example if RunReportRequest contains: ```none dimensions { name: \"eventName\" } dimensions { name: \"countryId\" } metrics { name: \"eventCount\" } ``` One row with 'in_app_purchase' as the eventName, 'us' as the countryId, and 15 as the eventCount, would be: ```none dimension_values { name: 'in_app_purchase' name: 'us' } metric_values { int64_value: 15 } ```",
+      "description": "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\" } ] ```",
       "id": "Row",
       "properties": {
         "dimensionValues": {
@@ -1205,6 +1234,130 @@
       },
       "type": "object"
     },
+    "RunRealtimeReportRequest": {
+      "description": "The request to generate a realtime report.",
+      "id": "RunRealtimeReportRequest",
+      "properties": {
+        "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."
+        },
+        "dimensions": {
+          "description": "The dimensions requested and displayed.",
+          "items": {
+            "$ref": "Dimension"
+          },
+          "type": "array"
+        },
+        "limit": {
+          "description": "The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.",
+          "format": "int64",
+          "type": "string"
+        },
+        "metricAggregations": {
+          "description": "Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to \"RESERVED_(MetricAggregation)\".",
+          "items": {
+            "enum": [
+              "METRIC_AGGREGATION_UNSPECIFIED",
+              "TOTAL",
+              "MINIMUM",
+              "MAXIMUM",
+              "COUNT"
+            ],
+            "enumDescriptions": [
+              "Unspecified operator.",
+              "SUM operator.",
+              "Minimum operator.",
+              "Maximum operator.",
+              "Count operator."
+            ],
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "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."
+        },
+        "metrics": {
+          "description": "The metrics requested and displayed.",
+          "items": {
+            "$ref": "Metric"
+          },
+          "type": "array"
+        },
+        "orderBys": {
+          "description": "Specifies how rows are ordered in the response.",
+          "items": {
+            "$ref": "OrderBy"
+          },
+          "type": "array"
+        },
+        "returnPropertyQuota": {
+          "description": "Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).",
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "RunRealtimeReportResponse": {
+      "description": "The response realtime report table corresponding to a request.",
+      "id": "RunRealtimeReportResponse",
+      "properties": {
+        "dimensionHeaders": {
+          "description": "Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.",
+          "items": {
+            "$ref": "DimensionHeader"
+          },
+          "type": "array"
+        },
+        "maximums": {
+          "description": "If requested, the maximum values of metrics.",
+          "items": {
+            "$ref": "Row"
+          },
+          "type": "array"
+        },
+        "metricHeaders": {
+          "description": "Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.",
+          "items": {
+            "$ref": "MetricHeader"
+          },
+          "type": "array"
+        },
+        "minimums": {
+          "description": "If requested, the minimum values of metrics.",
+          "items": {
+            "$ref": "Row"
+          },
+          "type": "array"
+        },
+        "propertyQuota": {
+          "$ref": "PropertyQuota",
+          "description": "This Analytics Property's Realtime quota state including this request."
+        },
+        "rowCount": {
+          "description": "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.",
+          "format": "int32",
+          "type": "integer"
+        },
+        "rows": {
+          "description": "Rows of dimension value combinations and metric values in the report.",
+          "items": {
+            "$ref": "Row"
+          },
+          "type": "array"
+        },
+        "totals": {
+          "description": "If requested, the totaled values of metrics.",
+          "items": {
+            "$ref": "Row"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
     "RunReportRequest": {
       "description": "The request to generate a report.",
       "id": "RunReportRequest",