google-apis-displayvideo_v4 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '07930cd4d0606d954b368b393cb607ce17faedb3f24acb15ac5704d58f1d4d78'
4
- data.tar.gz: 1888bebb0ffdff22a959c04a21607eeead1527b07d85ee4c7a2d8ed7525c5b7b
3
+ metadata.gz: 3f03339f798ce70630a51d43dfc45c0d38f706fa9efb1a4a31bffc0295cb1ea7
4
+ data.tar.gz: b68c6519b9d19adf021ba5780f925e4c0e128fd3fd31b0d86daecc003847af44
5
5
  SHA512:
6
- metadata.gz: 17ba6669e3edf6373bfbc91764e92846a440f3b04294f834a67d9e400ebf964d171a94cd8990caf73e82310733c232075761c07d26d19d4430aa0c72b9cb502e
7
- data.tar.gz: 57e1c0618e04f83917b9754911648eb37bb4a4c609c6bcc2bb6162c7c2047528ee0186023171c19f8b887a622307c94785781b49d9c35d0212d079cda4ff97e2
6
+ metadata.gz: 1293084c0130b36aee6947dad52672a5c23896bd1f89bce5e7030bfe0ef8f0892c2d9421aecdd94ccbe97b7f2c8efa79928b16995a447bedbc2bf9f881630e6c
7
+ data.tar.gz: a4d4c41c0d3a2c06406913e74544addf1d04571dde78ee210283060b1fb2c2a188039e6eeed7198b354cfec9606e409ff0b543aab8d46a5ba56bba9063641e8b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-displayvideo_v4
2
2
 
3
+ ### v0.5.0 (2025-04-27)
4
+
5
+ * Regenerated from discovery document revision 20250424
6
+
3
7
  ### v0.4.0 (2025-03-23)
4
8
 
5
9
  * Regenerated from discovery document revision 20250320
@@ -306,7 +306,7 @@ module Google
306
306
  end
307
307
  end
308
308
 
309
- # Details of Adloox brand safety settings.
309
+ # Details of Scope3 (previously known as Adloox) brand safety settings.
310
310
  class Adloox
311
311
  include Google::Apis::Core::Hashable
312
312
 
@@ -345,12 +345,12 @@ module Google
345
345
  # @return [String]
346
346
  attr_accessor :display_iab_viewability
347
347
 
348
- # Adloox categories to exclude.
348
+ # Scope3 categories to exclude.
349
349
  # Corresponds to the JSON property `excludedAdlooxCategories`
350
350
  # @return [Array<String>]
351
351
  attr_accessor :excluded_adloox_categories
352
352
 
353
- # Optional. Adloox's fraud IVT MFA categories to exclude.
353
+ # Optional. Scope3's fraud IVT MFA categories to exclude.
354
354
  # Corresponds to the JSON property `excludedFraudIvtMfaCategories`
355
355
  # @return [Array<String>]
356
356
  attr_accessor :excluded_fraud_ivt_mfa_categories
@@ -811,19 +811,32 @@ module Google
811
811
  class AlgorithmRules
812
812
  include Google::Apis::Core::Hashable
813
813
 
814
+ # Attribution model for the algorithm.
815
+ # Corresponds to the JSON property `attributionModelId`
816
+ # @return [Fixnum]
817
+ attr_accessor :attribution_model_id
818
+
814
819
  # A ruleset consisting of a list of rules and how to aggregate the resulting
815
820
  # values.
816
821
  # Corresponds to the JSON property `impressionSignalRuleset`
817
822
  # @return [Google::Apis::DisplayvideoV4::AlgorithmRulesRuleset]
818
823
  attr_accessor :impression_signal_ruleset
819
824
 
825
+ # A ruleset consisting of a list of rules and how to aggregate the resulting
826
+ # values.
827
+ # Corresponds to the JSON property `postImpressionSignalRuleset`
828
+ # @return [Google::Apis::DisplayvideoV4::AlgorithmRulesRuleset]
829
+ attr_accessor :post_impression_signal_ruleset
830
+
820
831
  def initialize(**args)
821
832
  update!(**args)
822
833
  end
823
834
 
824
835
  # Update properties of this object
825
836
  def update!(**args)
837
+ @attribution_model_id = args[:attribution_model_id] if args.key?(:attribution_model_id)
826
838
  @impression_signal_ruleset = args[:impression_signal_ruleset] if args.key?(:impression_signal_ruleset)
839
+ @post_impression_signal_ruleset = args[:post_impression_signal_ruleset] if args.key?(:post_impression_signal_ruleset)
827
840
  end
828
841
  end
829
842
 
@@ -882,6 +895,11 @@ module Google
882
895
  # @return [String]
883
896
  attr_accessor :string_value
884
897
 
898
+ # Video player size value.
899
+ # Corresponds to the JSON property `videoPlayerSizeValue`
900
+ # @return [String]
901
+ attr_accessor :video_player_size_value
902
+
885
903
  def initialize(**args)
886
904
  update!(**args)
887
905
  end
@@ -898,6 +916,40 @@ module Google
898
916
  @int64_value = args[:int64_value] if args.key?(:int64_value)
899
917
  @on_screen_position_value = args[:on_screen_position_value] if args.key?(:on_screen_position_value)
900
918
  @string_value = args[:string_value] if args.key?(:string_value)
919
+ @video_player_size_value = args[:video_player_size_value] if args.key?(:video_player_size_value)
920
+ end
921
+ end
922
+
923
+ # The rule to score impressions based on Floodlight conversion events.
924
+ class AlgorithmRulesFloodlightActivityConversionSignal
925
+ include Google::Apis::Core::Hashable
926
+
927
+ # Required. The type of conversions to be used in impression value computation,
928
+ # for example, post-click conversions.
929
+ # Corresponds to the JSON property `conversionCounting`
930
+ # @return [String]
931
+ attr_accessor :conversion_counting
932
+
933
+ # Required. The way to acquire value from the floodlight activity, for example,
934
+ # count of the conversion.
935
+ # Corresponds to the JSON property `countingMethod`
936
+ # @return [String]
937
+ attr_accessor :counting_method
938
+
939
+ # Required. Id of the floodlight activity.
940
+ # Corresponds to the JSON property `floodlightActivityId`
941
+ # @return [Fixnum]
942
+ attr_accessor :floodlight_activity_id
943
+
944
+ def initialize(**args)
945
+ update!(**args)
946
+ end
947
+
948
+ # Update properties of this object
949
+ def update!(**args)
950
+ @conversion_counting = args[:conversion_counting] if args.key?(:conversion_counting)
951
+ @counting_method = args[:counting_method] if args.key?(:counting_method)
952
+ @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id)
901
953
  end
902
954
  end
903
955
 
@@ -991,6 +1043,16 @@ module Google
991
1043
  class AlgorithmRulesSignal
992
1044
  include Google::Apis::Core::Hashable
993
1045
 
1046
+ # Signal based on active views.
1047
+ # Corresponds to the JSON property `activeViewSignal`
1048
+ # @return [String]
1049
+ attr_accessor :active_view_signal
1050
+
1051
+ # Signal based on clicks.
1052
+ # Corresponds to the JSON property `clickSignal`
1053
+ # @return [String]
1054
+ attr_accessor :click_signal
1055
+
994
1056
  # Signal based on impressions.
995
1057
  # Corresponds to the JSON property `impressionSignal`
996
1058
  # @return [String]
@@ -1002,6 +1064,8 @@ module Google
1002
1064
 
1003
1065
  # Update properties of this object
1004
1066
  def update!(**args)
1067
+ @active_view_signal = args[:active_view_signal] if args.key?(:active_view_signal)
1068
+ @click_signal = args[:click_signal] if args.key?(:click_signal)
1005
1069
  @impression_signal = args[:impression_signal] if args.key?(:impression_signal)
1006
1070
  end
1007
1071
  end
@@ -1045,6 +1109,16 @@ module Google
1045
1109
  class AlgorithmRulesSignalValue
1046
1110
  include Google::Apis::Core::Hashable
1047
1111
 
1112
+ # Signal based on active views. Only `TIME_ON_SCREEN` is supported.
1113
+ # Corresponds to the JSON property `activeViewSignal`
1114
+ # @return [String]
1115
+ attr_accessor :active_view_signal
1116
+
1117
+ # The rule to score impressions based on Floodlight conversion events.
1118
+ # Corresponds to the JSON property `floodlightActivityConversionSignal`
1119
+ # @return [Google::Apis::DisplayvideoV4::AlgorithmRulesFloodlightActivityConversionSignal]
1120
+ attr_accessor :floodlight_activity_conversion_signal
1121
+
1048
1122
  # Value to use as result.
1049
1123
  # Corresponds to the JSON property `number`
1050
1124
  # @return [Float]
@@ -1056,6 +1130,8 @@ module Google
1056
1130
 
1057
1131
  # Update properties of this object
1058
1132
  def update!(**args)
1133
+ @active_view_signal = args[:active_view_signal] if args.key?(:active_view_signal)
1134
+ @floodlight_activity_conversion_signal = args[:floodlight_activity_conversion_signal] if args.key?(:floodlight_activity_conversion_signal)
1059
1135
  @number = args[:number] if args.key?(:number)
1060
1136
  end
1061
1137
  end
@@ -4084,13 +4160,10 @@ module Google
4084
4160
 
4085
4161
  # The Floodlight activity configs used to track conversions. The number of
4086
4162
  # conversions counted is the sum of all of the conversions counted by all of the
4087
- # Floodlight activity IDs specified in this field. *Warning*: Starting **April 1,
4088
- # 2025**, this field will no longer be writable while a custom bidding
4089
- # algorithm is assigned to the line item. If you set this field and assign a
4090
- # custom bidding algorithm in the same request, the floodlight activities must
4091
- # match the ones used by the custom bidding algorithm. [Read more about this
4092
- # announced change](/display-video/api/deprecations#features.
4093
- # custom_bidding_floodlight).
4163
+ # Floodlight activity IDs specified in this field. This field can't be updated
4164
+ # if a custom bidding algorithm is assigned to the line item. If you set this
4165
+ # field and assign a custom bidding algorithm in the same request, the
4166
+ # floodlight activities must match the ones used by the custom bidding algorithm.
4094
4167
  # Corresponds to the JSON property `floodlightActivityConfigs`
4095
4168
  # @return [Array<Google::Apis::DisplayvideoV4::TrackingFloodlightActivityConfig>]
4096
4169
  attr_accessor :floodlight_activity_configs
@@ -6244,16 +6317,10 @@ module Google
6244
6317
  attr_accessor :gmail_audience_size
6245
6318
 
6246
6319
  # Output only. The duration in days that an entry remains in the audience after
6247
- # the qualifying event. If the audience has no expiration, set the value of this
6248
- # field to 10000. Otherwise, the set value must be greater than 0 and less than
6249
- # or equal to 540. Only applicable to first party audiences. This field is
6250
- # required if one of the following audience_type is used: * `
6251
- # CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting
6252
- # on **April 7, 2025**, audiences will no longer be able to have infinite
6253
- # membership duration. This field will no longer accept the value 10000 and all
6254
- # audiences with membership durations greater than 540 days will be updated to a
6255
- # membership duration of 540 days. [Read more about this announced change](/
6256
- # display-video/api/deprecations#features.audience_duration).
6320
+ # the qualifying event. The set value must be greater than 0 and less than or
6321
+ # equal to 540. Only applicable to first party audiences. This field is required
6322
+ # if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO`
6323
+ # * `CUSTOMER_MATCH_DEVICE_ID`
6257
6324
  # Corresponds to the JSON property `membershipDurationDays`
6258
6325
  # @return [Fixnum]
6259
6326
  attr_accessor :membership_duration_days
@@ -9568,11 +9635,9 @@ module Google
9568
9635
 
9569
9636
  # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable
9570
9637
  # when performance_goal_type is set to `
9571
- # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **
9572
- # April 1, 2025**, assigning a custom bidding algorithm that uses floodlight
9573
- # activities not identified in floodlightActivityConfigs will return an error. [
9574
- # Read more about this announced change](/display-video/api/deprecations#
9575
- # features.custom_bidding_floodlight).
9638
+ # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom
9639
+ # bidding algorithm that uses floodlight activities not identified in
9640
+ # floodlightActivityConfigs will return an error.
9576
9641
  # Corresponds to the JSON property `customBiddingAlgorithmId`
9577
9642
  # @return [Fixnum]
9578
9643
  attr_accessor :custom_bidding_algorithm_id
@@ -10625,11 +10690,9 @@ module Google
10625
10690
 
10626
10691
  # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable
10627
10692
  # when performance_goal_type is set to `
10628
- # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **
10629
- # April 1, 2025**, assigning a custom bidding algorithm that uses floodlight
10630
- # activities not identified in floodlightActivityConfigs will return an error. [
10631
- # Read more about this announced change](/display-video/api/deprecations#
10632
- # features.custom_bidding_floodlight).
10693
+ # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom
10694
+ # bidding algorithm that uses floodlight activities not identified in
10695
+ # floodlightActivityConfigs will return an error.
10633
10696
  # Corresponds to the JSON property `customBiddingAlgorithmId`
10634
10697
  # @return [Fixnum]
10635
10698
  attr_accessor :custom_bidding_algorithm_id
@@ -11254,8 +11317,7 @@ module Google
11254
11317
  end
11255
11318
  end
11256
11319
 
11257
- # Type for the response returned by [SdfDownloadTaskService.
11258
- # CreateSdfDownloadTask].
11320
+ # Type for the response returned by SdfDownloadTaskService.CreateSdfDownloadTask.
11259
11321
  class SdfDownloadTask
11260
11322
  include Google::Apis::Core::Hashable
11261
11323
 
@@ -11277,8 +11339,7 @@ module Google
11277
11339
  end
11278
11340
  end
11279
11341
 
11280
- # Type for the metadata returned by [SdfDownloadTaskService.
11281
- # CreateSdfDownloadTask].
11342
+ # Type for the metadata returned by SdfDownloadTaskService.CreateSdfDownloadTask.
11282
11343
  class SdfDownloadTaskMetadata
11283
11344
  include Google::Apis::Core::Hashable
11284
11345
 
@@ -12076,7 +12137,7 @@ module Google
12076
12137
  class ThirdPartyVerifierAssignedTargetingOptionDetails
12077
12138
  include Google::Apis::Core::Hashable
12078
12139
 
12079
- # Details of Adloox brand safety settings.
12140
+ # Details of Scope3 (previously known as Adloox) brand safety settings.
12080
12141
  # Corresponds to the JSON property `adloox`
12081
12142
  # @return [Google::Apis::DisplayvideoV4::Adloox]
12082
12143
  attr_accessor :adloox
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DisplayvideoV4
18
18
  # Version of the google-apis-displayvideo_v4 gem
19
- GEM_VERSION = "0.4.0"
19
+ GEM_VERSION = "0.5.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.16.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250320"
25
+ REVISION = "20250424"
26
26
  end
27
27
  end
28
28
  end
@@ -130,6 +130,12 @@ module Google
130
130
  include Google::Apis::Core::JsonObjectSupport
131
131
  end
132
132
 
133
+ class AlgorithmRulesFloodlightActivityConversionSignal
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
133
139
  class AlgorithmRulesRule
134
140
  class Representation < Google::Apis::Core::JsonRepresentation; end
135
141
 
@@ -2229,8 +2235,11 @@ module Google
2229
2235
  class AlgorithmRules
2230
2236
  # @private
2231
2237
  class Representation < Google::Apis::Core::JsonRepresentation
2238
+ property :attribution_model_id, :numeric_string => true, as: 'attributionModelId'
2232
2239
  property :impression_signal_ruleset, as: 'impressionSignalRuleset', class: Google::Apis::DisplayvideoV4::AlgorithmRulesRuleset, decorator: Google::Apis::DisplayvideoV4::AlgorithmRulesRuleset::Representation
2233
2240
 
2241
+ property :post_impression_signal_ruleset, as: 'postImpressionSignalRuleset', class: Google::Apis::DisplayvideoV4::AlgorithmRulesRuleset, decorator: Google::Apis::DisplayvideoV4::AlgorithmRulesRuleset::Representation
2242
+
2234
2243
  end
2235
2244
  end
2236
2245
 
@@ -2249,6 +2258,16 @@ module Google
2249
2258
  property :int64_value, :numeric_string => true, as: 'int64Value'
2250
2259
  property :on_screen_position_value, as: 'onScreenPositionValue'
2251
2260
  property :string_value, as: 'stringValue'
2261
+ property :video_player_size_value, as: 'videoPlayerSizeValue'
2262
+ end
2263
+ end
2264
+
2265
+ class AlgorithmRulesFloodlightActivityConversionSignal
2266
+ # @private
2267
+ class Representation < Google::Apis::Core::JsonRepresentation
2268
+ property :conversion_counting, as: 'conversionCounting'
2269
+ property :counting_method, as: 'countingMethod'
2270
+ property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId'
2252
2271
  end
2253
2272
  end
2254
2273
 
@@ -2285,6 +2304,8 @@ module Google
2285
2304
  class AlgorithmRulesSignal
2286
2305
  # @private
2287
2306
  class Representation < Google::Apis::Core::JsonRepresentation
2307
+ property :active_view_signal, as: 'activeViewSignal'
2308
+ property :click_signal, as: 'clickSignal'
2288
2309
  property :impression_signal, as: 'impressionSignal'
2289
2310
  end
2290
2311
  end
@@ -2303,6 +2324,9 @@ module Google
2303
2324
  class AlgorithmRulesSignalValue
2304
2325
  # @private
2305
2326
  class Representation < Google::Apis::Core::JsonRepresentation
2327
+ property :active_view_signal, as: 'activeViewSignal'
2328
+ property :floodlight_activity_conversion_signal, as: 'floodlightActivityConversionSignal', class: Google::Apis::DisplayvideoV4::AlgorithmRulesFloodlightActivityConversionSignal, decorator: Google::Apis::DisplayvideoV4::AlgorithmRulesFloodlightActivityConversionSignal::Representation
2329
+
2306
2330
  property :number, as: 'number'
2307
2331
  end
2308
2332
  end
@@ -3838,10 +3838,8 @@ module Google
3838
3838
  end
3839
3839
 
3840
3840
  # Updates an existing custom bidding algorithm. Returns the updated custom
3841
- # bidding algorithm if successful. *Warning*: Starting **April 1, 2025**,
3842
- # requests updating custom bidding algorithms that are assigned to line items
3843
- # will return an error. [Read more about this announced change](/display-video/
3844
- # api/deprecations#features.custom_bidding_floodlight).
3841
+ # bidding algorithm if successful. Requests updating a custom bidding algorithm
3842
+ # assigned to a line item will return an error.
3845
3843
  # @param [Fixnum] custom_bidding_algorithm_id
3846
3844
  # Output only. The unique ID of the custom bidding algorithm. Assigned by the
3847
3845
  # system.
@@ -3958,10 +3956,8 @@ module Google
3958
3956
  end
3959
3957
 
3960
3958
  # Creates a new rules resource. Returns the newly created rules resource if
3961
- # successful. *Warning*: Starting **April 1, 2025**, requests updating custom
3962
- # bidding algorithms that are assigned to line items will return an error. [Read
3963
- # more about this announced change](/display-video/api/deprecations#features.
3964
- # custom_bidding_floodlight).
3959
+ # successful. Requests creating a custom bidding rules resource under an
3960
+ # algorithm assigned to a line item will return an error.
3965
3961
  # @param [Fixnum] custom_bidding_algorithm_id
3966
3962
  # Required. The ID of the custom bidding algorithm that owns the rules resource.
3967
3963
  # @param [Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRules] custom_bidding_algorithm_rules_object
@@ -4094,10 +4090,8 @@ module Google
4094
4090
  end
4095
4091
 
4096
4092
  # Creates a new custom bidding script. Returns the newly created script if
4097
- # successful. *Warning*: Starting **April 1, 2025**, requests updating custom
4098
- # bidding algorithms that are assigned to line items will return an error. [Read
4099
- # more about this announced change](/display-video/api/deprecations#features.
4100
- # custom_bidding_floodlight).
4093
+ # successful. Requests creating a custom bidding script under an algorithm
4094
+ # assigned to a line item will return an error.
4101
4095
  # @param [Fixnum] custom_bidding_algorithm_id
4102
4096
  # Required. The ID of the custom bidding algorithm that owns the script.
4103
4097
  # @param [Google::Apis::DisplayvideoV4::CustomBiddingScript] custom_bidding_script_object
@@ -6431,8 +6425,8 @@ module Google
6431
6425
  # SdfDownloadTaskMetadata. If the request is successful, the response type of
6432
6426
  # the operation is SdfDownloadTask. The response will not include the download
6433
6427
  # files, which must be retrieved with media.download. The state of operation can
6434
- # be retrieved with sdfdownloadtask.operations.get. Any errors can be found in
6435
- # the error.message. Note that error.details is expected to be empty.
6428
+ # be retrieved with `sdfdownloadtasks.operations.get`. Any errors can be found
6429
+ # in the error.message. Note that error.details is expected to be empty.
6436
6430
  # @param [Google::Apis::DisplayvideoV4::CreateSdfDownloadTaskRequest] create_sdf_download_task_request_object
6437
6431
  # @param [String] fields
6438
6432
  # Selector specifying which fields to include in a partial response.
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-displayvideo_v4
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-03-23 00:00:00.000000000 Z
10
+ date: 2025-04-27 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: google-apis-core
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v4/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v4/v0.4.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v4/v0.5.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v4
62
62
  rdoc_options: []
63
63
  require_paths: