google-apis-displayvideo_v2 0.48.0 → 0.50.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:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c28f05d80c6d9ca14720864d38558fb245861a7e57b6cf92eb07319bee842bd7
|
4
|
+
data.tar.gz: b0d0b172d2fee89dc47cb0c01e562051f880b196d9102611991c056f65b4a1b4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: de36de6866561b105855995e28b66caab26c2cb492349b38ca6108e3aeffb22826ede376cce20b1ad8f3fb1aca1cb0b8e6b835c6ae8917e71c260f79a0e9fbb6
|
7
|
+
data.tar.gz: dc366e6b0457c6868575f1738001bd1246e0b867a03bf0b6307059b2fef2091b638aa99eee6044aae0cd236db2878fba5c1fd83987778b67ac11b50cb2bf72f0
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-displayvideo_v2
|
2
2
|
|
3
|
+
### v0.50.0 (2025-08-03)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20250729
|
6
|
+
|
7
|
+
### v0.49.0 (2025-07-13)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20250709
|
10
|
+
|
3
11
|
### v0.48.0 (2025-06-29)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20250625
|
@@ -2192,6 +2192,64 @@ module Google
|
|
2192
2192
|
end
|
2193
2193
|
end
|
2194
2194
|
|
2195
|
+
#
|
2196
|
+
class BulkListCampaignAssignedTargetingOptionsResponse
|
2197
|
+
include Google::Apis::Core::Hashable
|
2198
|
+
|
2199
|
+
# The list of assigned targeting options. This list will be absent if empty.
|
2200
|
+
# Corresponds to the JSON property `assignedTargetingOptions`
|
2201
|
+
# @return [Array<Google::Apis::DisplayvideoV2::AssignedTargetingOption>]
|
2202
|
+
attr_accessor :assigned_targeting_options
|
2203
|
+
|
2204
|
+
# A token identifying the next page of results. This value should be specified
|
2205
|
+
# as the pageToken in a subsequent
|
2206
|
+
# BulkListCampaignAssignedTargetingOptionsRequest to fetch the next page of
|
2207
|
+
# results. This token will be absent if there are no more
|
2208
|
+
# assigned_targeting_options to return.
|
2209
|
+
# Corresponds to the JSON property `nextPageToken`
|
2210
|
+
# @return [String]
|
2211
|
+
attr_accessor :next_page_token
|
2212
|
+
|
2213
|
+
def initialize(**args)
|
2214
|
+
update!(**args)
|
2215
|
+
end
|
2216
|
+
|
2217
|
+
# Update properties of this object
|
2218
|
+
def update!(**args)
|
2219
|
+
@assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
|
2220
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
2221
|
+
end
|
2222
|
+
end
|
2223
|
+
|
2224
|
+
#
|
2225
|
+
class BulkListInsertionOrderAssignedTargetingOptionsResponse
|
2226
|
+
include Google::Apis::Core::Hashable
|
2227
|
+
|
2228
|
+
# The list of assigned targeting options. This list will be absent if empty.
|
2229
|
+
# Corresponds to the JSON property `assignedTargetingOptions`
|
2230
|
+
# @return [Array<Google::Apis::DisplayvideoV2::AssignedTargetingOption>]
|
2231
|
+
attr_accessor :assigned_targeting_options
|
2232
|
+
|
2233
|
+
# A token identifying the next page of results. This value should be specified
|
2234
|
+
# as the pageToken in a subsequent
|
2235
|
+
# BulkListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page
|
2236
|
+
# of results. This token will be absent if there are no more
|
2237
|
+
# assigned_targeting_options to return.
|
2238
|
+
# Corresponds to the JSON property `nextPageToken`
|
2239
|
+
# @return [String]
|
2240
|
+
attr_accessor :next_page_token
|
2241
|
+
|
2242
|
+
def initialize(**args)
|
2243
|
+
update!(**args)
|
2244
|
+
end
|
2245
|
+
|
2246
|
+
# Update properties of this object
|
2247
|
+
def update!(**args)
|
2248
|
+
@assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
|
2249
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
2250
|
+
end
|
2251
|
+
end
|
2252
|
+
|
2195
2253
|
# Request message for LineItemService.BulkUpdateLineItems.
|
2196
2254
|
class BulkUpdateLineItemsRequest
|
2197
2255
|
include Google::Apis::Core::Hashable
|
@@ -7337,6 +7395,34 @@ module Google
|
|
7337
7395
|
end
|
7338
7396
|
end
|
7339
7397
|
|
7398
|
+
# Response message for ListCampaignAssignedTargetingOptions.
|
7399
|
+
class ListCampaignAssignedTargetingOptionsResponse
|
7400
|
+
include Google::Apis::Core::Hashable
|
7401
|
+
|
7402
|
+
# The list of assigned targeting options. This list will be absent if empty.
|
7403
|
+
# Corresponds to the JSON property `assignedTargetingOptions`
|
7404
|
+
# @return [Array<Google::Apis::DisplayvideoV2::AssignedTargetingOption>]
|
7405
|
+
attr_accessor :assigned_targeting_options
|
7406
|
+
|
7407
|
+
# A token identifying the next page of results. This value should be specified
|
7408
|
+
# as the pageToken in a subsequent ListCampaignAssignedTargetingOptionsRequest
|
7409
|
+
# to fetch the next page of results. This token will be absent if there are no
|
7410
|
+
# more assigned_targeting_options to return.
|
7411
|
+
# Corresponds to the JSON property `nextPageToken`
|
7412
|
+
# @return [String]
|
7413
|
+
attr_accessor :next_page_token
|
7414
|
+
|
7415
|
+
def initialize(**args)
|
7416
|
+
update!(**args)
|
7417
|
+
end
|
7418
|
+
|
7419
|
+
# Update properties of this object
|
7420
|
+
def update!(**args)
|
7421
|
+
@assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
|
7422
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
7423
|
+
end
|
7424
|
+
end
|
7425
|
+
|
7340
7426
|
#
|
7341
7427
|
class ListCampaignsResponse
|
7342
7428
|
include Google::Apis::Core::Hashable
|
@@ -7610,6 +7696,35 @@ module Google
|
|
7610
7696
|
end
|
7611
7697
|
end
|
7612
7698
|
|
7699
|
+
#
|
7700
|
+
class ListInsertionOrderAssignedTargetingOptionsResponse
|
7701
|
+
include Google::Apis::Core::Hashable
|
7702
|
+
|
7703
|
+
# The list of assigned targeting options. This list will be absent if empty.
|
7704
|
+
# Corresponds to the JSON property `assignedTargetingOptions`
|
7705
|
+
# @return [Array<Google::Apis::DisplayvideoV2::AssignedTargetingOption>]
|
7706
|
+
attr_accessor :assigned_targeting_options
|
7707
|
+
|
7708
|
+
# A token identifying the next page of results. This value should be specified
|
7709
|
+
# as the pageToken in a subsequent
|
7710
|
+
# ListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page of
|
7711
|
+
# results. This token will be absent if there are no more
|
7712
|
+
# assigned_targeting_options to return.
|
7713
|
+
# Corresponds to the JSON property `nextPageToken`
|
7714
|
+
# @return [String]
|
7715
|
+
attr_accessor :next_page_token
|
7716
|
+
|
7717
|
+
def initialize(**args)
|
7718
|
+
update!(**args)
|
7719
|
+
end
|
7720
|
+
|
7721
|
+
# Update properties of this object
|
7722
|
+
def update!(**args)
|
7723
|
+
@assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
|
7724
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
7725
|
+
end
|
7726
|
+
end
|
7727
|
+
|
7613
7728
|
#
|
7614
7729
|
class ListInsertionOrdersResponse
|
7615
7730
|
include Google::Apis::Core::Hashable
|
@@ -11103,6 +11218,40 @@ module Google
|
|
11103
11218
|
end
|
11104
11219
|
end
|
11105
11220
|
|
11221
|
+
# The video ad inventory control used in certain YouTube line item types.
|
11222
|
+
class VideoAdInventoryControl
|
11223
|
+
include Google::Apis::Core::Hashable
|
11224
|
+
|
11225
|
+
# Optional. Whether ads can serve as in-feed format.
|
11226
|
+
# Corresponds to the JSON property `allowInFeed`
|
11227
|
+
# @return [Boolean]
|
11228
|
+
attr_accessor :allow_in_feed
|
11229
|
+
alias_method :allow_in_feed?, :allow_in_feed
|
11230
|
+
|
11231
|
+
# Optional. Whether ads can serve as in-stream format.
|
11232
|
+
# Corresponds to the JSON property `allowInStream`
|
11233
|
+
# @return [Boolean]
|
11234
|
+
attr_accessor :allow_in_stream
|
11235
|
+
alias_method :allow_in_stream?, :allow_in_stream
|
11236
|
+
|
11237
|
+
# Optional. Whether ads can serve as shorts format.
|
11238
|
+
# Corresponds to the JSON property `allowShorts`
|
11239
|
+
# @return [Boolean]
|
11240
|
+
attr_accessor :allow_shorts
|
11241
|
+
alias_method :allow_shorts?, :allow_shorts
|
11242
|
+
|
11243
|
+
def initialize(**args)
|
11244
|
+
update!(**args)
|
11245
|
+
end
|
11246
|
+
|
11247
|
+
# Update properties of this object
|
11248
|
+
def update!(**args)
|
11249
|
+
@allow_in_feed = args[:allow_in_feed] if args.key?(:allow_in_feed)
|
11250
|
+
@allow_in_stream = args[:allow_in_stream] if args.key?(:allow_in_stream)
|
11251
|
+
@allow_shorts = args[:allow_shorts] if args.key?(:allow_shorts)
|
11252
|
+
end
|
11253
|
+
end
|
11254
|
+
|
11106
11255
|
# Settings related to VideoAdSequence.
|
11107
11256
|
class VideoAdSequenceSettings
|
11108
11257
|
include Google::Apis::Core::Hashable
|
@@ -11747,6 +11896,11 @@ module Google
|
|
11747
11896
|
# @return [Google::Apis::DisplayvideoV2::YoutubeAndPartnersThirdPartyMeasurementSettings]
|
11748
11897
|
attr_accessor :third_party_measurement_settings
|
11749
11898
|
|
11899
|
+
# The video ad inventory control used in certain YouTube line item types.
|
11900
|
+
# Corresponds to the JSON property `videoAdInventoryControl`
|
11901
|
+
# @return [Google::Apis::DisplayvideoV2::VideoAdInventoryControl]
|
11902
|
+
attr_accessor :video_ad_inventory_control
|
11903
|
+
|
11750
11904
|
# Settings related to VideoAdSequence.
|
11751
11905
|
# Corresponds to the JSON property `videoAdSequenceSettings`
|
11752
11906
|
# @return [Google::Apis::DisplayvideoV2::VideoAdSequenceSettings]
|
@@ -11773,6 +11927,7 @@ module Google
|
|
11773
11927
|
@related_video_ids = args[:related_video_ids] if args.key?(:related_video_ids)
|
11774
11928
|
@target_frequency = args[:target_frequency] if args.key?(:target_frequency)
|
11775
11929
|
@third_party_measurement_settings = args[:third_party_measurement_settings] if args.key?(:third_party_measurement_settings)
|
11930
|
+
@video_ad_inventory_control = args[:video_ad_inventory_control] if args.key?(:video_ad_inventory_control)
|
11776
11931
|
@video_ad_sequence_settings = args[:video_ad_sequence_settings] if args.key?(:video_ad_sequence_settings)
|
11777
11932
|
@view_frequency_cap = args[:view_frequency_cap] if args.key?(:view_frequency_cap)
|
11778
11933
|
end
|
@@ -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.
|
19
|
+
GEM_VERSION = "0.50.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 = "
|
25
|
+
REVISION = "20250729"
|
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
|
|
@@ -1780,6 +1804,12 @@ module Google
|
|
1780
1804
|
include Google::Apis::Core::JsonObjectSupport
|
1781
1805
|
end
|
1782
1806
|
|
1807
|
+
class VideoAdInventoryControl
|
1808
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1809
|
+
|
1810
|
+
include Google::Apis::Core::JsonObjectSupport
|
1811
|
+
end
|
1812
|
+
|
1783
1813
|
class VideoAdSequenceSettings
|
1784
1814
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1785
1815
|
|
@@ -2479,6 +2509,24 @@ module Google
|
|
2479
2509
|
end
|
2480
2510
|
end
|
2481
2511
|
|
2512
|
+
class BulkListCampaignAssignedTargetingOptionsResponse
|
2513
|
+
# @private
|
2514
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2515
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV2::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
|
2516
|
+
|
2517
|
+
property :next_page_token, as: 'nextPageToken'
|
2518
|
+
end
|
2519
|
+
end
|
2520
|
+
|
2521
|
+
class BulkListInsertionOrderAssignedTargetingOptionsResponse
|
2522
|
+
# @private
|
2523
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2524
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV2::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
|
2525
|
+
|
2526
|
+
property :next_page_token, as: 'nextPageToken'
|
2527
|
+
end
|
2528
|
+
end
|
2529
|
+
|
2482
2530
|
class BulkUpdateLineItemsRequest
|
2483
2531
|
# @private
|
2484
2532
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -3832,6 +3880,15 @@ module Google
|
|
3832
3880
|
end
|
3833
3881
|
end
|
3834
3882
|
|
3883
|
+
class ListCampaignAssignedTargetingOptionsResponse
|
3884
|
+
# @private
|
3885
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3886
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV2::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
|
3887
|
+
|
3888
|
+
property :next_page_token, as: 'nextPageToken'
|
3889
|
+
end
|
3890
|
+
end
|
3891
|
+
|
3835
3892
|
class ListCampaignsResponse
|
3836
3893
|
# @private
|
3837
3894
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -3922,6 +3979,15 @@ module Google
|
|
3922
3979
|
end
|
3923
3980
|
end
|
3924
3981
|
|
3982
|
+
class ListInsertionOrderAssignedTargetingOptionsResponse
|
3983
|
+
# @private
|
3984
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3985
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV2::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
|
3986
|
+
|
3987
|
+
property :next_page_token, as: 'nextPageToken'
|
3988
|
+
end
|
3989
|
+
end
|
3990
|
+
|
3925
3991
|
class ListInsertionOrdersResponse
|
3926
3992
|
# @private
|
3927
3993
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -4896,6 +4962,15 @@ module Google
|
|
4896
4962
|
end
|
4897
4963
|
end
|
4898
4964
|
|
4965
|
+
class VideoAdInventoryControl
|
4966
|
+
# @private
|
4967
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
4968
|
+
property :allow_in_feed, as: 'allowInFeed'
|
4969
|
+
property :allow_in_stream, as: 'allowInStream'
|
4970
|
+
property :allow_shorts, as: 'allowShorts'
|
4971
|
+
end
|
4972
|
+
end
|
4973
|
+
|
4899
4974
|
class VideoAdSequenceSettings
|
4900
4975
|
# @private
|
4901
4976
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -5070,6 +5145,8 @@ module Google
|
|
5070
5145
|
|
5071
5146
|
property :third_party_measurement_settings, as: 'thirdPartyMeasurementSettings', class: Google::Apis::DisplayvideoV2::YoutubeAndPartnersThirdPartyMeasurementSettings, decorator: Google::Apis::DisplayvideoV2::YoutubeAndPartnersThirdPartyMeasurementSettings::Representation
|
5072
5147
|
|
5148
|
+
property :video_ad_inventory_control, as: 'videoAdInventoryControl', class: Google::Apis::DisplayvideoV2::VideoAdInventoryControl, decorator: Google::Apis::DisplayvideoV2::VideoAdInventoryControl::Representation
|
5149
|
+
|
5073
5150
|
property :video_ad_sequence_settings, as: 'videoAdSequenceSettings', class: Google::Apis::DisplayvideoV2::VideoAdSequenceSettings, decorator: Google::Apis::DisplayvideoV2::VideoAdSequenceSettings::Representation
|
5074
5151
|
|
5075
5152
|
property :view_frequency_cap, as: 'viewFrequencyCap', class: Google::Apis::DisplayvideoV2::FrequencyCap, decorator: Google::Apis::DisplayvideoV2::FrequencyCap::Representation
|
@@ -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.
|
4
|
+
version: 0.50.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.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v2/v0.50.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:
|