google-apis-adsense_v2 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6782afae113a1c4289b707f0b2a32ed251d74b6c69cf64afb4d9d5cefb42569c
-  data.tar.gz: 37990c3ad8d3e58b226d15a82fd9f762bd566b1a1e150a1f5843f73de13b6f83
+  metadata.gz: 22436e147e0c59ac8fead60a2b862e224b6649b26893c1255f2424ac7191c858
+  data.tar.gz: 4b8c99e96446682bd9af921244995668d74d2d2479c7c8b13b139dc66b4af082
 SHA512:
-  metadata.gz: 182fdc06aad7bb1f940e79310b41e289f5fd97b36c5e274140412f7231ad677fa1379ace97c4d60e22104921bb0363b22bc849739da4f52dcf7d90dec0b14b8b
-  data.tar.gz: c8fa2943540a0038f0fa9dd224419842a6c15d70f8a76cdaa226bf663f53ac4a241b9d87f4bbfccb4ec9c8aecb7db783e60819a7e9cdf9bbaf1113e26c0e707a
+  metadata.gz: 7fa222801c702f2681ed99396717d0df2a39381756a05580f4dd8e06fc22a7ee41f59c775182e1e6515ddf25de05df9d6106c18305b73e3f2b633839e984cac8
+  data.tar.gz: 870b4e465afd95fe08cb2d3cd9dd445590ae3aee5e37c79f52c42d17580b8cf6c3c16fee90f9b257bcc18f86666a33ccd6cf6e2bf1b4234e724015cd7646893d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-adsense_v2
 
+### v0.28.0 (2023-10-15)
+
+* Regenerated from discovery document revision 20231011
+
 ### v0.27.0 (2023-06-04)
 
 * Regenerated from discovery document revision 20230531

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

@@ -739,6 +739,35 @@ module Google
         end
       end
       
+      # Response definition for the policy issues list rpc. Policy issues are reported
+      # only if the publisher has at least one AFC ad client in READY or GETTING_READY
+      # state. If the publisher has no such AFC ad client, the response will be an
+      # empty list.
+      class ListPolicyIssuesResponse
+        include Google::Apis::Core::Hashable
+      
+        # Continuation token used to page through policy issues. To retrieve the next
+        # page of the results, set the next request's "page_token" value to this.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # The policy issues returned in the list response.
+        # Corresponds to the JSON property `policyIssues`
+        # @return [Array<Google::Apis::AdsenseV2::PolicyIssue>]
+        attr_accessor :policy_issues
+      
+        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)
+          @policy_issues = args[:policy_issues] if args.key?(:policy_issues)
+        end
+      end
+      
       # Response definition for the saved reports list rpc.
       class ListSavedReportsResponse
         include Google::Apis::Core::Hashable
@@ -864,6 +893,162 @@ module Google
         end
       end
       
+      # Representation of a policy issue for a single entity (site, site-section, or
+      # page). All issues for a single entity are represented by a single PolicyIssue
+      # resource, though that PolicyIssue can have multiple causes (or "topics") that
+      # can change over time. Policy issues are removed if there are no issues
+      # detected recently or if there's a recent successful appeal for the entity.
+      class PolicyIssue
+        include Google::Apis::Core::Hashable
+      
+        # Required. The most severe action taken on the entity over the past seven days.
+        # Corresponds to the JSON property `action`
+        # @return [String]
+        attr_accessor :action
+      
+        # Optional. List of ad clients associated with the policy issue (either as the
+        # primary ad client or an associated host/secondary ad client). In the latter
+        # case, this will be an ad client that is not owned by the current account.
+        # Corresponds to the JSON property `adClients`
+        # @return [Array<String>]
+        attr_accessor :ad_clients
+      
+        # Required. Total number of ad requests affected by the policy violations over
+        # the past seven days.
+        # Corresponds to the JSON property `adRequestCount`
+        # @return [Fixnum]
+        attr_accessor :ad_request_count
+      
+        # Required. Type of the entity indicating if the entity is a site, site-section,
+        # or page.
+        # Corresponds to the JSON property `entityType`
+        # @return [String]
+        attr_accessor :entity_type
+      
+        # Represents a whole or partial calendar date, such as a birthday. The time of
+        # day and time zone are either specified elsewhere or are insignificant. The
+        # date is relative to the Gregorian Calendar. This can represent one of the
+        # following: * A full date, with non-zero year, month, and day values. * A month
+        # and day, with a zero year (for example, an anniversary). * A year on its own,
+        # with a zero month and a zero day. * A year and month, with a zero day (for
+        # example, a credit card expiration date). Related types: * google.type.
+        # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+        # Corresponds to the JSON property `firstDetectedDate`
+        # @return [Google::Apis::AdsenseV2::Date]
+        attr_accessor :first_detected_date
+      
+        # Represents a whole or partial calendar date, such as a birthday. The time of
+        # day and time zone are either specified elsewhere or are insignificant. The
+        # date is relative to the Gregorian Calendar. This can represent one of the
+        # following: * A full date, with non-zero year, month, and day values. * A month
+        # and day, with a zero year (for example, an anniversary). * A year on its own,
+        # with a zero month and a zero day. * A year and month, with a zero day (for
+        # example, a credit card expiration date). Related types: * google.type.
+        # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+        # Corresponds to the JSON property `lastDetectedDate`
+        # @return [Google::Apis::AdsenseV2::Date]
+        attr_accessor :last_detected_date
+      
+        # Required. Resource name of the entity with policy issues. Format: accounts/`
+        # account`/policyIssues/`policy_issue`
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Required. Unordered list. The policy topics that this entity was found to
+        # violate over the past seven days.
+        # Corresponds to the JSON property `policyTopics`
+        # @return [Array<Google::Apis::AdsenseV2::PolicyTopic>]
+        attr_accessor :policy_topics
+      
+        # Required. Hostname/domain of the entity (for example "foo.com" or "www.foo.com"
+        # ). This _should_ be a bare domain/host name without any protocol. This will be
+        # present for all policy issues.
+        # Corresponds to the JSON property `site`
+        # @return [String]
+        attr_accessor :site
+      
+        # Optional. Prefix of the site-section having policy issues (For example "foo.
+        # com/bar-section"). This will be present if the `entity_type` is `SITE_SECTION`
+        # and will be absent for other entity types.
+        # Corresponds to the JSON property `siteSection`
+        # @return [String]
+        attr_accessor :site_section
+      
+        # Optional. URI of the page having policy violations (for example "foo.com/bar"
+        # or "www.foo.com/bar"). This will be present if the `entity_type` is `PAGE` and
+        # will be absent for other entity types.
+        # Corresponds to the JSON property `uri`
+        # @return [String]
+        attr_accessor :uri
+      
+        # Represents a whole or partial calendar date, such as a birthday. The time of
+        # day and time zone are either specified elsewhere or are insignificant. The
+        # date is relative to the Gregorian Calendar. This can represent one of the
+        # following: * A full date, with non-zero year, month, and day values. * A month
+        # and day, with a zero year (for example, an anniversary). * A year on its own,
+        # with a zero month and a zero day. * A year and month, with a zero day (for
+        # example, a credit card expiration date). Related types: * google.type.
+        # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+        # Corresponds to the JSON property `warningEscalationDate`
+        # @return [Google::Apis::AdsenseV2::Date]
+        attr_accessor :warning_escalation_date
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @action = args[:action] if args.key?(:action)
+          @ad_clients = args[:ad_clients] if args.key?(:ad_clients)
+          @ad_request_count = args[:ad_request_count] if args.key?(:ad_request_count)
+          @entity_type = args[:entity_type] if args.key?(:entity_type)
+          @first_detected_date = args[:first_detected_date] if args.key?(:first_detected_date)
+          @last_detected_date = args[:last_detected_date] if args.key?(:last_detected_date)
+          @name = args[:name] if args.key?(:name)
+          @policy_topics = args[:policy_topics] if args.key?(:policy_topics)
+          @site = args[:site] if args.key?(:site)
+          @site_section = args[:site_section] if args.key?(:site_section)
+          @uri = args[:uri] if args.key?(:uri)
+          @warning_escalation_date = args[:warning_escalation_date] if args.key?(:warning_escalation_date)
+        end
+      end
+      
+      # Information about a particular policy topic. A policy topic represents a
+      # single class of policy issue that can impact ad serving for your site. For
+      # example, sexual content or having ads that obscure your content. A single
+      # policy issue can have multiple policy topics for a single entity.
+      class PolicyTopic
+        include Google::Apis::Core::Hashable
+      
+        # Required. Indicates if this is a policy violation or not. When the value is
+        # true, issues that are instances of this topic must be addressed to remain in
+        # compliance with the partner's agreements with Google. A false value indicates
+        # that it's not mandatory to fix the issues but advertising demand might be
+        # restricted.
+        # Corresponds to the JSON property `mustFix`
+        # @return [Boolean]
+        attr_accessor :must_fix
+        alias_method :must_fix?, :must_fix
+      
+        # Required. The policy topic. For example, "sexual-content" or "ads-obscuring-
+        # content"."
+        # Corresponds to the JSON property `topic`
+        # @return [String]
+        attr_accessor :topic
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @must_fix = args[:must_fix] if args.key?(:must_fix)
+          @topic = args[:topic] if args.key?(:topic)
+        end
+      end
+      
       # Result of a generated report.
       class ReportResult
         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.27.0"
+      GEM_VERSION = "0.28.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230531"
+      REVISION = "20231011"
     end
   end
 end

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

@@ -160,6 +160,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ListPolicyIssuesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ListSavedReportsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -184,6 +190,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class PolicyIssue
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class PolicyTopic
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ReportResult
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -427,6 +445,15 @@ module Google
         end
       end
       
+      class ListPolicyIssuesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :next_page_token, as: 'nextPageToken'
+          collection :policy_issues, as: 'policyIssues', class: Google::Apis::AdsenseV2::PolicyIssue, decorator: Google::Apis::AdsenseV2::PolicyIssue::Representation
+      
+        end
+      end
+      
       class ListSavedReportsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -464,6 +491,36 @@ module Google
         end
       end
       
+      class PolicyIssue
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :action, as: 'action'
+          collection :ad_clients, as: 'adClients'
+          property :ad_request_count, :numeric_string => true, as: 'adRequestCount'
+          property :entity_type, as: 'entityType'
+          property :first_detected_date, as: 'firstDetectedDate', class: Google::Apis::AdsenseV2::Date, decorator: Google::Apis::AdsenseV2::Date::Representation
+      
+          property :last_detected_date, as: 'lastDetectedDate', class: Google::Apis::AdsenseV2::Date, decorator: Google::Apis::AdsenseV2::Date::Representation
+      
+          property :name, as: 'name'
+          collection :policy_topics, as: 'policyTopics', class: Google::Apis::AdsenseV2::PolicyTopic, decorator: Google::Apis::AdsenseV2::PolicyTopic::Representation
+      
+          property :site, as: 'site'
+          property :site_section, as: 'siteSection'
+          property :uri, as: 'uri'
+          property :warning_escalation_date, as: 'warningEscalationDate', class: Google::Apis::AdsenseV2::Date, decorator: Google::Apis::AdsenseV2::Date::Representation
+      
+        end
+      end
+      
+      class PolicyTopic
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :must_fix, as: 'mustFix'
+          property :topic, as: 'topic'
+        end
+      end
+      
       class ReportResult
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -887,6 +887,79 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets information about the selected policy issue.
+        # @param [String] name
+        #   Required. Name of the policy issue. Format: accounts/`account`/policyIssues/`
+        #   policy_issue`
+        # @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::PolicyIssue] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdsenseV2::PolicyIssue]
+        #
+        # @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_policy_issue(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/{+name}', options)
+          command.response_representation = Google::Apis::AdsenseV2::PolicyIssue::Representation
+          command.response_class = Google::Apis::AdsenseV2::PolicyIssue
+          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 the policy issues for the specified account.
+        # @param [String] parent
+        #   Required. The account for which policy issues are being retrieved. Format:
+        #   accounts/`account`
+        # @param [Fixnum] page_size
+        #   The maximum number of policy issues to include in the response, used for
+        #   paging. If unspecified, at most 10000 policy issues will be returned. The
+        #   maximum value is 10000; values above 10000 will be coerced to 10000.
+        # @param [String] page_token
+        #   A page token, received from a previous `ListPolicyIssues` call. Provide this
+        #   to retrieve the subsequent page. When paginating, all other parameters
+        #   provided to `ListPolicyIssues` 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::AdsenseV2::ListPolicyIssuesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdsenseV2::ListPolicyIssuesResponse]
+        #
+        # @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_account_policy_issues(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/{+parent}/policyIssues', options)
+          command.response_representation = Google::Apis::AdsenseV2::ListPolicyIssuesResponse::Representation
+          command.response_class = Google::Apis::AdsenseV2::ListPolicyIssuesResponse
+          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
+        
         # Generates an ad hoc report.
         # @param [String] account
         #   Required. The account which owns the collection of reports. Format: accounts/`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-adsense_v2
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-04 00:00:00.000000000 Z
+date: 2023-10-15 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-adsense_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-adsense_v2/v0.27.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-adsense_v2/v0.28.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-adsense_v2
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Simple REST client for AdSense Management API V2