google-apis-adsense_v2 0.21.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24fd4988b7c6a246f286fd180ca47932e6f1c822b930a6a55fdd4314f4060583
-  data.tar.gz: 8e1ceae16e1d23d655c30e9fc4267485a3c5acfe62be00d220aca889367c3d84
+  metadata.gz: 3fac539562fd232a890d2b127657932ee0c63025349ed0c799869b87ae86df37
+  data.tar.gz: 560ba23886973bedec65d2c273f08db070dedd396e7ac001cb7ddca406097a25
 SHA512:
-  metadata.gz: f876eb16e1ee83c01f90a5fe59bb90c48e7a768764b050209aa1c30102a9a4333784bff63e572b3d3601cc86c7004dc609c6f594cf0c341bb3a590f76859ab6f
-  data.tar.gz: 93e4b61551c1bac5c072c75f3438cd7499cc7a5e3b4d42a5db050c90981e5bfe9c7f5ad7ba2cd2810ea873819dd839e1400848eccf05ad43f083c9606c7fb2f5
+  metadata.gz: c451423eace95379113524cb1bf6ea744df8ac17c4236415a6a04b75c3958cd631740004c3afdb7347b40d575629ec10ac63b3e94facc012fe7210c3ae8a8515
+  data.tar.gz: a5e171c903bc305514613f008e598aa91602ead7596816074569c5a1a54ee77d224de6fa57b521063fecd8a5d4861abf8d8646e9ee54425013060dbdfa569d6c

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-adsense_v2
 
+### v0.23.0 (2022-09-23)
+
+* Regenerated from discovery document revision 20220921
+* Regenerated using generator version 0.10.0
+
+### v0.22.0 (2022-08-20)
+
+* Regenerated from discovery document revision 20220817
+
 ### v0.21.0 (2022-08-09)
 
 * Regenerated from discovery document revision 20220808

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

@@ -81,6 +81,36 @@ module Google
         end
       end
       
+      # Representation of an ad blocking recovery tag. See https://support.google.com/
+      # adsense/answer/11575177.
+      class AdBlockingRecoveryTag
+        include Google::Apis::Core::Hashable
+      
+        # Error protection code that can be used in conjunction with the tag. It'll
+        # display a message to users if an [ad blocking extension blocks their access to
+        # your site](https://support.google.com/adsense/answer/11575480).
+        # Corresponds to the JSON property `errorProtectionCode`
+        # @return [String]
+        attr_accessor :error_protection_code
+      
+        # The ad blocking recovery tag. Note that the message generated by the tag can
+        # be blocked by an ad blocking extension. If this is not your desired outcome,
+        # then you'll need to use it in conjunction with the error protection code.
+        # Corresponds to the JSON property `tag`
+        # @return [String]
+        attr_accessor :tag
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @error_protection_code = args[:error_protection_code] if args.key?(:error_protection_code)
+          @tag = args[:tag] if args.key?(:tag)
+        end
+      end
+      
       # Representation of an ad client. An ad client represents a user's subscription
       # with a specific AdSense product.
       class AdClient
@@ -315,6 +345,13 @@ module Google
       class CustomChannel
         include Google::Apis::Core::Hashable
       
+        # Whether the custom channel is active and collecting data. See https://support.
+        # google.com/adsense/answer/10077192.
+        # Corresponds to the JSON property `active`
+        # @return [Boolean]
+        attr_accessor :active
+        alias_method :active?, :active
+      
         # Required. Display name of the custom channel.
         # Corresponds to the JSON property `displayName`
         # @return [String]
@@ -338,6 +375,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @active = args[:active] if args.key?(:active)
           @display_name = args[:display_name] if args.key?(:display_name)
           @name = args[:name] if args.key?(:name)
           @reporting_dimension_id = args[:reporting_dimension_id] if args.key?(:reporting_dimension_id)
@@ -385,6 +423,22 @@ module Google
         end
       end
       
+      # A generic empty message that you can re-use to avoid defining duplicated empty
+      # messages in your APIs. A typical example is to use it as the request or the
+      # response type of an API method. For instance: service Foo ` rpc Bar(google.
+      # protobuf.Empty) returns (google.protobuf.Empty); `
+      class Empty
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # The header information of the columns requested in the report.
       class Header
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AdsenseV2
       # Version of the google-apis-adsense_v2 gem
-      GEM_VERSION = "0.21.0"
+      GEM_VERSION = "0.23.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.9.0"
+      GENERATOR_VERSION = "0.10.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220808"
+      REVISION = "20220921"
     end
   end
 end

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

@@ -28,6 +28,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class AdBlockingRecoveryTag
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class AdClient
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -82,6 +88,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Empty
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Header
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -222,6 +234,14 @@ module Google
         end
       end
       
+      class AdBlockingRecoveryTag
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :error_protection_code, as: 'errorProtectionCode'
+          property :tag, as: 'tag'
+        end
+      end
+      
       class AdClient
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -288,6 +308,7 @@ module Google
       class CustomChannel
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :active, as: 'active'
           property :display_name, as: 'displayName'
           property :name, as: 'name'
           property :reporting_dimension_id, as: 'reportingDimensionId'
@@ -303,6 +324,12 @@ module Google
         end
       end
       
+      class Empty
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class Header
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -80,6 +80,37 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets the ad blocking recovery tag of an account.
+        # @param [String] name
+        #   Required. The name of the account to get the tag for. Format: accounts/`
+        #   account`
+        # @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::AdsenseV2::AdBlockingRecoveryTag] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdsenseV2::AdBlockingRecoveryTag]
+        #
+        # @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_account_ad_blocking_recovery_tag(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/{+name}/adBlockingRecoveryTag', options)
+          command.response_representation = Google::Apis::AdsenseV2::AdBlockingRecoveryTag::Representation
+          command.response_class = Google::Apis::AdsenseV2::AdBlockingRecoveryTag
+          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 accounts available to this user.
         # @param [Fixnum] page_size
         #   The maximum number of accounts to include in the response, used for paging. If
@@ -264,6 +295,46 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Creates an ad unit. This method can only be used by projects enabled for the [
+        # AdSense for Platforms](https://developers.google.com/adsense/platforms/)
+        # product. Note that ad units can only be created for ad clients with an "AFC"
+        # product code. For more info see the [AdClient resource](https://developers.
+        # google.com/adsense/management/reference/rest/v2/accounts.adclients). For now,
+        # this method can only be used to create `DISPLAY` ad units. See: https://
+        # support.google.com/adsense/answer/9183566
+        # @param [String] parent
+        #   Required. Ad client to create an ad unit under. Format: accounts/`account`/
+        #   adclients/`adclient`
+        # @param [Google::Apis::AdsenseV2::AdUnit] ad_unit_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::AdsenseV2::AdUnit] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdsenseV2::AdUnit]
+        #
+        # @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_account_adclient_adunit(parent, ad_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+parent}/adunits', options)
+          command.request_representation = Google::Apis::AdsenseV2::AdUnit::Representation
+          command.request_object = ad_unit_object
+          command.response_representation = Google::Apis::AdsenseV2::AdUnit::Representation
+          command.response_class = Google::Apis::AdsenseV2::AdUnit
+          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
+        
         # Gets an ad unit from a specified account and ad client.
         # @param [String] name
         #   Required. AdUnit to get information about. Format: accounts/`account`/
@@ -412,6 +483,115 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Updates an ad unit. This method can only be used by projects enabled for the [
+        # AdSense for Platforms](https://developers.google.com/adsense/platforms/)
+        # product. For now, this method can only be used to update `DISPLAY` ad units.
+        # See: https://support.google.com/adsense/answer/9183566
+        # @param [String] name
+        #   Output only. Resource name of the ad unit. Format: accounts/`account`/
+        #   adclients/`adclient`/adunits/`adunit`
+        # @param [Google::Apis::AdsenseV2::AdUnit] ad_unit_object
+        # @param [String] update_mask
+        #   The list of fields to update. If empty, a full update is performed.
+        # @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::AdsenseV2::AdUnit] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdsenseV2::AdUnit]
+        #
+        # @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_account_adclient_adunit(name, ad_unit_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v2/{+name}', options)
+          command.request_representation = Google::Apis::AdsenseV2::AdUnit::Representation
+          command.request_object = ad_unit_object
+          command.response_representation = Google::Apis::AdsenseV2::AdUnit::Representation
+          command.response_class = Google::Apis::AdsenseV2::AdUnit
+          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
+        
+        # Creates a custom channel. This method can only be used by projects enabled for
+        # the [AdSense for Platforms](https://developers.google.com/adsense/platforms/)
+        # product.
+        # @param [String] parent
+        #   Required. The ad client to create a custom channel under. Format: accounts/`
+        #   account`/adclients/`adclient`
+        # @param [Google::Apis::AdsenseV2::CustomChannel] custom_channel_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::AdsenseV2::CustomChannel] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdsenseV2::CustomChannel]
+        #
+        # @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_account_adclient_customchannel(parent, custom_channel_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+parent}/customchannels', options)
+          command.request_representation = Google::Apis::AdsenseV2::CustomChannel::Representation
+          command.request_object = custom_channel_object
+          command.response_representation = Google::Apis::AdsenseV2::CustomChannel::Representation
+          command.response_class = Google::Apis::AdsenseV2::CustomChannel
+          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 custom channel. This method can only be used by projects enabled for
+        # the [AdSense for Platforms](https://developers.google.com/adsense/platforms/)
+        # product.
+        # @param [String] name
+        #   Required. Name of the custom channel to delete. Format: accounts/`account`/
+        #   adclients/`adclient`/customchannels/`customchannel`
+        # @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::AdsenseV2::Empty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdsenseV2::Empty]
+        #
+        # @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_account_adclient_customchannel(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'v2/{+name}', options)
+          command.response_representation = Google::Apis::AdsenseV2::Empty::Representation
+          command.response_class = Google::Apis::AdsenseV2::Empty
+          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
+        
         # Gets information about the selected custom channel.
         # @param [String] name
         #   Required. Name of the custom channel. Format: accounts/`account`/adclients/`
@@ -527,6 +707,45 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Updates a custom channel. This method can only be used by projects enabled for
+        # the [AdSense for Platforms](https://developers.google.com/adsense/platforms/)
+        # product.
+        # @param [String] name
+        #   Output only. Resource name of the custom channel. Format: accounts/`account`/
+        #   adclients/`adclient`/customchannels/`customchannel`
+        # @param [Google::Apis::AdsenseV2::CustomChannel] custom_channel_object
+        # @param [String] update_mask
+        #   The list of fields to update. If empty, a full update is performed.
+        # @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::AdsenseV2::CustomChannel] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdsenseV2::CustomChannel]
+        #
+        # @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_account_adclient_customchannel(name, custom_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v2/{+name}', options)
+          command.request_representation = Google::Apis::AdsenseV2::CustomChannel::Representation
+          command.request_object = custom_channel_object
+          command.response_representation = Google::Apis::AdsenseV2::CustomChannel::Representation
+          command.response_class = Google::Apis::AdsenseV2::CustomChannel
+          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
+        
         # Gets information about the selected url channel.
         # @param [String] name
         #   Required. The name of the url channel to retrieve. Format: accounts/`account`/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-adsense_v2
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.9.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.9.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -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-adsense_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-adsense_v2/v0.21.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-adsense_v2/v0.23.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-adsense_v2
 post_install_message: 
 rdoc_options: []