Skip to content

Commit

Permalink
fix(analyticsdata): update the API
Browse files Browse the repository at this point in the history 
#### analyticsdata:v1alpha
The following keys were changed:
- documentationLink
- resources.properties.methods.getMetadata.parameters.name.description
- resources.properties.methods.runRealtimeReport.parameters.property.description
- schemas.Dimension.properties.name.description
- schemas.Entity.properties.propertyId.description
- schemas.Metric.properties.name.description
- schemas.RunReportRequest.properties.limit.description
- schemas.RunReportRequest.properties.offset.description
- schemas.RunReportResponse.properties.rowCount.description
  • Loading branch information
@yoshi-automation @JustinBeckwith
yoshi-automation authored and JustinBeckwith committed Nov 30, 2020
1 parent 823e05f commit 030ebba
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
20 changes: 10 additions & 10 deletions discovery/analyticsdata-v1alpha.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"canonicalName": "AnalyticsData",
"description": "Accesses report data in Google Analytics.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/analytics/trusted-testing/analytics-data/",
"documentationLink": "https://developers.google.com/analytics/devguides/reporting/data/v1/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
Expand Down Expand Up @@ -120,7 +120,7 @@
],
"parameters": {
"name": {
"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/trusted-testing/analytics-data/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.",
"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.",
"location": "path",
"pattern": "^properties/[^/]+/metadata$",
"required": true,
Expand All @@ -146,7 +146,7 @@
],
"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",
"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",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
Expand Down Expand Up @@ -248,7 +248,7 @@
}
}
},
"revision": "20201112",
"revision": "20201118",
"rootUrl": "https://analyticsdata.googleapis.com/",
"schemas": {
"BatchRunPivotReportsRequest": {
Expand Down Expand Up @@ -472,7 +472,7 @@
"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/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`.",
"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. 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`.",
"type": "string"
}
},
Expand Down Expand Up @@ -581,7 +581,7 @@
"id": "Entity",
"properties": {
"propertyId": {
"description": "A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).",
"description": "A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).",
"type": "string"
}
},
Expand Down Expand Up @@ -711,7 +711,7 @@
"type": "boolean"
},
"name": {
"description": "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`.",
"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. 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`.",
"type": "string"
}
},
Expand Down Expand Up @@ -1389,7 +1389,7 @@
"type": "boolean"
},
"limit": {
"description": "The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned. To learn more about this pagination parameter, see [Pagination](basics#pagination).",
"description": "The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
"format": "int64",
"type": "string"
},
Expand Down Expand Up @@ -1426,7 +1426,7 @@
"type": "array"
},
"offset": {
"description": "The row count of the start row. The first row is counted as row 0. To learn more about this pagination parameter, see [Pagination](basics#pagination).",
"description": "The row count of the start row. The first row is counted as row 0. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
"format": "int64",
"type": "string"
},
Expand Down Expand Up @@ -1485,7 +1485,7 @@
"description": "This Analytics Property's 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. To learn more about this pagination parameter, see [Pagination](basics#pagination).",
"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. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
"format": "int32",
"type": "integer"
},
Expand Down
20 changes: 10 additions & 10 deletions src/apis/analyticsdata/v1alpha.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ export namespace analyticsdata_v1alpha {
*/
dimensionExpression?: Schema$DimensionExpression;
/**
* 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`.
* 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. 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`.
*/
name?: string | null;
}
Expand Down Expand Up @@ -372,7 +372,7 @@ export namespace analyticsdata_v1alpha {
*/
export interface Schema$Entity {
/**
* A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
* A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
*/
propertyId?: string | null;
}
Expand Down Expand Up @@ -478,7 +478,7 @@ export namespace analyticsdata_v1alpha {
*/
invisible?: boolean | null;
/**
* 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`.
* 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. 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`.
*/
name?: string | null;
}
Expand Down Expand Up @@ -911,7 +911,7 @@ export namespace analyticsdata_v1alpha {
*/
keepEmptyRows?: boolean | null;
/**
* The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned. To learn more about this pagination parameter, see [Pagination](basics#pagination).
* The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*/
limit?: string | null;
/**
Expand All @@ -927,7 +927,7 @@ export namespace analyticsdata_v1alpha {
*/
metrics?: Schema$Metric[];
/**
* The row count of the start row. The first row is counted as row 0. To learn more about this pagination parameter, see [Pagination](basics#pagination).
* The row count of the start row. The first row is counted as row 0. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*/
offset?: string | null;
/**
Expand Down Expand Up @@ -968,7 +968,7 @@ export namespace analyticsdata_v1alpha {
*/
propertyQuota?: Schema$PropertyQuota;
/**
* 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. To learn more about this pagination parameter, see [Pagination](basics#pagination).
* 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. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*/
rowCount?: number | null;
/**
Expand Down Expand Up @@ -1034,7 +1034,7 @@ export namespace analyticsdata_v1alpha {
*
* // Do the magic
* const res = await analyticsdata.properties.getMetadata({
* // 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/trusted-testing/analytics-data/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.
* // 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.
* name: 'properties/my-propertie/metadata',
* });
* console.log(res.data);
Expand Down Expand Up @@ -1166,7 +1166,7 @@ export namespace analyticsdata_v1alpha {
*
* // Do the magic
* const res = await analyticsdata.properties.runRealtimeReport({
* // 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
* // 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
* property: 'properties/my-propertie',
*
* // Request body metadata
Expand Down Expand Up @@ -1302,14 +1302,14 @@ export namespace analyticsdata_v1alpha {
export interface Params$Resource$Properties$Getmetadata
extends StandardParameters {
/**
* 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/trusted-testing/analytics-data/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.
* 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.
*/
name?: string;
}
export interface Params$Resource$Properties$Runrealtimereport
extends StandardParameters {
/**
* 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
* 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
*/
property?: string;

Expand Down

0 comments on commit 030ebba

Please sign in to comment.