google-apis-displayvideo_v3 0.22.0 → 0.24.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: fc7c3ecf8c3b241ac1013c31a3f1878fc31a4c587ad5984cfb318505cbf57435
4
- data.tar.gz: b932d85383c1dae27ae4205f95d3f219adc90dc502458d84a9f201d349a03e95
3
+ metadata.gz: 91fe80587c721031cdbcc3853a069be08418fbf8be399c3da8480806d66b9dda
4
+ data.tar.gz: 812d503b2db371196b242992091ec89544e22f4557b5ab40dcce92a103ef2295
5
5
  SHA512:
6
- metadata.gz: 150b3ced390345313671298bd93a95fecf071a83386233feef6d5c48f54376cbbd7e8fe60047a3def253d094f8fbc62d598f92f32fbb7346e08e74341b3cd363
7
- data.tar.gz: 4be372bda044fd169bb4e997300da8fdef5e7c36e2bb88d9f5c147ba4f9e55df5bd9920fa43a10a0eaaf6026eba334b7d70bf6555cd591507d358610ce5970ab
6
+ metadata.gz: 34cf2a0dfeb92c0e6b173e8af3e624c535f5d66b7d746d2c7a42f0784657d4b9adefde44203c7f53f7b117abc0118bb9000e5fe4cdd9432e42c11a48f670c452
7
+ data.tar.gz: f8136923fcdba0db79d638eed0ee3447086aef66f1c9c1a8eb0cf7fffea480dccb93b56a15122487ddd32353fe8c2215020a494ae3bd3cd64f67d1e32e507fb0
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Release history for google-apis-displayvideo_v3
2
2
 
3
+ ### v0.24.0 (2025-03-16)
4
+
5
+ * Regenerated from discovery document revision 20250313
6
+
7
+ ### v0.23.0 (2025-02-26)
8
+
9
+ * Regenerated from discovery document revision 20250220
10
+ * Regenerated using generator version 0.16.0
11
+
3
12
  ### v0.22.0 (2024-12-08)
4
13
 
5
14
  * Regenerated from discovery document revision 20241205
@@ -1200,7 +1200,7 @@ module Google
1200
1200
  # @return [Google::Apis::DisplayvideoV3::Asset]
1201
1201
  attr_accessor :asset
1202
1202
 
1203
- # The role of this asset for the creative.
1203
+ # Optional. The role of this asset for the creative.
1204
1204
  # Corresponds to the JSON property `role`
1205
1205
  # @return [String]
1206
1206
  attr_accessor :role
@@ -1811,12 +1811,12 @@ module Google
1811
1811
  # @return [Google::Apis::DisplayvideoV3::CustomListGroup]
1812
1812
  attr_accessor :included_custom_list_group
1813
1813
 
1814
- # The first and third party audience ids and recencies of included first and
1815
- # third party audience groups. Each first and third party audience group
1816
- # contains first and third party audience ids only. The relation between each
1817
- # first and third party audience group is INTERSECTION, and the result is UNION'
1818
- # ed with other audience groups. Repeated groups with same settings will be
1819
- # ignored.
1814
+ # Optional. The first and third party audience ids and recencies of included
1815
+ # first and third party audience groups. Each first and third party audience
1816
+ # group contains first and third party audience ids only. The relation between
1817
+ # each first and third party audience group is INTERSECTION, and the result is
1818
+ # UNION'ed with other audience groups. Repeated groups with the same settings
1819
+ # will be ignored.
1820
1820
  # Corresponds to the JSON property `includedFirstAndThirdPartyAudienceGroups`
1821
1821
  # @return [Array<Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudienceGroup>]
1822
1822
  attr_accessor :included_first_and_third_party_audience_groups
@@ -1927,12 +1927,12 @@ module Google
1927
1927
  class AudioVideoOffset
1928
1928
  include Google::Apis::Core::Hashable
1929
1929
 
1930
- # The offset in percentage of the audio or video duration.
1930
+ # Optional. The offset in percentage of the audio or video duration.
1931
1931
  # Corresponds to the JSON property `percentage`
1932
1932
  # @return [Fixnum]
1933
1933
  attr_accessor :percentage
1934
1934
 
1935
- # The offset in seconds from the start of the audio or video.
1935
+ # Optional. The offset in seconds from the start of the audio or video.
1936
1936
  # Corresponds to the JSON property `seconds`
1937
1937
  # @return [Fixnum]
1938
1938
  attr_accessor :seconds
@@ -3537,17 +3537,17 @@ module Google
3537
3537
  class CmTrackingAd
3538
3538
  include Google::Apis::Core::Hashable
3539
3539
 
3540
- # The ad ID of the campaign manager 360 tracking Ad.
3540
+ # Optional. The ad ID of the campaign manager 360 tracking Ad.
3541
3541
  # Corresponds to the JSON property `cmAdId`
3542
3542
  # @return [Fixnum]
3543
3543
  attr_accessor :cm_ad_id
3544
3544
 
3545
- # The creative ID of the campaign manager 360 tracking Ad.
3545
+ # Optional. The creative ID of the campaign manager 360 tracking Ad.
3546
3546
  # Corresponds to the JSON property `cmCreativeId`
3547
3547
  # @return [Fixnum]
3548
3548
  attr_accessor :cm_creative_id
3549
3549
 
3550
- # The placement ID of the campaign manager 360 tracking Ad.
3550
+ # Optional. The placement ID of the campaign manager 360 tracking Ad.
3551
3551
  # Corresponds to the JSON property `cmPlacementId`
3552
3552
  # @return [Fixnum]
3553
3553
  attr_accessor :cm_placement_id
@@ -3601,7 +3601,7 @@ module Google
3601
3601
  include Google::Apis::Core::Hashable
3602
3602
 
3603
3603
  # Required. All combined audience targeting settings in combined audience group.
3604
- # Repeated settings with same id will be ignored. The number of combined
3604
+ # Repeated settings with the same id will be ignored. The number of combined
3605
3605
  # audience settings should be no more than five, error will be thrown otherwise.
3606
3606
  # Corresponds to the JSON property `settings`
3607
3607
  # @return [Array<Google::Apis::DisplayvideoV3::CombinedAudienceTargetingSetting>]
@@ -4080,7 +4080,13 @@ module Google
4080
4080
 
4081
4081
  # The Floodlight activity configs used to track conversions. The number of
4082
4082
  # conversions counted is the sum of all of the conversions counted by all of the
4083
- # Floodlight activity IDs specified in this field.
4083
+ # Floodlight activity IDs specified in this field. *Warning*: Starting **April 1,
4084
+ # 2025**, this field will no longer be writable while a custom bidding
4085
+ # algorithm is assigned to the line item. If you set this field and assign a
4086
+ # custom bidding algorithm in the same request, the floodlight activities must
4087
+ # match the ones used by the custom bidding algorithm. [Read more about this
4088
+ # announced change](/display-video/api/deprecations#features.
4089
+ # custom_bidding_floodlight).
4084
4090
  # Corresponds to the JSON property `floodlightActivityConfigs`
4085
4091
  # @return [Array<Google::Apis::DisplayvideoV3::TrackingFloodlightActivityConfig>]
4086
4092
  attr_accessor :floodlight_activity_configs
@@ -4250,7 +4256,7 @@ module Google
4250
4256
  class Creative
4251
4257
  include Google::Apis::Core::Hashable
4252
4258
 
4253
- # Additional dimensions. Applicable when creative_type is one of: * `
4259
+ # Optional. Additional dimensions. Applicable when creative_type is one of: * `
4254
4260
  # CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` *
4255
4261
  # `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `
4256
4262
  # CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and
@@ -4264,7 +4270,7 @@ module Google
4264
4270
  # @return [Fixnum]
4265
4271
  attr_accessor :advertiser_id
4266
4272
 
4267
- # Third-party HTML tracking tag to be appended to the creative tag.
4273
+ # Optional. Third-party HTML tracking tag to be appended to the creative tag.
4268
4274
  # Corresponds to the JSON property `appendedTag`
4269
4275
  # @return [String]
4270
4276
  attr_accessor :appended_tag
@@ -4286,22 +4292,23 @@ module Google
4286
4292
  # @return [Google::Apis::DisplayvideoV3::CmTrackingAd]
4287
4293
  attr_accessor :cm_tracking_ad
4288
4294
 
4289
- # The IDs of companion creatives for a video creative. You can assign existing
4290
- # display creatives (with image or HTML5 assets) to serve surrounding the
4291
- # publisher's video player. Companions display around the video player while the
4292
- # video is playing and remain after the video has completed. Creatives contain
4293
- # additional dimensions can not be companion creatives. This field is only
4294
- # supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `
4295
+ # Optional. The IDs of companion creatives for a video creative. You can assign
4296
+ # existing display creatives (with image or HTML5 assets) to serve surrounding
4297
+ # the publisher's video player. Companions display around the video player while
4298
+ # the video is playing and remain after the video has completed. Creatives
4299
+ # contain additional dimensions can not be companion creatives. This field is
4300
+ # only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `
4295
4301
  # CREATIVE_TYPE_VIDEO`
4296
4302
  # Corresponds to the JSON property `companionCreativeIds`
4297
4303
  # @return [Array<Fixnum>]
4298
4304
  attr_accessor :companion_creative_ids
4299
4305
 
4300
- # Counter events for a rich media creative. Counters track the number of times
4301
- # that a user interacts with any part of a rich media creative in a specified
4302
- # way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries,
4303
- # etc.). Any event that can be captured in the creative can be recorded as a
4304
- # counter. Leave it empty or unset for creatives containing image assets only.
4306
+ # Optional. Counter events for a rich media creative. Counters track the number
4307
+ # of times that a user interacts with any part of a rich media creative in a
4308
+ # specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard
4309
+ # entries, etc.). Any event that can be captured in the creative can be recorded
4310
+ # as a counter. Leave it empty or unset for creatives containing image assets
4311
+ # only.
4305
4312
  # Corresponds to the JSON property `counterEvents`
4306
4313
  # @return [Array<Google::Apis::DisplayvideoV3::CounterEvent>]
4307
4314
  attr_accessor :counter_events
@@ -4394,24 +4401,25 @@ module Google
4394
4401
  attr_accessor :html5_video
4395
4402
  alias_method :html5_video?, :html5_video
4396
4403
 
4397
- # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To
4398
- # enable this for the creative, make sure the Advertiser.creative_config.
4399
- # ias_client_id has been set to your IAS client ID.
4404
+ # Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is
4405
+ # enabled. To enable this for the creative, make sure the Advertiser.
4406
+ # creative_config.ias_client_id has been set to your IAS client ID.
4400
4407
  # Corresponds to the JSON property `iasCampaignMonitoring`
4401
4408
  # @return [Boolean]
4402
4409
  attr_accessor :ias_campaign_monitoring
4403
4410
  alias_method :ias_campaign_monitoring?, :ias_campaign_monitoring
4404
4411
 
4405
- # ID information used to link this creative to an external system. Must be UTF-8
4406
- # encoded with a length of no more than 10,000 characters.
4412
+ # Optional. ID information used to link this creative to an external system.
4413
+ # Must be UTF-8 encoded with a length of no more than 10,000 characters.
4407
4414
  # Corresponds to the JSON property `integrationCode`
4408
4415
  # @return [String]
4409
4416
  attr_accessor :integration_code
4410
4417
 
4411
- # JavaScript measurement URL from supported third-party verification providers (
4412
- # ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This
4413
- # field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` *
4414
- # `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
4418
+ # Optional. JavaScript measurement URL from supported third-party verification
4419
+ # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
4420
+ # supported. This field is only writeable in the following creative_type: * `
4421
+ # CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `
4422
+ # CREATIVE_TYPE_NATIVE_VIDEO`
4415
4423
  # Corresponds to the JSON property `jsTrackerUrl`
4416
4424
  # @return [String]
4417
4425
  attr_accessor :js_tracker_url
@@ -4444,8 +4452,8 @@ module Google
4444
4452
  # @return [String]
4445
4453
  attr_accessor :name
4446
4454
 
4447
- # User notes for this creative. Must be UTF-8 encoded with a length of no more
4448
- # than 20,000 characters.
4455
+ # Optional. User notes for this creative. Must be UTF-8 encoded with a length of
4456
+ # no more than 20,000 characters.
4449
4457
  # Corresponds to the JSON property `notes`
4450
4458
  # @return [String]
4451
4459
  attr_accessor :notes
@@ -4517,8 +4525,8 @@ module Google
4517
4525
  # @return [Google::Apis::DisplayvideoV3::AudioVideoOffset]
4518
4526
  attr_accessor :skip_offset
4519
4527
 
4520
- # Whether the user can choose to skip a video creative. This field is only
4521
- # supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
4528
+ # Optional. Whether the user can choose to skip a video creative. This field is
4529
+ # only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
4522
4530
  # Corresponds to the JSON property `skippable`
4523
4531
  # @return [Boolean]
4524
4532
  attr_accessor :skippable
@@ -4533,27 +4541,28 @@ module Google
4533
4541
  # @return [String]
4534
4542
  attr_accessor :third_party_tag
4535
4543
 
4536
- # Tracking URLs from third parties to track interactions with a video creative.
4537
- # This field is only supported for the following creative_type: * `
4544
+ # Optional. Tracking URLs from third parties to track interactions with a video
4545
+ # creative. This field is only supported for the following creative_type: * `
4538
4546
  # CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`
4539
4547
  # Corresponds to the JSON property `thirdPartyUrls`
4540
4548
  # @return [Array<Google::Apis::DisplayvideoV3::ThirdPartyUrl>]
4541
4549
  attr_accessor :third_party_urls
4542
4550
 
4543
- # Timer custom events for a rich media creative. Timers track the time during
4544
- # which a user views and interacts with a specified part of a rich media
4551
+ # Optional. Timer custom events for a rich media creative. Timers track the time
4552
+ # during which a user views and interacts with a specified part of a rich media
4545
4553
  # creative. A creative can have multiple timer events, each timed independently.
4546
4554
  # Leave it empty or unset for creatives containing image assets only.
4547
4555
  # Corresponds to the JSON property `timerEvents`
4548
4556
  # @return [Array<Google::Apis::DisplayvideoV3::TimerEvent>]
4549
4557
  attr_accessor :timer_events
4550
4558
 
4551
- # Tracking URLs for analytics providers or third-party ad technology vendors.
4552
- # The URLs must start with https (except on inventory that doesn't require SSL
4553
- # compliance). If using macros in your URL, use only macros supported by Display
4554
- # & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only
4555
- # writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `
4556
- # CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
4559
+ # Optional. Tracking URLs for analytics providers or third-party ad technology
4560
+ # vendors. The URLs must start with `https:` (except on inventory that doesn't
4561
+ # require SSL compliance). If using macros in your URL, use only macros
4562
+ # supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags.
4563
+ # This field is only writeable in the following creative_type: * `
4564
+ # CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `
4565
+ # CREATIVE_TYPE_NATIVE_VIDEO`
4557
4566
  # Corresponds to the JSON property `trackerUrls`
4558
4567
  # @return [Array<String>]
4559
4568
  attr_accessor :tracker_urls
@@ -4564,7 +4573,7 @@ module Google
4564
4573
  # each designed for specific video players or bandwidths. These transcodes give
4565
4574
  # a publisher's system more options to choose from for each impression on your
4566
4575
  # video and ensures that the appropriate file serves based on the viewer’s
4567
- # connection and screen size. This field is only supported in following
4576
+ # connection and screen size. This field is only supported in the following
4568
4577
  # creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `
4569
4578
  # CREATIVE_TYPE_AUDIO`
4570
4579
  # Corresponds to the JSON property `transcodes`
@@ -5061,7 +5070,7 @@ module Google
5061
5070
  include Google::Apis::Core::Hashable
5062
5071
 
5063
5072
  # Required. All custom list targeting settings in custom list group. Repeated
5064
- # settings with same id will be ignored.
5073
+ # settings with the same id will be ignored.
5065
5074
  # Corresponds to the JSON property `settings`
5066
5075
  # @return [Array<Google::Apis::DisplayvideoV3::CustomListTargetingSetting>]
5067
5076
  attr_accessor :settings
@@ -6092,15 +6101,15 @@ module Google
6092
6101
  class ExitEvent
6093
6102
  include Google::Apis::Core::Hashable
6094
6103
 
6095
- # The name of the click tag of the exit event. The name must be unique within
6096
- # one creative. Leave it empty or unset for creatives containing image assets
6097
- # only.
6104
+ # Optional. The name of the click tag of the exit event. The name must be unique
6105
+ # within one creative. Leave it empty or unset for creatives containing image
6106
+ # assets only.
6098
6107
  # Corresponds to the JSON property `name`
6099
6108
  # @return [String]
6100
6109
  attr_accessor :name
6101
6110
 
6102
- # The name used to identify this event in reports. Leave it empty or unset for
6103
- # creatives containing image assets only.
6111
+ # Optional. The name used to identify this event in reports. Leave it empty or
6112
+ # unset for creatives containing image assets only.
6104
6113
  # Corresponds to the JSON property `reportingName`
6105
6114
  # @return [String]
6106
6115
  attr_accessor :reporting_name
@@ -6235,7 +6244,12 @@ module Google
6235
6244
  # field to 10000. Otherwise, the set value must be greater than 0 and less than
6236
6245
  # or equal to 540. Only applicable to first party audiences. This field is
6237
6246
  # required if one of the following audience_type is used: * `
6238
- # CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
6247
+ # CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting
6248
+ # on **April 7, 2025**, audiences will no longer be able to have infinite
6249
+ # membership duration. This field will no longer accept the value 10000 and all
6250
+ # audiences with membership durations greater than 540 days will be updated to a
6251
+ # membership duration of 540 days. [Read more about this announced change](/
6252
+ # display-video/api/deprecations#features.audience_duration).
6239
6253
  # Corresponds to the JSON property `membershipDurationDays`
6240
6254
  # @return [Fixnum]
6241
6255
  attr_accessor :membership_duration_days
@@ -6292,7 +6306,7 @@ module Google
6292
6306
  include Google::Apis::Core::Hashable
6293
6307
 
6294
6308
  # Required. All first and third party audience targeting settings in first and
6295
- # third party audience group. Repeated settings with same id are not allowed.
6309
+ # third party audience group. Repeated settings with the same id are not allowed.
6296
6310
  # Corresponds to the JSON property `settings`
6297
6311
  # @return [Array<Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudienceTargetingSetting>]
6298
6312
  attr_accessor :settings
@@ -6317,10 +6331,10 @@ module Google
6317
6331
  # @return [Fixnum]
6318
6332
  attr_accessor :first_and_third_party_audience_id
6319
6333
 
6320
- # The recency of the first and third party audience targeting setting. Only
6321
- # applicable to first party audiences, otherwise will be ignored. For more info,
6322
- # refer to https://support.google.com/displayvideo/answer/2949947#recency When
6323
- # unspecified, no recency limit will be used.
6334
+ # Optional. The recency of the first and third party audience targeting setting.
6335
+ # Only applicable to first party audiences, otherwise will be ignored. For more
6336
+ # info, refer to https://support.google.com/displayvideo/answer/2949947#recency
6337
+ # When unspecified, no recency limit will be used.
6324
6338
  # Corresponds to the JSON property `recency`
6325
6339
  # @return [String]
6326
6340
  attr_accessor :recency
@@ -6522,11 +6536,9 @@ module Google
6522
6536
 
6523
6537
  # The number of time_unit the frequency cap will last. Required when unlimited
6524
6538
  # is `false`. The following restrictions apply based on the value of time_unit: *
6525
- # `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `
6526
- # TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be
6527
- # between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `
6528
- # TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be
6529
- # between 1 and 59
6539
+ # `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 *
6540
+ # `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be
6541
+ # between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59
6530
6542
  # Corresponds to the JSON property `timeUnitCount`
6531
6543
  # @return [Fixnum]
6532
6544
  attr_accessor :time_unit_count
@@ -6763,7 +6775,7 @@ module Google
6763
6775
  include Google::Apis::Core::Hashable
6764
6776
 
6765
6777
  # Required. All Google audience targeting settings in Google audience group.
6766
- # Repeated settings with same id will be ignored.
6778
+ # Repeated settings with the same id will be ignored.
6767
6779
  # Corresponds to the JSON property `settings`
6768
6780
  # @return [Array<Google::Apis::DisplayvideoV3::GoogleAudienceTargetingSetting>]
6769
6781
  attr_accessor :settings
@@ -7193,8 +7205,8 @@ module Google
7193
7205
  # @return [Fixnum]
7194
7206
  attr_accessor :insertion_order_id
7195
7207
 
7196
- # The type of insertion order. If this field is unspecified in creation, the
7197
- # value defaults to `RTB`.
7208
+ # Optional. The type of insertion order. If this field is unspecified in
7209
+ # creation, the value defaults to `RTB`.
7198
7210
  # Corresponds to the JSON property `insertionOrderType`
7199
7211
  # @return [String]
7200
7212
  attr_accessor :insertion_order_type
@@ -7215,9 +7227,7 @@ module Google
7215
7227
  # @return [String]
7216
7228
  attr_accessor :name
7217
7229
 
7218
- # Optional. The optimization objective of the insertion order. **This field is
7219
- # only available to allowlisted customers.** If a customer is not allowlisted,
7220
- # this field will be null and attempts to set it will return an error.
7230
+ # Optional. Required. The optimization objective of the insertion order.
7221
7231
  # Corresponds to the JSON property `optimizationObjective`
7222
7232
  # @return [String]
7223
7233
  attr_accessor :optimization_objective
@@ -7227,9 +7237,9 @@ module Google
7227
7237
  # @return [Google::Apis::DisplayvideoV3::Pacing]
7228
7238
  attr_accessor :pacing
7229
7239
 
7230
- # The partner costs associated with the insertion order. If absent or empty in
7231
- # CreateInsertionOrder method, the newly created insertion order will inherit
7232
- # partner costs from the partner settings.
7240
+ # Optional. The partner costs associated with the insertion order. If absent or
7241
+ # empty in CreateInsertionOrder method, the newly created insertion order will
7242
+ # inherit partner costs from the partner settings.
7233
7243
  # Corresponds to the JSON property `partnerCosts`
7234
7244
  # @return [Array<Google::Apis::DisplayvideoV3::PartnerCost>]
7235
7245
  attr_accessor :partner_costs
@@ -7275,9 +7285,9 @@ module Google
7275
7285
  class InsertionOrderBudget
7276
7286
  include Google::Apis::Core::Hashable
7277
7287
 
7278
- # The type of automation used to manage bid and budget for the insertion order.
7279
- # If this field is unspecified in creation, the value defaults to `
7280
- # INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
7288
+ # Optional. The type of automation used to manage bid and budget for the
7289
+ # insertion order. If this field is unspecified in creation, the value defaults
7290
+ # to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
7281
7291
  # Corresponds to the JSON property `automationType`
7282
7292
  # @return [String]
7283
7293
  attr_accessor :automation_type
@@ -7317,8 +7327,8 @@ module Google
7317
7327
  # @return [Fixnum]
7318
7328
  attr_accessor :budget_amount_micros
7319
7329
 
7320
- # The budget_id of the campaign budget that this insertion order budget segment
7321
- # is a part of.
7330
+ # Optional. The budget_id of the campaign budget that this insertion order
7331
+ # budget segment is a part of.
7322
7332
  # Corresponds to the JSON property `campaignBudgetId`
7323
7333
  # @return [Fixnum]
7324
7334
  attr_accessor :campaign_budget_id
@@ -7328,9 +7338,9 @@ module Google
7328
7338
  # @return [Google::Apis::DisplayvideoV3::DateRange]
7329
7339
  attr_accessor :date_range
7330
7340
 
7331
- # The budget segment description. It can be used to enter Purchase Order
7332
- # information for each budget segment and have that information printed on the
7333
- # invoices. Must be UTF-8 encoded.
7341
+ # Optional. The budget segment description. It can be used to enter Purchase
7342
+ # Order information for each budget segment and have that information printed on
7343
+ # the invoices. Must be UTF-8 encoded.
7334
7344
  # Corresponds to the JSON property `description`
7335
7345
  # @return [String]
7336
7346
  attr_accessor :description
@@ -7353,7 +7363,7 @@ module Google
7353
7363
  include Google::Apis::Core::Hashable
7354
7364
 
7355
7365
  # The custom segment ID provided by Integral Ad Science. The ID must be between `
7356
- # 1000001` and `1999999`, inclusive.
7366
+ # 1000001` and `1999999` or `3000001` and `3999999`, inclusive.
7357
7367
  # Corresponds to the JSON property `customSegmentId`
7358
7368
  # @return [Array<Fixnum>]
7359
7369
  attr_accessor :custom_segment_id
@@ -7414,6 +7424,12 @@ module Google
7414
7424
  # @return [String]
7415
7425
  attr_accessor :excluded_violence_risk
7416
7426
 
7427
+ # Optional. The quality sync custom segment ID provided by Integral Ad Science.
7428
+ # The ID must be between `3000000` and `4999999`, inclusive.
7429
+ # Corresponds to the JSON property `qualitySyncCustomSegmentId`
7430
+ # @return [Array<Fixnum>]
7431
+ attr_accessor :quality_sync_custom_segment_id
7432
+
7417
7433
  # True advertising quality (applicable to Display line items only).
7418
7434
  # Corresponds to the JSON property `traqScoreOption`
7419
7435
  # @return [String]
@@ -7442,6 +7458,7 @@ module Google
7442
7458
  @excluded_illegal_downloads_risk = args[:excluded_illegal_downloads_risk] if args.key?(:excluded_illegal_downloads_risk)
7443
7459
  @excluded_offensive_language_risk = args[:excluded_offensive_language_risk] if args.key?(:excluded_offensive_language_risk)
7444
7460
  @excluded_violence_risk = args[:excluded_violence_risk] if args.key?(:excluded_violence_risk)
7461
+ @quality_sync_custom_segment_id = args[:quality_sync_custom_segment_id] if args.key?(:quality_sync_custom_segment_id)
7445
7462
  @traq_score_option = args[:traq_score_option] if args.key?(:traq_score_option)
7446
7463
  @video_viewability = args[:video_viewability] if args.key?(:video_viewability)
7447
7464
  end
@@ -9603,7 +9620,11 @@ module Google
9603
9620
 
9604
9621
  # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable
9605
9622
  # when performance_goal_type is set to `
9606
- # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
9623
+ # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **
9624
+ # April 1, 2025**, assigning a custom bidding algorithm that uses floodlight
9625
+ # activities not identified in floodlightActivityConfigs will return an error. [
9626
+ # Read more about this announced change](/display-video/api/deprecations#
9627
+ # features.custom_bidding_floodlight).
9607
9628
  # Corresponds to the JSON property `customBiddingAlgorithmId`
9608
9629
  # @return [Fixnum]
9609
9630
  attr_accessor :custom_bidding_algorithm_id
@@ -9945,7 +9966,7 @@ module Google
9945
9966
  include Google::Apis::Core::Hashable
9946
9967
 
9947
9968
  # Required. The click tracking URL of the OBA icon. Only URLs of the following
9948
- # domains are allowed: * https://info.evidon.com * https://l.betrad.com
9969
+ # domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
9949
9970
  # Corresponds to the JSON property `clickTrackingUrl`
9950
9971
  # @return [String]
9951
9972
  attr_accessor :click_tracking_url
@@ -9956,33 +9977,33 @@ module Google
9956
9977
  attr_accessor :dimensions
9957
9978
 
9958
9979
  # Required. The landing page URL of the OBA icon. Only URLs of the following
9959
- # domains are allowed: * https://info.evidon.com * https://l.betrad.com
9980
+ # domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
9960
9981
  # Corresponds to the JSON property `landingPageUrl`
9961
9982
  # @return [String]
9962
9983
  attr_accessor :landing_page_url
9963
9984
 
9964
- # The position of the OBA icon on the creative.
9985
+ # Optional. The position of the OBA icon on the creative.
9965
9986
  # Corresponds to the JSON property `position`
9966
9987
  # @return [String]
9967
9988
  attr_accessor :position
9968
9989
 
9969
- # The program of the OBA icon. For example: “AdChoices”.
9990
+ # Optional. The program of the OBA icon. For example: “AdChoices”.
9970
9991
  # Corresponds to the JSON property `program`
9971
9992
  # @return [String]
9972
9993
  attr_accessor :program
9973
9994
 
9974
- # The MIME type of the OBA icon resource.
9995
+ # Optional. The MIME type of the OBA icon resource.
9975
9996
  # Corresponds to the JSON property `resourceMimeType`
9976
9997
  # @return [String]
9977
9998
  attr_accessor :resource_mime_type
9978
9999
 
9979
- # The URL of the OBA icon resource.
10000
+ # Optional. The URL of the OBA icon resource.
9980
10001
  # Corresponds to the JSON property `resourceUrl`
9981
10002
  # @return [String]
9982
10003
  attr_accessor :resource_url
9983
10004
 
9984
10005
  # Required. The view tracking URL of the OBA icon. Only URLs of the following
9985
- # domains are allowed: * https://info.evidon.com * https://l.betrad.com
10006
+ # domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
9986
10007
  # Corresponds to the JSON property `viewTrackingUrl`
9987
10008
  # @return [String]
9988
10009
  attr_accessor :view_tracking_url
@@ -10656,7 +10677,11 @@ module Google
10656
10677
 
10657
10678
  # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable
10658
10679
  # when performance_goal_type is set to `
10659
- # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
10680
+ # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **
10681
+ # April 1, 2025**, assigning a custom bidding algorithm that uses floodlight
10682
+ # activities not identified in floodlightActivityConfigs will return an error. [
10683
+ # Read more about this announced change](/display-video/api/deprecations#
10684
+ # features.custom_bidding_floodlight).
10660
10685
  # Corresponds to the JSON property `customBiddingAlgorithmId`
10661
10686
  # @return [Fixnum]
10662
10687
  attr_accessor :custom_bidding_algorithm_id
@@ -11679,10 +11704,10 @@ module Google
11679
11704
 
11680
11705
  # Required. Whether to enable Optimized Targeting for the line item. Optimized
11681
11706
  # targeting is not compatible with all bid strategies. Attempting to set this
11682
- # field to `true` for a line item using one of the following combinations of
11683
- # BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in
11684
- # an error: maximize_auto_spend_bid: * `
11685
- # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `
11707
+ # field to `true` for a line item using the BiddingStrategy field fixed_bid or
11708
+ # one of the following combinations of BiddingStrategy fields and
11709
+ # BiddingStrategyPerformanceGoalType will result in an error:
11710
+ # maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `
11686
11711
  # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `
11687
11712
  # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: *
11688
11713
  # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
@@ -12071,14 +12096,14 @@ module Google
12071
12096
  class ThirdPartyUrl
12072
12097
  include Google::Apis::Core::Hashable
12073
12098
 
12074
- # The type of interaction needs to be tracked by the tracking URL
12099
+ # Optional. The type of interaction needs to be tracked by the tracking URL
12075
12100
  # Corresponds to the JSON property `type`
12076
12101
  # @return [String]
12077
12102
  attr_accessor :type
12078
12103
 
12079
- # Tracking URL used to track the interaction. Provide a URL with optional path
12080
- # or query string, beginning with `https:`. For example, https://www.example.com/
12081
- # path
12104
+ # Optional. Tracking URL used to track the interaction. Provide a URL with
12105
+ # optional path or query string, beginning with `https:`. For example, `https://
12106
+ # www.example.com/path`
12082
12107
  # Corresponds to the JSON property `url`
12083
12108
  # @return [String]
12084
12109
  attr_accessor :url
@@ -12240,19 +12265,20 @@ module Google
12240
12265
  class Transcode
12241
12266
  include Google::Apis::Core::Hashable
12242
12267
 
12243
- # The bit rate for the audio stream of the transcoded video, or the bit rate for
12244
- # the transcoded audio, in kilobits per second.
12268
+ # Optional. The bit rate for the audio stream of the transcoded video, or the
12269
+ # bit rate for the transcoded audio, in kilobits per second.
12245
12270
  # Corresponds to the JSON property `audioBitRateKbps`
12246
12271
  # @return [Fixnum]
12247
12272
  attr_accessor :audio_bit_rate_kbps
12248
12273
 
12249
- # The sample rate for the audio stream of the transcoded video, or the sample
12250
- # rate for the transcoded audio, in hertz.
12274
+ # Optional. The sample rate for the audio stream of the transcoded video, or the
12275
+ # sample rate for the transcoded audio, in hertz.
12251
12276
  # Corresponds to the JSON property `audioSampleRateHz`
12252
12277
  # @return [Fixnum]
12253
12278
  attr_accessor :audio_sample_rate_hz
12254
12279
 
12255
- # The transcoding bit rate of the transcoded video, in kilobits per second.
12280
+ # Optional. The transcoding bit rate of the transcoded video, in kilobits per
12281
+ # second.
12256
12282
  # Corresponds to the JSON property `bitRateKbps`
12257
12283
  # @return [Fixnum]
12258
12284
  attr_accessor :bit_rate_kbps
@@ -12262,27 +12288,27 @@ module Google
12262
12288
  # @return [Google::Apis::DisplayvideoV3::Dimensions]
12263
12289
  attr_accessor :dimensions
12264
12290
 
12265
- # The size of the transcoded file, in bytes.
12291
+ # Optional. The size of the transcoded file, in bytes.
12266
12292
  # Corresponds to the JSON property `fileSizeBytes`
12267
12293
  # @return [Fixnum]
12268
12294
  attr_accessor :file_size_bytes
12269
12295
 
12270
- # The frame rate of the transcoded video, in frames per second.
12296
+ # Optional. The frame rate of the transcoded video, in frames per second.
12271
12297
  # Corresponds to the JSON property `frameRate`
12272
12298
  # @return [Float]
12273
12299
  attr_accessor :frame_rate
12274
12300
 
12275
- # The MIME type of the transcoded file.
12301
+ # Optional. The MIME type of the transcoded file.
12276
12302
  # Corresponds to the JSON property `mimeType`
12277
12303
  # @return [String]
12278
12304
  attr_accessor :mime_type
12279
12305
 
12280
- # The name of the transcoded file.
12306
+ # Optional. The name of the transcoded file.
12281
12307
  # Corresponds to the JSON property `name`
12282
12308
  # @return [String]
12283
12309
  attr_accessor :name
12284
12310
 
12285
- # Indicates if the transcoding was successful.
12311
+ # Optional. Indicates if the transcoding was successful.
12286
12312
  # Corresponds to the JSON property `transcoded`
12287
12313
  # @return [Boolean]
12288
12314
  attr_accessor :transcoded
@@ -12311,12 +12337,12 @@ module Google
12311
12337
  class UniversalAdId
12312
12338
  include Google::Apis::Core::Hashable
12313
12339
 
12314
- # The unique creative identifier.
12340
+ # Optional. The unique creative identifier.
12315
12341
  # Corresponds to the JSON property `id`
12316
12342
  # @return [String]
12317
12343
  attr_accessor :id
12318
12344
 
12319
- # The registry provides unique creative identifiers.
12345
+ # Optional. The registry provides unique creative identifiers.
12320
12346
  # Corresponds to the JSON property `registry`
12321
12347
  # @return [String]
12322
12348
  attr_accessor :registry
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DisplayvideoV3
18
18
  # Version of the google-apis-displayvideo_v3 gem
19
- GEM_VERSION = "0.22.0"
19
+ GEM_VERSION = "0.24.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.15.1"
22
+ GENERATOR_VERSION = "0.16.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20241205"
25
+ REVISION = "20250313"
26
26
  end
27
27
  end
28
28
  end
@@ -4015,6 +4015,7 @@ module Google
4015
4015
  property :excluded_illegal_downloads_risk, as: 'excludedIllegalDownloadsRisk'
4016
4016
  property :excluded_offensive_language_risk, as: 'excludedOffensiveLanguageRisk'
4017
4017
  property :excluded_violence_risk, as: 'excludedViolenceRisk'
4018
+ collection :quality_sync_custom_segment_id, as: 'qualitySyncCustomSegmentId'
4018
4019
  property :traq_score_option, as: 'traqScoreOption'
4019
4020
  property :video_viewability, as: 'videoViewability'
4020
4021
  end
@@ -4372,7 +4372,10 @@ module Google
4372
4372
  end
4373
4373
 
4374
4374
  # Updates an existing custom bidding algorithm. Returns the updated custom
4375
- # bidding algorithm if successful.
4375
+ # bidding algorithm if successful. *Warning*: Starting **April 1, 2025**,
4376
+ # requests updating custom bidding algorithms that are assigned to line items
4377
+ # will return an error. [Read more about this announced change](/display-video/
4378
+ # api/deprecations#features.custom_bidding_floodlight).
4376
4379
  # @param [Fixnum] custom_bidding_algorithm_id
4377
4380
  # Output only. The unique ID of the custom bidding algorithm. Assigned by the
4378
4381
  # system.
@@ -4489,7 +4492,10 @@ module Google
4489
4492
  end
4490
4493
 
4491
4494
  # Creates a new rules resource. Returns the newly created rules resource if
4492
- # successful.
4495
+ # successful. *Warning*: Starting **April 1, 2025**, requests updating custom
4496
+ # bidding algorithms that are assigned to line items will return an error. [Read
4497
+ # more about this announced change](/display-video/api/deprecations#features.
4498
+ # custom_bidding_floodlight).
4493
4499
  # @param [Fixnum] custom_bidding_algorithm_id
4494
4500
  # Required. The ID of the custom bidding algorithm that owns the rules resource.
4495
4501
  # @param [Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules] custom_bidding_algorithm_rules_object
@@ -4622,7 +4628,10 @@ module Google
4622
4628
  end
4623
4629
 
4624
4630
  # Creates a new custom bidding script. Returns the newly created script if
4625
- # successful.
4631
+ # successful. *Warning*: Starting **April 1, 2025**, requests updating custom
4632
+ # bidding algorithms that are assigned to line items will return an error. [Read
4633
+ # more about this announced change](/display-video/api/deprecations#features.
4634
+ # custom_bidding_floodlight).
4626
4635
  # @param [Fixnum] custom_bidding_algorithm_id
4627
4636
  # Required. The ID of the custom bidding algorithm that owns the script.
4628
4637
  # @param [Google::Apis::DisplayvideoV3::CustomBiddingScript] custom_bidding_script_object
@@ -4977,7 +4986,7 @@ module Google
4977
4986
  # should be added to the field name. Example: `displayName desc`.
4978
4987
  # @param [Fixnum] page_size
4979
4988
  # Requested page size. Must be between `1` and `5000`. If unspecified, this
4980
- # value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid
4989
+ # value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid
4981
4990
  # value is specified.
4982
4991
  # @param [String] page_token
4983
4992
  # A token identifying a page of results the server should return. Typically,
@@ -7018,6 +7027,37 @@ module Google
7018
7027
  execute_or_queue_command(command, &block)
7019
7028
  end
7020
7029
 
7030
+ # Gets the latest state of an asynchronous SDF download task operation. Clients
7031
+ # should poll this method at intervals of 30 seconds.
7032
+ # @param [String] name
7033
+ # The name of the operation resource.
7034
+ # @param [String] fields
7035
+ # Selector specifying which fields to include in a partial response.
7036
+ # @param [String] quota_user
7037
+ # Available to use for quota purposes for server-side applications. Can be any
7038
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7039
+ # @param [Google::Apis::RequestOptions] options
7040
+ # Request-specific options
7041
+ #
7042
+ # @yield [result, err] Result & error if block supplied
7043
+ # @yieldparam result [Google::Apis::DisplayvideoV3::Operation] parsed result object
7044
+ # @yieldparam err [StandardError] error object if request failed
7045
+ #
7046
+ # @return [Google::Apis::DisplayvideoV3::Operation]
7047
+ #
7048
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7049
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7050
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7051
+ def get_sdfuploadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block)
7052
+ command = make_simple_command(:get, 'v3/{+name}', options)
7053
+ command.response_representation = Google::Apis::DisplayvideoV3::Operation::Representation
7054
+ command.response_class = Google::Apis::DisplayvideoV3::Operation
7055
+ command.params['name'] = name unless name.nil?
7056
+ command.query['fields'] = fields unless fields.nil?
7057
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7058
+ execute_or_queue_command(command, &block)
7059
+ end
7060
+
7021
7061
  # Gets a single targeting option.
7022
7062
  # @param [String] targeting_type
7023
7063
  # Required. The type of targeting option to retrieve. Accepted values are: * `
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-displayvideo_v3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.22.0
4
+ version: 0.24.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-12-08 00:00:00.000000000 Z
10
+ date: 2025-03-16 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-apis-core
@@ -58,9 +57,8 @@ licenses:
58
57
  metadata:
59
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v3/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v3/v0.22.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v3/v0.24.0
62
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v3
63
- post_install_message:
64
62
  rdoc_options: []
65
63
  require_paths:
66
64
  - lib
@@ -75,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
73
  - !ruby/object:Gem::Version
76
74
  version: '0'
77
75
  requirements: []
78
- rubygems_version: 3.5.23
79
- signing_key:
76
+ rubygems_version: 3.6.5
80
77
  specification_version: 4
81
78
  summary: Simple REST client for Display & Video 360 API V3
82
79
  test_files: []