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

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: 20230222
+// Revision: 20230226
 
 /// <reference types="gapi.client" />
 
@@ -560,6 +560,12 @@ declare namespace gapi.client {
              */
             userActorEmail?: string;
         }
+        interface GoogleAnalyticsAdminV1alphaConnectedSiteTag {
+            /** Required. User-provided display name for the connected site tag. Must be less than 256 characters. */
+            displayName?: string;
+            /** Required. Measurement ID to forward events to. Also known as “G-ID” (For example: G-12345). */
+            measurementId?: string;
+        }
         interface GoogleAnalyticsAdminV1alphaConversionEvent {
             /** Output only. Time when this conversion event was created in the property. */
             createTime?: string;
@@ -569,7 +575,7 @@ declare namespace gapi.client {
              * number of custom conversion events that may be created per property.
              */
             custom?: boolean;
-            /** Output only. If set, this event can currently be deleted via DeleteConversionEvent. */
+            /** Output only. If set, this event can currently be deleted with DeleteConversionEvent. */
             deletable?: boolean;
             /** Immutable. The event name for this conversion event. Examples: 'click', 'purchase' */
             eventName?: string;
@@ -700,6 +706,15 @@ declare namespace gapi.client {
             /** Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} */
             name?: string;
         }
+        interface GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest {
+            /** The measurement ID of the tag to remove from the Universal Analytics property. Also known as "G-ID". Example: "G-12345" */
+            measurementId?: string;
+            /**
+             * The Universal Analytics property to delete connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example:
+             * properties/1234
+             */
+            property?: string;
+        }
         interface GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest {
             /** Required. Example format: accounts/1234/userLinks/5678 */
             name?: string;
@@ -913,6 +928,26 @@ 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 GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest {
+            /**
+             * The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. 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 `ListConnectedSiteTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
+             * `ListConnectedSiteTags` must match the call that provided the page token.
+             */
+            pageToken?: string;
+            /** The Universal Analytics property to fetch connected site tags for. This does not work on GA4 properties. Format: `properties/1234` */
+            property?: string;
+        }
+        interface GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse {
+            /** The site tags for the Universal Analytics property */
+            connectedSiteTags?: GoogleAnalyticsAdminV1alphaConnectedSiteTag[];
+            /** 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 GoogleAnalyticsAdminV1alphaListConversionEventsResponse {
             /** The requested conversion events */
             conversionEvents?: GoogleAnalyticsAdminV1alphaConversionEvent[];
@@ -1038,7 +1073,7 @@ declare namespace gapi.client {
             parent?: string;
             /**
              * Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied.
-             * "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created via Google Analytics Admin API.
+             * "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created with the Google Analytics Admin API.
              */
             propertyType?: string;
             /** Output only. The Google Analytics service level that applies to this property. */
@@ -1067,7 +1102,7 @@ declare namespace gapi.client {
         interface GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest {
             /** The account to create. */
             account?: GoogleAnalyticsAdminV1alphaAccount;
-            /** Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI. */
+            /** Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI. */
             redirectUri?: string;
         }
         interface GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse {
@@ -1109,7 +1144,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 +1163,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
@@ -2408,7 +2446,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;
@@ -2436,7 +2478,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;
@@ -6197,6 +6243,58 @@ declare namespace gapi.client {
                 /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                 uploadType?: string;
             }): Request<GoogleAnalyticsAdminV1alphaProperty>;
+            /** Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties. */
+            deleteConnectedSiteTag(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;
+                /** 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: GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest;
+            }): Request<{}>;
+            deleteConnectedSiteTag(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;
+                /** 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: GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest): Request<{}>;
             /** Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
             fetchAutomatedGa4ConfigurationOptOut(request: {
                 /** V1 error format. */
@@ -6405,6 +6503,58 @@ declare namespace gapi.client {
                 /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                 uploadType?: string;
             }): Request<GoogleAnalyticsAdminV1alphaListPropertiesResponse>;
+            /** Lists the connected site tags for a Universal Analytics property. Note: this has no effect on GA4 property. */
+            listConnectedSiteTags(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;
+                /** 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: GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest;
+            }): Request<GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse>;
+            listConnectedSiteTags(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;
+                /** 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: GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest): Request<GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse>;
             /** Updates a property. */
             patch(request: {
                 /** V1 error format. */
@@ -6487,7 +6637,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;
@@ -6515,7 +6669,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.20230222",
+  "version": "0.0.20230226",
   "description": "TypeScript typings for Google Analytics Admin API v1alpha",
   "license": "MIT",
   "author": {

package/readme.md

@@ -135,6 +135,11 @@ Marks target Property as soft-deleted (ie: "trashed") and returns it. This API d
 */
 await gapi.client.analyticsadmin.properties.delete({ name: "name",  });
 
+/*
+Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.
+*/
+await gapi.client.analyticsadmin.properties.deleteConnectedSiteTag({  });
+
 /*
 Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
 */
@@ -165,6 +170,11 @@ Returns child Properties under the specified parent Account. Only "GA4" properti
 */
 await gapi.client.analyticsadmin.properties.list({  });
 
+/*
+Lists the connected site tags for a Universal Analytics property. Note: this has no effect on GA4 property.
+*/
+await gapi.client.analyticsadmin.properties.listConnectedSiteTags({  });
+
 /*
 Updates a property.
 */

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: 20230222
+// Revision: 20230226
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -450,6 +450,12 @@ gapi.load('client', async () => {
         await gapi.client.analyticsadmin.properties.delete({
             name: "Test string",
         });
+        /** Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties. */
+        await gapi.client.analyticsadmin.properties.deleteConnectedSiteTag({
+        }, {
+            measurementId: "Test string",
+            property: "Test string",
+        });
         /** Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property. */
         await gapi.client.analyticsadmin.properties.fetchAutomatedGa4ConfigurationOptOut({
         }, {
@@ -481,6 +487,13 @@ gapi.load('client', async () => {
             pageToken: "Test string",
             showDeleted: true,
         });
+        /** Lists the connected site tags for a Universal Analytics property. Note: this has no effect on GA4 property. */
+        await gapi.client.analyticsadmin.properties.listConnectedSiteTags({
+        }, {
+            pageSize: 42,
+            pageToken: "Test string",
+            property: "Test string",
+        });
         /** Updates a property. */
         await gapi.client.analyticsadmin.properties.patch({
             name: "Test string",