@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20220928 → 0.0.20221003

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: 20220928
+// Revision: 20221003
 
 /// <reference types="gapi.client" />
 
@@ -477,6 +477,8 @@ declare namespace gapi.client {
             measurementProtocolSecret?: GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret;
             /** A snapshot of a Property resource in change history. */
             property?: GoogleAnalyticsAdminV1alphaProperty;
+            /** A snapshot of a SearchAds360Link resource in change history. */
+            searchAds360Link?: GoogleAnalyticsAdminV1alphaSearchAds360Link;
         }
         interface GoogleAnalyticsAdminV1alphaChangeHistoryEvent {
             /** The type of actor that made this change. */
@@ -816,6 +818,12 @@ declare namespace gapi.client {
             /** Results that matched the filter criteria and were accessible to the caller. */
             properties?: GoogleAnalyticsAdminV1alphaProperty[];
         }
+        interface GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse {
+            /** 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;
+            /** List of SearchAds360Links. */
+            searchAds360Links?: GoogleAnalyticsAdminV1alphaSearchAds360Link[];
+        }
         interface GoogleAnalyticsAdminV1alphaListUserLinksResponse {
             /** 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;
@@ -964,6 +972,28 @@ declare namespace gapi.client {
             /** Rows of dimension value combinations and metric values in the report. */
             rows?: GoogleAnalyticsAdminV1alphaAccessRow[];
         }
+        interface GoogleAnalyticsAdminV1alphaSearchAds360Link {
+            /** Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. */
+            adsPersonalizationEnabled?: boolean;
+            /** Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource. */
+            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.
+             */
+            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.
+             */
+            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;
+            /** Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. */
+            siteStatsSharingEnabled?: boolean;
+        }
         interface GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest {
             /** Optional. If set, only return changes that match one or more of these types of actions. */
             action?: string[];
@@ -3931,6 +3961,218 @@ declare namespace gapi.client {
             },
             body: GoogleAnalyticsAdminV1alphaGoogleAdsLink): Request<GoogleAnalyticsAdminV1alphaGoogleAdsLink>;
         }
+        interface SearchAds360LinksResource {
+            /** Creates a SearchAds360Link. */
+            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: GoogleAnalyticsAdminV1alphaSearchAds360Link;
+            }): Request<GoogleAnalyticsAdminV1alphaSearchAds360Link>;
+            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: GoogleAnalyticsAdminV1alphaSearchAds360Link): Request<GoogleAnalyticsAdminV1alphaSearchAds360Link>;
+            /** Deletes a SearchAds360Link 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. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/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<{}>;
+            /** Look up a single SearchAds360Link */
+            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 SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/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<GoogleAnalyticsAdminV1alphaSearchAds360Link>;
+            /** Lists all SearchAds360Links 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 `ListSearchAds360Links` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
+                 * `ListSearchAds360Links` 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<GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse>;
+            /** Updates a SearchAds360Link 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 SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser
+                 * ID
+                 */
+                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. 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: GoogleAnalyticsAdminV1alphaSearchAds360Link;
+            }): Request<GoogleAnalyticsAdminV1alphaSearchAds360Link>;
+            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 SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser
+                 * ID
+                 */
+                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. 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: GoogleAnalyticsAdminV1alphaSearchAds360Link): Request<GoogleAnalyticsAdminV1alphaSearchAds360Link>;
+        }
         interface UserLinksResource {
             /**
              * Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link
@@ -5055,6 +5297,7 @@ declare namespace gapi.client {
             displayVideo360AdvertiserLinks: DisplayVideo360AdvertiserLinksResource;
             firebaseLinks: FirebaseLinksResource;
             googleAdsLinks: GoogleAdsLinksResource;
+            searchAds360Links: SearchAds360LinksResource;
             userLinks: UserLinksResource;
         }
 

package/package.json

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

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: 20220928
+// Revision: 20221003
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -1045,6 +1045,45 @@ gapi.load('client', async () => {
             name: "Test string",
             updateTime: "Test string",
         });
+        /** Creates a SearchAds360Link. */
+        await gapi.client.analyticsadmin.properties.searchAds360Links.create({
+            parent: "Test string",
+        }, {
+            adsPersonalizationEnabled: true,
+            advertiserDisplayName: "Test string",
+            advertiserId: "Test string",
+            campaignDataSharingEnabled: true,
+            costDataSharingEnabled: true,
+            name: "Test string",
+            siteStatsSharingEnabled: true,
+        });
+        /** Deletes a SearchAds360Link on a property. */
+        await gapi.client.analyticsadmin.properties.searchAds360Links.delete({
+            name: "Test string",
+        });
+        /** Look up a single SearchAds360Link */
+        await gapi.client.analyticsadmin.properties.searchAds360Links.get({
+            name: "Test string",
+        });
+        /** Lists all SearchAds360Links on a property. */
+        await gapi.client.analyticsadmin.properties.searchAds360Links.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Updates a SearchAds360Link on a property. */
+        await gapi.client.analyticsadmin.properties.searchAds360Links.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            adsPersonalizationEnabled: true,
+            advertiserDisplayName: "Test string",
+            advertiserId: "Test string",
+            campaignDataSharingEnabled: true,
+            costDataSharingEnabled: true,
+            name: "Test string",
+            siteStatsSharingEnabled: true,
+        });
         /**
          * Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does
          * not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them