@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230221 → 0.0.20230223

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://analyticsadmin.googleapis.com/$discovery/rest?version=v1alpha
-// Revision: 20230221
+// Revision: 20230223
 
 /// <reference types="gapi.client" />
 
@@ -1109,7 +1109,10 @@ declare namespace gapi.client {
             offset?: string;
             /** Specifies how rows are ordered in the response. */
             orderBys?: GoogleAnalyticsAdminV1alphaAccessOrderBy[];
-            /** Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). */
+            /**
+             * Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be
+             * false.
+             */
             returnEntityQuota?: boolean;
             /**
              * This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted
@@ -1125,7 +1128,7 @@ declare namespace gapi.client {
             dimensionHeaders?: GoogleAnalyticsAdminV1alphaAccessDimensionHeader[];
             /** The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. */
             metricHeaders?: GoogleAnalyticsAdminV1alphaAccessMetricHeader[];
-            /** The quota state for this Analytics property including this request. */
+            /** The quota state for this Analytics property including this request. This field doesn't work with account-level requests. */
             quota?: GoogleAnalyticsAdminV1alphaAccessQuota;
             /**
              * 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
@@ -2392,6 +2395,76 @@ declare namespace gapi.client {
                 uploadType?: string;
             },
             body: GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest): Request<GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse>;
+            /**
+             * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2
+             * years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records
+             * include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records
+             * don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see
+             * [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
+             */
+            runAccessReport(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /**
+                 * The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties
+                 * under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity
+                 * should be for example 'accounts/1234' if "1234" is your GA4 Account ID.
+                 */
+                entity: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Request body */
+                resource: GoogleAnalyticsAdminV1alphaRunAccessReportRequest;
+            }): Request<GoogleAnalyticsAdminV1alphaRunAccessReportResponse>;
+            runAccessReport(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /**
+                 * The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties
+                 * under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity
+                 * should be for example 'accounts/1234' if "1234" is your GA4 Account ID.
+                 */
+                entity: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: GoogleAnalyticsAdminV1alphaRunAccessReportRequest): Request<GoogleAnalyticsAdminV1alphaRunAccessReportResponse>;
             /** Searches through all changes to an account or its children given the specified set of filters. */
             searchChangeHistoryEvents(request: {
                 /** V1 error format. */
@@ -6425,7 +6498,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** The Data Access Report is requested for this property. For example if "123" is your GA4 property ID, then entity should be "properties/123". */
+                /**
+                 * The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties
+                 * under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity
+                 * should be for example 'accounts/1234' if "1234" is your GA4 Account ID.
+                 */
                 entity: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -6453,7 +6530,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** The Data Access Report is requested for this property. For example if "123" is your GA4 property ID, then entity should be "properties/123". */
+                /**
+                 * The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties
+                 * under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity
+                 * should be for example 'accounts/1234' if "1234" is your GA4 Account ID.
+                 */
                 entity: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.analyticsadmin-v1alpha",
-  "version": "0.0.20230221",
+  "version": "0.0.20230223",
   "description": "TypeScript typings for Google Analytics Admin API v1alpha",
   "license": "MIT",
   "author": {

package/readme.md

@@ -105,6 +105,11 @@ Requests a ticket for creating an account.
 */
 await gapi.client.analyticsadmin.accounts.provisionAccountTicket({  });
 
+/*
+Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
+*/
+await gapi.client.analyticsadmin.accounts.runAccessReport({ entity: "entity",  });
+
 /*
 Searches through all changes to an account or its children given the specified set of filters.
 */

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230221
+// Revision: 20230223
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -85,6 +85,129 @@ gapi.load('client', async () => {
             },
             redirectUri: "Test string",
         });
+        /**
+         * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years.
+         * Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4
+         * UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include
+         * property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see
+         * [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
+         */
+        await gapi.client.analyticsadmin.accounts.runAccessReport({
+            entity: "Test string",
+        }, {
+            dateRanges: [
+                {
+                    endDate: "Test string",
+                    startDate: "Test string",
+                }
+            ],
+            dimensionFilter: {
+                accessFilter: {
+                    betweenFilter: {
+                        fromValue: {
+                            doubleValue: 42,
+                            int64Value: "Test string",
+                        },
+                        toValue: {
+                            doubleValue: 42,
+                            int64Value: "Test string",
+                        },
+                    },
+                    fieldName: "Test string",
+                    inListFilter: {
+                        caseSensitive: true,
+                        values: [
+                            "Test string"
+                        ],
+                    },
+                    numericFilter: {
+                        operation: "Test string",
+                        value: {
+                            doubleValue: 42,
+                            int64Value: "Test string",
+                        },
+                    },
+                    stringFilter: {
+                        caseSensitive: true,
+                        matchType: "Test string",
+                        value: "Test string",
+                    },
+                },
+                andGroup: {
+                    expressions: undefined,
+                },
+                notExpression: undefined,
+                orGroup: {
+                    expressions: undefined,
+                },
+            },
+            dimensions: [
+                {
+                    dimensionName: "Test string",
+                }
+            ],
+            limit: "Test string",
+            metricFilter: {
+                accessFilter: {
+                    betweenFilter: {
+                        fromValue: {
+                            doubleValue: 42,
+                            int64Value: "Test string",
+                        },
+                        toValue: {
+                            doubleValue: 42,
+                            int64Value: "Test string",
+                        },
+                    },
+                    fieldName: "Test string",
+                    inListFilter: {
+                        caseSensitive: true,
+                        values: [
+                            "Test string"
+                        ],
+                    },
+                    numericFilter: {
+                        operation: "Test string",
+                        value: {
+                            doubleValue: 42,
+                            int64Value: "Test string",
+                        },
+                    },
+                    stringFilter: {
+                        caseSensitive: true,
+                        matchType: "Test string",
+                        value: "Test string",
+                    },
+                },
+                andGroup: {
+                    expressions: undefined,
+                },
+                notExpression: undefined,
+                orGroup: {
+                    expressions: undefined,
+                },
+            },
+            metrics: [
+                {
+                    metricName: "Test string",
+                }
+            ],
+            offset: "Test string",
+            orderBys: [
+                {
+                    desc: true,
+                    dimension: {
+                        dimensionName: "Test string",
+                        orderType: "Test string",
+                    },
+                    metric: {
+                        metricName: "Test string",
+                    },
+                }
+            ],
+            returnEntityQuota: true,
+            timeZone: "Test string",
+        });
         /** Searches through all changes to an account or its children given the specified set of filters. */
         await gapi.client.analyticsadmin.accounts.searchChangeHistoryEvents({
             account: "Test string",