|
111 | 111 | "properties": {
|
112 | 112 | "methods": {
|
113 | 113 | "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.", |
115 | 115 | "flatPath": "v1beta/properties/{propertiesId}:batchRunPivotReports",
|
116 | 116 | "httpMethod": "POST",
|
117 | 117 | "id": "analyticsdata.properties.batchRunPivotReports",
|
|
120 | 120 | ],
|
121 | 121 | "parameters": {
|
122 | 122 | "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", |
124 | 124 | "location": "path",
|
125 | 125 | "pattern": "^properties/[^/]+$",
|
126 | 126 | "required": true,
|
|
140 | 140 | ]
|
141 | 141 | },
|
142 | 142 | "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.", |
144 | 144 | "flatPath": "v1beta/properties/{propertiesId}:batchRunReports",
|
145 | 145 | "httpMethod": "POST",
|
146 | 146 | "id": "analyticsdata.properties.batchRunReports",
|
|
149 | 149 | ],
|
150 | 150 | "parameters": {
|
151 | 151 | "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", |
153 | 153 | "location": "path",
|
154 | 154 | "pattern": "^properties/[^/]+$",
|
155 | 155 | "required": true,
|
|
178 | 178 | ],
|
179 | 179 | "parameters": {
|
180 | 180 | "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", |
182 | 182 | "location": "path",
|
183 | 183 | "pattern": "^properties/[^/]+$",
|
184 | 184 | "required": true,
|
|
198 | 198 | ]
|
199 | 199 | },
|
200 | 200 | "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`.", |
202 | 202 | "flatPath": "v1beta/properties/{propertiesId}/metadata",
|
203 | 203 | "httpMethod": "GET",
|
204 | 204 | "id": "analyticsdata.properties.getMetadata",
|
|
207 | 207 | ],
|
208 | 208 | "parameters": {
|
209 | 209 | "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.", |
211 | 211 | "location": "path",
|
212 | 212 | "pattern": "^properties/[^/]+/metadata$",
|
213 | 213 | "required": true,
|
|
233 | 233 | ],
|
234 | 234 | "parameters": {
|
235 | 235 | "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", |
237 | 237 | "location": "path",
|
238 | 238 | "pattern": "^properties/[^/]+$",
|
239 | 239 | "required": true,
|
|
262 | 262 | ],
|
263 | 263 | "parameters": {
|
264 | 264 | "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", |
266 | 266 | "location": "path",
|
267 | 267 | "pattern": "^properties/[^/]+$",
|
268 | 268 | "required": true,
|
|
291 | 291 | ],
|
292 | 292 | "parameters": {
|
293 | 293 | "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", |
295 | 295 | "location": "path",
|
296 | 296 | "pattern": "^properties/[^/]+$",
|
297 | 297 | "required": true,
|
|
440 | 440 | }
|
441 | 441 | }
|
442 | 442 | },
|
443 |
| - "revision": "20240731", |
| 443 | + "revision": "20240825", |
444 | 444 | "rootUrl": "https://analyticsdata.googleapis.com/",
|
445 | 445 | "schemas": {
|
446 | 446 | "ActiveMetricRestriction": {
|
|
1769 | 1769 | "type": "array"
|
1770 | 1770 | },
|
1771 | 1771 | "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.", |
1773 | 1773 | "type": "boolean"
|
1774 | 1774 | },
|
1775 | 1775 | "metricFilter": {
|
|
1791 | 1791 | "type": "array"
|
1792 | 1792 | },
|
1793 | 1793 | "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", |
1795 | 1795 | "type": "string"
|
1796 | 1796 | },
|
1797 | 1797 | "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).", |
1799 | 1799 | "type": "boolean"
|
1800 | 1800 | }
|
1801 | 1801 | },
|
|
1843 | 1843 | },
|
1844 | 1844 | "propertyQuota": {
|
1845 | 1845 | "$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." |
1847 | 1847 | },
|
1848 | 1848 | "rows": {
|
1849 | 1849 | "description": "Rows of dimension value combinations and metric values in the report.",
|
|
1922 | 1922 | "type": "array"
|
1923 | 1923 | },
|
1924 | 1924 | "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).", |
1926 | 1926 | "type": "boolean"
|
1927 | 1927 | }
|
1928 | 1928 | },
|
|
1966 | 1966 | },
|
1967 | 1967 | "propertyQuota": {
|
1968 | 1968 | "$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." |
1970 | 1970 | },
|
1971 | 1971 | "rowCount": {
|
1972 | 1972 | "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 | 2028 | "type": "array"
|
2029 | 2029 | },
|
2030 | 2030 | "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.", |
2032 | 2032 | "type": "boolean"
|
2033 | 2033 | },
|
2034 | 2034 | "limit": {
|
|
2081 | 2081 | "type": "array"
|
2082 | 2082 | },
|
2083 | 2083 | "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", |
2085 | 2085 | "type": "string"
|
2086 | 2086 | },
|
2087 | 2087 | "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).", |
2089 | 2089 | "type": "boolean"
|
2090 | 2090 | }
|
2091 | 2091 | },
|
|
2133 | 2133 | },
|
2134 | 2134 | "propertyQuota": {
|
2135 | 2135 | "$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." |
2137 | 2137 | },
|
2138 | 2138 | "rowCount": {
|
2139 | 2139 | "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