@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20240820 → 0.0.20240823

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: 20240820
+// Revision: 20240823
 
 /// <reference types="gapi.client" />
 
@@ -192,7 +192,7 @@ declare namespace gapi.client {
     }
     interface GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse {}
     interface GoogleAnalyticsAdminV1alphaAdSenseLink {
-      /** Immutable. The AdSense ad client code that the GA4 property is linked to. Example format: "ca-pub-1234567890" */
+      /** Immutable. The AdSense ad client code that the Google Analytics property is linked to. Example format: "ca-pub-1234567890" */
       adClientCode?: string;
       /** Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789 */
       name?: string;
@@ -386,7 +386,7 @@ declare namespace gapi.client {
       includeAdvertisingId?: boolean;
       /** Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' */
       name?: string;
-      /** Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' */
+      /** Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234' */
       project?: string;
       /** If set true, enables streaming export to the linked Google Cloud project. */
       streamingExportEnabled?: boolean;
@@ -714,9 +714,9 @@ declare namespace gapi.client {
       advertiserDisplayName?: string;
       /** Immutable. The Display & Video 360 Advertiser's advertiser ID. */
       advertiserId?: string;
-      /** Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. */
+      /** Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. */
       campaignDataSharingEnabled?: boolean;
-      /** Immutable. Enables the import of cost data from Display & Video 360 into the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. */
+      /** Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. */
       costDataSharingEnabled?: boolean;
       /** Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID */
       name?: string;
@@ -788,7 +788,7 @@ declare namespace gapi.client {
       processingOrder?: string;
     }
     interface GoogleAnalyticsAdminV1alphaEventMapping {
-      /** Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units. */
+      /** Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units. */
       eventName?: string;
       /** The maximum number of times the event occurred. If not set, maximum event count won't be checked. */
       maxEventCount?: string;
@@ -1250,9 +1250,9 @@ declare namespace gapi.client {
       advertiserDisplayName?: string;
       /** Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. */
       advertiserId?: string;
-      /** Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. */
+      /** Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. */
       campaignDataSharingEnabled?: boolean;
-      /** Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. */
+      /** Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. */
       costDataSharingEnabled?: boolean;
       /** Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID */
       name?: string;
@@ -1837,7 +1837,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<GoogleAnalyticsAdminV1alphaDataSharingSettings>;
-      /** Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. */
+      /** Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. */
       list(request?: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -1984,7 +1984,7 @@ declare namespace gapi.client {
         },
         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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. 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). */
+      /** 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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA 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;
@@ -1994,7 +1994,7 @@ declare namespace gapi.client {
         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. */
+        /** 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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID. */
         entity: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
@@ -2023,7 +2023,7 @@ declare namespace gapi.client {
           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. */
+          /** 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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID. */
           entity: string;
           /** Selector specifying which fields to include in a partial response. */
           fields?: string;
@@ -4788,7 +4788,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<{}>;
-      /** Lookup for a single "GA4" MeasurementProtocolSecret. */
+      /** Lookup for a single MeasurementProtocolSecret. */
       get(request?: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -7330,7 +7330,7 @@ declare namespace gapi.client {
         },
         body: GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest
       ): Request<{}>;
-      /** Creates an "GA4" property with the specified location and attributes. */
+      /** Creates a Google Analytics property with the specified location and attributes. */
       create(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -7492,7 +7492,7 @@ declare namespace gapi.client {
         },
         body: GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest
       ): Request<GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse>;
-      /** Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property. */
+      /** Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found. */
       delete(request?: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -7654,7 +7654,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse>;
-      /** Lookup for a single "GA4" Property. */
+      /** Lookup for a single GA Property. */
       get(request?: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -7762,7 +7762,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<GoogleAnalyticsAdminV1alphaGoogleSignalsSettings>;
-      /** Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found. */
+      /** Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found. */
       list(request?: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -7965,7 +7965,7 @@ declare namespace gapi.client {
         },
         body: GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest
       ): Request<GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse>;
-      /** 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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. 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). */
+      /** 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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA 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;
@@ -7975,7 +7975,7 @@ declare namespace gapi.client {
         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. */
+        /** 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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID. */
         entity: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
@@ -8004,7 +8004,7 @@ declare namespace gapi.client {
           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. */
+          /** 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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics 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.20240820",
+  "version": "0.0.20240823",
   "description": "TypeScript typings for Google Analytics Admin API v1alpha",
   "repository": {
     "type": "git",

package/readme.md

@@ -96,7 +96,7 @@ await gapi.client.analyticsadmin.accounts.getDataSharingSettings({
 });
 
 /*
-Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
+Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
 */
 await gapi.client.analyticsadmin.accounts.list({});
 
@@ -111,7 +111,7 @@ 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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. 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).
+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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA 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'});
 
@@ -135,7 +135,7 @@ await gapi.client.analyticsadmin.properties.acknowledgeUserDataCollection({
 });
 
 /*
-Creates an "GA4" property with the specified location and attributes.
+Creates a Google Analytics property with the specified location and attributes.
 */
 await gapi.client.analyticsadmin.properties.create({});
 
@@ -150,7 +150,7 @@ Create a roll-up property and all roll-up property source links.
 await gapi.client.analyticsadmin.properties.createRollupProperty({});
 
 /*
-Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.
+Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
 */
 await gapi.client.analyticsadmin.properties.delete({name: 'name'});
 
@@ -172,7 +172,7 @@ Given a specified UA property, looks up the GA4 property connected to it. Note:
 await gapi.client.analyticsadmin.properties.fetchConnectedGa4Property({});
 
 /*
-Lookup for a single "GA4" Property.
+Lookup for a single GA Property.
 */
 await gapi.client.analyticsadmin.properties.get({name: 'name'});
 
@@ -198,7 +198,7 @@ await gapi.client.analyticsadmin.properties.getGoogleSignalsSettings({
 });
 
 /*
-Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
+Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
 */
 await gapi.client.analyticsadmin.properties.list({});
 
@@ -218,7 +218,7 @@ Create a subproperty and a subproperty event filter that applies to the created
 await gapi.client.analyticsadmin.properties.provisionSubproperty({});
 
 /*
-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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. 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).
+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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA 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.properties.runAccessReport({entity: 'entity'});