Skip to content

Commit 725603f

Browse files
yoshi-automationsofisl
authored andcommitted
fix(analyticsdata): update the API
#### analyticsdata:v1beta The following keys were changed: - resources.properties.methods.batchRunPivotReports.description - resources.properties.methods.batchRunPivotReports.parameters.property.description - resources.properties.methods.batchRunReports.description - resources.properties.methods.batchRunReports.parameters.property.description - resources.properties.methods.checkCompatibility.parameters.property.description - resources.properties.methods.getMetadata.description - resources.properties.methods.getMetadata.parameters.name.description - resources.properties.methods.runPivotReport.parameters.property.description - resources.properties.methods.runRealtimeReport.parameters.property.description - resources.properties.methods.runReport.parameters.property.description - schemas.RunPivotReportRequest.properties.keepEmptyRows.description - schemas.RunPivotReportRequest.properties.property.description - schemas.RunPivotReportRequest.properties.returnPropertyQuota.description - schemas.RunPivotReportResponse.properties.propertyQuota.description - schemas.RunRealtimeReportRequest.properties.returnPropertyQuota.description - schemas.RunRealtimeReportResponse.properties.propertyQuota.description - schemas.RunReportRequest.properties.keepEmptyRows.description - schemas.RunReportRequest.properties.property.description - schemas.RunReportRequest.properties.returnPropertyQuota.description - schemas.RunReportResponse.properties.propertyQuota.description
1 parent 9b434bb commit 725603f

File tree

2 files changed

+41
-41
lines changed

2 files changed

+41
-41
lines changed

discovery/analyticsdata-v1beta.json

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@
111111
"properties": {
112112
"methods": {
113113
"batchRunPivotReports": {
114-
"description": "Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.",
114+
"description": "Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property.",
115115
"flatPath": "v1beta/properties/{propertiesId}:batchRunPivotReports",
116116
"httpMethod": "POST",
117117
"id": "analyticsdata.properties.batchRunPivotReports",
@@ -120,7 +120,7 @@
120120
],
121121
"parameters": {
122122
"property": {
123-
"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/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent with this property. Example: properties/1234",
123+
"description": "A Google Analytics 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/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent with this property. Example: properties/1234",
124124
"location": "path",
125125
"pattern": "^properties/[^/]+$",
126126
"required": true,
@@ -140,7 +140,7 @@
140140
]
141141
},
142142
"batchRunReports": {
143-
"description": "Returns multiple reports in a batch. All reports must be for the same GA4 Property.",
143+
"description": "Returns multiple reports in a batch. All reports must be for the same Google Analytics property.",
144144
"flatPath": "v1beta/properties/{propertiesId}:batchRunReports",
145145
"httpMethod": "POST",
146146
"id": "analyticsdata.properties.batchRunReports",
@@ -149,7 +149,7 @@
149149
],
150150
"parameters": {
151151
"property": {
152-
"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/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunReportRequest may either be unspecified or consistent with this property. Example: properties/1234",
152+
"description": "A Google Analytics 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/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunReportRequest may either be unspecified or consistent with this property. Example: properties/1234",
153153
"location": "path",
154154
"pattern": "^properties/[^/]+$",
155155
"required": true,
@@ -178,7 +178,7 @@
178178
],
179179
"parameters": {
180180
"property": {
181-
"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",
181+
"description": "A Google Analytics 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",
182182
"location": "path",
183183
"pattern": "^properties/[^/]+$",
184184
"required": true,
@@ -198,7 +198,7 @@
198198
]
199199
},
200200
"getMetadata": {
201-
"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`.",
201+
"description": "Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics 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`.",
202202
"flatPath": "v1beta/properties/{propertiesId}/metadata",
203203
"httpMethod": "GET",
204204
"id": "analyticsdata.properties.getMetadata",
@@ -207,7 +207,7 @@
207207
],
208208
"parameters": {
209209
"name": {
210-
"description": "Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.",
210+
"description": "Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.",
211211
"location": "path",
212212
"pattern": "^properties/[^/]+/metadata$",
213213
"required": true,
@@ -233,7 +233,7 @@
233233
],
234234
"parameters": {
235235
"property": {
236-
"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/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234",
236+
"description": "A Google Analytics 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/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234",
237237
"location": "path",
238238
"pattern": "^properties/[^/]+$",
239239
"required": true,
@@ -262,7 +262,7 @@
262262
],
263263
"parameters": {
264264
"property": {
265-
"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/devguides/reporting/data/v1/property-id). Example: properties/1234",
265+
"description": "A Google Analytics 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/devguides/reporting/data/v1/property-id). Example: properties/1234",
266266
"location": "path",
267267
"pattern": "^properties/[^/]+$",
268268
"required": true,
@@ -291,7 +291,7 @@
291291
],
292292
"parameters": {
293293
"property": {
294-
"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/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234",
294+
"description": "A Google Analytics 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/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234",
295295
"location": "path",
296296
"pattern": "^properties/[^/]+$",
297297
"required": true,
@@ -440,7 +440,7 @@
440440
}
441441
}
442442
},
443-
"revision": "20240731",
443+
"revision": "20240825",
444444
"rootUrl": "https://analyticsdata.googleapis.com/",
445445
"schemas": {
446446
"ActiveMetricRestriction": {
@@ -1769,7 +1769,7 @@
17691769
"type": "array"
17701770
},
17711771
"keepEmptyRows": {
1772-
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: \"purchase\" and eventCount: 0.",
1772+
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: \"purchase\" and eventCount: 0.",
17731773
"type": "boolean"
17741774
},
17751775
"metricFilter": {
@@ -1791,11 +1791,11 @@
17911791
"type": "array"
17921792
},
17931793
"property": {
1794-
"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/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234",
1794+
"description": "A Google Analytics 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/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234",
17951795
"type": "string"
17961796
},
17971797
"returnPropertyQuota": {
1798-
"description": "Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).",
1798+
"description": "Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).",
17991799
"type": "boolean"
18001800
}
18011801
},
@@ -1843,7 +1843,7 @@
18431843
},
18441844
"propertyQuota": {
18451845
"$ref": "PropertyQuota",
1846-
"description": "This Analytics Property's quota state including this request."
1846+
"description": "This Google Analytics property's quota state including this request."
18471847
},
18481848
"rows": {
18491849
"description": "Rows of dimension value combinations and metric values in the report.",
@@ -1922,7 +1922,7 @@
19221922
"type": "array"
19231923
},
19241924
"returnPropertyQuota": {
1925-
"description": "Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).",
1925+
"description": "Toggles whether to return the current state of this Google Analytics property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).",
19261926
"type": "boolean"
19271927
}
19281928
},
@@ -1966,7 +1966,7 @@
19661966
},
19671967
"propertyQuota": {
19681968
"$ref": "PropertyQuota",
1969-
"description": "This Analytics Property's Realtime quota state including this request."
1969+
"description": "This Google Analytics property's Realtime quota state including this request."
19701970
},
19711971
"rowCount": {
19721972
"description": "The total number of rows in the query result. `rowCount` is independent of the number of rows returned in the response and the `limit` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows.",
@@ -2028,7 +2028,7 @@
20282028
"type": "array"
20292029
},
20302030
"keepEmptyRows": {
2031-
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: \"purchase\" and eventCount: 0.",
2031+
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: \"purchase\" and eventCount: 0.",
20322032
"type": "boolean"
20332033
},
20342034
"limit": {
@@ -2081,11 +2081,11 @@
20812081
"type": "array"
20822082
},
20832083
"property": {
2084-
"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/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234",
2084+
"description": "A Google Analytics 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/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234",
20852085
"type": "string"
20862086
},
20872087
"returnPropertyQuota": {
2088-
"description": "Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).",
2088+
"description": "Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).",
20892089
"type": "boolean"
20902090
}
20912091
},
@@ -2133,7 +2133,7 @@
21332133
},
21342134
"propertyQuota": {
21352135
"$ref": "PropertyQuota",
2136-
"description": "This Analytics Property's quota state including this request."
2136+
"description": "This Google Analytics property's quota state including this request."
21372137
},
21382138
"rowCount": {
21392139
"description": "The total number of rows in the query result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",

0 commit comments

Comments
 (0)