google-apis-displayvideo_v1 0.32.0 → 0.33.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: bfd977c758004f5a9bd0861c3e54e2a797fccf030f8de37da487e67af9cee091
4
- data.tar.gz: ae196be3108a348dc4b32b0086b1234661999ec2be3d441215d4c75c1c1e1d3a
3
+ metadata.gz: 6e6de1a8fbd7a7f88938676ce13239b16da0317af8e482b5897f299caf271baf
4
+ data.tar.gz: 992d6b1774885c52d371ca1ef8d193e351edd350cce747623f74cb984e47cf0d
5
5
  SHA512:
6
- metadata.gz: 2ade31d08015ac3e6397b7297d0ca0ae82878b08ce77839fed1964ab042d6f41241c5bdb777dfb064a3bfdfdce49cb058a4f54b04543bffa3e07e9e4d4bc9d76
7
- data.tar.gz: 9b9edc778cf3094299e22b8038d84188ea96b57a6f02bea081ccc2890655935e4136da26a7080ee943ccf46bad29bd7360a1465c8628f42de7990cf2fa48432e
6
+ metadata.gz: baccc2c6260f3fdbbdd65b36b7d9818c7bceb2cb1678217e33eb57cec67e2aa04012763fbb91dba7096fd222965be97723d249f098a22096074d709b6047a3d3
7
+ data.tar.gz: e1618386bec6dc746dc1ed0d0b6862a69be25317684a5bc4f821b16430148b70552b4a3ac75e2c9c483742d6dfbd35ec8549aa451451fd530baae6212a5475af
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-displayvideo_v1
2
2
 
3
+ ### v0.33.0 (2022-05-28)
4
+
5
+ * Regenerated from discovery document revision 20220526
6
+
3
7
  ### v0.32.0 (2022-05-20)
4
8
 
5
9
  * Regenerated from discovery document revision 20220518
@@ -3781,9 +3781,9 @@ module Google
3781
3781
  # @return [String]
3782
3782
  attr_accessor :entity_status
3783
3783
 
3784
- # Output only. The custom bidding model readiness state for each advertiser who
3785
- # have access. This field may only include the state of the queried advertiser
3786
- # if the algorithm [`owner`](/display-video/api/reference/rest/v1/
3784
+ # Output only. The state of custom bidding model readiness for each advertiser
3785
+ # who has access. This field may only include the state of the queried
3786
+ # advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/
3787
3787
  # customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a
3788
3788
  # partner and is being retrieved using an advertiser [`accessor`](/display-video/
3789
3789
  # api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.
@@ -3837,7 +3837,7 @@ module Google
3837
3837
  class CustomBiddingModelReadinessState
3838
3838
  include Google::Apis::Core::Hashable
3839
3839
 
3840
- # The unique ID of the advertiser with access to the custom bidding algorithm.
3840
+ # The unique ID of the relevant advertiser.
3841
3841
  # Corresponds to the JSON property `advertiserId`
3842
3842
  # @return [Fixnum]
3843
3843
  attr_accessor :advertiser_id
@@ -4606,6 +4606,134 @@ module Google
4606
4606
  end
4607
4607
  end
4608
4608
 
4609
+ # Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors.
4610
+ class EditGuaranteedOrderReadAccessorsRequest
4611
+ include Google::Apis::Core::Hashable
4612
+
4613
+ # The advertisers to add as read accessors to the guaranteed order.
4614
+ # Corresponds to the JSON property `addedAdvertisers`
4615
+ # @return [Array<Fixnum>]
4616
+ attr_accessor :added_advertisers
4617
+
4618
+ # Required. The partner context in which the change is being made.
4619
+ # Corresponds to the JSON property `partnerId`
4620
+ # @return [Fixnum]
4621
+ attr_accessor :partner_id
4622
+
4623
+ # Whether to give all advertisers of the read/write accessor partner read access
4624
+ # to the guaranteed order. Only applicable if read_write_partner_id is set in
4625
+ # the guaranteed order.
4626
+ # Corresponds to the JSON property `readAccessInherited`
4627
+ # @return [Boolean]
4628
+ attr_accessor :read_access_inherited
4629
+ alias_method :read_access_inherited?, :read_access_inherited
4630
+
4631
+ # The advertisers to remove as read accessors to the guaranteed order.
4632
+ # Corresponds to the JSON property `removedAdvertisers`
4633
+ # @return [Array<Fixnum>]
4634
+ attr_accessor :removed_advertisers
4635
+
4636
+ def initialize(**args)
4637
+ update!(**args)
4638
+ end
4639
+
4640
+ # Update properties of this object
4641
+ def update!(**args)
4642
+ @added_advertisers = args[:added_advertisers] if args.key?(:added_advertisers)
4643
+ @partner_id = args[:partner_id] if args.key?(:partner_id)
4644
+ @read_access_inherited = args[:read_access_inherited] if args.key?(:read_access_inherited)
4645
+ @removed_advertisers = args[:removed_advertisers] if args.key?(:removed_advertisers)
4646
+ end
4647
+ end
4648
+
4649
+ #
4650
+ class EditGuaranteedOrderReadAccessorsResponse
4651
+ include Google::Apis::Core::Hashable
4652
+
4653
+ # Whether all advertisers of read_write_partner_id have read access to the
4654
+ # guaranteed order.
4655
+ # Corresponds to the JSON property `readAccessInherited`
4656
+ # @return [Boolean]
4657
+ attr_accessor :read_access_inherited
4658
+ alias_method :read_access_inherited?, :read_access_inherited
4659
+
4660
+ # The IDs of advertisers with read access to the guaranteed order.
4661
+ # Corresponds to the JSON property `readAdvertiserIds`
4662
+ # @return [Array<Fixnum>]
4663
+ attr_accessor :read_advertiser_ids
4664
+
4665
+ def initialize(**args)
4666
+ update!(**args)
4667
+ end
4668
+
4669
+ # Update properties of this object
4670
+ def update!(**args)
4671
+ @read_access_inherited = args[:read_access_inherited] if args.key?(:read_access_inherited)
4672
+ @read_advertiser_ids = args[:read_advertiser_ids] if args.key?(:read_advertiser_ids)
4673
+ end
4674
+ end
4675
+
4676
+ # Request message for InventorySourceService.
4677
+ # EditInventorySourceReadWriteAccessors.
4678
+ class EditInventorySourceReadWriteAccessorsRequest
4679
+ include Google::Apis::Core::Hashable
4680
+
4681
+ # Update to the list of advertisers with read/write access to the inventory
4682
+ # source.
4683
+ # Corresponds to the JSON property `advertisersUpdate`
4684
+ # @return [Google::Apis::DisplayvideoV1::EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate]
4685
+ attr_accessor :advertisers_update
4686
+
4687
+ # Set the partner context as read/write accessor of the inventory source. This
4688
+ # will remove all other current read/write advertiser accessors.
4689
+ # Corresponds to the JSON property `assignPartner`
4690
+ # @return [Boolean]
4691
+ attr_accessor :assign_partner
4692
+ alias_method :assign_partner?, :assign_partner
4693
+
4694
+ # Required. The partner context by which the accessors change is being made.
4695
+ # Corresponds to the JSON property `partnerId`
4696
+ # @return [Fixnum]
4697
+ attr_accessor :partner_id
4698
+
4699
+ def initialize(**args)
4700
+ update!(**args)
4701
+ end
4702
+
4703
+ # Update properties of this object
4704
+ def update!(**args)
4705
+ @advertisers_update = args[:advertisers_update] if args.key?(:advertisers_update)
4706
+ @assign_partner = args[:assign_partner] if args.key?(:assign_partner)
4707
+ @partner_id = args[:partner_id] if args.key?(:partner_id)
4708
+ end
4709
+ end
4710
+
4711
+ # Update to the list of advertisers with read/write access to the inventory
4712
+ # source.
4713
+ class EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate
4714
+ include Google::Apis::Core::Hashable
4715
+
4716
+ # The advertisers to add.
4717
+ # Corresponds to the JSON property `addedAdvertisers`
4718
+ # @return [Array<Fixnum>]
4719
+ attr_accessor :added_advertisers
4720
+
4721
+ # The advertisers to remove.
4722
+ # Corresponds to the JSON property `removedAdvertisers`
4723
+ # @return [Array<Fixnum>]
4724
+ attr_accessor :removed_advertisers
4725
+
4726
+ def initialize(**args)
4727
+ update!(**args)
4728
+ end
4729
+
4730
+ # Update properties of this object
4731
+ def update!(**args)
4732
+ @added_advertisers = args[:added_advertisers] if args.key?(:added_advertisers)
4733
+ @removed_advertisers = args[:removed_advertisers] if args.key?(:removed_advertisers)
4734
+ end
4735
+ end
4736
+
4609
4737
  # A generic empty message that you can re-use to avoid defining duplicated empty
4610
4738
  # messages in your APIs. A typical example is to use it as the request or the
4611
4739
  # response type of an API method. For instance: service Foo ` rpc Bar(google.
@@ -5458,6 +5586,161 @@ module Google
5458
5586
  end
5459
5587
  end
5460
5588
 
5589
+ # A guaranteed order. Guaranteed orders are parent entity of guaranteed
5590
+ # inventory sources. When creating a guaranteed inventory source, a guaranteed
5591
+ # order ID must be assigned to the inventory source.
5592
+ class GuaranteedOrder
5593
+ include Google::Apis::Core::Hashable
5594
+
5595
+ # Output only. The ID of default advertiser of the guaranteed order. The default
5596
+ # advertiser is either the read_write_advertiser_id or, if that is not set, the
5597
+ # first advertiser listed in read_advertiser_ids. Otherwise, there is no default
5598
+ # advertiser.
5599
+ # Corresponds to the JSON property `defaultAdvertiserId`
5600
+ # @return [Fixnum]
5601
+ attr_accessor :default_advertiser_id
5602
+
5603
+ # The ID of the default campaign that is assigned to the guaranteed order. The
5604
+ # default campaign must belong to the default advertiser.
5605
+ # Corresponds to the JSON property `defaultCampaignId`
5606
+ # @return [Fixnum]
5607
+ attr_accessor :default_campaign_id
5608
+
5609
+ # Required. The display name of the guaranteed order. Must be UTF-8 encoded with
5610
+ # a maximum size of 240 bytes.
5611
+ # Corresponds to the JSON property `displayName`
5612
+ # @return [String]
5613
+ attr_accessor :display_name
5614
+
5615
+ # Required. Immutable. The exchange where the guaranteed order originated.
5616
+ # Corresponds to the JSON property `exchange`
5617
+ # @return [String]
5618
+ attr_accessor :exchange
5619
+
5620
+ # Output only. The unique identifier of the guaranteed order. The guaranteed
5621
+ # order IDs have the format ``exchange`-`legacy_guaranteed_order_id``.
5622
+ # Corresponds to the JSON property `guaranteedOrderId`
5623
+ # @return [String]
5624
+ attr_accessor :guaranteed_order_id
5625
+
5626
+ # Output only. The legacy ID of the guaranteed order. Assigned by the original
5627
+ # exchange. The legacy ID is unique within one exchange, but is not guaranteed
5628
+ # to be unique across all guaranteed orders. This ID is used in SDF and UI.
5629
+ # Corresponds to the JSON property `legacyGuaranteedOrderId`
5630
+ # @return [String]
5631
+ attr_accessor :legacy_guaranteed_order_id
5632
+
5633
+ # Output only. The resource name of the guaranteed order.
5634
+ # Corresponds to the JSON property `name`
5635
+ # @return [String]
5636
+ attr_accessor :name
5637
+
5638
+ # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded
5639
+ # with a maximum size of 240 bytes.
5640
+ # Corresponds to the JSON property `publisherName`
5641
+ # @return [String]
5642
+ attr_accessor :publisher_name
5643
+
5644
+ # Whether all advertisers of read_write_partner_id have read access to the
5645
+ # guaranteed order. Only applicable if read_write_partner_id is set. If True,
5646
+ # overrides read_advertiser_ids.
5647
+ # Corresponds to the JSON property `readAccessInherited`
5648
+ # @return [Boolean]
5649
+ attr_accessor :read_access_inherited
5650
+ alias_method :read_access_inherited?, :read_access_inherited
5651
+
5652
+ # The IDs of advertisers with read access to the guaranteed order. This field
5653
+ # must not include the advertiser assigned to read_write_advertiser_id if it is
5654
+ # set. All advertisers in this field must belong to read_write_partner_id or the
5655
+ # same partner as read_write_advertiser_id.
5656
+ # Corresponds to the JSON property `readAdvertiserIds`
5657
+ # @return [Array<Fixnum>]
5658
+ attr_accessor :read_advertiser_ids
5659
+
5660
+ # The advertiser with read/write access to the guaranteed order. This is also
5661
+ # the default advertiser of the guaranteed order.
5662
+ # Corresponds to the JSON property `readWriteAdvertiserId`
5663
+ # @return [Fixnum]
5664
+ attr_accessor :read_write_advertiser_id
5665
+
5666
+ # The partner with read/write access to the guaranteed order.
5667
+ # Corresponds to the JSON property `readWritePartnerId`
5668
+ # @return [Fixnum]
5669
+ attr_accessor :read_write_partner_id
5670
+
5671
+ # The status settings of the guaranteed order.
5672
+ # Corresponds to the JSON property `status`
5673
+ # @return [Google::Apis::DisplayvideoV1::GuaranteedOrderStatus]
5674
+ attr_accessor :status
5675
+
5676
+ # Output only. The timestamp when the guaranteed order was last updated.
5677
+ # Assigned by the system.
5678
+ # Corresponds to the JSON property `updateTime`
5679
+ # @return [String]
5680
+ attr_accessor :update_time
5681
+
5682
+ def initialize(**args)
5683
+ update!(**args)
5684
+ end
5685
+
5686
+ # Update properties of this object
5687
+ def update!(**args)
5688
+ @default_advertiser_id = args[:default_advertiser_id] if args.key?(:default_advertiser_id)
5689
+ @default_campaign_id = args[:default_campaign_id] if args.key?(:default_campaign_id)
5690
+ @display_name = args[:display_name] if args.key?(:display_name)
5691
+ @exchange = args[:exchange] if args.key?(:exchange)
5692
+ @guaranteed_order_id = args[:guaranteed_order_id] if args.key?(:guaranteed_order_id)
5693
+ @legacy_guaranteed_order_id = args[:legacy_guaranteed_order_id] if args.key?(:legacy_guaranteed_order_id)
5694
+ @name = args[:name] if args.key?(:name)
5695
+ @publisher_name = args[:publisher_name] if args.key?(:publisher_name)
5696
+ @read_access_inherited = args[:read_access_inherited] if args.key?(:read_access_inherited)
5697
+ @read_advertiser_ids = args[:read_advertiser_ids] if args.key?(:read_advertiser_ids)
5698
+ @read_write_advertiser_id = args[:read_write_advertiser_id] if args.key?(:read_write_advertiser_id)
5699
+ @read_write_partner_id = args[:read_write_partner_id] if args.key?(:read_write_partner_id)
5700
+ @status = args[:status] if args.key?(:status)
5701
+ @update_time = args[:update_time] if args.key?(:update_time)
5702
+ end
5703
+ end
5704
+
5705
+ # The status settings of the guaranteed order.
5706
+ class GuaranteedOrderStatus
5707
+ include Google::Apis::Core::Hashable
5708
+
5709
+ # Output only. The configuration status of the guaranteed order. Acceptable
5710
+ # values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (
5711
+ # fill in the required fields, choose creatives, and select a default campaign)
5712
+ # before it can serve. Currently the configuration action can only be performed
5713
+ # via UI.
5714
+ # Corresponds to the JSON property `configStatus`
5715
+ # @return [String]
5716
+ attr_accessor :config_status
5717
+
5718
+ # The user-provided reason for pausing this guaranteed order. Must be UTF-8
5719
+ # encoded with a maximum length of 100 bytes. Only applicable when entity_status
5720
+ # is set to `ENTITY_STATUS_PAUSED`.
5721
+ # Corresponds to the JSON property `entityPauseReason`
5722
+ # @return [String]
5723
+ attr_accessor :entity_pause_reason
5724
+
5725
+ # Whether or not the guaranteed order is servable. Acceptable values are `
5726
+ # ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`.
5727
+ # Default value is `ENTITY_STATUS_ACTIVE`.
5728
+ # Corresponds to the JSON property `entityStatus`
5729
+ # @return [String]
5730
+ attr_accessor :entity_status
5731
+
5732
+ def initialize(**args)
5733
+ update!(**args)
5734
+ end
5735
+
5736
+ # Update properties of this object
5737
+ def update!(**args)
5738
+ @config_status = args[:config_status] if args.key?(:config_status)
5739
+ @entity_pause_reason = args[:entity_pause_reason] if args.key?(:entity_pause_reason)
5740
+ @entity_status = args[:entity_status] if args.key?(:entity_status)
5741
+ end
5742
+ end
5743
+
5461
5744
  # Details for assigned household income targeting option. This will be populated
5462
5745
  # in the details field of an AssignedTargetingOption when targeting_type is `
5463
5746
  # TARGETING_TYPE_HOUSEHOLD_INCOME`.
@@ -5936,11 +6219,24 @@ module Google
5936
6219
  # @return [String]
5937
6220
  attr_accessor :exchange
5938
6221
 
6222
+ # Immutable. The ID of the guaranteed order that this inventory source belongs
6223
+ # to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`
6224
+ # .
6225
+ # Corresponds to the JSON property `guaranteedOrderId`
6226
+ # @return [String]
6227
+ attr_accessor :guaranteed_order_id
6228
+
5939
6229
  # Output only. The unique ID of the inventory source. Assigned by the system.
5940
6230
  # Corresponds to the JSON property `inventorySourceId`
5941
6231
  # @return [Fixnum]
5942
6232
  attr_accessor :inventory_source_id
5943
6233
 
6234
+ # Output only. The product type of the inventory source, denoting the way
6235
+ # through which it sells inventory.
6236
+ # Corresponds to the JSON property `inventorySourceProductType`
6237
+ # @return [String]
6238
+ attr_accessor :inventory_source_product_type
6239
+
5944
6240
  # Denotes the type of the inventory source.
5945
6241
  # Corresponds to the JSON property `inventorySourceType`
5946
6242
  # @return [String]
@@ -5961,11 +6257,35 @@ module Google
5961
6257
  # @return [Google::Apis::DisplayvideoV1::RateDetails]
5962
6258
  attr_accessor :rate_details
5963
6259
 
6260
+ # Output only. The IDs of advertisers with read-only access to the inventory
6261
+ # source.
6262
+ # Corresponds to the JSON property `readAdvertiserIds`
6263
+ # @return [Array<Fixnum>]
6264
+ attr_accessor :read_advertiser_ids
6265
+
6266
+ # Output only. The IDs of partners with read-only access to the inventory source.
6267
+ # All advertisers of partners in this field inherit read-only access to the
6268
+ # inventory source.
6269
+ # Corresponds to the JSON property `readPartnerIds`
6270
+ # @return [Array<Fixnum>]
6271
+ attr_accessor :read_partner_ids
6272
+
6273
+ # The partner or advertisers with access to the inventory source.
6274
+ # Corresponds to the JSON property `readWriteAccessors`
6275
+ # @return [Google::Apis::DisplayvideoV1::InventorySourceAccessors]
6276
+ attr_accessor :read_write_accessors
6277
+
5964
6278
  # The status related settings of the inventory source.
5965
6279
  # Corresponds to the JSON property `status`
5966
6280
  # @return [Google::Apis::DisplayvideoV1::InventorySourceStatus]
5967
6281
  attr_accessor :status
5968
6282
 
6283
+ # Immutable. The unique ID of the sub-site property assigned to this inventory
6284
+ # source.
6285
+ # Corresponds to the JSON property `subSitePropertyId`
6286
+ # @return [Fixnum]
6287
+ attr_accessor :sub_site_property_id
6288
+
5969
6289
  # A time range.
5970
6290
  # Corresponds to the JSON property `timeRange`
5971
6291
  # @return [Google::Apis::DisplayvideoV1::TimeRange]
@@ -5989,17 +6309,86 @@ module Google
5989
6309
  @delivery_method = args[:delivery_method] if args.key?(:delivery_method)
5990
6310
  @display_name = args[:display_name] if args.key?(:display_name)
5991
6311
  @exchange = args[:exchange] if args.key?(:exchange)
6312
+ @guaranteed_order_id = args[:guaranteed_order_id] if args.key?(:guaranteed_order_id)
5992
6313
  @inventory_source_id = args[:inventory_source_id] if args.key?(:inventory_source_id)
6314
+ @inventory_source_product_type = args[:inventory_source_product_type] if args.key?(:inventory_source_product_type)
5993
6315
  @inventory_source_type = args[:inventory_source_type] if args.key?(:inventory_source_type)
5994
6316
  @name = args[:name] if args.key?(:name)
5995
6317
  @publisher_name = args[:publisher_name] if args.key?(:publisher_name)
5996
6318
  @rate_details = args[:rate_details] if args.key?(:rate_details)
6319
+ @read_advertiser_ids = args[:read_advertiser_ids] if args.key?(:read_advertiser_ids)
6320
+ @read_partner_ids = args[:read_partner_ids] if args.key?(:read_partner_ids)
6321
+ @read_write_accessors = args[:read_write_accessors] if args.key?(:read_write_accessors)
5997
6322
  @status = args[:status] if args.key?(:status)
6323
+ @sub_site_property_id = args[:sub_site_property_id] if args.key?(:sub_site_property_id)
5998
6324
  @time_range = args[:time_range] if args.key?(:time_range)
5999
6325
  @update_time = args[:update_time] if args.key?(:update_time)
6000
6326
  end
6001
6327
  end
6002
6328
 
6329
+ # The partner or advertisers with access to the inventory source.
6330
+ class InventorySourceAccessors
6331
+ include Google::Apis::Core::Hashable
6332
+
6333
+ # The advertisers with access to the inventory source.
6334
+ # Corresponds to the JSON property `advertisers`
6335
+ # @return [Google::Apis::DisplayvideoV1::InventorySourceAccessorsAdvertiserAccessors]
6336
+ attr_accessor :advertisers
6337
+
6338
+ # The partner with access to the inventory source.
6339
+ # Corresponds to the JSON property `partner`
6340
+ # @return [Google::Apis::DisplayvideoV1::InventorySourceAccessorsPartnerAccessor]
6341
+ attr_accessor :partner
6342
+
6343
+ def initialize(**args)
6344
+ update!(**args)
6345
+ end
6346
+
6347
+ # Update properties of this object
6348
+ def update!(**args)
6349
+ @advertisers = args[:advertisers] if args.key?(:advertisers)
6350
+ @partner = args[:partner] if args.key?(:partner)
6351
+ end
6352
+ end
6353
+
6354
+ # The advertisers with access to the inventory source.
6355
+ class InventorySourceAccessorsAdvertiserAccessors
6356
+ include Google::Apis::Core::Hashable
6357
+
6358
+ # The IDs of the advertisers.
6359
+ # Corresponds to the JSON property `advertiserIds`
6360
+ # @return [Array<Fixnum>]
6361
+ attr_accessor :advertiser_ids
6362
+
6363
+ def initialize(**args)
6364
+ update!(**args)
6365
+ end
6366
+
6367
+ # Update properties of this object
6368
+ def update!(**args)
6369
+ @advertiser_ids = args[:advertiser_ids] if args.key?(:advertiser_ids)
6370
+ end
6371
+ end
6372
+
6373
+ # The partner with access to the inventory source.
6374
+ class InventorySourceAccessorsPartnerAccessor
6375
+ include Google::Apis::Core::Hashable
6376
+
6377
+ # The ID of the partner.
6378
+ # Corresponds to the JSON property `partnerId`
6379
+ # @return [Fixnum]
6380
+ attr_accessor :partner_id
6381
+
6382
+ def initialize(**args)
6383
+ update!(**args)
6384
+ end
6385
+
6386
+ # Update properties of this object
6387
+ def update!(**args)
6388
+ @partner_id = args[:partner_id] if args.key?(:partner_id)
6389
+ end
6390
+ end
6391
+
6003
6392
  # Targeting details for inventory source. This will be populated in the details
6004
6393
  # field of an AssignedTargetingOption when targeting_type is `
6005
6394
  # TARGETING_TYPE_INVENTORY_SOURCE`.
@@ -7095,6 +7484,33 @@ module Google
7095
7484
  end
7096
7485
  end
7097
7486
 
7487
+ #
7488
+ class ListGuaranteedOrdersResponse
7489
+ include Google::Apis::Core::Hashable
7490
+
7491
+ # The list of guaranteed orders. This list will be absent if empty.
7492
+ # Corresponds to the JSON property `guaranteedOrders`
7493
+ # @return [Array<Google::Apis::DisplayvideoV1::GuaranteedOrder>]
7494
+ attr_accessor :guaranteed_orders
7495
+
7496
+ # A token to retrieve the next page of results. Pass this value in the
7497
+ # page_token field in the subsequent call to `ListGuaranteedOrders` method to
7498
+ # retrieve the next page of results.
7499
+ # Corresponds to the JSON property `nextPageToken`
7500
+ # @return [String]
7501
+ attr_accessor :next_page_token
7502
+
7503
+ def initialize(**args)
7504
+ update!(**args)
7505
+ end
7506
+
7507
+ # Update properties of this object
7508
+ def update!(**args)
7509
+ @guaranteed_orders = args[:guaranteed_orders] if args.key?(:guaranteed_orders)
7510
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
7511
+ end
7512
+ end
7513
+
7098
7514
  # Response message for ListInsertionOrderAssignedTargetingOptions.
7099
7515
  class ListInsertionOrderAssignedTargetingOptionsResponse
7100
7516
  include Google::Apis::Core::Hashable
@@ -8388,7 +8804,7 @@ module Google
8388
8804
  class ParentalStatusAssignedTargetingOptionDetails
8389
8805
  include Google::Apis::Core::Hashable
8390
8806
 
8391
- # Output only. The parental status of the audience.
8807
+ # The parental status of the audience. Output only in v1. Required in v2.
8392
8808
  # Corresponds to the JSON property `parentalStatus`
8393
8809
  # @return [String]
8394
8810
  attr_accessor :parental_status
@@ -9423,7 +9839,7 @@ module Google
9423
9839
  # @return [String]
9424
9840
  attr_accessor :excluded_targeting_option_id
9425
9841
 
9426
- # An enum for the DV360 Sensitive category content classifier. Output only in v1.
9842
+ # Output only. An enum for the DV360 Sensitive category content classifier.
9427
9843
  # Corresponds to the JSON property `sensitiveCategory`
9428
9844
  # @return [String]
9429
9845
  attr_accessor :sensitive_category
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DisplayvideoV1
18
18
  # Version of the google-apis-displayvideo_v1 gem
19
- GEM_VERSION = "0.32.0"
19
+ GEM_VERSION = "0.33.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220518"
25
+ REVISION = "20220526"
26
26
  end
27
27
  end
28
28
  end
@@ -724,6 +724,30 @@ module Google
724
724
  include Google::Apis::Core::JsonObjectSupport
725
725
  end
726
726
 
727
+ class EditGuaranteedOrderReadAccessorsRequest
728
+ class Representation < Google::Apis::Core::JsonRepresentation; end
729
+
730
+ include Google::Apis::Core::JsonObjectSupport
731
+ end
732
+
733
+ class EditGuaranteedOrderReadAccessorsResponse
734
+ class Representation < Google::Apis::Core::JsonRepresentation; end
735
+
736
+ include Google::Apis::Core::JsonObjectSupport
737
+ end
738
+
739
+ class EditInventorySourceReadWriteAccessorsRequest
740
+ class Representation < Google::Apis::Core::JsonRepresentation; end
741
+
742
+ include Google::Apis::Core::JsonObjectSupport
743
+ end
744
+
745
+ class EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate
746
+ class Representation < Google::Apis::Core::JsonRepresentation; end
747
+
748
+ include Google::Apis::Core::JsonObjectSupport
749
+ end
750
+
727
751
  class Empty
728
752
  class Representation < Google::Apis::Core::JsonRepresentation; end
729
753
 
@@ -874,6 +898,18 @@ module Google
874
898
  include Google::Apis::Core::JsonObjectSupport
875
899
  end
876
900
 
901
+ class GuaranteedOrder
902
+ class Representation < Google::Apis::Core::JsonRepresentation; end
903
+
904
+ include Google::Apis::Core::JsonObjectSupport
905
+ end
906
+
907
+ class GuaranteedOrderStatus
908
+ class Representation < Google::Apis::Core::JsonRepresentation; end
909
+
910
+ include Google::Apis::Core::JsonObjectSupport
911
+ end
912
+
877
913
  class HouseholdIncomeAssignedTargetingOptionDetails
878
914
  class Representation < Google::Apis::Core::JsonRepresentation; end
879
915
 
@@ -928,6 +964,24 @@ module Google
928
964
  include Google::Apis::Core::JsonObjectSupport
929
965
  end
930
966
 
967
+ class InventorySourceAccessors
968
+ class Representation < Google::Apis::Core::JsonRepresentation; end
969
+
970
+ include Google::Apis::Core::JsonObjectSupport
971
+ end
972
+
973
+ class InventorySourceAccessorsAdvertiserAccessors
974
+ class Representation < Google::Apis::Core::JsonRepresentation; end
975
+
976
+ include Google::Apis::Core::JsonObjectSupport
977
+ end
978
+
979
+ class InventorySourceAccessorsPartnerAccessor
980
+ class Representation < Google::Apis::Core::JsonRepresentation; end
981
+
982
+ include Google::Apis::Core::JsonObjectSupport
983
+ end
984
+
931
985
  class InventorySourceAssignedTargetingOptionDetails
932
986
  class Representation < Google::Apis::Core::JsonRepresentation; end
933
987
 
@@ -1096,6 +1150,12 @@ module Google
1096
1150
  include Google::Apis::Core::JsonObjectSupport
1097
1151
  end
1098
1152
 
1153
+ class ListGuaranteedOrdersResponse
1154
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1155
+
1156
+ include Google::Apis::Core::JsonObjectSupport
1157
+ end
1158
+
1099
1159
  class ListInsertionOrderAssignedTargetingOptionsResponse
1100
1160
  class Representation < Google::Apis::Core::JsonRepresentation; end
1101
1161
 
@@ -2897,6 +2957,42 @@ module Google
2897
2957
  end
2898
2958
  end
2899
2959
 
2960
+ class EditGuaranteedOrderReadAccessorsRequest
2961
+ # @private
2962
+ class Representation < Google::Apis::Core::JsonRepresentation
2963
+ collection :added_advertisers, as: 'addedAdvertisers'
2964
+ property :partner_id, :numeric_string => true, as: 'partnerId'
2965
+ property :read_access_inherited, as: 'readAccessInherited'
2966
+ collection :removed_advertisers, as: 'removedAdvertisers'
2967
+ end
2968
+ end
2969
+
2970
+ class EditGuaranteedOrderReadAccessorsResponse
2971
+ # @private
2972
+ class Representation < Google::Apis::Core::JsonRepresentation
2973
+ property :read_access_inherited, as: 'readAccessInherited'
2974
+ collection :read_advertiser_ids, as: 'readAdvertiserIds'
2975
+ end
2976
+ end
2977
+
2978
+ class EditInventorySourceReadWriteAccessorsRequest
2979
+ # @private
2980
+ class Representation < Google::Apis::Core::JsonRepresentation
2981
+ property :advertisers_update, as: 'advertisersUpdate', class: Google::Apis::DisplayvideoV1::EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate, decorator: Google::Apis::DisplayvideoV1::EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate::Representation
2982
+
2983
+ property :assign_partner, as: 'assignPartner'
2984
+ property :partner_id, :numeric_string => true, as: 'partnerId'
2985
+ end
2986
+ end
2987
+
2988
+ class EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate
2989
+ # @private
2990
+ class Representation < Google::Apis::Core::JsonRepresentation
2991
+ collection :added_advertisers, as: 'addedAdvertisers'
2992
+ collection :removed_advertisers, as: 'removedAdvertisers'
2993
+ end
2994
+ end
2995
+
2900
2996
  class Empty
2901
2997
  # @private
2902
2998
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3125,6 +3221,36 @@ module Google
3125
3221
  end
3126
3222
  end
3127
3223
 
3224
+ class GuaranteedOrder
3225
+ # @private
3226
+ class Representation < Google::Apis::Core::JsonRepresentation
3227
+ property :default_advertiser_id, :numeric_string => true, as: 'defaultAdvertiserId'
3228
+ property :default_campaign_id, :numeric_string => true, as: 'defaultCampaignId'
3229
+ property :display_name, as: 'displayName'
3230
+ property :exchange, as: 'exchange'
3231
+ property :guaranteed_order_id, as: 'guaranteedOrderId'
3232
+ property :legacy_guaranteed_order_id, as: 'legacyGuaranteedOrderId'
3233
+ property :name, as: 'name'
3234
+ property :publisher_name, as: 'publisherName'
3235
+ property :read_access_inherited, as: 'readAccessInherited'
3236
+ collection :read_advertiser_ids, as: 'readAdvertiserIds'
3237
+ property :read_write_advertiser_id, :numeric_string => true, as: 'readWriteAdvertiserId'
3238
+ property :read_write_partner_id, :numeric_string => true, as: 'readWritePartnerId'
3239
+ property :status, as: 'status', class: Google::Apis::DisplayvideoV1::GuaranteedOrderStatus, decorator: Google::Apis::DisplayvideoV1::GuaranteedOrderStatus::Representation
3240
+
3241
+ property :update_time, as: 'updateTime'
3242
+ end
3243
+ end
3244
+
3245
+ class GuaranteedOrderStatus
3246
+ # @private
3247
+ class Representation < Google::Apis::Core::JsonRepresentation
3248
+ property :config_status, as: 'configStatus'
3249
+ property :entity_pause_reason, as: 'entityPauseReason'
3250
+ property :entity_status, as: 'entityStatus'
3251
+ end
3252
+ end
3253
+
3128
3254
  class HouseholdIncomeAssignedTargetingOptionDetails
3129
3255
  # @private
3130
3256
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3241,20 +3367,51 @@ module Google
3241
3367
  property :delivery_method, as: 'deliveryMethod'
3242
3368
  property :display_name, as: 'displayName'
3243
3369
  property :exchange, as: 'exchange'
3370
+ property :guaranteed_order_id, as: 'guaranteedOrderId'
3244
3371
  property :inventory_source_id, :numeric_string => true, as: 'inventorySourceId'
3372
+ property :inventory_source_product_type, as: 'inventorySourceProductType'
3245
3373
  property :inventory_source_type, as: 'inventorySourceType'
3246
3374
  property :name, as: 'name'
3247
3375
  property :publisher_name, as: 'publisherName'
3248
3376
  property :rate_details, as: 'rateDetails', class: Google::Apis::DisplayvideoV1::RateDetails, decorator: Google::Apis::DisplayvideoV1::RateDetails::Representation
3249
3377
 
3378
+ collection :read_advertiser_ids, as: 'readAdvertiserIds'
3379
+ collection :read_partner_ids, as: 'readPartnerIds'
3380
+ property :read_write_accessors, as: 'readWriteAccessors', class: Google::Apis::DisplayvideoV1::InventorySourceAccessors, decorator: Google::Apis::DisplayvideoV1::InventorySourceAccessors::Representation
3381
+
3250
3382
  property :status, as: 'status', class: Google::Apis::DisplayvideoV1::InventorySourceStatus, decorator: Google::Apis::DisplayvideoV1::InventorySourceStatus::Representation
3251
3383
 
3384
+ property :sub_site_property_id, :numeric_string => true, as: 'subSitePropertyId'
3252
3385
  property :time_range, as: 'timeRange', class: Google::Apis::DisplayvideoV1::TimeRange, decorator: Google::Apis::DisplayvideoV1::TimeRange::Representation
3253
3386
 
3254
3387
  property :update_time, as: 'updateTime'
3255
3388
  end
3256
3389
  end
3257
3390
 
3391
+ class InventorySourceAccessors
3392
+ # @private
3393
+ class Representation < Google::Apis::Core::JsonRepresentation
3394
+ property :advertisers, as: 'advertisers', class: Google::Apis::DisplayvideoV1::InventorySourceAccessorsAdvertiserAccessors, decorator: Google::Apis::DisplayvideoV1::InventorySourceAccessorsAdvertiserAccessors::Representation
3395
+
3396
+ property :partner, as: 'partner', class: Google::Apis::DisplayvideoV1::InventorySourceAccessorsPartnerAccessor, decorator: Google::Apis::DisplayvideoV1::InventorySourceAccessorsPartnerAccessor::Representation
3397
+
3398
+ end
3399
+ end
3400
+
3401
+ class InventorySourceAccessorsAdvertiserAccessors
3402
+ # @private
3403
+ class Representation < Google::Apis::Core::JsonRepresentation
3404
+ collection :advertiser_ids, as: 'advertiserIds'
3405
+ end
3406
+ end
3407
+
3408
+ class InventorySourceAccessorsPartnerAccessor
3409
+ # @private
3410
+ class Representation < Google::Apis::Core::JsonRepresentation
3411
+ property :partner_id, :numeric_string => true, as: 'partnerId'
3412
+ end
3413
+ end
3414
+
3258
3415
  class InventorySourceAssignedTargetingOptionDetails
3259
3416
  # @private
3260
3417
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3552,6 +3709,15 @@ module Google
3552
3709
  end
3553
3710
  end
3554
3711
 
3712
+ class ListGuaranteedOrdersResponse
3713
+ # @private
3714
+ class Representation < Google::Apis::Core::JsonRepresentation
3715
+ collection :guaranteed_orders, as: 'guaranteedOrders', class: Google::Apis::DisplayvideoV1::GuaranteedOrder, decorator: Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
3716
+
3717
+ property :next_page_token, as: 'nextPageToken'
3718
+ end
3719
+ end
3720
+
3555
3721
  class ListInsertionOrderAssignedTargetingOptionsResponse
3556
3722
  # @private
3557
3723
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1324,31 +1324,33 @@ module Google
1324
1324
  # operator` `value``. * The operator must be `EQUALS (=)` for the following
1325
1325
  # fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `
1326
1326
  # maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` - `
1327
- # creativeId` - `minModifiedTime` - `maxModifiedTime` * The operator must be `
1328
- # HAS (:)` for the following fields: - `lineItemIds` * For `entityStatus`, `
1329
- # minDuration`, `maxDuration`, `minModifiedTime`, `maxModifiedTime`, and `
1330
- # dynamic`, there may be at most one restriction. * For `dimensions`, the value
1331
- # is in the form of `"`width`x`height`"`. * For `exchangeReviewStatus`, the
1332
- # value is in the form of ``exchange`-`reviewStatus``. * For `minDuration` and `
1333
- # maxDuration`, the value is in the form of `"`duration`s"`. Only seconds are
1334
- # supported with millisecond granularity. * For `minModifiedTime` and `
1335
- # maxModifiedTime`, the value is a unix timestamp (GMT) in seconds. The time
1336
- # filtered is against the update_time field in the creative, which includes
1337
- # system updates to the creative (e.g. creative review updates). * There may be
1338
- # multiple `lineItemIds` restrictions in order to search against multiple
1339
- # possible line item IDs. * There may be multiple `creativeId` restrictions in
1340
- # order to search against multiple possible creative IDs. Examples: * All native
1341
- # creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with
1342
- # 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (
1343
- # dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are
1344
- # approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `
1345
- # dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="
1327
+ # creativeId` * The operator must be `HAS (:)` for the following fields: - `
1328
+ # lineItemIds` * The operator must be `GREATER THAN OR EQUAL TO (>=)` or `LESS
1329
+ # THAN OR EQUAL TO (<=)` for the following fields: - `updateTime` (input in ISO
1330
+ # 8601 format, or YYYY-MM-DDTHH:MM:SSZ) * For `entityStatus`, `minDuration`, `
1331
+ # maxDuration`, `updateTime`, `and `dynamic`, there may be at most one
1332
+ # restriction. * For `dimensions`, the value is in the form of `"`width`x`height`
1333
+ # "`. * For `exchangeReviewStatus`, the value is in the form of ``exchange`-`
1334
+ # reviewStatus``. * For `minDuration` and `maxDuration`, the value is in the
1335
+ # form of `"`duration`s"`. Only seconds are supported with millisecond
1336
+ # granularity. * For `updateTime`, a creative resource's field value reflects
1337
+ # the last time that a creative has been updated, which includes updates made by
1338
+ # the system (e.g. creative review updates). * There may be multiple `
1339
+ # lineItemIds` restrictions in order to search against multiple possible line
1340
+ # item IDs. * There may be multiple `creativeId` restrictions in order to search
1341
+ # against multiple possible creative IDs. Examples: * All native creatives: `
1342
+ # creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or
1343
+ # 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="
1344
+ # 300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by
1345
+ # AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="
1346
+ # true" AND minDuration="5.2s" AND (exchangeReviewStatus="
1346
1347
  # EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="
1347
1348
  # EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are
1348
1349
  # associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (
1349
1350
  # lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `
1350
- # creativeId=1 OR creativeId=2` The length of this field should be no more than
1351
- # 500 characters.
1351
+ # creativeId=1 OR creativeId=2` * All creatives with an update time greater than
1352
+ # or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>="2020-11-
1353
+ # 04T18:54:47Z"` The length of this field should be no more than 500 characters.
1352
1354
  # @param [String] order_by
1353
1355
  # Field by which to sort the list. Acceptable values are: * `creativeId` (
1354
1356
  # default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first,
@@ -4542,6 +4544,222 @@ module Google
4542
4544
  execute_or_queue_command(command, &block)
4543
4545
  end
4544
4546
 
4547
+ # Creates a new guaranteed order. Returns the newly created guaranteed order if
4548
+ # successful.
4549
+ # @param [Google::Apis::DisplayvideoV1::GuaranteedOrder] guaranteed_order_object
4550
+ # @param [Fixnum] advertiser_id
4551
+ # The ID of the advertiser that the request is being made within.
4552
+ # @param [Fixnum] partner_id
4553
+ # The ID of the partner that the request is being made within.
4554
+ # @param [String] fields
4555
+ # Selector specifying which fields to include in a partial response.
4556
+ # @param [String] quota_user
4557
+ # Available to use for quota purposes for server-side applications. Can be any
4558
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4559
+ # @param [Google::Apis::RequestOptions] options
4560
+ # Request-specific options
4561
+ #
4562
+ # @yield [result, err] Result & error if block supplied
4563
+ # @yieldparam result [Google::Apis::DisplayvideoV1::GuaranteedOrder] parsed result object
4564
+ # @yieldparam err [StandardError] error object if request failed
4565
+ #
4566
+ # @return [Google::Apis::DisplayvideoV1::GuaranteedOrder]
4567
+ #
4568
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4569
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4570
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4571
+ def create_guaranteed_order(guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
4572
+ command = make_simple_command(:post, 'v1/guaranteedOrders', options)
4573
+ command.request_representation = Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
4574
+ command.request_object = guaranteed_order_object
4575
+ command.response_representation = Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
4576
+ command.response_class = Google::Apis::DisplayvideoV1::GuaranteedOrder
4577
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
4578
+ command.query['partnerId'] = partner_id unless partner_id.nil?
4579
+ command.query['fields'] = fields unless fields.nil?
4580
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4581
+ execute_or_queue_command(command, &block)
4582
+ end
4583
+
4584
+ # Edits read advertisers of a guaranteed order.
4585
+ # @param [String] guaranteed_order_id
4586
+ # Required. The ID of the guaranteed order to edit. The ID is of the format ``
4587
+ # exchange`-`legacy_guaranteed_order_id``
4588
+ # @param [Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsRequest] edit_guaranteed_order_read_accessors_request_object
4589
+ # @param [String] fields
4590
+ # Selector specifying which fields to include in a partial response.
4591
+ # @param [String] quota_user
4592
+ # Available to use for quota purposes for server-side applications. Can be any
4593
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4594
+ # @param [Google::Apis::RequestOptions] options
4595
+ # Request-specific options
4596
+ #
4597
+ # @yield [result, err] Result & error if block supplied
4598
+ # @yieldparam result [Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsResponse] parsed result object
4599
+ # @yieldparam err [StandardError] error object if request failed
4600
+ #
4601
+ # @return [Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsResponse]
4602
+ #
4603
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4604
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4605
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4606
+ def edit_guaranteed_order_read_accessors(guaranteed_order_id, edit_guaranteed_order_read_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4607
+ command = make_simple_command(:post, 'v1/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors', options)
4608
+ command.request_representation = Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsRequest::Representation
4609
+ command.request_object = edit_guaranteed_order_read_accessors_request_object
4610
+ command.response_representation = Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsResponse::Representation
4611
+ command.response_class = Google::Apis::DisplayvideoV1::EditGuaranteedOrderReadAccessorsResponse
4612
+ command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
4613
+ command.query['fields'] = fields unless fields.nil?
4614
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4615
+ execute_or_queue_command(command, &block)
4616
+ end
4617
+
4618
+ # Gets a guaranteed order.
4619
+ # @param [String] guaranteed_order_id
4620
+ # Required. The ID of the guaranteed order to fetch. The ID is of the format ``
4621
+ # exchange`-`legacy_guaranteed_order_id``
4622
+ # @param [Fixnum] advertiser_id
4623
+ # The ID of the advertiser that has access to the guaranteed order.
4624
+ # @param [Fixnum] partner_id
4625
+ # The ID of the partner that has access to the guaranteed order.
4626
+ # @param [String] fields
4627
+ # Selector specifying which fields to include in a partial response.
4628
+ # @param [String] quota_user
4629
+ # Available to use for quota purposes for server-side applications. Can be any
4630
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4631
+ # @param [Google::Apis::RequestOptions] options
4632
+ # Request-specific options
4633
+ #
4634
+ # @yield [result, err] Result & error if block supplied
4635
+ # @yieldparam result [Google::Apis::DisplayvideoV1::GuaranteedOrder] parsed result object
4636
+ # @yieldparam err [StandardError] error object if request failed
4637
+ #
4638
+ # @return [Google::Apis::DisplayvideoV1::GuaranteedOrder]
4639
+ #
4640
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4641
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4642
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4643
+ def get_guaranteed_order(guaranteed_order_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
4644
+ command = make_simple_command(:get, 'v1/guaranteedOrders/{+guaranteedOrderId}', options)
4645
+ command.response_representation = Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
4646
+ command.response_class = Google::Apis::DisplayvideoV1::GuaranteedOrder
4647
+ command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
4648
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
4649
+ command.query['partnerId'] = partner_id unless partner_id.nil?
4650
+ command.query['fields'] = fields unless fields.nil?
4651
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4652
+ execute_or_queue_command(command, &block)
4653
+ end
4654
+
4655
+ # Lists guaranteed orders that are accessible to the current user. The order is
4656
+ # defined by the order_by parameter. If a filter by entity_status is not
4657
+ # specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will
4658
+ # not be included in the results.
4659
+ # @param [Fixnum] advertiser_id
4660
+ # The ID of the advertiser that has access to the guaranteed order.
4661
+ # @param [String] filter
4662
+ # Allows filtering by guaranteed order properties. * Filter expressions are made
4663
+ # up of one or more restrictions. * Restrictions can be combined by `AND` or `OR`
4664
+ # logical operators. A sequence of restrictions implicitly uses `AND`. * A
4665
+ # restriction has the form of ``field` `operator` `value``. * The operator must
4666
+ # be `EQUALS (=)`. * Supported fields: - `guaranteed_order_id` - `exchange` - `
4667
+ # display_name` - `status.entityStatus` Examples: * All active guaranteed orders:
4668
+ # `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to
4669
+ # Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER"
4670
+ # OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more
4671
+ # than 500 characters.
4672
+ # @param [String] order_by
4673
+ # Field by which to sort the list. Acceptable values are: * `displayName` (
4674
+ # default) The default sorting order is ascending. To specify descending order
4675
+ # for a field, a suffix "desc" should be added to the field name. For example, `
4676
+ # displayName desc`.
4677
+ # @param [Fixnum] page_size
4678
+ # Requested page size. Must be between `1` and `100`. If unspecified or greater
4679
+ # than `100` will default to `100`.
4680
+ # @param [String] page_token
4681
+ # A token identifying a page of results the server should return. Typically,
4682
+ # this is the value of next_page_token returned from the previous call to `
4683
+ # ListGuaranteedOrders` method. If not specified, the first page of results will
4684
+ # be returned.
4685
+ # @param [Fixnum] partner_id
4686
+ # The ID of the partner that has access to the guaranteed order.
4687
+ # @param [String] fields
4688
+ # Selector specifying which fields to include in a partial response.
4689
+ # @param [String] quota_user
4690
+ # Available to use for quota purposes for server-side applications. Can be any
4691
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4692
+ # @param [Google::Apis::RequestOptions] options
4693
+ # Request-specific options
4694
+ #
4695
+ # @yield [result, err] Result & error if block supplied
4696
+ # @yieldparam result [Google::Apis::DisplayvideoV1::ListGuaranteedOrdersResponse] parsed result object
4697
+ # @yieldparam err [StandardError] error object if request failed
4698
+ #
4699
+ # @return [Google::Apis::DisplayvideoV1::ListGuaranteedOrdersResponse]
4700
+ #
4701
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4702
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4703
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4704
+ def list_guaranteed_orders(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
4705
+ command = make_simple_command(:get, 'v1/guaranteedOrders', options)
4706
+ command.response_representation = Google::Apis::DisplayvideoV1::ListGuaranteedOrdersResponse::Representation
4707
+ command.response_class = Google::Apis::DisplayvideoV1::ListGuaranteedOrdersResponse
4708
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
4709
+ command.query['filter'] = filter unless filter.nil?
4710
+ command.query['orderBy'] = order_by unless order_by.nil?
4711
+ command.query['pageSize'] = page_size unless page_size.nil?
4712
+ command.query['pageToken'] = page_token unless page_token.nil?
4713
+ command.query['partnerId'] = partner_id unless partner_id.nil?
4714
+ command.query['fields'] = fields unless fields.nil?
4715
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4716
+ execute_or_queue_command(command, &block)
4717
+ end
4718
+
4719
+ # Updates an existing guaranteed order. Returns the updated guaranteed order if
4720
+ # successful.
4721
+ # @param [String] guaranteed_order_id
4722
+ # Output only. The unique identifier of the guaranteed order. The guaranteed
4723
+ # order IDs have the format ``exchange`-`legacy_guaranteed_order_id``.
4724
+ # @param [Google::Apis::DisplayvideoV1::GuaranteedOrder] guaranteed_order_object
4725
+ # @param [Fixnum] advertiser_id
4726
+ # The ID of the advertiser that the request is being made within.
4727
+ # @param [Fixnum] partner_id
4728
+ # The ID of the partner that the request is being made within.
4729
+ # @param [String] update_mask
4730
+ # Required. The mask to control which fields to update.
4731
+ # @param [String] fields
4732
+ # Selector specifying which fields to include in a partial response.
4733
+ # @param [String] quota_user
4734
+ # Available to use for quota purposes for server-side applications. Can be any
4735
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4736
+ # @param [Google::Apis::RequestOptions] options
4737
+ # Request-specific options
4738
+ #
4739
+ # @yield [result, err] Result & error if block supplied
4740
+ # @yieldparam result [Google::Apis::DisplayvideoV1::GuaranteedOrder] parsed result object
4741
+ # @yieldparam err [StandardError] error object if request failed
4742
+ #
4743
+ # @return [Google::Apis::DisplayvideoV1::GuaranteedOrder]
4744
+ #
4745
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4746
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4747
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4748
+ def patch_guaranteed_order(guaranteed_order_id, guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
4749
+ command = make_simple_command(:patch, 'v1/guaranteedOrders/{+guaranteedOrderId}', options)
4750
+ command.request_representation = Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
4751
+ command.request_object = guaranteed_order_object
4752
+ command.response_representation = Google::Apis::DisplayvideoV1::GuaranteedOrder::Representation
4753
+ command.response_class = Google::Apis::DisplayvideoV1::GuaranteedOrder
4754
+ command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
4755
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
4756
+ command.query['partnerId'] = partner_id unless partner_id.nil?
4757
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4758
+ command.query['fields'] = fields unless fields.nil?
4759
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4760
+ execute_or_queue_command(command, &block)
4761
+ end
4762
+
4545
4763
  # Creates a new inventory source group. Returns the newly created inventory
4546
4764
  # source group if successful.
4547
4765
  # @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object
@@ -4957,6 +5175,77 @@ module Google
4957
5175
  execute_or_queue_command(command, &block)
4958
5176
  end
4959
5177
 
5178
+ # Creates a new inventory source. Returns the newly created inventory source if
5179
+ # successful.
5180
+ # @param [Google::Apis::DisplayvideoV1::InventorySource] inventory_source_object
5181
+ # @param [Fixnum] advertiser_id
5182
+ # The ID of the advertiser that the request is being made within.
5183
+ # @param [Fixnum] partner_id
5184
+ # The ID of the partner that the request is being made within.
5185
+ # @param [String] fields
5186
+ # Selector specifying which fields to include in a partial response.
5187
+ # @param [String] quota_user
5188
+ # Available to use for quota purposes for server-side applications. Can be any
5189
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5190
+ # @param [Google::Apis::RequestOptions] options
5191
+ # Request-specific options
5192
+ #
5193
+ # @yield [result, err] Result & error if block supplied
5194
+ # @yieldparam result [Google::Apis::DisplayvideoV1::InventorySource] parsed result object
5195
+ # @yieldparam err [StandardError] error object if request failed
5196
+ #
5197
+ # @return [Google::Apis::DisplayvideoV1::InventorySource]
5198
+ #
5199
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5200
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5201
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5202
+ def create_inventory_source(inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
5203
+ command = make_simple_command(:post, 'v1/inventorySources', options)
5204
+ command.request_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
5205
+ command.request_object = inventory_source_object
5206
+ command.response_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
5207
+ command.response_class = Google::Apis::DisplayvideoV1::InventorySource
5208
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
5209
+ command.query['partnerId'] = partner_id unless partner_id.nil?
5210
+ command.query['fields'] = fields unless fields.nil?
5211
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5212
+ execute_or_queue_command(command, &block)
5213
+ end
5214
+
5215
+ # Edits read/write accessors of an inventory source. Returns the updated
5216
+ # read_write_accessors for the inventory source.
5217
+ # @param [Fixnum] inventory_source_id
5218
+ # Required. The ID of inventory source to update.
5219
+ # @param [Google::Apis::DisplayvideoV1::EditInventorySourceReadWriteAccessorsRequest] edit_inventory_source_read_write_accessors_request_object
5220
+ # @param [String] fields
5221
+ # Selector specifying which fields to include in a partial response.
5222
+ # @param [String] quota_user
5223
+ # Available to use for quota purposes for server-side applications. Can be any
5224
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5225
+ # @param [Google::Apis::RequestOptions] options
5226
+ # Request-specific options
5227
+ #
5228
+ # @yield [result, err] Result & error if block supplied
5229
+ # @yieldparam result [Google::Apis::DisplayvideoV1::InventorySourceAccessors] parsed result object
5230
+ # @yieldparam err [StandardError] error object if request failed
5231
+ #
5232
+ # @return [Google::Apis::DisplayvideoV1::InventorySourceAccessors]
5233
+ #
5234
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5235
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5236
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5237
+ def edit_inventory_source_read_write_accessors(inventory_source_id, edit_inventory_source_read_write_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5238
+ command = make_simple_command(:post, 'v1/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors', options)
5239
+ command.request_representation = Google::Apis::DisplayvideoV1::EditInventorySourceReadWriteAccessorsRequest::Representation
5240
+ command.request_object = edit_inventory_source_read_write_accessors_request_object
5241
+ command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceAccessors::Representation
5242
+ command.response_class = Google::Apis::DisplayvideoV1::InventorySourceAccessors
5243
+ command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
5244
+ command.query['fields'] = fields unless fields.nil?
5245
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5246
+ execute_or_queue_command(command, &block)
5247
+ end
5248
+
4960
5249
  # Gets an inventory source.
4961
5250
  # @param [Fixnum] inventory_source_id
4962
5251
  # Required. The ID of the inventory source to fetch.
@@ -5056,6 +5345,49 @@ module Google
5056
5345
  execute_or_queue_command(command, &block)
5057
5346
  end
5058
5347
 
5348
+ # Updates an existing inventory source. Returns the updated inventory source if
5349
+ # successful.
5350
+ # @param [Fixnum] inventory_source_id
5351
+ # Output only. The unique ID of the inventory source. Assigned by the system.
5352
+ # @param [Google::Apis::DisplayvideoV1::InventorySource] inventory_source_object
5353
+ # @param [Fixnum] advertiser_id
5354
+ # The ID of the advertiser that the request is being made within.
5355
+ # @param [Fixnum] partner_id
5356
+ # The ID of the partner that the request is being made within.
5357
+ # @param [String] update_mask
5358
+ # Required. The mask to control which fields to update.
5359
+ # @param [String] fields
5360
+ # Selector specifying which fields to include in a partial response.
5361
+ # @param [String] quota_user
5362
+ # Available to use for quota purposes for server-side applications. Can be any
5363
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5364
+ # @param [Google::Apis::RequestOptions] options
5365
+ # Request-specific options
5366
+ #
5367
+ # @yield [result, err] Result & error if block supplied
5368
+ # @yieldparam result [Google::Apis::DisplayvideoV1::InventorySource] parsed result object
5369
+ # @yieldparam err [StandardError] error object if request failed
5370
+ #
5371
+ # @return [Google::Apis::DisplayvideoV1::InventorySource]
5372
+ #
5373
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5374
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5375
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5376
+ def patch_inventory_source(inventory_source_id, inventory_source_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
5377
+ command = make_simple_command(:patch, 'v1/inventorySources/{+inventorySourceId}', options)
5378
+ command.request_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
5379
+ command.request_object = inventory_source_object
5380
+ command.response_representation = Google::Apis::DisplayvideoV1::InventorySource::Representation
5381
+ command.response_class = Google::Apis::DisplayvideoV1::InventorySource
5382
+ command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
5383
+ command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
5384
+ command.query['partnerId'] = partner_id unless partner_id.nil?
5385
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5386
+ command.query['fields'] = fields unless fields.nil?
5387
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5388
+ execute_or_queue_command(command, &block)
5389
+ end
5390
+
5059
5391
  # Downloads media. Download is supported on the URI `/download/`resource_name=**`
5060
5392
  # ?alt=media.` **Note**: Download requests will not be successful without
5061
5393
  # including `alt=media` query string.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-displayvideo_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.32.0
4
+ version: 0.33.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-05-23 00:00:00.000000000 Z
11
+ date: 2022-05-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v1/v0.32.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v1/v0.33.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v1
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.3.5
78
+ rubygems_version: 3.3.14
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Display & Video 360 API V1