google-apis-analyticsadmin_v1alpha 0.39.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7357c560b281595b6ea76a1c381c0e21a29b927c2b753efe1606b90fd7d64c8f
-  data.tar.gz: 565273b4bcb272f7ccf80c25f0f58508f3aa068808e74242f1d17e1c2931458e
+  metadata.gz: fb2169ceae8dc7b769f38ae62c390bd7d360359d36f46a11720421723bc65b51
+  data.tar.gz: ef76d15f712f982e761941a9d5e3b9bb89a1d3245f59def9b77640a5a7528ef3
 SHA512:
-  metadata.gz: 958364b9f4cc8295899cb7b8ddee764f9e2dc012de909736490256c742324a6fb9f7b044a78ae01acd57600ab866d363f1b1467690dcc048b2c63f70581cd4f2
-  data.tar.gz: 96befa3ce1ecd3951ede27963ef7fe37c3f77142eb1a9c45f215b28c1752ea89b30b37a608a5a1d595d5ce8ba657649089a6c6aa9ce5c4c334fce8f8abb8271e
+  metadata.gz: 28e36afa481028eaef7f4f6bb24e94b506e74260f1936b73e83244404ff83f9e3b3adfb3600c220f54a87ae50a2aabcfd2fca4699d21624999f298f18e7dceeb
+  data.tar.gz: 840f97ef3f405063480afc41d7030963c7f04c32c02a48818a97d090a1b557f48148ce77e57b715683137d155a82f71d232f59a3bb6b07544a860f67a94b5881

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-analyticsadmin_v1alpha
 
+### v0.40.0 (2022-09-30)
+
+* Regenerated from discovery document revision 20220929
+
 ### v0.39.0 (2022-09-21)
 
 * Regenerated using generator version 0.10.0

data/lib/google/apis/analyticsadmin_v1alpha/classes.rb

@@ -1695,6 +1695,11 @@ module Google
         # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty]
         attr_accessor :property
       
+        # A link between a GA4 property and a Search Ads 360 entity.
+        # Corresponds to the JSON property `searchAds360Link`
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link]
+        attr_accessor :search_ads360_link
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1715,6 +1720,7 @@ module Google
           @google_signals_settings = args[:google_signals_settings] if args.key?(:google_signals_settings)
           @measurement_protocol_secret = args[:measurement_protocol_secret] if args.key?(:measurement_protocol_secret)
           @property = args[:property] if args.key?(:property)
+          @search_ads360_link = args[:search_ads360_link] if args.key?(:search_ads360_link)
         end
       end
       
@@ -2926,6 +2932,32 @@ module Google
         end
       end
       
+      # Response message for ListSearchAds360Links RPC.
+      class GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse
+        include Google::Apis::Core::Hashable
+      
+        # A token, which can be sent as `page_token` to retrieve the next page. If this
+        # field is omitted, there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # List of SearchAds360Links.
+        # Corresponds to the JSON property `searchAds360Links`
+        # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link>]
+        attr_accessor :search_ads360_links
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @search_ads360_links = args[:search_ads360_links] if args.key?(:search_ads360_links)
+        end
+      end
+      
       # Response message for ListUserLinks RPC.
       class GoogleAnalyticsAdminV1alphaListUserLinksResponse
         include Google::Apis::Core::Hashable
@@ -3357,6 +3389,77 @@ module Google
         end
       end
       
+      # A link between a GA4 property and a Search Ads 360 entity.
+      class GoogleAnalyticsAdminV1alphaSearchAds360Link
+        include Google::Apis::Core::Hashable
+      
+        # Enables personalized advertising features with this integration. If this field
+        # is not set on create, it will be defaulted to true.
+        # Corresponds to the JSON property `adsPersonalizationEnabled`
+        # @return [Boolean]
+        attr_accessor :ads_personalization_enabled
+        alias_method :ads_personalization_enabled?, :ads_personalization_enabled
+      
+        # Output only. The display name of the Search Ads 360 Advertiser. Allows users
+        # to easily identify the linked resource.
+        # Corresponds to the JSON property `advertiserDisplayName`
+        # @return [String]
+        attr_accessor :advertiser_display_name
+      
+        # Immutable. This field represents the Advertiser ID of the Search Ads 360
+        # Advertiser. that has been linked.
+        # Corresponds to the JSON property `advertiserId`
+        # @return [String]
+        attr_accessor :advertiser_id
+      
+        # 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.
+        # Corresponds to the JSON property `campaignDataSharingEnabled`
+        # @return [Boolean]
+        attr_accessor :campaign_data_sharing_enabled
+        alias_method :campaign_data_sharing_enabled?, :campaign_data_sharing_enabled
+      
+        # 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.
+        # Corresponds to the JSON property `costDataSharingEnabled`
+        # @return [Boolean]
+        attr_accessor :cost_data_sharing_enabled
+        alias_method :cost_data_sharing_enabled?, :cost_data_sharing_enabled
+      
+        # Output only. The resource name for this SearchAds360Link resource. Format:
+        # properties/`propertyId`/searchAds360Links/`linkId` Note: linkId is not the
+        # Search Ads 360 advertiser ID
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Enables export of site stats with this integration. If this field is not set
+        # on create, it will be defaulted to true.
+        # Corresponds to the JSON property `siteStatsSharingEnabled`
+        # @return [Boolean]
+        attr_accessor :site_stats_sharing_enabled
+        alias_method :site_stats_sharing_enabled?, :site_stats_sharing_enabled
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @ads_personalization_enabled = args[:ads_personalization_enabled] if args.key?(:ads_personalization_enabled)
+          @advertiser_display_name = args[:advertiser_display_name] if args.key?(:advertiser_display_name)
+          @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
+          @campaign_data_sharing_enabled = args[:campaign_data_sharing_enabled] if args.key?(:campaign_data_sharing_enabled)
+          @cost_data_sharing_enabled = args[:cost_data_sharing_enabled] if args.key?(:cost_data_sharing_enabled)
+          @name = args[:name] if args.key?(:name)
+          @site_stats_sharing_enabled = args[:site_stats_sharing_enabled] if args.key?(:site_stats_sharing_enabled)
+        end
+      end
+      
       # Request message for SearchChangeHistoryEvents RPC.
       class GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest
         include Google::Apis::Core::Hashable

data/lib/google/apis/analyticsadmin_v1alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AnalyticsadminV1alpha
       # Version of the google-apis-analyticsadmin_v1alpha gem
-      GEM_VERSION = "0.39.0"
+      GEM_VERSION = "0.40.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.10.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220825"
+      REVISION = "20220929"
     end
   end
 end

data/lib/google/apis/analyticsadmin_v1alpha/representations.rb

@@ -556,6 +556,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleAnalyticsAdminV1alphaListUserLinksResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -610,6 +616,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleAnalyticsAdminV1alphaSearchAds360Link
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1185,6 +1197,8 @@ module Google
       
           property :property, as: 'property', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty::Representation
       
+          property :search_ads360_link, as: 'searchAds360Link', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link::Representation
+      
         end
       end
       
@@ -1509,6 +1523,15 @@ module Google
         end
       end
       
+      class GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :next_page_token, as: 'nextPageToken'
+          collection :search_ads360_links, as: 'searchAds360Links', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link::Representation
+      
+        end
+      end
+      
       class GoogleAnalyticsAdminV1alphaListUserLinksResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1617,6 +1640,19 @@ module Google
         end
       end
       
+      class GoogleAnalyticsAdminV1alphaSearchAds360Link
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :ads_personalization_enabled, as: 'adsPersonalizationEnabled'
+          property :advertiser_display_name, as: 'advertiserDisplayName'
+          property :advertiser_id, as: 'advertiserId'
+          property :campaign_data_sharing_enabled, as: 'campaignDataSharingEnabled'
+          property :cost_data_sharing_enabled, as: 'costDataSharingEnabled'
+          property :name, as: 'name'
+          property :site_stats_sharing_enabled, as: 'siteStatsSharingEnabled'
+        end
+      end
+      
       class GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/analyticsadmin_v1alpha/service.rb

@@ -2874,6 +2874,182 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Creates a SearchAds360Link.
+        # @param [String] parent
+        #   Required. Example format: properties/1234
+        # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link] google_analytics_admin_v1alpha_search_ads360_link_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def create_property_search_ads360_link(parent, google_analytics_admin_v1alpha_search_ads360_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+parent}/searchAds360Links', options)
+          command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link::Representation
+          command.request_object = google_analytics_admin_v1alpha_search_ads360_link_object
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Deletes a SearchAds360Link on a property.
+        # @param [String] name
+        #   Required. The name of the SearchAds360Link to delete. Example format:
+        #   properties/1234/SearchAds360Links/5678
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def delete_property_search_ads360_link(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'v1alpha/{+name}', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Look up a single SearchAds360Link
+        # @param [String] name
+        #   Required. The name of the SearchAds360Link to get. Example format: properties/
+        #   1234/SearchAds360Link/5678
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_property_search_ads360_link(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+name}', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists all SearchAds360Links on a property.
+        # @param [String] parent
+        #   Required. Example format: properties/1234
+        # @param [Fixnum] page_size
+        #   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).
+        # @param [String] page_token
+        #   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.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_property_search_ads360_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+parent}/searchAds360Links', options)
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Updates a SearchAds360Link on a property.
+        # @param [String] name
+        #   Output only. The resource name for this SearchAds360Link resource. Format:
+        #   properties/`propertyId`/searchAds360Links/`linkId` Note: linkId is not the
+        #   Search Ads 360 advertiser ID
+        # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link] google_analytics_admin_v1alpha_search_ads360_link_object
+        # @param [String] update_mask
+        #   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.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def patch_property_search_ads360_link(name, google_analytics_admin_v1alpha_search_ads360_link_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1alpha/{+name}', options)
+          command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link::Representation
+          command.request_object = google_analytics_admin_v1alpha_search_ads360_link_object
+          command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link::Representation
+          command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaSearchAds360Link
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-analyticsadmin_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.39.0
+  version: 0.40.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.39.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.40.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
 post_install_message: 
 rdoc_options: []