google-apis-displayvideo_v2 0.30.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0774c4f5e7e01a26a332362525f54336852608cd252555851647b9c7b647e77b
-  data.tar.gz: 9e24429986721285ce0dba910518747fe3b1cf30c156279e48e11bfe072ff43f
+  metadata.gz: 3872b5b6ef19300f9445a5012acd5d114a64d48858774325e03b57c2b5c30014
+  data.tar.gz: 72f0640369b50ce6ba4babc9688c3bc513191f669db125705031ed3f36209feb
 SHA512:
-  metadata.gz: 34067b85232fd3430ea10b765894361a80bec0d1ff502b9d2db702b4c0c8f637cb1c2f203558c9da0e7b789bc3de9f222bf9c68a1686cf264a358fbd74459345
-  data.tar.gz: 53a44e33939f49bfca43ebcecffecd0bb8d6af073411d1fdad19986c0a1a9e38ecb610cbd5fb9aec2e4852b10e193a42864a80cfc61cf83fb5732c1a799e7a08
+  metadata.gz: fab7a8276e25e39195032e3282290c98938301f38c342d0a6cd7b88b160ebbc6b17e0b9d34288fcd42cbe275789830574cbb4efa59859b58141075cc5ff2fb0e
+  data.tar.gz: b82716d86112347c7c8b3e4fbc3f44103a7a1570352533f793267bcc58d6354346ee30c8584d4d14cc901f37ec5ad34147831067ae4ecf2f24d1a2343f053c18

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-displayvideo_v2
 
+### v0.32.0 (2024-02-04)
+
+* Regenerated from discovery document revision 20240201
+
+### v0.31.0 (2024-01-28)
+
+* Regenerated from discovery document revision 20240125
+* Regenerated using generator version 0.13.1
+
 ### v0.30.0 (2024-01-22)
 
 * Regenerated from discovery document revision 20240118

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

@@ -303,9 +303,12 @@ module Google
         attr_accessor :ias_client_id
       
         # Whether or not to use DV360's Online Behavioral Advertising (OBA) compliance.
-        # Warning: Changing OBA settings may cause the audit status of your creatives to
-        # be reset by some ad exchanges, making them ineligible to serve until they are
-        # re-approved.
+        # Starting on February 9, 2024, this field will be affected by an update to the
+        # Display & Video 360 API Terms of Service. See our [announcement](//ads-
+        # developers.googleblog.com/2024/01/update-to-display-video-360-api-terms.html)
+        # for more detail. Warning: Changing OBA settings may cause the audit status of
+        # your creatives to be reset by some ad exchanges, making them ineligible to
+        # serve until they are re-approved.
         # Corresponds to the JSON property `obaComplianceDisabled`
         # @return [Boolean]
         attr_accessor :oba_compliance_disabled
@@ -2907,6 +2910,12 @@ module Google
         # @return [Fixnum]
         attr_accessor :cm_account_id
       
+        # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight
+        # configuration.
+        # Corresponds to the JSON property `cmAdvertiserIds`
+        # @return [Array<Fixnum>]
+        attr_accessor :cm_advertiser_ids
+      
         # Required. Immutable. ID of the CM360 Floodlight configuration linked with the
         # DV360 advertiser.
         # Corresponds to the JSON property `cmFloodlightConfigId`
@@ -2948,6 +2957,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @cm_account_id = args[:cm_account_id] if args.key?(:cm_account_id)
+          @cm_advertiser_ids = args[:cm_advertiser_ids] if args.key?(:cm_advertiser_ids)
           @cm_floodlight_config_id = args[:cm_floodlight_config_id] if args.key?(:cm_floodlight_config_id)
           @cm_floodlight_linking_authorized = args[:cm_floodlight_linking_authorized] if args.key?(:cm_floodlight_linking_authorized)
           @cm_syncable_site_ids = args[:cm_syncable_site_ids] if args.key?(:cm_syncable_site_ids)
@@ -5644,6 +5654,73 @@ module Google
         end
       end
       
+      # A single Floodlight activity.
+      class FloodlightActivity
+        include Google::Apis::Core::Hashable
+      
+        # Output only. IDs of the advertisers that have access to the parent Floodlight
+        # group. Only advertisers under the provided partner ID will be listed in this
+        # field.
+        # Corresponds to the JSON property `advertiserIds`
+        # @return [Array<Fixnum>]
+        attr_accessor :advertiser_ids
+      
+        # Required. The display name of the Floodlight activity.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        # Output only. The unique ID of the Floodlight activity. Assigned by the system.
+        # Corresponds to the JSON property `floodlightActivityId`
+        # @return [Fixnum]
+        attr_accessor :floodlight_activity_id
+      
+        # Required. Immutable. The ID of the parent Floodlight group.
+        # Corresponds to the JSON property `floodlightGroupId`
+        # @return [Fixnum]
+        attr_accessor :floodlight_group_id
+      
+        # Output only. The resource name of the Floodlight activity.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Output only. A list of configuration objects designating whether remarketing
+        # for this Floodlight Activity is enabled and available for a specifc advertiser.
+        # If enabled, this Floodlight Activity generates a remarketing user list that
+        # is able to be used in targeting under the advertiser.
+        # Corresponds to the JSON property `remarketingConfigs`
+        # @return [Array<Google::Apis::DisplayvideoV2::RemarketingConfig>]
+        attr_accessor :remarketing_configs
+      
+        # Optional. Whether the Floodlight activity is served.
+        # Corresponds to the JSON property `servingStatus`
+        # @return [String]
+        attr_accessor :serving_status
+      
+        # Output only. Whether tags are required to be compliant.
+        # Corresponds to the JSON property `sslRequired`
+        # @return [Boolean]
+        attr_accessor :ssl_required
+        alias_method :ssl_required?, :ssl_required
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @advertiser_ids = args[:advertiser_ids] if args.key?(:advertiser_ids)
+          @display_name = args[:display_name] if args.key?(:display_name)
+          @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id)
+          @floodlight_group_id = args[:floodlight_group_id] if args.key?(:floodlight_group_id)
+          @name = args[:name] if args.key?(:name)
+          @remarketing_configs = args[:remarketing_configs] if args.key?(:remarketing_configs)
+          @serving_status = args[:serving_status] if args.key?(:serving_status)
+          @ssl_required = args[:ssl_required] if args.key?(:ssl_required)
+        end
+      end
+      
       # A single Floodlight group.
       class FloodlightGroup
         include Google::Apis::Core::Hashable
@@ -7965,6 +8042,33 @@ module Google
         end
       end
       
+      # 
+      class ListFloodlightActivitiesResponse
+        include Google::Apis::Core::Hashable
+      
+        # The list of Floodlight activities. This list will be absent if empty.
+        # Corresponds to the JSON property `floodlightActivities`
+        # @return [Array<Google::Apis::DisplayvideoV2::FloodlightActivity>]
+        attr_accessor :floodlight_activities
+      
+        # A token to retrieve the next page of results. Pass this value in the
+        # page_token field in the subsequent call to `ListFloodlightActivities` method
+        # to retrieve the next page of results.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @floodlight_activities = args[:floodlight_activities] if args.key?(:floodlight_activities)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # 
       class ListGoogleAudiencesResponse
         include Google::Apis::Core::Hashable
@@ -10242,6 +10346,34 @@ module Google
         end
       end
       
+      # Settings that control the whether remarketing is enabled for the given
+      # identified advertiser.
+      class RemarketingConfig
+        include Google::Apis::Core::Hashable
+      
+        # Output only. The ID of the advertiser.
+        # Corresponds to the JSON property `advertiserId`
+        # @return [Fixnum]
+        attr_accessor :advertiser_id
+      
+        # Output only. Whether the Floodlight activity remarketing user list is
+        # available to the identified advertiser.
+        # Corresponds to the JSON property `remarketingEnabled`
+        # @return [Boolean]
+        attr_accessor :remarketing_enabled
+        alias_method :remarketing_enabled?, :remarketing_enabled
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
+          @remarketing_enabled = args[:remarketing_enabled] if args.key?(:remarketing_enabled)
+        end
+      end
+      
       # Request message for NegativeKeywordService.ReplaceNegativeKeywords.
       class ReplaceNegativeKeywordsRequest
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DisplayvideoV2
       # Version of the google-apis-displayvideo_v2 gem
-      GEM_VERSION = "0.30.0"
+      GEM_VERSION = "0.32.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.13.0"
+      GENERATOR_VERSION = "0.13.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240118"
+      REVISION = "20240201"
     end
   end
 end

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

@@ -904,6 +904,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class FloodlightActivity
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class FloodlightGroup
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1240,6 +1246,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ListFloodlightActivitiesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ListGoogleAudiencesResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1648,6 +1660,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class RemarketingConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ReplaceNegativeKeywordsRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2751,6 +2769,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :cm_account_id, :numeric_string => true, as: 'cmAccountId'
+          collection :cm_advertiser_ids, as: 'cmAdvertiserIds'
           property :cm_floodlight_config_id, :numeric_string => true, as: 'cmFloodlightConfigId'
           property :cm_floodlight_linking_authorized, as: 'cmFloodlightLinkingAuthorized'
           collection :cm_syncable_site_ids, as: 'cmSyncableSiteIds'
@@ -3477,6 +3496,21 @@ module Google
         end
       end
       
+      class FloodlightActivity
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :advertiser_ids, as: 'advertiserIds'
+          property :display_name, as: 'displayName'
+          property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId'
+          property :floodlight_group_id, :numeric_string => true, as: 'floodlightGroupId'
+          property :name, as: 'name'
+          collection :remarketing_configs, as: 'remarketingConfigs', class: Google::Apis::DisplayvideoV2::RemarketingConfig, decorator: Google::Apis::DisplayvideoV2::RemarketingConfig::Representation
+      
+          property :serving_status, as: 'servingStatus'
+          property :ssl_required, as: 'sslRequired'
+        end
+      end
+      
       class FloodlightGroup
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -4090,6 +4124,15 @@ module Google
         end
       end
       
+      class ListFloodlightActivitiesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :floodlight_activities, as: 'floodlightActivities', class: Google::Apis::DisplayvideoV2::FloodlightActivity, decorator: Google::Apis::DisplayvideoV2::FloodlightActivity::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class ListGoogleAudiencesResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -4723,6 +4766,14 @@ module Google
         end
       end
       
+      class RemarketingConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :advertiser_id, :numeric_string => true, as: 'advertiserId'
+          property :remarketing_enabled, as: 'remarketingEnabled'
+        end
+      end
+      
       class ReplaceNegativeKeywordsRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -5214,6 +5214,96 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets a Floodlight activity.
+        # @param [Fixnum] floodlight_group_id
+        #   Required. The ID of the parent Floodlight group to which the requested
+        #   Floodlight activity belongs.
+        # @param [Fixnum] floodlight_activity_id
+        #   Required. The ID of the Floodlight activity to fetch.
+        # @param [Fixnum] partner_id
+        #   Required. The ID of the partner through which the Floodlight activity is being
+        #   accessed.
+        # @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::DisplayvideoV2::FloodlightActivity] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DisplayvideoV2::FloodlightActivity]
+        #
+        # @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_floodlight_group_floodlight_activity(floodlight_group_id, floodlight_activity_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}', options)
+          command.response_representation = Google::Apis::DisplayvideoV2::FloodlightActivity::Representation
+          command.response_class = Google::Apis::DisplayvideoV2::FloodlightActivity
+          command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
+          command.params['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil?
+          command.query['partnerId'] = partner_id unless partner_id.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 Floodlight activities in a Floodlight group.
+        # @param [Fixnum] floodlight_group_id
+        #   Required. The ID of the parent Floodlight group to which the requested
+        #   Floodlight activities belong.
+        # @param [String] order_by
+        #   Optional. Field by which to sort the list. Acceptable values are: * `
+        #   displayName` (default) * `floodlightActivityId` The default sorting order is
+        #   ascending. To specify descending order for a field, a suffix "desc" should be
+        #   added to the field name. Example: `displayName desc`.
+        # @param [Fixnum] page_size
+        #   Optional. Requested page size. Must be between `1` and `100`. If unspecified
+        #   will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid
+        #   value is specified.
+        # @param [String] page_token
+        #   Optional. A token identifying a page of results the server should return.
+        #   Typically, this is the value of next_page_token returned from the previous
+        #   call to `ListFloodlightActivities` method. If not specified, the first page of
+        #   results will be returned.
+        # @param [Fixnum] partner_id
+        #   Required. The ID of the partner through which the Floodlight activities are
+        #   being accessed.
+        # @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::DisplayvideoV2::ListFloodlightActivitiesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DisplayvideoV2::ListFloodlightActivitiesResponse]
+        #
+        # @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_floodlight_group_floodlight_activities(floodlight_group_id, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/floodlightGroups/{+floodlightGroupId}/floodlightActivities', options)
+          command.response_representation = Google::Apis::DisplayvideoV2::ListFloodlightActivitiesResponse::Representation
+          command.response_class = Google::Apis::DisplayvideoV2::ListFloodlightActivitiesResponse
+          command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
+          command.query['orderBy'] = order_by unless order_by.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['partnerId'] = partner_id unless partner_id.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 a Google audience.
         # @param [Fixnum] google_audience_id
         #   Required. The ID of the Google audience to fetch.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-displayvideo_v2
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-02-04 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-displayvideo_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v2/v0.30.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v2/v0.32.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v2
 post_install_message: 
 rdoc_options: []