google-apis-displayvideo_v1 0.3.0 → 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 88a67ce37a07c98119a90676e956989da2414b1e8d2e492446c4f50580b931f2
|
4
|
+
data.tar.gz: 3a9d374618661e16ecaf53acccdab2d748b49b1ea8ebc6ed6ec0bbe3113c8beb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ab47d2ec2a95b6bff916d52b45bb056adf25082ec16e94a0e9275cbdd8f03e72a3558b4ffe6bf2eda0b7bdfe7f4d1d3ac249486e2a5f768645367f8a3d6379dd
|
7
|
+
data.tar.gz: aeb12222e9efa1929b7a9be05ab7b1cddd46ad838e2cac5e055e79eed4fc905fe740f0b158467f11005e4e3c2ec404cddaeac15fc75d4d2cc2ce9326f41ca3f5
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,27 @@
|
|
1
1
|
# Release history for google-apis-displayvideo_v1
|
2
2
|
|
3
|
+
### v0.8.0 (2021-04-23)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20210422
|
6
|
+
|
7
|
+
### v0.7.0 (2021-03-23)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20210318
|
10
|
+
|
11
|
+
### v0.6.0 (2021-03-16)
|
12
|
+
|
13
|
+
* Regenerated from discovery document revision 20210312
|
14
|
+
* Regenerated using generator version 0.2.0
|
15
|
+
|
16
|
+
### v0.5.0 (2021-03-05)
|
17
|
+
|
18
|
+
* Regenerated from discovery document revision 20210304
|
19
|
+
* Unspecified changes
|
20
|
+
|
21
|
+
### v0.4.0 (2021-02-26)
|
22
|
+
|
23
|
+
* Regenerated from discovery document revision 20210225
|
24
|
+
|
3
25
|
### v0.3.0 (2021-02-19)
|
4
26
|
|
5
27
|
* Regenerated from discovery document revision 20210218
|
@@ -137,8 +137,9 @@ module Google
|
|
137
137
|
|
138
138
|
# Required. Controls whether or not insertion orders and line items of the
|
139
139
|
# advertiser can spend their budgets and bid on inventory. * Accepted values are
|
140
|
-
# `ENTITY_STATUS_ACTIVE` and `
|
141
|
-
#
|
140
|
+
# `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `
|
141
|
+
# ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `
|
142
|
+
# ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days
|
142
143
|
# from when it was first scheduled for deletion.
|
143
144
|
# Corresponds to the JSON property `entityStatus`
|
144
145
|
# @return [String]
|
@@ -456,6 +457,13 @@ module Google
|
|
456
457
|
# @return [String]
|
457
458
|
attr_accessor :app_id
|
458
459
|
|
460
|
+
# Indicates the platform of the targeted app. If this field is not specified,
|
461
|
+
# the app platform will be assumed to be mobile (i.e., Android or iOS), and we
|
462
|
+
# will derive the appropriate mobile platform from the app ID.
|
463
|
+
# Corresponds to the JSON property `appPlatform`
|
464
|
+
# @return [String]
|
465
|
+
attr_accessor :app_platform
|
466
|
+
|
459
467
|
# Output only. The display name of the app.
|
460
468
|
# Corresponds to the JSON property `displayName`
|
461
469
|
# @return [String]
|
@@ -474,6 +482,7 @@ module Google
|
|
474
482
|
# Update properties of this object
|
475
483
|
def update!(**args)
|
476
484
|
@app_id = args[:app_id] if args.key?(:app_id)
|
485
|
+
@app_platform = args[:app_platform] if args.key?(:app_platform)
|
477
486
|
@display_name = args[:display_name] if args.key?(:display_name)
|
478
487
|
@negative = args[:negative] if args.key?(:negative)
|
479
488
|
end
|
@@ -685,7 +694,7 @@ module Google
|
|
685
694
|
attr_accessor :app_details
|
686
695
|
|
687
696
|
# Output only. The unique ID of the assigned targeting option. The ID is only
|
688
|
-
# unique within a given
|
697
|
+
# unique within a given resource and targeting type. It may be reused in other
|
689
698
|
# contexts.
|
690
699
|
# Corresponds to the JSON property `assignedTargetingOptionId`
|
691
700
|
# @return [String]
|
@@ -1301,8 +1310,7 @@ module Google
|
|
1301
1310
|
attr_accessor :display_name
|
1302
1311
|
|
1303
1312
|
# Indicates if this option is being negatively targeted. All assigned browser
|
1304
|
-
# targeting options on the same
|
1305
|
-
# field.
|
1313
|
+
# targeting options on the same resource must have the same value for this field.
|
1306
1314
|
# Corresponds to the JSON property `negative`
|
1307
1315
|
# @return [Boolean]
|
1308
1316
|
attr_accessor :negative
|
@@ -1782,6 +1790,35 @@ module Google
|
|
1782
1790
|
end
|
1783
1791
|
end
|
1784
1792
|
|
1793
|
+
# Response message for BulkListCampaignAssignedTargetingOptions.
|
1794
|
+
class BulkListCampaignAssignedTargetingOptionsResponse
|
1795
|
+
include Google::Apis::Core::Hashable
|
1796
|
+
|
1797
|
+
# The list of assigned targeting options. This list will be absent if empty.
|
1798
|
+
# Corresponds to the JSON property `assignedTargetingOptions`
|
1799
|
+
# @return [Array<Google::Apis::DisplayvideoV1::AssignedTargetingOption>]
|
1800
|
+
attr_accessor :assigned_targeting_options
|
1801
|
+
|
1802
|
+
# A token identifying the next page of results. This value should be specified
|
1803
|
+
# as the pageToken in a subsequent
|
1804
|
+
# BulkListCampaignAssignedTargetingOptionsRequest to fetch the next page of
|
1805
|
+
# results. This token will be absent if there are no more
|
1806
|
+
# assigned_targeting_options to return.
|
1807
|
+
# Corresponds to the JSON property `nextPageToken`
|
1808
|
+
# @return [String]
|
1809
|
+
attr_accessor :next_page_token
|
1810
|
+
|
1811
|
+
def initialize(**args)
|
1812
|
+
update!(**args)
|
1813
|
+
end
|
1814
|
+
|
1815
|
+
# Update properties of this object
|
1816
|
+
def update!(**args)
|
1817
|
+
@assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
|
1818
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
1819
|
+
end
|
1820
|
+
end
|
1821
|
+
|
1785
1822
|
# Response message for BulkListInsertionOrderAssignedTargetingOptions.
|
1786
1823
|
class BulkListInsertionOrderAssignedTargetingOptionsResponse
|
1787
1824
|
include Google::Apis::Core::Hashable
|
@@ -1978,7 +2015,7 @@ module Google
|
|
1978
2015
|
attr_accessor :display_name
|
1979
2016
|
|
1980
2017
|
# Indicates if this option is being negatively targeted. All assigned carrier
|
1981
|
-
# and ISP targeting options on the same
|
2018
|
+
# and ISP targeting options on the same resource must have the same value for
|
1982
2019
|
# this field.
|
1983
2020
|
# Corresponds to the JSON property `negative`
|
1984
2021
|
# @return [Boolean]
|
@@ -2110,11 +2147,23 @@ module Google
|
|
2110
2147
|
# @return [String]
|
2111
2148
|
attr_accessor :name
|
2112
2149
|
|
2150
|
+
# Output only. Number of line items that are directly targeting this channel
|
2151
|
+
# negatively.
|
2152
|
+
# Corresponds to the JSON property `negativelyTargetedLineItemCount`
|
2153
|
+
# @return [Fixnum]
|
2154
|
+
attr_accessor :negatively_targeted_line_item_count
|
2155
|
+
|
2113
2156
|
# The ID of the partner that owns the channel.
|
2114
2157
|
# Corresponds to the JSON property `partnerId`
|
2115
2158
|
# @return [Fixnum]
|
2116
2159
|
attr_accessor :partner_id
|
2117
2160
|
|
2161
|
+
# Output only. Number of line items that are directly targeting this channel
|
2162
|
+
# positively.
|
2163
|
+
# Corresponds to the JSON property `positivelyTargetedLineItemCount`
|
2164
|
+
# @return [Fixnum]
|
2165
|
+
attr_accessor :positively_targeted_line_item_count
|
2166
|
+
|
2118
2167
|
def initialize(**args)
|
2119
2168
|
update!(**args)
|
2120
2169
|
end
|
@@ -2125,7 +2174,9 @@ module Google
|
|
2125
2174
|
@channel_id = args[:channel_id] if args.key?(:channel_id)
|
2126
2175
|
@display_name = args[:display_name] if args.key?(:display_name)
|
2127
2176
|
@name = args[:name] if args.key?(:name)
|
2177
|
+
@negatively_targeted_line_item_count = args[:negatively_targeted_line_item_count] if args.key?(:negatively_targeted_line_item_count)
|
2128
2178
|
@partner_id = args[:partner_id] if args.key?(:partner_id)
|
2179
|
+
@positively_targeted_line_item_count = args[:positively_targeted_line_item_count] if args.key?(:positively_targeted_line_item_count)
|
2129
2180
|
end
|
2130
2181
|
end
|
2131
2182
|
|
@@ -4255,18 +4306,18 @@ module Google
|
|
4255
4306
|
include Google::Apis::Core::Hashable
|
4256
4307
|
|
4257
4308
|
# The maximum number of times a user may be shown with the same ad during this
|
4258
|
-
# period. Must be greater than 0.
|
4309
|
+
# period. Must be greater than 0. Required when unlimited is `false`.
|
4259
4310
|
# Corresponds to the JSON property `maxImpressions`
|
4260
4311
|
# @return [Fixnum]
|
4261
4312
|
attr_accessor :max_impressions
|
4262
4313
|
|
4263
|
-
# The time unit in which the frequency cap will be applied.
|
4314
|
+
# The time unit in which the frequency cap will be applied. Required when
|
4264
4315
|
# unlimited is `false`.
|
4265
4316
|
# Corresponds to the JSON property `timeUnit`
|
4266
4317
|
# @return [String]
|
4267
4318
|
attr_accessor :time_unit
|
4268
4319
|
|
4269
|
-
# The number of time_unit the frequency cap will last.
|
4320
|
+
# The number of time_unit the frequency cap will last. Required when unlimited
|
4270
4321
|
# is `false`. The following restrictions apply based on the value of time_unit: *
|
4271
4322
|
# `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `
|
4272
4323
|
# TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be
|
@@ -4345,6 +4396,44 @@ module Google
|
|
4345
4396
|
end
|
4346
4397
|
end
|
4347
4398
|
|
4399
|
+
# Request message for LineItemService.GenerateDefaultLineItem.
|
4400
|
+
class GenerateDefaultLineItemRequest
|
4401
|
+
include Google::Apis::Core::Hashable
|
4402
|
+
|
4403
|
+
# Required. The display name of the line item. Must be UTF-8 encoded with a
|
4404
|
+
# maximum size of 240 bytes.
|
4405
|
+
# Corresponds to the JSON property `displayName`
|
4406
|
+
# @return [String]
|
4407
|
+
attr_accessor :display_name
|
4408
|
+
|
4409
|
+
# Required. The unique ID of the insertion order that the line item belongs to.
|
4410
|
+
# Corresponds to the JSON property `insertionOrderId`
|
4411
|
+
# @return [Fixnum]
|
4412
|
+
attr_accessor :insertion_order_id
|
4413
|
+
|
4414
|
+
# Required. The type of the line item.
|
4415
|
+
# Corresponds to the JSON property `lineItemType`
|
4416
|
+
# @return [String]
|
4417
|
+
attr_accessor :line_item_type
|
4418
|
+
|
4419
|
+
# A mobile app promoted by a mobile app install line item.
|
4420
|
+
# Corresponds to the JSON property `mobileApp`
|
4421
|
+
# @return [Google::Apis::DisplayvideoV1::MobileApp]
|
4422
|
+
attr_accessor :mobile_app
|
4423
|
+
|
4424
|
+
def initialize(**args)
|
4425
|
+
update!(**args)
|
4426
|
+
end
|
4427
|
+
|
4428
|
+
# Update properties of this object
|
4429
|
+
def update!(**args)
|
4430
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
4431
|
+
@insertion_order_id = args[:insertion_order_id] if args.key?(:insertion_order_id)
|
4432
|
+
@line_item_type = args[:line_item_type] if args.key?(:line_item_type)
|
4433
|
+
@mobile_app = args[:mobile_app] if args.key?(:mobile_app)
|
4434
|
+
end
|
4435
|
+
end
|
4436
|
+
|
4348
4437
|
# Details for assigned geographic region targeting option. This will be
|
4349
4438
|
# populated in the details field of an AssignedTargetingOption when
|
4350
4439
|
# targeting_type is `TARGETING_TYPE_GEO_REGION`.
|
@@ -5295,8 +5384,7 @@ module Google
|
|
5295
5384
|
attr_accessor :display_name
|
5296
5385
|
|
5297
5386
|
# Indicates if this option is being negatively targeted. All assigned language
|
5298
|
-
# targeting options on the same
|
5299
|
-
# field.
|
5387
|
+
# targeting options on the same resource must have the same value for this field.
|
5300
5388
|
# Corresponds to the JSON property `negative`
|
5301
5389
|
# @return [Boolean]
|
5302
5390
|
attr_accessor :negative
|
@@ -5697,6 +5785,34 @@ module Google
|
|
5697
5785
|
end
|
5698
5786
|
end
|
5699
5787
|
|
5788
|
+
# Response message for ListCampaignAssignedTargetingOptions.
|
5789
|
+
class ListCampaignAssignedTargetingOptionsResponse
|
5790
|
+
include Google::Apis::Core::Hashable
|
5791
|
+
|
5792
|
+
# The list of assigned targeting options. This list will be absent if empty.
|
5793
|
+
# Corresponds to the JSON property `assignedTargetingOptions`
|
5794
|
+
# @return [Array<Google::Apis::DisplayvideoV1::AssignedTargetingOption>]
|
5795
|
+
attr_accessor :assigned_targeting_options
|
5796
|
+
|
5797
|
+
# A token identifying the next page of results. This value should be specified
|
5798
|
+
# as the pageToken in a subsequent ListCampaignAssignedTargetingOptionsRequest
|
5799
|
+
# to fetch the next page of results. This token will be absent if there are no
|
5800
|
+
# more assigned_targeting_options to return.
|
5801
|
+
# Corresponds to the JSON property `nextPageToken`
|
5802
|
+
# @return [String]
|
5803
|
+
attr_accessor :next_page_token
|
5804
|
+
|
5805
|
+
def initialize(**args)
|
5806
|
+
update!(**args)
|
5807
|
+
end
|
5808
|
+
|
5809
|
+
# Update properties of this object
|
5810
|
+
def update!(**args)
|
5811
|
+
@assigned_targeting_options = args[:assigned_targeting_options] if args.key?(:assigned_targeting_options)
|
5812
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
5813
|
+
end
|
5814
|
+
end
|
5815
|
+
|
5700
5816
|
#
|
5701
5817
|
class ListCampaignsResponse
|
5702
5818
|
include Google::Apis::Core::Hashable
|
@@ -6659,6 +6775,12 @@ module Google
|
|
6659
6775
|
# @return [Fixnum]
|
6660
6776
|
attr_accessor :negative_keyword_list_id
|
6661
6777
|
|
6778
|
+
# Output only. Number of line items that are directly targeting this negative
|
6779
|
+
# keyword list.
|
6780
|
+
# Corresponds to the JSON property `targetedLineItemCount`
|
6781
|
+
# @return [Fixnum]
|
6782
|
+
attr_accessor :targeted_line_item_count
|
6783
|
+
|
6662
6784
|
def initialize(**args)
|
6663
6785
|
update!(**args)
|
6664
6786
|
end
|
@@ -6669,6 +6791,7 @@ module Google
|
|
6669
6791
|
@display_name = args[:display_name] if args.key?(:display_name)
|
6670
6792
|
@name = args[:name] if args.key?(:name)
|
6671
6793
|
@negative_keyword_list_id = args[:negative_keyword_list_id] if args.key?(:negative_keyword_list_id)
|
6794
|
+
@targeted_line_item_count = args[:targeted_line_item_count] if args.key?(:targeted_line_item_count)
|
6672
6795
|
end
|
6673
6796
|
end
|
6674
6797
|
|
@@ -7423,9 +7546,9 @@ module Google
|
|
7423
7546
|
|
7424
7547
|
# Required. Radius range for proximity location list. This represents the size
|
7425
7548
|
# of the area around a chosen location that will be targeted. `All` proximity
|
7426
|
-
# location targeting under a single
|
7549
|
+
# location targeting under a single resource must have the same radius range
|
7427
7550
|
# value. Set this value to match any existing targeting. If updated, this field
|
7428
|
-
# will change the radius range for all proximity targeting under the
|
7551
|
+
# will change the radius range for all proximity targeting under the resource.
|
7429
7552
|
# Corresponds to the JSON property `proximityRadiusRange`
|
7430
7553
|
# @return [String]
|
7431
7554
|
attr_accessor :proximity_radius_range
|
@@ -7535,6 +7658,96 @@ module Google
|
|
7535
7658
|
end
|
7536
7659
|
end
|
7537
7660
|
|
7661
|
+
# Request message for NegativeKeywordService.ReplaceNegativeKeywords.
|
7662
|
+
class ReplaceNegativeKeywordsRequest
|
7663
|
+
include Google::Apis::Core::Hashable
|
7664
|
+
|
7665
|
+
# The negative keywords that will replace the existing keywords in the negative
|
7666
|
+
# keyword list, specified as a list of NegativeKeywords.
|
7667
|
+
# Corresponds to the JSON property `newNegativeKeywords`
|
7668
|
+
# @return [Array<Google::Apis::DisplayvideoV1::NegativeKeyword>]
|
7669
|
+
attr_accessor :new_negative_keywords
|
7670
|
+
|
7671
|
+
def initialize(**args)
|
7672
|
+
update!(**args)
|
7673
|
+
end
|
7674
|
+
|
7675
|
+
# Update properties of this object
|
7676
|
+
def update!(**args)
|
7677
|
+
@new_negative_keywords = args[:new_negative_keywords] if args.key?(:new_negative_keywords)
|
7678
|
+
end
|
7679
|
+
end
|
7680
|
+
|
7681
|
+
# Response message for NegativeKeywordService.ReplaceNegativeKeywords.
|
7682
|
+
class ReplaceNegativeKeywordsResponse
|
7683
|
+
include Google::Apis::Core::Hashable
|
7684
|
+
|
7685
|
+
# The full list of negative keywords now present in the negative keyword list.
|
7686
|
+
# Corresponds to the JSON property `negativeKeywords`
|
7687
|
+
# @return [Array<Google::Apis::DisplayvideoV1::NegativeKeyword>]
|
7688
|
+
attr_accessor :negative_keywords
|
7689
|
+
|
7690
|
+
def initialize(**args)
|
7691
|
+
update!(**args)
|
7692
|
+
end
|
7693
|
+
|
7694
|
+
# Update properties of this object
|
7695
|
+
def update!(**args)
|
7696
|
+
@negative_keywords = args[:negative_keywords] if args.key?(:negative_keywords)
|
7697
|
+
end
|
7698
|
+
end
|
7699
|
+
|
7700
|
+
# Request message for SiteService.ReplaceSites.
|
7701
|
+
class ReplaceSitesRequest
|
7702
|
+
include Google::Apis::Core::Hashable
|
7703
|
+
|
7704
|
+
# The ID of the advertiser that owns the parent channel.
|
7705
|
+
# Corresponds to the JSON property `advertiserId`
|
7706
|
+
# @return [Fixnum]
|
7707
|
+
attr_accessor :advertiser_id
|
7708
|
+
|
7709
|
+
# The sites that will replace the existing sites assigned to the channel,
|
7710
|
+
# specified as a list of Sites.
|
7711
|
+
# Corresponds to the JSON property `newSites`
|
7712
|
+
# @return [Array<Google::Apis::DisplayvideoV1::Site>]
|
7713
|
+
attr_accessor :new_sites
|
7714
|
+
|
7715
|
+
# The ID of the partner that owns the parent channel.
|
7716
|
+
# Corresponds to the JSON property `partnerId`
|
7717
|
+
# @return [Fixnum]
|
7718
|
+
attr_accessor :partner_id
|
7719
|
+
|
7720
|
+
def initialize(**args)
|
7721
|
+
update!(**args)
|
7722
|
+
end
|
7723
|
+
|
7724
|
+
# Update properties of this object
|
7725
|
+
def update!(**args)
|
7726
|
+
@advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
|
7727
|
+
@new_sites = args[:new_sites] if args.key?(:new_sites)
|
7728
|
+
@partner_id = args[:partner_id] if args.key?(:partner_id)
|
7729
|
+
end
|
7730
|
+
end
|
7731
|
+
|
7732
|
+
# Response message for SiteService.ReplaceSites.
|
7733
|
+
class ReplaceSitesResponse
|
7734
|
+
include Google::Apis::Core::Hashable
|
7735
|
+
|
7736
|
+
# The list of sites in the channel after replacing.
|
7737
|
+
# Corresponds to the JSON property `sites`
|
7738
|
+
# @return [Array<Google::Apis::DisplayvideoV1::Site>]
|
7739
|
+
attr_accessor :sites
|
7740
|
+
|
7741
|
+
def initialize(**args)
|
7742
|
+
update!(**args)
|
7743
|
+
end
|
7744
|
+
|
7745
|
+
# Update properties of this object
|
7746
|
+
def update!(**args)
|
7747
|
+
@sites = args[:sites] if args.key?(:sites)
|
7748
|
+
end
|
7749
|
+
end
|
7750
|
+
|
7538
7751
|
# Review statuses for the creative.
|
7539
7752
|
class ReviewStatusInfo
|
7540
7753
|
include Google::Apis::Core::Hashable
|
@@ -7788,7 +8001,7 @@ module Google
|
|
7788
8001
|
# @return [String]
|
7789
8002
|
attr_accessor :name
|
7790
8003
|
|
7791
|
-
# Required. The
|
8004
|
+
# Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum
|
7792
8005
|
# length of 240 bytes.
|
7793
8006
|
# Corresponds to the JSON property `urlOrAppId`
|
7794
8007
|
# @return [String]
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module DisplayvideoV1
|
18
18
|
# Version of the google-apis-displayvideo_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.8.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.2.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210422"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -298,6 +298,12 @@ module Google
|
|
298
298
|
include Google::Apis::Core::JsonObjectSupport
|
299
299
|
end
|
300
300
|
|
301
|
+
class BulkListCampaignAssignedTargetingOptionsResponse
|
302
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
303
|
+
|
304
|
+
include Google::Apis::Core::JsonObjectSupport
|
305
|
+
end
|
306
|
+
|
301
307
|
class BulkListInsertionOrderAssignedTargetingOptionsResponse
|
302
308
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
303
309
|
|
@@ -700,6 +706,12 @@ module Google
|
|
700
706
|
include Google::Apis::Core::JsonObjectSupport
|
701
707
|
end
|
702
708
|
|
709
|
+
class GenerateDefaultLineItemRequest
|
710
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
711
|
+
|
712
|
+
include Google::Apis::Core::JsonObjectSupport
|
713
|
+
end
|
714
|
+
|
703
715
|
class GeoRegionAssignedTargetingOptionDetails
|
704
716
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
705
717
|
|
@@ -898,6 +910,12 @@ module Google
|
|
898
910
|
include Google::Apis::Core::JsonObjectSupport
|
899
911
|
end
|
900
912
|
|
913
|
+
class ListCampaignAssignedTargetingOptionsResponse
|
914
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
915
|
+
|
916
|
+
include Google::Apis::Core::JsonObjectSupport
|
917
|
+
end
|
918
|
+
|
901
919
|
class ListCampaignsResponse
|
902
920
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
903
921
|
|
@@ -1228,6 +1246,30 @@ module Google
|
|
1228
1246
|
include Google::Apis::Core::JsonObjectSupport
|
1229
1247
|
end
|
1230
1248
|
|
1249
|
+
class ReplaceNegativeKeywordsRequest
|
1250
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1251
|
+
|
1252
|
+
include Google::Apis::Core::JsonObjectSupport
|
1253
|
+
end
|
1254
|
+
|
1255
|
+
class ReplaceNegativeKeywordsResponse
|
1256
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1257
|
+
|
1258
|
+
include Google::Apis::Core::JsonObjectSupport
|
1259
|
+
end
|
1260
|
+
|
1261
|
+
class ReplaceSitesRequest
|
1262
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1263
|
+
|
1264
|
+
include Google::Apis::Core::JsonObjectSupport
|
1265
|
+
end
|
1266
|
+
|
1267
|
+
class ReplaceSitesResponse
|
1268
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1269
|
+
|
1270
|
+
include Google::Apis::Core::JsonObjectSupport
|
1271
|
+
end
|
1272
|
+
|
1231
1273
|
class ReviewStatusInfo
|
1232
1274
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1233
1275
|
|
@@ -1528,6 +1570,7 @@ module Google
|
|
1528
1570
|
# @private
|
1529
1571
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1530
1572
|
property :app_id, as: 'appId'
|
1573
|
+
property :app_platform, as: 'appPlatform'
|
1531
1574
|
property :display_name, as: 'displayName'
|
1532
1575
|
property :negative, as: 'negative'
|
1533
1576
|
end
|
@@ -1913,6 +1956,15 @@ module Google
|
|
1913
1956
|
end
|
1914
1957
|
end
|
1915
1958
|
|
1959
|
+
class BulkListCampaignAssignedTargetingOptionsResponse
|
1960
|
+
# @private
|
1961
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1962
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
1963
|
+
|
1964
|
+
property :next_page_token, as: 'nextPageToken'
|
1965
|
+
end
|
1966
|
+
end
|
1967
|
+
|
1916
1968
|
class BulkListInsertionOrderAssignedTargetingOptionsResponse
|
1917
1969
|
# @private
|
1918
1970
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2007,7 +2059,9 @@ module Google
|
|
2007
2059
|
property :channel_id, :numeric_string => true, as: 'channelId'
|
2008
2060
|
property :display_name, as: 'displayName'
|
2009
2061
|
property :name, as: 'name'
|
2062
|
+
property :negatively_targeted_line_item_count, :numeric_string => true, as: 'negativelyTargetedLineItemCount'
|
2010
2063
|
property :partner_id, :numeric_string => true, as: 'partnerId'
|
2064
|
+
property :positively_targeted_line_item_count, :numeric_string => true, as: 'positivelyTargetedLineItemCount'
|
2011
2065
|
end
|
2012
2066
|
end
|
2013
2067
|
|
@@ -2579,6 +2633,17 @@ module Google
|
|
2579
2633
|
end
|
2580
2634
|
end
|
2581
2635
|
|
2636
|
+
class GenerateDefaultLineItemRequest
|
2637
|
+
# @private
|
2638
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2639
|
+
property :display_name, as: 'displayName'
|
2640
|
+
property :insertion_order_id, :numeric_string => true, as: 'insertionOrderId'
|
2641
|
+
property :line_item_type, as: 'lineItemType'
|
2642
|
+
property :mobile_app, as: 'mobileApp', class: Google::Apis::DisplayvideoV1::MobileApp, decorator: Google::Apis::DisplayvideoV1::MobileApp::Representation
|
2643
|
+
|
2644
|
+
end
|
2645
|
+
end
|
2646
|
+
|
2582
2647
|
class GeoRegionAssignedTargetingOptionDetails
|
2583
2648
|
# @private
|
2584
2649
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2939,6 +3004,15 @@ module Google
|
|
2939
3004
|
end
|
2940
3005
|
end
|
2941
3006
|
|
3007
|
+
class ListCampaignAssignedTargetingOptionsResponse
|
3008
|
+
# @private
|
3009
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3010
|
+
collection :assigned_targeting_options, as: 'assignedTargetingOptions', class: Google::Apis::DisplayvideoV1::AssignedTargetingOption, decorator: Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
3011
|
+
|
3012
|
+
property :next_page_token, as: 'nextPageToken'
|
3013
|
+
end
|
3014
|
+
end
|
3015
|
+
|
2942
3016
|
class ListCampaignsResponse
|
2943
3017
|
# @private
|
2944
3018
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -3229,6 +3303,7 @@ module Google
|
|
3229
3303
|
property :display_name, as: 'displayName'
|
3230
3304
|
property :name, as: 'name'
|
3231
3305
|
property :negative_keyword_list_id, :numeric_string => true, as: 'negativeKeywordListId'
|
3306
|
+
property :targeted_line_item_count, :numeric_string => true, as: 'targetedLineItemCount'
|
3232
3307
|
end
|
3233
3308
|
end
|
3234
3309
|
|
@@ -3450,6 +3525,40 @@ module Google
|
|
3450
3525
|
end
|
3451
3526
|
end
|
3452
3527
|
|
3528
|
+
class ReplaceNegativeKeywordsRequest
|
3529
|
+
# @private
|
3530
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3531
|
+
collection :new_negative_keywords, as: 'newNegativeKeywords', class: Google::Apis::DisplayvideoV1::NegativeKeyword, decorator: Google::Apis::DisplayvideoV1::NegativeKeyword::Representation
|
3532
|
+
|
3533
|
+
end
|
3534
|
+
end
|
3535
|
+
|
3536
|
+
class ReplaceNegativeKeywordsResponse
|
3537
|
+
# @private
|
3538
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3539
|
+
collection :negative_keywords, as: 'negativeKeywords', class: Google::Apis::DisplayvideoV1::NegativeKeyword, decorator: Google::Apis::DisplayvideoV1::NegativeKeyword::Representation
|
3540
|
+
|
3541
|
+
end
|
3542
|
+
end
|
3543
|
+
|
3544
|
+
class ReplaceSitesRequest
|
3545
|
+
# @private
|
3546
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3547
|
+
property :advertiser_id, :numeric_string => true, as: 'advertiserId'
|
3548
|
+
collection :new_sites, as: 'newSites', class: Google::Apis::DisplayvideoV1::Site, decorator: Google::Apis::DisplayvideoV1::Site::Representation
|
3549
|
+
|
3550
|
+
property :partner_id, :numeric_string => true, as: 'partnerId'
|
3551
|
+
end
|
3552
|
+
end
|
3553
|
+
|
3554
|
+
class ReplaceSitesResponse
|
3555
|
+
# @private
|
3556
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3557
|
+
collection :sites, as: 'sites', class: Google::Apis::DisplayvideoV1::Site, decorator: Google::Apis::DisplayvideoV1::Site::Representation
|
3558
|
+
|
3559
|
+
end
|
3560
|
+
end
|
3561
|
+
|
3453
3562
|
class ReviewStatusInfo
|
3454
3563
|
# @private
|
3455
3564
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -421,6 +421,69 @@ module Google
|
|
421
421
|
execute_or_queue_command(command, &block)
|
422
422
|
end
|
423
423
|
|
424
|
+
# Lists assigned targeting options of a campaign across targeting types.
|
425
|
+
# @param [Fixnum] advertiser_id
|
426
|
+
# Required. The ID of the advertiser the campaign belongs to.
|
427
|
+
# @param [Fixnum] campaign_id
|
428
|
+
# Required. The ID of the campaign to list assigned targeting options for.
|
429
|
+
# @param [String] filter
|
430
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
431
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
432
|
+
# be combined by the logical operator `OR` on the same field. * A restriction
|
433
|
+
# has the form of ``field` `operator` `value``. * The operator must be `EQUALS (=
|
434
|
+
# )`. * Supported fields: - `targetingType` - `inheritance` Examples: *
|
435
|
+
# AssignedTargetingOptions of targeting type TARGETING_TYPE_LANGUAGE or
|
436
|
+
# TARGETING_TYPE_GENDER `targetingType="TARGETING_TYPE_LANGUAGE" OR
|
437
|
+
# targetingType="TARGETING_TYPE_GENDER"` * AssignedTargetingOptions with
|
438
|
+
# inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="
|
439
|
+
# NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this
|
440
|
+
# field should be no more than 500 characters.
|
441
|
+
# @param [String] order_by
|
442
|
+
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
443
|
+
# default) The default sorting order is ascending. To specify descending order
|
444
|
+
# for a field, a suffix "desc" should be added to the field name. Example: `
|
445
|
+
# targetingType desc`.
|
446
|
+
# @param [Fixnum] page_size
|
447
|
+
# Requested page size. The size must be an integer between `1` and `5000`. If
|
448
|
+
# unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if
|
449
|
+
# an invalid value is specified.
|
450
|
+
# @param [String] page_token
|
451
|
+
# A token that lets the client fetch the next page of results. Typically, this
|
452
|
+
# is the value of next_page_token returned from the previous call to `
|
453
|
+
# BulkListCampaignAssignedTargetingOptions` method. If not specified, the first
|
454
|
+
# page of results will be returned.
|
455
|
+
# @param [String] fields
|
456
|
+
# Selector specifying which fields to include in a partial response.
|
457
|
+
# @param [String] quota_user
|
458
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
459
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
460
|
+
# @param [Google::Apis::RequestOptions] options
|
461
|
+
# Request-specific options
|
462
|
+
#
|
463
|
+
# @yield [result, err] Result & error if block supplied
|
464
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::BulkListCampaignAssignedTargetingOptionsResponse] parsed result object
|
465
|
+
# @yieldparam err [StandardError] error object if request failed
|
466
|
+
#
|
467
|
+
# @return [Google::Apis::DisplayvideoV1::BulkListCampaignAssignedTargetingOptionsResponse]
|
468
|
+
#
|
469
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
470
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
471
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
472
|
+
def bulk_advertiser_campaign_list_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)
|
473
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}:bulkListCampaignAssignedTargetingOptions', options)
|
474
|
+
command.response_representation = Google::Apis::DisplayvideoV1::BulkListCampaignAssignedTargetingOptionsResponse::Representation
|
475
|
+
command.response_class = Google::Apis::DisplayvideoV1::BulkListCampaignAssignedTargetingOptionsResponse
|
476
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
477
|
+
command.params['campaignId'] = campaign_id unless campaign_id.nil?
|
478
|
+
command.query['filter'] = filter unless filter.nil?
|
479
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
480
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
481
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
482
|
+
command.query['fields'] = fields unless fields.nil?
|
483
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
484
|
+
execute_or_queue_command(command, &block)
|
485
|
+
end
|
486
|
+
|
424
487
|
# Creates a new campaign. Returns the newly created campaign if successful.
|
425
488
|
# @param [Fixnum] advertiser_id
|
426
489
|
# Output only. The unique ID of the advertiser the campaign belongs to.
|
@@ -626,6 +689,136 @@ module Google
|
|
626
689
|
execute_or_queue_command(command, &block)
|
627
690
|
end
|
628
691
|
|
692
|
+
# Gets a single targeting option assigned to a campaign.
|
693
|
+
# @param [Fixnum] advertiser_id
|
694
|
+
# Required. The ID of the advertiser the campaign belongs to.
|
695
|
+
# @param [Fixnum] campaign_id
|
696
|
+
# Required. The ID of the campaign the assigned targeting option belongs to.
|
697
|
+
# @param [String] targeting_type
|
698
|
+
# Required. Identifies the type of this assigned targeting option. Supported
|
699
|
+
# targeting types: * `TARGETING_TYPE_AGE_RANGE` * `
|
700
|
+
# TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `
|
701
|
+
# TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
|
702
|
+
# TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
|
703
|
+
# TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
|
704
|
+
# * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
|
705
|
+
# TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
|
706
|
+
# TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
|
707
|
+
# TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `
|
708
|
+
# TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
|
709
|
+
# * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `
|
710
|
+
# TARGETING_TYPE_VIEWABILITY`
|
711
|
+
# @param [String] assigned_targeting_option_id
|
712
|
+
# Required. An identifier unique to the targeting type in this campaign that
|
713
|
+
# identifies the assigned targeting option being requested.
|
714
|
+
# @param [String] fields
|
715
|
+
# Selector specifying which fields to include in a partial response.
|
716
|
+
# @param [String] quota_user
|
717
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
718
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
719
|
+
# @param [Google::Apis::RequestOptions] options
|
720
|
+
# Request-specific options
|
721
|
+
#
|
722
|
+
# @yield [result, err] Result & error if block supplied
|
723
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::AssignedTargetingOption] parsed result object
|
724
|
+
# @yieldparam err [StandardError] error object if request failed
|
725
|
+
#
|
726
|
+
# @return [Google::Apis::DisplayvideoV1::AssignedTargetingOption]
|
727
|
+
#
|
728
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
729
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
730
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
731
|
+
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)
|
732
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
|
733
|
+
command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
|
734
|
+
command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
|
735
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
736
|
+
command.params['campaignId'] = campaign_id unless campaign_id.nil?
|
737
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
738
|
+
command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
|
739
|
+
command.query['fields'] = fields unless fields.nil?
|
740
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
741
|
+
execute_or_queue_command(command, &block)
|
742
|
+
end
|
743
|
+
|
744
|
+
# Lists the targeting options assigned to a campaign for a specified targeting
|
745
|
+
# type.
|
746
|
+
# @param [Fixnum] advertiser_id
|
747
|
+
# Required. The ID of the advertiser the campaign belongs to.
|
748
|
+
# @param [Fixnum] campaign_id
|
749
|
+
# Required. The ID of the campaign to list assigned targeting options for.
|
750
|
+
# @param [String] targeting_type
|
751
|
+
# Required. Identifies the type of assigned targeting options to list. Supported
|
752
|
+
# targeting types: * `TARGETING_TYPE_AGE_RANGE` * `
|
753
|
+
# TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `
|
754
|
+
# TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
|
755
|
+
# TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
|
756
|
+
# TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
|
757
|
+
# * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
|
758
|
+
# TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
|
759
|
+
# TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
|
760
|
+
# TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `
|
761
|
+
# TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
|
762
|
+
# * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `
|
763
|
+
# TARGETING_TYPE_VIEWABILITY`
|
764
|
+
# @param [String] filter
|
765
|
+
# Allows filtering by assigned targeting option properties. Supported syntax: *
|
766
|
+
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
767
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
768
|
+
# field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
|
769
|
+
# fields: - `assignedTargetingOptionId` - `inheritance` Examples: *
|
770
|
+
# AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR
|
771
|
+
# assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance
|
772
|
+
# status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED"
|
773
|
+
# OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
|
774
|
+
# more than 500 characters.
|
775
|
+
# @param [String] order_by
|
776
|
+
# Field by which to sort the list. Acceptable values are: * `
|
777
|
+
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
778
|
+
# To specify descending order for a field, a suffix "desc" should be added to
|
779
|
+
# the field name. Example: `assignedTargetingOptionId desc`.
|
780
|
+
# @param [Fixnum] page_size
|
781
|
+
# Requested page size. Must be between `1` and `100`. If unspecified will
|
782
|
+
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
783
|
+
# specified.
|
784
|
+
# @param [String] page_token
|
785
|
+
# A token identifying a page of results the server should return. Typically,
|
786
|
+
# this is the value of next_page_token returned from the previous call to `
|
787
|
+
# ListCampaignAssignedTargetingOptions` method. If not specified, the first page
|
788
|
+
# of results will be returned.
|
789
|
+
# @param [String] fields
|
790
|
+
# Selector specifying which fields to include in a partial response.
|
791
|
+
# @param [String] quota_user
|
792
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
793
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
794
|
+
# @param [Google::Apis::RequestOptions] options
|
795
|
+
# Request-specific options
|
796
|
+
#
|
797
|
+
# @yield [result, err] Result & error if block supplied
|
798
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ListCampaignAssignedTargetingOptionsResponse] parsed result object
|
799
|
+
# @yieldparam err [StandardError] error object if request failed
|
800
|
+
#
|
801
|
+
# @return [Google::Apis::DisplayvideoV1::ListCampaignAssignedTargetingOptionsResponse]
|
802
|
+
#
|
803
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
804
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
805
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
806
|
+
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)
|
807
|
+
command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
|
808
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ListCampaignAssignedTargetingOptionsResponse::Representation
|
809
|
+
command.response_class = Google::Apis::DisplayvideoV1::ListCampaignAssignedTargetingOptionsResponse
|
810
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
811
|
+
command.params['campaignId'] = campaign_id unless campaign_id.nil?
|
812
|
+
command.params['targetingType'] = targeting_type unless targeting_type.nil?
|
813
|
+
command.query['filter'] = filter unless filter.nil?
|
814
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
815
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
816
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
817
|
+
command.query['fields'] = fields unless fields.nil?
|
818
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
819
|
+
execute_or_queue_command(command, &block)
|
820
|
+
end
|
821
|
+
|
629
822
|
# Creates a new channel. Returns the newly created channel if successful.
|
630
823
|
# @param [Fixnum] advertiser_id
|
631
824
|
# The ID of the advertiser that owns the created channel.
|
@@ -931,7 +1124,7 @@ module Google
|
|
931
1124
|
# for a field, a suffix " desc" should be added to the field name. Example: `
|
932
1125
|
# urlOrAppId desc`.
|
933
1126
|
# @param [Fixnum] page_size
|
934
|
-
# Requested page size. Must be between `1` and `
|
1127
|
+
# Requested page size. Must be between `1` and `10000`. If unspecified will
|
935
1128
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
936
1129
|
# specified.
|
937
1130
|
# @param [String] page_token
|
@@ -974,6 +1167,44 @@ module Google
|
|
974
1167
|
execute_or_queue_command(command, &block)
|
975
1168
|
end
|
976
1169
|
|
1170
|
+
# Replaces all of the sites under a single channel. The operation will replace
|
1171
|
+
# the sites under a channel with the sites provided in ReplaceSitesRequest.
|
1172
|
+
# new_sites.
|
1173
|
+
# @param [Fixnum] advertiser_id
|
1174
|
+
# The ID of the advertiser that owns the parent channel.
|
1175
|
+
# @param [Fixnum] channel_id
|
1176
|
+
# Required. The ID of the parent channel whose sites will be replaced.
|
1177
|
+
# @param [Google::Apis::DisplayvideoV1::ReplaceSitesRequest] replace_sites_request_object
|
1178
|
+
# @param [String] fields
|
1179
|
+
# Selector specifying which fields to include in a partial response.
|
1180
|
+
# @param [String] quota_user
|
1181
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1182
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1183
|
+
# @param [Google::Apis::RequestOptions] options
|
1184
|
+
# Request-specific options
|
1185
|
+
#
|
1186
|
+
# @yield [result, err] Result & error if block supplied
|
1187
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ReplaceSitesResponse] parsed result object
|
1188
|
+
# @yieldparam err [StandardError] error object if request failed
|
1189
|
+
#
|
1190
|
+
# @return [Google::Apis::DisplayvideoV1::ReplaceSitesResponse]
|
1191
|
+
#
|
1192
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1193
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1194
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1195
|
+
def replace_advertiser_channel_site(advertiser_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1196
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites:replace', options)
|
1197
|
+
command.request_representation = Google::Apis::DisplayvideoV1::ReplaceSitesRequest::Representation
|
1198
|
+
command.request_object = replace_sites_request_object
|
1199
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ReplaceSitesResponse::Representation
|
1200
|
+
command.response_class = Google::Apis::DisplayvideoV1::ReplaceSitesResponse
|
1201
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
1202
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
1203
|
+
command.query['fields'] = fields unless fields.nil?
|
1204
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1205
|
+
execute_or_queue_command(command, &block)
|
1206
|
+
end
|
1207
|
+
|
977
1208
|
# Creates a new creative. Returns the newly created creative if successful.
|
978
1209
|
# @param [Fixnum] advertiser_id
|
979
1210
|
# Output only. The unique ID of the advertiser the creative belongs to.
|
@@ -1750,6 +1981,43 @@ module Google
|
|
1750
1981
|
execute_or_queue_command(command, &block)
|
1751
1982
|
end
|
1752
1983
|
|
1984
|
+
# Creates a new line item with settings (including targeting) inherited from the
|
1985
|
+
# insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly
|
1986
|
+
# created line item if successful. There are default values based on the three
|
1987
|
+
# fields: * The insertion order's insertion_order_type * The insertion order's
|
1988
|
+
# automation_type * The given line_item_type
|
1989
|
+
# @param [Fixnum] advertiser_id
|
1990
|
+
# Required. The ID of the advertiser this line item belongs to.
|
1991
|
+
# @param [Google::Apis::DisplayvideoV1::GenerateDefaultLineItemRequest] generate_default_line_item_request_object
|
1992
|
+
# @param [String] fields
|
1993
|
+
# Selector specifying which fields to include in a partial response.
|
1994
|
+
# @param [String] quota_user
|
1995
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1996
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1997
|
+
# @param [Google::Apis::RequestOptions] options
|
1998
|
+
# Request-specific options
|
1999
|
+
#
|
2000
|
+
# @yield [result, err] Result & error if block supplied
|
2001
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::LineItem] parsed result object
|
2002
|
+
# @yieldparam err [StandardError] error object if request failed
|
2003
|
+
#
|
2004
|
+
# @return [Google::Apis::DisplayvideoV1::LineItem]
|
2005
|
+
#
|
2006
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2007
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2008
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2009
|
+
def generate_default_line_item(advertiser_id, generate_default_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2010
|
+
command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems:generateDefault', options)
|
2011
|
+
command.request_representation = Google::Apis::DisplayvideoV1::GenerateDefaultLineItemRequest::Representation
|
2012
|
+
command.request_object = generate_default_line_item_request_object
|
2013
|
+
command.response_representation = Google::Apis::DisplayvideoV1::LineItem::Representation
|
2014
|
+
command.response_class = Google::Apis::DisplayvideoV1::LineItem
|
2015
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
2016
|
+
command.query['fields'] = fields unless fields.nil?
|
2017
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2018
|
+
execute_or_queue_command(command, &block)
|
2019
|
+
end
|
2020
|
+
|
1753
2021
|
# Gets a line item.
|
1754
2022
|
# @param [Fixnum] advertiser_id
|
1755
2023
|
# Required. The ID of the advertiser this line item belongs to.
|
@@ -1797,23 +2065,26 @@ module Google
|
|
1797
2065
|
# ). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)`
|
1798
2066
|
# or `LESS THAN OR EQUAL TO (<=)`. * The operator used on `warningMessages` must
|
1799
2067
|
# be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. *
|
1800
|
-
# Supported
|
2068
|
+
# Supported properties: - `campaignId` - `displayName` - `insertionOrderId` - `
|
1801
2069
|
# entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (
|
1802
2070
|
# input formatted as YYYY-MM-DD) - `warningMessages` - `flight.triggerId` - `
|
1803
|
-
# updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ)
|
1804
|
-
#
|
1805
|
-
#
|
1806
|
-
#
|
1807
|
-
#
|
1808
|
-
#
|
1809
|
-
#
|
1810
|
-
#
|
1811
|
-
#
|
2071
|
+
# updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) - `
|
2072
|
+
# targetedChannelId` - `targetedNegativeKeywordListId` Examples: * All line
|
2073
|
+
# items under an insertion order: `insertionOrderId="1234"` * All `
|
2074
|
+
# ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `
|
2075
|
+
# LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=
|
2076
|
+
# "ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND
|
2077
|
+
# lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose flight
|
2078
|
+
# dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"` * All
|
2079
|
+
# line items that have `NO_VALID_CREATIVE` in `warningMessages`: `
|
1812
2080
|
# warningMessages:"NO_VALID_CREATIVE"` * All line items with an update time less
|
1813
2081
|
# than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<="
|
1814
2082
|
# 2020-11-04T18:54:47Z"` * All line items with an update time greater than or
|
1815
2083
|
# equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>="2020-11-
|
1816
|
-
# 04T18:54:47Z"`
|
2084
|
+
# 04T18:54:47Z"` * All line items that are using both the specified channel and
|
2085
|
+
# specified negative keyword list in their targeting: `
|
2086
|
+
# targetedNegativeKeywordListId=789 AND targetedChannelId=12345` The length of
|
2087
|
+
# this field should be no more than 500 characters.
|
1817
2088
|
# @param [String] order_by
|
1818
2089
|
# Field by which to sort the list. Acceptable values are: * "displayName" (
|
1819
2090
|
# default) * "entityStatus" * “flight.dateRange.endDate” * "updateTime" The
|
@@ -2982,7 +3253,7 @@ module Google
|
|
2982
3253
|
# for a field, a suffix " desc" should be added to the field name. Example: `
|
2983
3254
|
# keywordValue desc`.
|
2984
3255
|
# @param [Fixnum] page_size
|
2985
|
-
# Requested page size. Must be between `1` and `
|
3256
|
+
# Requested page size. Must be between `1` and `1000`. If unspecified will
|
2986
3257
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
2987
3258
|
# specified.
|
2988
3259
|
# @param [String] page_token
|
@@ -3022,6 +3293,46 @@ module Google
|
|
3022
3293
|
execute_or_queue_command(command, &block)
|
3023
3294
|
end
|
3024
3295
|
|
3296
|
+
# Replaces all negative keywords in a single negative keyword list. The
|
3297
|
+
# operation will replace the keywords in a negative keyword list with keywords
|
3298
|
+
# provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.
|
3299
|
+
# @param [Fixnum] advertiser_id
|
3300
|
+
# Required. The ID of the DV360 advertiser to which the parent negative keyword
|
3301
|
+
# list belongs.
|
3302
|
+
# @param [Fixnum] negative_keyword_list_id
|
3303
|
+
# Required. The ID of the parent negative keyword list to which the negative
|
3304
|
+
# keywords belong.
|
3305
|
+
# @param [Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsRequest] replace_negative_keywords_request_object
|
3306
|
+
# @param [String] fields
|
3307
|
+
# Selector specifying which fields to include in a partial response.
|
3308
|
+
# @param [String] quota_user
|
3309
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3310
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3311
|
+
# @param [Google::Apis::RequestOptions] options
|
3312
|
+
# Request-specific options
|
3313
|
+
#
|
3314
|
+
# @yield [result, err] Result & error if block supplied
|
3315
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse] parsed result object
|
3316
|
+
# @yieldparam err [StandardError] error object if request failed
|
3317
|
+
#
|
3318
|
+
# @return [Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse]
|
3319
|
+
#
|
3320
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3321
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3322
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3323
|
+
def replace_negative_keywords(advertiser_id, negative_keyword_list_id, replace_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3324
|
+
command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace', options)
|
3325
|
+
command.request_representation = Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsRequest::Representation
|
3326
|
+
command.request_object = replace_negative_keywords_request_object
|
3327
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse::Representation
|
3328
|
+
command.response_class = Google::Apis::DisplayvideoV1::ReplaceNegativeKeywordsResponse
|
3329
|
+
command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
3330
|
+
command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
|
3331
|
+
command.query['fields'] = fields unless fields.nil?
|
3332
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3333
|
+
execute_or_queue_command(command, &block)
|
3334
|
+
end
|
3335
|
+
|
3025
3336
|
# Assigns a targeting option to an advertiser. Returns the assigned targeting
|
3026
3337
|
# option if successful.
|
3027
3338
|
# @param [Fixnum] advertiser_id
|
@@ -4738,7 +5049,7 @@ module Google
|
|
4738
5049
|
# for a field, a suffix " desc" should be added to the field name. Example: `
|
4739
5050
|
# urlOrAppId desc`.
|
4740
5051
|
# @param [Fixnum] page_size
|
4741
|
-
# Requested page size. Must be between `1` and `
|
5052
|
+
# Requested page size. Must be between `1` and `10000`. If unspecified will
|
4742
5053
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
4743
5054
|
# specified.
|
4744
5055
|
# @param [String] page_token
|
@@ -4779,6 +5090,44 @@ module Google
|
|
4779
5090
|
execute_or_queue_command(command, &block)
|
4780
5091
|
end
|
4781
5092
|
|
5093
|
+
# Replaces all of the sites under a single channel. The operation will replace
|
5094
|
+
# the sites under a channel with the sites provided in ReplaceSitesRequest.
|
5095
|
+
# new_sites.
|
5096
|
+
# @param [Fixnum] partner_id
|
5097
|
+
# The ID of the partner that owns the parent channel.
|
5098
|
+
# @param [Fixnum] channel_id
|
5099
|
+
# Required. The ID of the parent channel whose sites will be replaced.
|
5100
|
+
# @param [Google::Apis::DisplayvideoV1::ReplaceSitesRequest] replace_sites_request_object
|
5101
|
+
# @param [String] fields
|
5102
|
+
# Selector specifying which fields to include in a partial response.
|
5103
|
+
# @param [String] quota_user
|
5104
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5105
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5106
|
+
# @param [Google::Apis::RequestOptions] options
|
5107
|
+
# Request-specific options
|
5108
|
+
#
|
5109
|
+
# @yield [result, err] Result & error if block supplied
|
5110
|
+
# @yieldparam result [Google::Apis::DisplayvideoV1::ReplaceSitesResponse] parsed result object
|
5111
|
+
# @yieldparam err [StandardError] error object if request failed
|
5112
|
+
#
|
5113
|
+
# @return [Google::Apis::DisplayvideoV1::ReplaceSitesResponse]
|
5114
|
+
#
|
5115
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5116
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5117
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5118
|
+
def replace_partner_channel_site(partner_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5119
|
+
command = make_simple_command(:post, 'v1/partners/{partnerId}/channels/{+channelId}/sites:replace', options)
|
5120
|
+
command.request_representation = Google::Apis::DisplayvideoV1::ReplaceSitesRequest::Representation
|
5121
|
+
command.request_object = replace_sites_request_object
|
5122
|
+
command.response_representation = Google::Apis::DisplayvideoV1::ReplaceSitesResponse::Representation
|
5123
|
+
command.response_class = Google::Apis::DisplayvideoV1::ReplaceSitesResponse
|
5124
|
+
command.params['partnerId'] = partner_id unless partner_id.nil?
|
5125
|
+
command.params['channelId'] = channel_id unless channel_id.nil?
|
5126
|
+
command.query['fields'] = fields unless fields.nil?
|
5127
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5128
|
+
execute_or_queue_command(command, &block)
|
5129
|
+
end
|
5130
|
+
|
4782
5131
|
# Assigns a targeting option to a partner. Returns the assigned targeting option
|
4783
5132
|
# if successful.
|
4784
5133
|
# @param [Fixnum] partner_id
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-displayvideo_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.8.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-05-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -52,7 +52,7 @@ licenses:
|
|
52
52
|
metadata:
|
53
53
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
54
54
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-displayvideo_v1/CHANGELOG.md
|
55
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v1/v0.
|
55
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v1/v0.8.0
|
56
56
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-displayvideo_v1
|
57
57
|
post_install_message:
|
58
58
|
rdoc_options: []
|
@@ -62,14 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
62
62
|
requirements:
|
63
63
|
- - ">="
|
64
64
|
- !ruby/object:Gem::Version
|
65
|
-
version: '2.
|
65
|
+
version: '2.5'
|
66
66
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
67
67
|
requirements:
|
68
68
|
- - ">="
|
69
69
|
- !ruby/object:Gem::Version
|
70
70
|
version: '0'
|
71
71
|
requirements: []
|
72
|
-
rubygems_version: 3.2.
|
72
|
+
rubygems_version: 3.2.17
|
73
73
|
signing_key:
|
74
74
|
specification_version: 4
|
75
75
|
summary: Simple REST client for Display & Video 360 API V1
|