google-apis-displayvideo_v2 0.49.0 → 0.51.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: 85a0513457e03676b7af958c6cdd50639493e5fc38d60742dd16edb361968bd3
4
- data.tar.gz: 169e464d7d50c3fe740715f96c9653e06887ad4451fed046a44a55a34db911ab
3
+ metadata.gz: ed179ae6ca965e93c5e25cf46d19d138ed8d4dac6250f7b28bb998ee106ef331
4
+ data.tar.gz: cae6cbb277308847f37921bb511489ca7906e5155a3593e96783fc0b05483885
5
5
  SHA512:
6
- metadata.gz: 71ed5ab20140d6939513bf66cc3b8f28bbf07a629a6f72a688878152415b0089d1261484e5a8856762a3bcd8fd8c2e79842c9f42cecfd6775e26d4cd430aed37
7
- data.tar.gz: 7dcda7d5510465206e9de667f1a346519ed8d932b1029a9419bf7eff55c0eda8b5a9de28b328e45fe62baa4d3e4fea52ffe174052b63485cce6067c5e63b940a
6
+ metadata.gz: 5c802240888bfe4b7afc8e12acb95ea0f2e436ccc54a328bc982c7064b5a9437c93a0815bf35de4a112a621600f9eb17ab3c010eeb3f22f60f9438956447ba89
7
+ data.tar.gz: e5dc7917d98fb3fb963358e7126f6a01b333752eceb6951ca074d40c557d0ff33123ce79473f97d9040ead1c6084065621b814c32c283038a40d6a233aafed1b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-displayvideo_v2
2
2
 
3
+ ### v0.51.0 (2025-08-24)
4
+
5
+ * Regenerated from discovery document revision 20250819
6
+
7
+ ### v0.50.0 (2025-08-03)
8
+
9
+ * Regenerated from discovery document revision 20250729
10
+
3
11
  ### v0.49.0 (2025-07-13)
4
12
 
5
13
  * Regenerated from discovery document revision 20250709
@@ -144,6 +144,17 @@ module Google
144
144
  # @return [Fixnum]
145
145
  attr_accessor :advertiser_id
146
146
 
147
+ # Optional. Whether this advertiser contains line items that serve European
148
+ # Union political ads. If this field is set to `
149
+ # DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: *
150
+ # Any new line items created under this advertiser will be assigned `
151
+ # DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any
152
+ # existing line items under this advertiser that do not have a set value be
153
+ # updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day.
154
+ # Corresponds to the JSON property `containsEuPoliticalAds`
155
+ # @return [String]
156
+ attr_accessor :contains_eu_political_ads
157
+
147
158
  # Creatives related settings of an advertiser.
148
159
  # Corresponds to the JSON property `creativeConfig`
149
160
  # @return [Google::Apis::DisplayvideoV2::AdvertiserCreativeConfig]
@@ -220,6 +231,7 @@ module Google
220
231
  def update!(**args)
221
232
  @ad_server_config = args[:ad_server_config] if args.key?(:ad_server_config)
222
233
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
234
+ @contains_eu_political_ads = args[:contains_eu_political_ads] if args.key?(:contains_eu_political_ads)
223
235
  @creative_config = args[:creative_config] if args.key?(:creative_config)
224
236
  @data_access_config = args[:data_access_config] if args.key?(:data_access_config)
225
237
  @display_name = args[:display_name] if args.key?(:display_name)
@@ -2192,6 +2204,64 @@ module Google
2192
2204
  end
2193
2205
  end
2194
2206
 
2207
+ #
2208
+ class BulkListCampaignAssignedTargetingOptionsResponse
2209
+ include Google::Apis::Core::Hashable
2210
+
2211
+ # The list of assigned targeting options. This list will be absent if empty.
2212
+ # Corresponds to the JSON property `assignedTargetingOptions`
2213
+ # @return [Array<Google::Apis::DisplayvideoV2::AssignedTargetingOption>]
2214
+ attr_accessor :assigned_targeting_options
2215
+
2216
+ # A token identifying the next page of results. This value should be specified
2217
+ # as the pageToken in a subsequent
2218
+ # BulkListCampaignAssignedTargetingOptionsRequest to fetch the next page of
2219
+ # results. This token will be absent if there are no more
2220
+ # assigned_targeting_options to return.
2221
+ # Corresponds to the JSON property `nextPageToken`
2222
+ # @return [String]
2223
+ attr_accessor :next_page_token
2224
+
2225
+ def initialize(**args)
2226
+ update!(**args)
2227
+ end
2228
+
2229
+ # Update properties of this object
2230
+ def update!(**args)
2231
+ @assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
2232
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2233
+ end
2234
+ end
2235
+
2236
+ #
2237
+ class BulkListInsertionOrderAssignedTargetingOptionsResponse
2238
+ include Google::Apis::Core::Hashable
2239
+
2240
+ # The list of assigned targeting options. This list will be absent if empty.
2241
+ # Corresponds to the JSON property `assignedTargetingOptions`
2242
+ # @return [Array<Google::Apis::DisplayvideoV2::AssignedTargetingOption>]
2243
+ attr_accessor :assigned_targeting_options
2244
+
2245
+ # A token identifying the next page of results. This value should be specified
2246
+ # as the pageToken in a subsequent
2247
+ # BulkListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page
2248
+ # of results. This token will be absent if there are no more
2249
+ # assigned_targeting_options to return.
2250
+ # Corresponds to the JSON property `nextPageToken`
2251
+ # @return [String]
2252
+ attr_accessor :next_page_token
2253
+
2254
+ def initialize(**args)
2255
+ update!(**args)
2256
+ end
2257
+
2258
+ # Update properties of this object
2259
+ def update!(**args)
2260
+ @assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
2261
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2262
+ end
2263
+ end
2264
+
2195
2265
  # Request message for LineItemService.BulkUpdateLineItems.
2196
2266
  class BulkUpdateLineItemsRequest
2197
2267
  include Google::Apis::Core::Hashable
@@ -2207,7 +2277,7 @@ module Google
2207
2277
  attr_accessor :target_line_item
2208
2278
 
2209
2279
  # Required. A field mask identifying which fields to update. Only the following
2210
- # fields are currently supported: * entityStatus
2280
+ # fields are currently supported: * entityStatus * containsEuPoliticalAds
2211
2281
  # Corresponds to the JSON property `updateMask`
2212
2282
  # @return [String]
2213
2283
  attr_accessor :update_mask
@@ -4788,6 +4858,20 @@ module Google
4788
4858
  class DuplicateLineItemRequest
4789
4859
  include Google::Apis::Core::Hashable
4790
4860
 
4861
+ # Whether this line item will serve European Union political ads. If
4862
+ # contains_eu_political_ads has been set to `
4863
+ # DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this
4864
+ # field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not
4865
+ # otherwise specified. This field can then be updated using the UI, API, or
4866
+ # Structured Data Files. *Warning*: Starting **September 8, 2025**, this field
4867
+ # must be set. If not, either the value `
4868
+ # DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item
4869
+ # if the parent advertiser has declared that it does not serve EU political ads,
4870
+ # or **the request will fail**.
4871
+ # Corresponds to the JSON property `containsEuPoliticalAds`
4872
+ # @return [String]
4873
+ attr_accessor :contains_eu_political_ads
4874
+
4791
4875
  # The display name of the new line item. Must be UTF-8 encoded with a maximum
4792
4876
  # size of 240 bytes.
4793
4877
  # Corresponds to the JSON property `targetDisplayName`
@@ -4800,6 +4884,7 @@ module Google
4800
4884
 
4801
4885
  # Update properties of this object
4802
4886
  def update!(**args)
4887
+ @contains_eu_political_ads = args[:contains_eu_political_ads] if args.key?(:contains_eu_political_ads)
4803
4888
  @target_display_name = args[:target_display_name] if args.key?(:target_display_name)
4804
4889
  end
4805
4890
  end
@@ -5435,6 +5520,20 @@ module Google
5435
5520
  class GenerateDefaultLineItemRequest
5436
5521
  include Google::Apis::Core::Hashable
5437
5522
 
5523
+ # Whether this line item will serve European Union political ads. If
5524
+ # contains_eu_political_ads has been set to `
5525
+ # DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this
5526
+ # field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not
5527
+ # otherwise specified. This field can then be updated using the UI, API, or
5528
+ # Structured Data Files. *Warning*: Starting **September 8, 2025**, this field
5529
+ # must be set. If not, either the value `
5530
+ # DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item
5531
+ # if the parent advertiser has declared that it does not serve EU political ads,
5532
+ # or **the request will fail**.
5533
+ # Corresponds to the JSON property `containsEuPoliticalAds`
5534
+ # @return [String]
5535
+ attr_accessor :contains_eu_political_ads
5536
+
5438
5537
  # Required. The display name of the line item. Must be UTF-8 encoded with a
5439
5538
  # maximum size of 240 bytes.
5440
5539
  # Corresponds to the JSON property `displayName`
@@ -5462,6 +5561,7 @@ module Google
5462
5561
 
5463
5562
  # Update properties of this object
5464
5563
  def update!(**args)
5564
+ @contains_eu_political_ads = args[:contains_eu_political_ads] if args.key?(:contains_eu_political_ads)
5465
5565
  @display_name = args[:display_name] if args.key?(:display_name)
5466
5566
  @insertion_order_id = args[:insertion_order_id] if args.key?(:insertion_order_id)
5467
5567
  @line_item_type = args[:line_item_type] if args.key?(:line_item_type)
@@ -6974,6 +7074,20 @@ module Google
6974
7074
  # @return [Fixnum]
6975
7075
  attr_accessor :campaign_id
6976
7076
 
7077
+ # Whether this line item will serve European Union political ads. If
7078
+ # contains_eu_political_ads has been set to `
7079
+ # DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this
7080
+ # field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not
7081
+ # otherwise specified. This field can then be updated using the UI, API, or
7082
+ # Structured Data Files. *Warning*: Starting **September 8, 2025**, this field
7083
+ # must be set when creating a new line item. If not, either the value `
7084
+ # DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent
7085
+ # advertiser has declared that it does not serve EU political ads, or **the `
7086
+ # advertisers.lineItems.create` request will fail**.
7087
+ # Corresponds to the JSON property `containsEuPoliticalAds`
7088
+ # @return [String]
7089
+ attr_accessor :contains_eu_political_ads
7090
+
6977
7091
  # Settings that control how conversions are counted. All post-click conversions
6978
7092
  # will be counted. A percentage value can be set for post-view conversions
6979
7093
  # counting.
@@ -7108,6 +7222,7 @@ module Google
7108
7222
  @bid_strategy = args[:bid_strategy] if args.key?(:bid_strategy)
7109
7223
  @budget = args[:budget] if args.key?(:budget)
7110
7224
  @campaign_id = args[:campaign_id] if args.key?(:campaign_id)
7225
+ @contains_eu_political_ads = args[:contains_eu_political_ads] if args.key?(:contains_eu_political_ads)
7111
7226
  @conversion_counting = args[:conversion_counting] if args.key?(:conversion_counting)
7112
7227
  @creative_ids = args[:creative_ids] if args.key?(:creative_ids)
7113
7228
  @display_name = args[:display_name] if args.key?(:display_name)
@@ -7337,6 +7452,34 @@ module Google
7337
7452
  end
7338
7453
  end
7339
7454
 
7455
+ # Response message for ListCampaignAssignedTargetingOptions.
7456
+ class ListCampaignAssignedTargetingOptionsResponse
7457
+ include Google::Apis::Core::Hashable
7458
+
7459
+ # The list of assigned targeting options. This list will be absent if empty.
7460
+ # Corresponds to the JSON property `assignedTargetingOptions`
7461
+ # @return [Array<Google::Apis::DisplayvideoV2::AssignedTargetingOption>]
7462
+ attr_accessor :assigned_targeting_options
7463
+
7464
+ # A token identifying the next page of results. This value should be specified
7465
+ # as the pageToken in a subsequent ListCampaignAssignedTargetingOptionsRequest
7466
+ # to fetch the next page of results. This token will be absent if there are no
7467
+ # more assigned_targeting_options to return.
7468
+ # Corresponds to the JSON property `nextPageToken`
7469
+ # @return [String]
7470
+ attr_accessor :next_page_token
7471
+
7472
+ def initialize(**args)
7473
+ update!(**args)
7474
+ end
7475
+
7476
+ # Update properties of this object
7477
+ def update!(**args)
7478
+ @assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
7479
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
7480
+ end
7481
+ end
7482
+
7340
7483
  #
7341
7484
  class ListCampaignsResponse
7342
7485
  include Google::Apis::Core::Hashable
@@ -7610,6 +7753,35 @@ module Google
7610
7753
  end
7611
7754
  end
7612
7755
 
7756
+ #
7757
+ class ListInsertionOrderAssignedTargetingOptionsResponse
7758
+ include Google::Apis::Core::Hashable
7759
+
7760
+ # The list of assigned targeting options. This list will be absent if empty.
7761
+ # Corresponds to the JSON property `assignedTargetingOptions`
7762
+ # @return [Array<Google::Apis::DisplayvideoV2::AssignedTargetingOption>]
7763
+ attr_accessor :assigned_targeting_options
7764
+
7765
+ # A token identifying the next page of results. This value should be specified
7766
+ # as the pageToken in a subsequent
7767
+ # ListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page of
7768
+ # results. This token will be absent if there are no more
7769
+ # assigned_targeting_options to return.
7770
+ # Corresponds to the JSON property `nextPageToken`
7771
+ # @return [String]
7772
+ attr_accessor :next_page_token
7773
+
7774
+ def initialize(**args)
7775
+ update!(**args)
7776
+ end
7777
+
7778
+ # Update properties of this object
7779
+ def update!(**args)
7780
+ @assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
7781
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
7782
+ end
7783
+ end
7784
+
7613
7785
  #
7614
7786
  class ListInsertionOrdersResponse
7615
7787
  include Google::Apis::Core::Hashable
@@ -11651,9 +11823,10 @@ module Google
11651
11823
  # The value used by the bidding strategy. When the bidding strategy is assigned
11652
11824
  # at the line item level, this field is only applicable for the following
11653
11825
  # strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `
11654
- # YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding
11655
- # strategy is assigned at the ad group level, this field is only applicable for
11656
- # the following strategy types: * `
11826
+ # YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `
11827
+ # YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the
11828
+ # bidding strategy is assigned at the ad group level, this field is only
11829
+ # applicable for the following strategy types: * `
11657
11830
  # YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `
11658
11831
  # YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `
11659
11832
  # YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DisplayvideoV2
18
18
  # Version of the google-apis-displayvideo_v2 gem
19
- GEM_VERSION = "0.49.0"
19
+ GEM_VERSION = "0.51.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.18.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250709"
25
+ REVISION = "20250819"
26
26
  end
27
27
  end
28
28
  end
@@ -340,6 +340,18 @@ module Google
340
340
  include Google::Apis::Core::JsonObjectSupport
341
341
  end
342
342
 
343
+ class BulkListCampaignAssignedTargetingOptionsResponse
344
+ class Representation < Google::Apis::Core::JsonRepresentation; end
345
+
346
+ include Google::Apis::Core::JsonObjectSupport
347
+ end
348
+
349
+ class BulkListInsertionOrderAssignedTargetingOptionsResponse
350
+ class Representation < Google::Apis::Core::JsonRepresentation; end
351
+
352
+ include Google::Apis::Core::JsonObjectSupport
353
+ end
354
+
343
355
  class BulkUpdateLineItemsRequest
344
356
  class Representation < Google::Apis::Core::JsonRepresentation; end
345
357
 
@@ -1126,6 +1138,12 @@ module Google
1126
1138
  include Google::Apis::Core::JsonObjectSupport
1127
1139
  end
1128
1140
 
1141
+ class ListCampaignAssignedTargetingOptionsResponse
1142
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1143
+
1144
+ include Google::Apis::Core::JsonObjectSupport
1145
+ end
1146
+
1129
1147
  class ListCampaignsResponse
1130
1148
  class Representation < Google::Apis::Core::JsonRepresentation; end
1131
1149
 
@@ -1186,6 +1204,12 @@ module Google
1186
1204
  include Google::Apis::Core::JsonObjectSupport
1187
1205
  end
1188
1206
 
1207
+ class ListInsertionOrderAssignedTargetingOptionsResponse
1208
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1209
+
1210
+ include Google::Apis::Core::JsonObjectSupport
1211
+ end
1212
+
1189
1213
  class ListInsertionOrdersResponse
1190
1214
  class Representation < Google::Apis::Core::JsonRepresentation; end
1191
1215
 
@@ -1932,6 +1956,7 @@ module Google
1932
1956
  property :ad_server_config, as: 'adServerConfig', class: Google::Apis::DisplayvideoV2::AdvertiserAdServerConfig, decorator: Google::Apis::DisplayvideoV2::AdvertiserAdServerConfig::Representation
1933
1957
 
1934
1958
  property :advertiser_id, :numeric_string => true, as: 'advertiserId'
1959
+ property :contains_eu_political_ads, as: 'containsEuPoliticalAds'
1935
1960
  property :creative_config, as: 'creativeConfig', class: Google::Apis::DisplayvideoV2::AdvertiserCreativeConfig, decorator: Google::Apis::DisplayvideoV2::AdvertiserCreativeConfig::Representation
1936
1961
 
1937
1962
  property :data_access_config, as: 'dataAccessConfig', class: Google::Apis::DisplayvideoV2::AdvertiserDataAccessConfig, decorator: Google::Apis::DisplayvideoV2::AdvertiserDataAccessConfig::Representation
@@ -2485,6 +2510,24 @@ module Google
2485
2510
  end
2486
2511
  end
2487
2512
 
2513
+ class BulkListCampaignAssignedTargetingOptionsResponse
2514
+ # @private
2515
+ class Representation < Google::Apis::Core::JsonRepresentation
2516
+ collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV2::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
2517
+
2518
+ property :next_page_token, as: 'nextPageToken'
2519
+ end
2520
+ end
2521
+
2522
+ class BulkListInsertionOrderAssignedTargetingOptionsResponse
2523
+ # @private
2524
+ class Representation < Google::Apis::Core::JsonRepresentation
2525
+ collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV2::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
2526
+
2527
+ property :next_page_token, as: 'nextPageToken'
2528
+ end
2529
+ end
2530
+
2488
2531
  class BulkUpdateLineItemsRequest
2489
2532
  # @private
2490
2533
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3167,6 +3210,7 @@ module Google
3167
3210
  class DuplicateLineItemRequest
3168
3211
  # @private
3169
3212
  class Representation < Google::Apis::Core::JsonRepresentation
3213
+ property :contains_eu_political_ads, as: 'containsEuPoliticalAds'
3170
3214
  property :target_display_name, as: 'targetDisplayName'
3171
3215
  end
3172
3216
  end
@@ -3349,6 +3393,7 @@ module Google
3349
3393
  class GenerateDefaultLineItemRequest
3350
3394
  # @private
3351
3395
  class Representation < Google::Apis::Core::JsonRepresentation
3396
+ property :contains_eu_political_ads, as: 'containsEuPoliticalAds'
3352
3397
  property :display_name, as: 'displayName'
3353
3398
  property :insertion_order_id, :numeric_string => true, as: 'insertionOrderId'
3354
3399
  property :line_item_type, as: 'lineItemType'
@@ -3741,6 +3786,7 @@ module Google
3741
3786
  property :budget, as: 'budget', class: Google::Apis::DisplayvideoV2::LineItemBudget, decorator: Google::Apis::DisplayvideoV2::LineItemBudget::Representation
3742
3787
 
3743
3788
  property :campaign_id, :numeric_string => true, as: 'campaignId'
3789
+ property :contains_eu_political_ads, as: 'containsEuPoliticalAds'
3744
3790
  property :conversion_counting, as: 'conversionCounting', class: Google::Apis::DisplayvideoV2::ConversionCountingConfig, decorator: Google::Apis::DisplayvideoV2::ConversionCountingConfig::Representation
3745
3791
 
3746
3792
  collection :creative_ids, as: 'creativeIds'
@@ -3838,6 +3884,15 @@ module Google
3838
3884
  end
3839
3885
  end
3840
3886
 
3887
+ class ListCampaignAssignedTargetingOptionsResponse
3888
+ # @private
3889
+ class Representation < Google::Apis::Core::JsonRepresentation
3890
+ collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV2::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
3891
+
3892
+ property :next_page_token, as: 'nextPageToken'
3893
+ end
3894
+ end
3895
+
3841
3896
  class ListCampaignsResponse
3842
3897
  # @private
3843
3898
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3928,6 +3983,15 @@ module Google
3928
3983
  end
3929
3984
  end
3930
3985
 
3986
+ class ListInsertionOrderAssignedTargetingOptionsResponse
3987
+ # @private
3988
+ class Representation < Google::Apis::Core::JsonRepresentation
3989
+ collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV2::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
3990
+
3991
+ property :next_page_token, as: 'nextPageToken'
3992
+ end
3993
+ end
3994
+
3931
3995
  class ListInsertionOrdersResponse
3932
3996
  # @private
3933
3997
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -603,6 +603,71 @@ module Google
603
603
  execute_or_queue_command(command, &block)
604
604
  end
605
605
 
606
+ # Lists assigned targeting options of a campaign across targeting types.
607
+ # @param [Fixnum] advertiser_id
608
+ # Required. The ID of the advertiser the campaign belongs to.
609
+ # @param [Fixnum] campaign_id
610
+ # Required. The ID of the campaign to list assigned targeting options for.
611
+ # @param [String] filter
612
+ # Allows filtering by assigned targeting option fields. Supported syntax: *
613
+ # Filter expressions are made up of one or more restrictions. * Restrictions can
614
+ # be combined by the `OR` logical operator. * A restriction has the form of ``
615
+ # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
616
+ # Supported fields: * `targetingType` * `inheritance` Examples: * `
617
+ # AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE`
618
+ # or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR
619
+ # targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources
620
+ # with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
621
+ # inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
622
+ # length of this field should be no more than 500 characters. Reference our [
623
+ # filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
624
+ # more information.
625
+ # @param [String] order_by
626
+ # Field by which to sort the list. Acceptable values are: * `targetingType` (
627
+ # default) The default sorting order is ascending. To specify descending order
628
+ # for a field, a suffix "desc" should be added to the field name. Example: `
629
+ # targetingType desc`.
630
+ # @param [Fixnum] page_size
631
+ # Requested page size. The size must be an integer between `1` and `5000`. If
632
+ # unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if
633
+ # an invalid value is specified.
634
+ # @param [String] page_token
635
+ # A token that lets the client fetch the next page of results. Typically, this
636
+ # is the value of next_page_token returned from the previous call to `
637
+ # BulkListCampaignAssignedTargetingOptions` method. If not specified, the first
638
+ # page of results will be returned.
639
+ # @param [String] fields
640
+ # Selector specifying which fields to include in a partial response.
641
+ # @param [String] quota_user
642
+ # Available to use for quota purposes for server-side applications. Can be any
643
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
644
+ # @param [Google::Apis::RequestOptions] options
645
+ # Request-specific options
646
+ #
647
+ # @yield [result, err] Result & error if block supplied
648
+ # @yieldparam result [Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse] parsed result object
649
+ # @yieldparam err [StandardError] error object if request failed
650
+ #
651
+ # @return [Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse]
652
+ #
653
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
654
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
655
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
656
+ def list_advertiser_campaign_assigned_targeting_options(advertiser_id, campaign_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
657
+ command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions', options)
658
+ command.response_representation = Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse::Representation
659
+ command.response_class = Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse
660
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
661
+ command.params['campaignId'] = campaign_id unless campaign_id.nil?
662
+ command.query['filter'] = filter unless filter.nil?
663
+ command.query['orderBy'] = order_by unless order_by.nil?
664
+ command.query['pageSize'] = page_size unless page_size.nil?
665
+ command.query['pageToken'] = page_token unless page_token.nil?
666
+ command.query['fields'] = fields unless fields.nil?
667
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
668
+ execute_or_queue_command(command, &block)
669
+ end
670
+
606
671
  # Updates an existing campaign. Returns the updated campaign if successful.
607
672
  # @param [Fixnum] advertiser_id
608
673
  # Output only. The unique ID of the advertiser the campaign belongs to.
@@ -642,6 +707,138 @@ module Google
642
707
  execute_or_queue_command(command, &block)
643
708
  end
644
709
 
710
+ # Gets a single targeting option assigned to a campaign.
711
+ # @param [Fixnum] advertiser_id
712
+ # Required. The ID of the advertiser the campaign belongs to.
713
+ # @param [Fixnum] campaign_id
714
+ # Required. The ID of the campaign the assigned targeting option belongs to.
715
+ # @param [String] targeting_type
716
+ # Required. Identifies the type of this assigned targeting option. Supported
717
+ # targeting types: * `TARGETING_TYPE_AGE_RANGE` * `
718
+ # TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `
719
+ # TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
720
+ # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
721
+ # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
722
+ # * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
723
+ # TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
724
+ # TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
725
+ # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `
726
+ # TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
727
+ # * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `
728
+ # TARGETING_TYPE_VIEWABILITY`
729
+ # @param [String] assigned_targeting_option_id
730
+ # Required. An identifier unique to the targeting type in this campaign that
731
+ # identifies the assigned targeting option being requested.
732
+ # @param [String] fields
733
+ # Selector specifying which fields to include in a partial response.
734
+ # @param [String] quota_user
735
+ # Available to use for quota purposes for server-side applications. Can be any
736
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
737
+ # @param [Google::Apis::RequestOptions] options
738
+ # Request-specific options
739
+ #
740
+ # @yield [result, err] Result & error if block supplied
741
+ # @yieldparam result [Google::Apis::DisplayvideoV2::AssignedTargetingOption] parsed result object
742
+ # @yieldparam err [StandardError] error object if request failed
743
+ #
744
+ # @return [Google::Apis::DisplayvideoV2::AssignedTargetingOption]
745
+ #
746
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
747
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
748
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
749
+ def get_advertiser_campaign_targeting_type_assigned_targeting_option(advertiser_id, campaign_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
750
+ command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
751
+ command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
752
+ command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
753
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
754
+ command.params['campaignId'] = campaign_id unless campaign_id.nil?
755
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
756
+ command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
757
+ command.query['fields'] = fields unless fields.nil?
758
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
759
+ execute_or_queue_command(command, &block)
760
+ end
761
+
762
+ # Lists the targeting options assigned to a campaign for a specified targeting
763
+ # type.
764
+ # @param [Fixnum] advertiser_id
765
+ # Required. The ID of the advertiser the campaign belongs to.
766
+ # @param [Fixnum] campaign_id
767
+ # Required. The ID of the campaign to list assigned targeting options for.
768
+ # @param [String] targeting_type
769
+ # Required. Identifies the type of assigned targeting options to list. Supported
770
+ # targeting types: * `TARGETING_TYPE_AGE_RANGE` * `
771
+ # TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `
772
+ # TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
773
+ # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
774
+ # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
775
+ # * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
776
+ # TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
777
+ # TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
778
+ # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `
779
+ # TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
780
+ # * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `
781
+ # TARGETING_TYPE_VIEWABILITY`
782
+ # @param [String] filter
783
+ # Allows filtering by assigned targeting option fields. Supported syntax: *
784
+ # Filter expressions are made up of one or more restrictions. * Restrictions can
785
+ # be combined by the `OR` logical operator. * A restriction has the form of ``
786
+ # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
787
+ # Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `
788
+ # AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="
789
+ # 1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources
790
+ # with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `
791
+ # inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
792
+ # length of this field should be no more than 500 characters. Reference our [
793
+ # filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
794
+ # more information.
795
+ # @param [String] order_by
796
+ # Field by which to sort the list. Acceptable values are: * `
797
+ # assignedTargetingOptionId` (default) The default sorting order is ascending.
798
+ # To specify descending order for a field, a suffix "desc" should be added to
799
+ # the field name. Example: `assignedTargetingOptionId desc`.
800
+ # @param [Fixnum] page_size
801
+ # Requested page size. Must be between `1` and `5000`. If unspecified will
802
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
803
+ # specified.
804
+ # @param [String] page_token
805
+ # A token identifying a page of results the server should return. Typically,
806
+ # this is the value of next_page_token returned from the previous call to `
807
+ # ListCampaignAssignedTargetingOptions` method. If not specified, the first page
808
+ # of results will be returned.
809
+ # @param [String] fields
810
+ # Selector specifying which fields to include in a partial response.
811
+ # @param [String] quota_user
812
+ # Available to use for quota purposes for server-side applications. Can be any
813
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
814
+ # @param [Google::Apis::RequestOptions] options
815
+ # Request-specific options
816
+ #
817
+ # @yield [result, err] Result & error if block supplied
818
+ # @yieldparam result [Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse] parsed result object
819
+ # @yieldparam err [StandardError] error object if request failed
820
+ #
821
+ # @return [Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse]
822
+ #
823
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
824
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
825
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
826
+ def list_advertiser_campaign_targeting_type_assigned_targeting_options(advertiser_id, campaign_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
827
+ command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
828
+ command.response_representation = Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse::Representation
829
+ command.response_class = Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse
830
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
831
+ command.params['campaignId'] = campaign_id unless campaign_id.nil?
832
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
833
+ command.query['filter'] = filter unless filter.nil?
834
+ command.query['orderBy'] = order_by unless order_by.nil?
835
+ command.query['pageSize'] = page_size unless page_size.nil?
836
+ command.query['pageToken'] = page_token unless page_token.nil?
837
+ command.query['fields'] = fields unless fields.nil?
838
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
839
+ execute_or_queue_command(command, &block)
840
+ end
841
+
645
842
  # Creates a new channel. Returns the newly created channel if successful.
646
843
  # @param [Fixnum] advertiser_id
647
844
  # The ID of the advertiser that owns the created channel.
@@ -1437,6 +1634,72 @@ module Google
1437
1634
  execute_or_queue_command(command, &block)
1438
1635
  end
1439
1636
 
1637
+ # Lists assigned targeting options of an insertion order across targeting types.
1638
+ # @param [Fixnum] advertiser_id
1639
+ # Required. The ID of the advertiser the insertion order belongs to.
1640
+ # @param [Fixnum] insertion_order_id
1641
+ # Required. The ID of the insertion order to list assigned targeting options for.
1642
+ # @param [String] filter
1643
+ # Allows filtering by assigned targeting option fields. Supported syntax: *
1644
+ # Filter expressions are made up of one or more restrictions. * Restrictions can
1645
+ # be combined by the logical operator `OR`. * A restriction has the form of ``
1646
+ # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
1647
+ # Supported fields: * `targetingType` * `inheritance` Examples: * `
1648
+ # AssignedTargetingOption` resources of targeting type `
1649
+ # TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `
1650
+ # targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="
1651
+ # TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with
1652
+ # inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
1653
+ # inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
1654
+ # length of this field should be no more than 500 characters. Reference our [
1655
+ # filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
1656
+ # more information.
1657
+ # @param [String] order_by
1658
+ # Field by which to sort the list. Acceptable values are: * `targetingType` (
1659
+ # default) The default sorting order is ascending. To specify descending order
1660
+ # for a field, a suffix "desc" should be added to the field name. Example: `
1661
+ # targetingType desc`.
1662
+ # @param [Fixnum] page_size
1663
+ # Requested page size. The size must be an integer between `1` and `5000`. If
1664
+ # unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if
1665
+ # an invalid value is specified.
1666
+ # @param [String] page_token
1667
+ # A token that lets the client fetch the next page of results. Typically, this
1668
+ # is the value of next_page_token returned from the previous call to `
1669
+ # BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the
1670
+ # first page of results will be returned.
1671
+ # @param [String] fields
1672
+ # Selector specifying which fields to include in a partial response.
1673
+ # @param [String] quota_user
1674
+ # Available to use for quota purposes for server-side applications. Can be any
1675
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1676
+ # @param [Google::Apis::RequestOptions] options
1677
+ # Request-specific options
1678
+ #
1679
+ # @yield [result, err] Result & error if block supplied
1680
+ # @yieldparam result [Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse] parsed result object
1681
+ # @yieldparam err [StandardError] error object if request failed
1682
+ #
1683
+ # @return [Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse]
1684
+ #
1685
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1686
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1687
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1688
+ def list_advertiser_insertion_order_assigned_targeting_options(advertiser_id, insertion_order_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1689
+ command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions', options)
1690
+ command.response_representation = Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse::Representation
1691
+ command.response_class = Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse
1692
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1693
+ command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
1694
+ command.query['filter'] = filter unless filter.nil?
1695
+ command.query['orderBy'] = order_by unless order_by.nil?
1696
+ command.query['pageSize'] = page_size unless page_size.nil?
1697
+ command.query['pageToken'] = page_token unless page_token.nil?
1698
+ command.query['fields'] = fields unless fields.nil?
1699
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1700
+ execute_or_queue_command(command, &block)
1701
+ end
1702
+
1440
1703
  # Updates an existing insertion order. Returns the updated insertion order if
1441
1704
  # successful.
1442
1705
  # @param [Fixnum] advertiser_id
@@ -1477,6 +1740,277 @@ module Google
1477
1740
  execute_or_queue_command(command, &block)
1478
1741
  end
1479
1742
 
1743
+ # Assigns a targeting option to an insertion order. Returns the assigned
1744
+ # targeting option if successful. Supported targeting types: * `
1745
+ # TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `
1746
+ # TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `
1747
+ # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `
1748
+ # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1749
+ # * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `
1750
+ # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `
1751
+ # TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `
1752
+ # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
1753
+ # @param [Fixnum] advertiser_id
1754
+ # Required. The ID of the advertiser the insertion order belongs to.
1755
+ # @param [Fixnum] insertion_order_id
1756
+ # Required. The ID of the insertion order the assigned targeting option will
1757
+ # belong to.
1758
+ # @param [String] targeting_type
1759
+ # Required. Identifies the type of this assigned targeting option. Supported
1760
+ # targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `
1761
+ # TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `
1762
+ # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `
1763
+ # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1764
+ # * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `
1765
+ # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `
1766
+ # TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `
1767
+ # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
1768
+ # @param [Google::Apis::DisplayvideoV2::AssignedTargetingOption] assigned_targeting_option_object
1769
+ # @param [String] fields
1770
+ # Selector specifying which fields to include in a partial response.
1771
+ # @param [String] quota_user
1772
+ # Available to use for quota purposes for server-side applications. Can be any
1773
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1774
+ # @param [Google::Apis::RequestOptions] options
1775
+ # Request-specific options
1776
+ #
1777
+ # @yield [result, err] Result & error if block supplied
1778
+ # @yieldparam result [Google::Apis::DisplayvideoV2::AssignedTargetingOption] parsed result object
1779
+ # @yieldparam err [StandardError] error object if request failed
1780
+ #
1781
+ # @return [Google::Apis::DisplayvideoV2::AssignedTargetingOption]
1782
+ #
1783
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1784
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1785
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1786
+ def create_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1787
+ command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
1788
+ command.request_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
1789
+ command.request_object = assigned_targeting_option_object
1790
+ command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
1791
+ command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
1792
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1793
+ command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
1794
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
1795
+ command.query['fields'] = fields unless fields.nil?
1796
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1797
+ execute_or_queue_command(command, &block)
1798
+ end
1799
+
1800
+ # Deletes an assigned targeting option from an insertion order. Supported
1801
+ # targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `
1802
+ # TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `
1803
+ # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `
1804
+ # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1805
+ # * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `
1806
+ # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `
1807
+ # TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `
1808
+ # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
1809
+ # @param [Fixnum] advertiser_id
1810
+ # Required. The ID of the advertiser the insertion order belongs to.
1811
+ # @param [Fixnum] insertion_order_id
1812
+ # Required. The ID of the insertion order the assigned targeting option belongs
1813
+ # to.
1814
+ # @param [String] targeting_type
1815
+ # Required. Identifies the type of this assigned targeting option. Supported
1816
+ # targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `
1817
+ # TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `
1818
+ # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `
1819
+ # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1820
+ # * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `
1821
+ # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `
1822
+ # TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `
1823
+ # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
1824
+ # @param [String] assigned_targeting_option_id
1825
+ # Required. The ID of the assigned targeting option to delete.
1826
+ # @param [String] fields
1827
+ # Selector specifying which fields to include in a partial response.
1828
+ # @param [String] quota_user
1829
+ # Available to use for quota purposes for server-side applications. Can be any
1830
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1831
+ # @param [Google::Apis::RequestOptions] options
1832
+ # Request-specific options
1833
+ #
1834
+ # @yield [result, err] Result & error if block supplied
1835
+ # @yieldparam result [Google::Apis::DisplayvideoV2::Empty] parsed result object
1836
+ # @yieldparam err [StandardError] error object if request failed
1837
+ #
1838
+ # @return [Google::Apis::DisplayvideoV2::Empty]
1839
+ #
1840
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1841
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1842
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1843
+ def delete_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
1844
+ command = make_simple_command(:delete, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
1845
+ command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
1846
+ command.response_class = Google::Apis::DisplayvideoV2::Empty
1847
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1848
+ command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
1849
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
1850
+ command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
1851
+ command.query['fields'] = fields unless fields.nil?
1852
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1853
+ execute_or_queue_command(command, &block)
1854
+ end
1855
+
1856
+ # Gets a single targeting option assigned to an insertion order.
1857
+ # @param [Fixnum] advertiser_id
1858
+ # Required. The ID of the advertiser the insertion order belongs to.
1859
+ # @param [Fixnum] insertion_order_id
1860
+ # Required. The ID of the insertion order the assigned targeting option belongs
1861
+ # to.
1862
+ # @param [String] targeting_type
1863
+ # Required. Identifies the type of this assigned targeting option. Supported
1864
+ # targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` *
1865
+ # `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `
1866
+ # TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`
1867
+ # * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `
1868
+ # TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `
1869
+ # TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `
1870
+ # TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
1871
+ # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
1872
+ # TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `
1873
+ # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `
1874
+ # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1875
+ # * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
1876
+ # TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
1877
+ # TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
1878
+ # TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `
1879
+ # TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `
1880
+ # TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `
1881
+ # TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `
1882
+ # TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `
1883
+ # TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `
1884
+ # TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `
1885
+ # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` *
1886
+ # `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `
1887
+ # TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `
1888
+ # TARGETING_TYPE_VIEWABILITY`
1889
+ # @param [String] assigned_targeting_option_id
1890
+ # Required. An identifier unique to the targeting type in this insertion order
1891
+ # that identifies the assigned targeting option being requested.
1892
+ # @param [String] fields
1893
+ # Selector specifying which fields to include in a partial response.
1894
+ # @param [String] quota_user
1895
+ # Available to use for quota purposes for server-side applications. Can be any
1896
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1897
+ # @param [Google::Apis::RequestOptions] options
1898
+ # Request-specific options
1899
+ #
1900
+ # @yield [result, err] Result & error if block supplied
1901
+ # @yieldparam result [Google::Apis::DisplayvideoV2::AssignedTargetingOption] parsed result object
1902
+ # @yieldparam err [StandardError] error object if request failed
1903
+ #
1904
+ # @return [Google::Apis::DisplayvideoV2::AssignedTargetingOption]
1905
+ #
1906
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1907
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1908
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1909
+ def get_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
1910
+ command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
1911
+ command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
1912
+ command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
1913
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1914
+ command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
1915
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
1916
+ command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
1917
+ command.query['fields'] = fields unless fields.nil?
1918
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1919
+ execute_or_queue_command(command, &block)
1920
+ end
1921
+
1922
+ # Lists the targeting options assigned to an insertion order.
1923
+ # @param [Fixnum] advertiser_id
1924
+ # Required. The ID of the advertiser the insertion order belongs to.
1925
+ # @param [Fixnum] insertion_order_id
1926
+ # Required. The ID of the insertion order to list assigned targeting options for.
1927
+ # @param [String] targeting_type
1928
+ # Required. Identifies the type of assigned targeting options to list. Supported
1929
+ # targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` *
1930
+ # `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `
1931
+ # TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`
1932
+ # * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `
1933
+ # TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `
1934
+ # TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `
1935
+ # TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
1936
+ # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
1937
+ # TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `
1938
+ # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `
1939
+ # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1940
+ # * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
1941
+ # TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
1942
+ # TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
1943
+ # TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `
1944
+ # TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `
1945
+ # TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `
1946
+ # TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `
1947
+ # TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `
1948
+ # TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `
1949
+ # TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `
1950
+ # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` *
1951
+ # `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `
1952
+ # TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `
1953
+ # TARGETING_TYPE_VIEWABILITY`
1954
+ # @param [String] filter
1955
+ # Allows filtering by assigned targeting option fields. Supported syntax: *
1956
+ # Filter expressions are made up of one or more restrictions. * Restrictions can
1957
+ # be combined by the logical operator `OR`. * A restriction has the form of ``
1958
+ # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
1959
+ # Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `
1960
+ # AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="
1961
+ # 1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources
1962
+ # with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
1963
+ # inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
1964
+ # length of this field should be no more than 500 characters. Reference our [
1965
+ # filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
1966
+ # more information.
1967
+ # @param [String] order_by
1968
+ # Field by which to sort the list. Acceptable values are: * `
1969
+ # assignedTargetingOptionId` (default) The default sorting order is ascending.
1970
+ # To specify descending order for a field, a suffix "desc" should be added to
1971
+ # the field name. Example: `assignedTargetingOptionId desc`.
1972
+ # @param [Fixnum] page_size
1973
+ # Requested page size. Must be between `1` and `5000`. If unspecified will
1974
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
1975
+ # specified.
1976
+ # @param [String] page_token
1977
+ # A token identifying a page of results the server should return. Typically,
1978
+ # this is the value of next_page_token returned from the previous call to `
1979
+ # ListInsertionOrderAssignedTargetingOptions` method. If not specified, the
1980
+ # first page of results will be returned.
1981
+ # @param [String] fields
1982
+ # Selector specifying which fields to include in a partial response.
1983
+ # @param [String] quota_user
1984
+ # Available to use for quota purposes for server-side applications. Can be any
1985
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1986
+ # @param [Google::Apis::RequestOptions] options
1987
+ # Request-specific options
1988
+ #
1989
+ # @yield [result, err] Result & error if block supplied
1990
+ # @yieldparam result [Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse] parsed result object
1991
+ # @yieldparam err [StandardError] error object if request failed
1992
+ #
1993
+ # @return [Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse]
1994
+ #
1995
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1996
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1997
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1998
+ def list_advertiser_insertion_order_targeting_type_assigned_targeting_options(advertiser_id, insertion_order_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1999
+ command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
2000
+ command.response_representation = Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse::Representation
2001
+ command.response_class = Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse
2002
+ command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
2003
+ command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
2004
+ command.params['targetingType'] = targeting_type unless targeting_type.nil?
2005
+ command.query['filter'] = filter unless filter.nil?
2006
+ command.query['orderBy'] = order_by unless order_by.nil?
2007
+ command.query['pageSize'] = page_size unless page_size.nil?
2008
+ command.query['pageToken'] = page_token unless page_token.nil?
2009
+ command.query['fields'] = fields unless fields.nil?
2010
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2011
+ execute_or_queue_command(command, &block)
2012
+ end
2013
+
1480
2014
  # Lists invoices posted for an advertiser in a given month. Invoices generated
1481
2015
  # by billing profiles with a "Partner" invoice level are not retrievable through
1482
2016
  # this method.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-displayvideo_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.49.0
4
+ version: 0.51.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v2/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v2/v0.49.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v2/v0.51.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v2
62
62
  rdoc_options: []
63
63
  require_paths: