@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230216 → 0.0.20230222

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: 20230216
+// Revision: 20230222
 
 /// <reference types="gapi.client" />
 
@@ -949,6 +949,12 @@ declare namespace gapi.client {
             /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
             nextPageToken?: string;
         }
+        interface GoogleAnalyticsAdminV1alphaListExpandedDataSetsResponse {
+            /** List of ExpandedDataSet. These will be ordered stably, but in an arbitrary order. */
+            expandedDataSets?: GoogleAnalyticsAdminV1alphaExpandedDataSet[];
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?: string;
+        }
         interface GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse {
             /** List of FirebaseLinks. This will have at most one value. */
             firebaseLinks?: GoogleAnalyticsAdminV1alphaFirebaseLink[];
@@ -2386,6 +2392,68 @@ 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 is requested for this property. For example if "123" is your GA4 property ID, then entity should be "properties/123". */
+                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 is requested for this property. For example if "123" is your GA4 property ID, then entity should be "properties/123". */
+                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. */
@@ -4765,6 +4833,218 @@ declare namespace gapi.client {
             },
             body: GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink): Request<GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink>;
         }
+        interface ExpandedDataSetsResource {
+            /** Creates a ExpandedDataSet. */
+            create(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: 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;
+                /** Required. Example format: properties/1234 */
+                parent: 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: GoogleAnalyticsAdminV1alphaExpandedDataSet;
+            }): Request<GoogleAnalyticsAdminV1alphaExpandedDataSet>;
+            create(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: 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;
+                /** Required. Example format: properties/1234 */
+                parent: 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: GoogleAnalyticsAdminV1alphaExpandedDataSet): Request<GoogleAnalyticsAdminV1alphaExpandedDataSet>;
+            /** Deletes a ExpandedDataSet on a property. */
+            delete(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: 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;
+                /** Required. Example format: properties/1234/expandedDataSets/5678 */
+                name: 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<{}>;
+            /** Lookup for a single ExpandedDataSet. */
+            get(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: 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;
+                /** Required. The name of the Audience to get. Example format: properties/1234/expandedDataSets/5678 */
+                name: 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<GoogleAnalyticsAdminV1alphaExpandedDataSet>;
+            /** Lists ExpandedDataSets on a property. */
+            list(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: 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;
+                /** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
+                pageSize?: number;
+                /**
+                 * A page token, received from a previous `ListExpandedDataSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
+                 * `ListExpandedDataSet` must match the call that provided the page token.
+                 */
+                pageToken?: string;
+                /** Required. Example format: properties/1234 */
+                parent: 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<GoogleAnalyticsAdminV1alphaListExpandedDataSetsResponse>;
+            /** Updates a ExpandedDataSet on a property. */
+            patch(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: 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;
+                /** Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set} */
+                name: 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;
+                /**
+                 * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use
+                 * one path with the string "*" to match all fields.
+                 */
+                updateMask?: 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: GoogleAnalyticsAdminV1alphaExpandedDataSet;
+            }): Request<GoogleAnalyticsAdminV1alphaExpandedDataSet>;
+            patch(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: 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;
+                /** Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set} */
+                name: 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;
+                /**
+                 * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use
+                 * one path with the string "*" to match all fields.
+                 */
+                updateMask?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: GoogleAnalyticsAdminV1alphaExpandedDataSet): Request<GoogleAnalyticsAdminV1alphaExpandedDataSet>;
+        }
         interface FirebaseLinksResource {
             /** Creates a FirebaseLink. Properties can have at most one FirebaseLink. */
             create(request: {
@@ -6512,6 +6792,7 @@ declare namespace gapi.client {
             dataStreams: DataStreamsResource;
             displayVideo360AdvertiserLinkProposals: DisplayVideo360AdvertiserLinkProposalsResource;
             displayVideo360AdvertiserLinks: DisplayVideo360AdvertiserLinksResource;
+            expandedDataSets: ExpandedDataSetsResource;
             firebaseLinks: FirebaseLinksResource;
             googleAdsLinks: GoogleAdsLinksResource;
             searchAds360Links: SearchAds360LinksResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.analyticsadmin-v1alpha",
-  "version": "0.0.20230216",
+  "version": "0.0.20230222",
   "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: 20230216
+// Revision: 20230222
 
 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",
@@ -1183,6 +1306,91 @@ gapi.load('client', async () => {
             costDataSharingEnabled: true,
             name: "Test string",
         });
+        /** Creates a ExpandedDataSet. */
+        await gapi.client.analyticsadmin.properties.expandedDataSets.create({
+            parent: "Test string",
+        }, {
+            dataCollectionStartTime: "Test string",
+            description: "Test string",
+            dimensionFilterExpression: {
+                andGroup: {
+                    filterExpressions: undefined,
+                },
+                filter: {
+                    fieldName: "Test string",
+                    inListFilter: {
+                        caseSensitive: true,
+                        values: [
+                            "Test string"
+                        ],
+                    },
+                    stringFilter: {
+                        caseSensitive: true,
+                        matchType: "Test string",
+                        value: "Test string",
+                    },
+                },
+                notExpression: undefined,
+            },
+            dimensionNames: [
+                "Test string"
+            ],
+            displayName: "Test string",
+            metricNames: [
+                "Test string"
+            ],
+            name: "Test string",
+        });
+        /** Deletes a ExpandedDataSet on a property. */
+        await gapi.client.analyticsadmin.properties.expandedDataSets.delete({
+            name: "Test string",
+        });
+        /** Lookup for a single ExpandedDataSet. */
+        await gapi.client.analyticsadmin.properties.expandedDataSets.get({
+            name: "Test string",
+        });
+        /** Lists ExpandedDataSets on a property. */
+        await gapi.client.analyticsadmin.properties.expandedDataSets.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Updates a ExpandedDataSet on a property. */
+        await gapi.client.analyticsadmin.properties.expandedDataSets.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            dataCollectionStartTime: "Test string",
+            description: "Test string",
+            dimensionFilterExpression: {
+                andGroup: {
+                    filterExpressions: undefined,
+                },
+                filter: {
+                    fieldName: "Test string",
+                    inListFilter: {
+                        caseSensitive: true,
+                        values: [
+                            "Test string"
+                        ],
+                    },
+                    stringFilter: {
+                        caseSensitive: true,
+                        matchType: "Test string",
+                        value: "Test string",
+                    },
+                },
+                notExpression: undefined,
+            },
+            dimensionNames: [
+                "Test string"
+            ],
+            displayName: "Test string",
+            metricNames: [
+                "Test string"
+            ],
+            name: "Test string",
+        });
         /** Creates a FirebaseLink. Properties can have at most one FirebaseLink. */
         await gapi.client.analyticsadmin.properties.firebaseLinks.create({
             parent: "Test string",