lib/google/apis/displayvideo_v3/classes.rb in google-apis-displayvideo_v3-0.4.0 vs lib/google/apis/displayvideo_v3/classes.rb in google-apis-displayvideo_v3-0.5.0
- old
+ new
@@ -691,10 +691,263 @@
def update!(**args)
@age_range = args[:age_range] if args.key?(:age_range)
end
end
+ # Rule-based algorithm.
+ class AlgorithmRules
+ include Google::Apis::Core::Hashable
+
+ # A ruleset consisting of a list of rules and how to aggregate the resulting
+ # values.
+ # Corresponds to the JSON property `impressionSignalRuleset`
+ # @return [Google::Apis::DisplayvideoV3::AlgorithmRulesRuleset]
+ attr_accessor :impression_signal_ruleset
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @impression_signal_ruleset = args[:impression_signal_ruleset] if args.key?(:impression_signal_ruleset)
+ end
+ end
+
+ # A value to compare the signal to.
+ class AlgorithmRulesComparisonValue
+ include Google::Apis::Core::Hashable
+
+ # Boolean value.
+ # Corresponds to the JSON property `boolValue`
+ # @return [Boolean]
+ attr_accessor :bool_value
+ alias_method :bool_value?, :bool_value
+
+ # Dimensions.
+ # Corresponds to the JSON property `creativeDimensionValue`
+ # @return [Google::Apis::DisplayvideoV3::Dimensions]
+ attr_accessor :creative_dimension_value
+
+ # Representation of time defined by day of the week and hour of the day.
+ # Corresponds to the JSON property `dayAndTimeValue`
+ # @return [Google::Apis::DisplayvideoV3::DayAndTime]
+ attr_accessor :day_and_time_value
+
+ # Device type value.
+ # Corresponds to the JSON property `deviceTypeValue`
+ # @return [String]
+ attr_accessor :device_type_value
+
+ # Double value.
+ # Corresponds to the JSON property `doubleValue`
+ # @return [Float]
+ attr_accessor :double_value
+
+ # Environment value.
+ # Corresponds to the JSON property `environmentValue`
+ # @return [String]
+ attr_accessor :environment_value
+
+ # Exchange value.
+ # Corresponds to the JSON property `exchangeValue`
+ # @return [String]
+ attr_accessor :exchange_value
+
+ # Integer value.
+ # Corresponds to the JSON property `int64Value`
+ # @return [Fixnum]
+ attr_accessor :int64_value
+
+ # Ad position value.
+ # Corresponds to the JSON property `onScreenPositionValue`
+ # @return [String]
+ attr_accessor :on_screen_position_value
+
+ # String value.
+ # Corresponds to the JSON property `stringValue`
+ # @return [String]
+ attr_accessor :string_value
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @bool_value = args[:bool_value] if args.key?(:bool_value)
+ @creative_dimension_value = args[:creative_dimension_value] if args.key?(:creative_dimension_value)
+ @day_and_time_value = args[:day_and_time_value] if args.key?(:day_and_time_value)
+ @device_type_value = args[:device_type_value] if args.key?(:device_type_value)
+ @double_value = args[:double_value] if args.key?(:double_value)
+ @environment_value = args[:environment_value] if args.key?(:environment_value)
+ @exchange_value = args[:exchange_value] if args.key?(:exchange_value)
+ @int64_value = args[:int64_value] if args.key?(:int64_value)
+ @on_screen_position_value = args[:on_screen_position_value] if args.key?(:on_screen_position_value)
+ @string_value = args[:string_value] if args.key?(:string_value)
+ end
+ end
+
+ # Set of conditions. The return value of the rule is either: * The return value
+ # for single met condition or * The defined default return value if no
+ # conditions are met.
+ class AlgorithmRulesRule
+ include Google::Apis::Core::Hashable
+
+ # List of conditions in this rule. The criteria among conditions should be
+ # mutually exclusive.
+ # Corresponds to the JSON property `conditions`
+ # @return [Array<Google::Apis::DisplayvideoV3::AlgorithmRulesRuleCondition>]
+ attr_accessor :conditions
+
+ # Adjusted value of the signal used for rule evaluation.
+ # Corresponds to the JSON property `defaultReturnValue`
+ # @return [Google::Apis::DisplayvideoV3::AlgorithmRulesSignalValue]
+ attr_accessor :default_return_value
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @conditions = args[:conditions] if args.key?(:conditions)
+ @default_return_value = args[:default_return_value] if args.key?(:default_return_value)
+ end
+ end
+
+ # Set of signal comparisons. Equivalent of an `if` statement.
+ class AlgorithmRulesRuleCondition
+ include Google::Apis::Core::Hashable
+
+ # Adjusted value of the signal used for rule evaluation.
+ # Corresponds to the JSON property `returnValue`
+ # @return [Google::Apis::DisplayvideoV3::AlgorithmRulesSignalValue]
+ attr_accessor :return_value
+
+ # List of comparisons that build `if` statement condition. The comparisons are
+ # combined into a single condition with `AND` logical operators.
+ # Corresponds to the JSON property `signalComparisons`
+ # @return [Array<Google::Apis::DisplayvideoV3::AlgorithmRulesSignalComparison>]
+ attr_accessor :signal_comparisons
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @return_value = args[:return_value] if args.key?(:return_value)
+ @signal_comparisons = args[:signal_comparisons] if args.key?(:signal_comparisons)
+ end
+ end
+
+ # A ruleset consisting of a list of rules and how to aggregate the resulting
+ # values.
+ class AlgorithmRulesRuleset
+ include Google::Apis::Core::Hashable
+
+ # How to aggregate values of evaluated rules.
+ # Corresponds to the JSON property `aggregationType`
+ # @return [String]
+ attr_accessor :aggregation_type
+
+ # Maximum value the ruleset can evaluate to.
+ # Corresponds to the JSON property `maxValue`
+ # @return [Float]
+ attr_accessor :max_value
+
+ # List of rules to generate the impression value.
+ # Corresponds to the JSON property `rules`
+ # @return [Array<Google::Apis::DisplayvideoV3::AlgorithmRulesRule>]
+ attr_accessor :rules
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @aggregation_type = args[:aggregation_type] if args.key?(:aggregation_type)
+ @max_value = args[:max_value] if args.key?(:max_value)
+ @rules = args[:rules] if args.key?(:rules)
+ end
+ end
+
+ # Signal used to evaluate rules.
+ class AlgorithmRulesSignal
+ include Google::Apis::Core::Hashable
+
+ # Signal based on impressions.
+ # Corresponds to the JSON property `impressionSignal`
+ # @return [String]
+ attr_accessor :impression_signal
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @impression_signal = args[:impression_signal] if args.key?(:impression_signal)
+ end
+ end
+
+ # A single comparison. The comparison compares the `signal` to the `
+ # comparisonValue`. The comparison of `siteId==123` is represented with the
+ # following field values: * `signal` has an `impressionSignal` of `SITE_ID`. * `
+ # comparisonOperator` is set to `EQUAL`. * `comparisonValue` is set to 123.
+ class AlgorithmRulesSignalComparison
+ include Google::Apis::Core::Hashable
+
+ # Operator used to compare the two values. In the resulting experession, the `
+ # signal` will be the first value and the `comparisonValue will be the second.
+ # Corresponds to the JSON property `comparisonOperator`
+ # @return [String]
+ attr_accessor :comparison_operator
+
+ # A value to compare the signal to.
+ # Corresponds to the JSON property `comparisonValue`
+ # @return [Google::Apis::DisplayvideoV3::AlgorithmRulesComparisonValue]
+ attr_accessor :comparison_value
+
+ # Signal used to evaluate rules.
+ # Corresponds to the JSON property `signal`
+ # @return [Google::Apis::DisplayvideoV3::AlgorithmRulesSignal]
+ attr_accessor :signal
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @comparison_operator = args[:comparison_operator] if args.key?(:comparison_operator)
+ @comparison_value = args[:comparison_value] if args.key?(:comparison_value)
+ @signal = args[:signal] if args.key?(:signal)
+ end
+ end
+
+ # Adjusted value of the signal used for rule evaluation.
+ class AlgorithmRulesSignalValue
+ include Google::Apis::Core::Hashable
+
+ # Value to use as result.
+ # Corresponds to the JSON property `number`
+ # @return [Float]
+ attr_accessor :number
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @number = args[:number] if args.key?(:number)
+ end
+ end
+
# Details for assigned app targeting option. This will be populated in the
# details field of an AssignedTargetingOption when targeting_type is `
# TARGETING_TYPE_APP`.
class AppAssignedTargetingOptionDetails
include Google::Apis::Core::Hashable
@@ -3106,10 +3359,16 @@
# with the DV360 advertiser.
# Corresponds to the JSON property `cmAccountId`
# @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`
# @return [Fixnum]
attr_accessor :cm_floodlight_config_id
@@ -3147,10 +3406,11 @@
end
# 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)
@dv360_to_cm_cost_reporting_enabled = args[:dv360_to_cm_cost_reporting_enabled] if args.key?(:dv360_to_cm_cost_reporting_enabled)
@dv360_to_cm_data_sharing_enabled = args[:dv360_to_cm_data_sharing_enabled] if args.key?(:dv360_to_cm_data_sharing_enabled)
@@ -4798,10 +5058,41 @@
@end_date = args[:end_date] if args.key?(:end_date)
@start_date = args[:start_date] if args.key?(:start_date)
end
end
+ # Representation of time defined by day of the week and hour of the day.
+ class DayAndTime
+ include Google::Apis::Core::Hashable
+
+ # Required. Day of the week.
+ # Corresponds to the JSON property `dayOfWeek`
+ # @return [String]
+ attr_accessor :day_of_week
+
+ # Required. Hour of the day.
+ # Corresponds to the JSON property `hourOfDay`
+ # @return [Fixnum]
+ attr_accessor :hour_of_day
+
+ # Required. The mechanism used to determine the relevant timezone.
+ # Corresponds to the JSON property `timeZoneResolution`
+ # @return [String]
+ attr_accessor :time_zone_resolution
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @day_of_week = args[:day_of_week] if args.key?(:day_of_week)
+ @hour_of_day = args[:hour_of_day] if args.key?(:hour_of_day)
+ @time_zone_resolution = args[:time_zone_resolution] if args.key?(:time_zone_resolution)
+ end
+ end
+
# Representation of a segment of time defined on a specific day of the week and
# with a start and end time. The time represented by `start_hour` must be before
# the time represented by `end_hour`.
class DayAndTimeAssignedTargetingOptionDetails
include Google::Apis::Core::Hashable
@@ -5936,10 +6227,77 @@
def update!(**args)
@bid_amount_micros = args[:bid_amount_micros] if args.key?(:bid_amount_micros)
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::DisplayvideoV3::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
# Configuration for custom Active View video viewability metrics.
@@ -8409,10 +8767,37 @@
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
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::DisplayvideoV3::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
# The list of Google audiences. This list will be absent if empty.
# Corresponds to the JSON property `googleAudiences`
@@ -10537,10 +10922,38 @@
@negative = args[:negative] if args.key?(:negative)
@regional_location_list_id = args[:regional_location_list_id] if args.key?(:regional_location_list_id)
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
# The negative keywords that will replace the existing keywords in the negative
@@ -10731,9 +11144,64 @@
end
# Update properties of this object
def update!(**args)
@admin_email = args[:admin_email] if args.key?(:admin_email)
+ @version = args[:version] if args.key?(:version)
+ end
+ end
+
+ # Type for the response returned by [SdfDownloadTaskService.
+ # CreateSdfDownloadTask].
+ class SdfDownloadTask
+ include Google::Apis::Core::Hashable
+
+ # A resource name to be used in media.download to Download the prepared files.
+ # Resource names have the format `download/sdfdownloadtasks/media/`media_id``. `
+ # media_id` will be made available by the long running operation service once
+ # the task status is done.
+ # Corresponds to the JSON property `resourceName`
+ # @return [String]
+ attr_accessor :resource_name
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @resource_name = args[:resource_name] if args.key?(:resource_name)
+ end
+ end
+
+ # Type for the metadata returned by [SdfDownloadTaskService.
+ # CreateSdfDownloadTask].
+ class SdfDownloadTaskMetadata
+ include Google::Apis::Core::Hashable
+
+ # The time when the operation was created.
+ # Corresponds to the JSON property `createTime`
+ # @return [String]
+ attr_accessor :create_time
+
+ # The time when execution was completed.
+ # Corresponds to the JSON property `endTime`
+ # @return [String]
+ attr_accessor :end_time
+
+ # The SDF version used to execute this download task.
+ # Corresponds to the JSON property `version`
+ # @return [String]
+ attr_accessor :version
+
+ def initialize(**args)
+ update!(**args)
+ end
+
+ # Update properties of this object
+ def update!(**args)
+ @create_time = args[:create_time] if args.key?(:create_time)
+ @end_time = args[:end_time] if args.key?(:end_time)
@version = args[:version] if args.key?(:version)
end
end
# Request message for SearchTargetingOptions.