google-apis-displayvideo_v1 0.49.0 → 0.51.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/displayvideo_v1/classes.rb +19 -5
- data/lib/google/apis/displayvideo_v1/gem_version.rb +2 -2
- data/lib/google/apis/displayvideo_v1/service.rb +399 -307
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 658c35f2e8e7c5815ed6d4862ba85c2b38b618537147449aa04ae0fc27b93a95
|
|
4
|
+
data.tar.gz: 6231a340a25af15e55e867901f956c8690f7328c4c0cde630b76ff37b3017131
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9195983b22f6ac71c5b3bb5f684742105f085551c64180af2b4250156d3e728cb17a3f5fc81516b071cf4c55e803e1cfb93162f025993c70155690438436de57
|
|
7
|
+
data.tar.gz: 73426536564b0b479c7cab912bb76153740215a458453b3d6c55f2be449d91b623f9c79eaf8b98fd3882ed53f66c77e7f0fa63f0ddaffc02a8c9c7f9d1ab4fab
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Release history for google-apis-displayvideo_v1
|
|
2
2
|
|
|
3
|
+
### v0.51.0 (2023-05-14)
|
|
4
|
+
|
|
5
|
+
* Regenerated from discovery document revision 20230504
|
|
6
|
+
|
|
7
|
+
### v0.50.0 (2023-04-30)
|
|
8
|
+
|
|
9
|
+
* Regenerated from discovery document revision 20230427
|
|
10
|
+
|
|
3
11
|
### v0.49.0 (2023-04-23)
|
|
4
12
|
|
|
5
13
|
* Regenerated from discovery document revision 20230420
|
|
@@ -734,7 +734,9 @@ module Google
|
|
|
734
734
|
|
|
735
735
|
# Represents an assigned authorized seller status. This will be populated in the
|
|
736
736
|
# details field of an AssignedTargetingOption when targeting_type is `
|
|
737
|
-
# TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
|
|
737
|
+
# TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `
|
|
738
|
+
# TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is
|
|
739
|
+
# using the "Authorized Direct Sellers and Resellers" option.
|
|
738
740
|
# Corresponds to the JSON property `authorizedSellerStatusDetails`
|
|
739
741
|
# @return [Google::Apis::DisplayvideoV1::AuthorizedSellerStatusAssignedTargetingOptionDetails]
|
|
740
742
|
attr_accessor :authorized_seller_status_details
|
|
@@ -1169,7 +1171,11 @@ module Google
|
|
|
1169
1171
|
# contains first and third party audience ids only. The relation between each
|
|
1170
1172
|
# first and third party audience group is INTERSECTION, and the result is UNION'
|
|
1171
1173
|
# ed with other audience groups. Repeated groups with same settings will be
|
|
1172
|
-
# ignored.
|
|
1174
|
+
# ignored. **Warning:** `ACTIVITY_BASED` and `FREQUENCY_CAP` audience types will
|
|
1175
|
+
# be deprecated on **May 20, 2023**. After this date, these audiences will not
|
|
1176
|
+
# be able to be added to resource targeting. Read our [feature deprecation
|
|
1177
|
+
# announcement](/display-video/api/deprecations#features.
|
|
1178
|
+
# first_and_third_party_audience_types) for more information.
|
|
1173
1179
|
# Corresponds to the JSON property `includedFirstAndThirdPartyAudienceGroups`
|
|
1174
1180
|
# @return [Array<Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudienceGroup>]
|
|
1175
1181
|
attr_accessor :included_first_and_third_party_audience_groups
|
|
@@ -1355,7 +1361,9 @@ module Google
|
|
|
1355
1361
|
|
|
1356
1362
|
# Represents an assigned authorized seller status. This will be populated in the
|
|
1357
1363
|
# details field of an AssignedTargetingOption when targeting_type is `
|
|
1358
|
-
# TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
|
|
1364
|
+
# TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `
|
|
1365
|
+
# TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is
|
|
1366
|
+
# using the "Authorized Direct Sellers and Resellers" option.
|
|
1359
1367
|
class AuthorizedSellerStatusAssignedTargetingOptionDetails
|
|
1360
1368
|
include Google::Apis::Core::Hashable
|
|
1361
1369
|
|
|
@@ -7083,7 +7091,10 @@ module Google
|
|
|
7083
7091
|
# flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER`. Must not be set
|
|
7084
7092
|
# otherwise. * When set, the line item's flight dates are inherited from its
|
|
7085
7093
|
# parent insertion order. * Active line items will spend when the selected
|
|
7086
|
-
# trigger is activated within the parent insertion order's flight dates.
|
|
7094
|
+
# trigger is activated within the parent insertion order's flight dates. **
|
|
7095
|
+
# Warning:** Line Items using manual triggers will stop serving in Display &
|
|
7096
|
+
# Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/
|
|
7097
|
+
# display-video/api/deprecations#features.manual_triggers) for more information.
|
|
7087
7098
|
# Corresponds to the JSON property `triggerId`
|
|
7088
7099
|
# @return [Fixnum]
|
|
7089
7100
|
attr_accessor :trigger_id
|
|
@@ -8043,7 +8054,10 @@ module Google
|
|
|
8043
8054
|
end
|
|
8044
8055
|
end
|
|
8045
8056
|
|
|
8046
|
-
# A single manual trigger in Display & Video 360.
|
|
8057
|
+
# A single manual trigger in Display & Video 360. **Warning:** Line Items using
|
|
8058
|
+
# manual triggers will stop serving in Display & Video 360 on **May 17, 2023**.
|
|
8059
|
+
# Read our [feature deprecation announcement](/display-video/api/deprecations#
|
|
8060
|
+
# features.manual_triggers) for more information.
|
|
8047
8061
|
class ManualTrigger
|
|
8048
8062
|
include Google::Apis::Core::Hashable
|
|
8049
8063
|
|
|
@@ -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.51.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
22
|
GENERATOR_VERSION = "0.12.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20230504"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -131,13 +131,15 @@ module Google
|
|
|
131
131
|
# @param [Fixnum] advertiser_id
|
|
132
132
|
# Required. The ID of the advertiser the line item belongs to.
|
|
133
133
|
# @param [String] filter
|
|
134
|
-
# Allows filtering by assigned targeting option
|
|
134
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
135
135
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
136
|
-
# be combined by the logical operator
|
|
137
|
-
# field` `operator` `value``. *
|
|
138
|
-
# fields:
|
|
136
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
137
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=) operator`.
|
|
138
|
+
# Supported fields: * `targetingType` Examples: * targetingType with value
|
|
139
139
|
# TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of
|
|
140
|
-
# this field should be no more than 500 characters.
|
|
140
|
+
# this field should be no more than 500 characters. Reference our [filter `LIST`
|
|
141
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
142
|
+
# information.
|
|
141
143
|
# @param [String] order_by
|
|
142
144
|
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
|
143
145
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -280,20 +282,21 @@ module Google
|
|
|
280
282
|
# defined by the order_by parameter. A single partner_id is required. Cross-
|
|
281
283
|
# partner listing is not supported.
|
|
282
284
|
# @param [String] filter
|
|
283
|
-
# Allows filtering by advertiser
|
|
284
|
-
#
|
|
285
|
-
#
|
|
286
|
-
#
|
|
287
|
-
#
|
|
288
|
-
#
|
|
289
|
-
#
|
|
290
|
-
#
|
|
291
|
-
#
|
|
292
|
-
#
|
|
293
|
-
#
|
|
294
|
-
#
|
|
295
|
-
#
|
|
296
|
-
#
|
|
285
|
+
# Allows filtering by advertiser fields. Supported syntax: * Filter expressions
|
|
286
|
+
# are made up of one or more restrictions. * Restrictions can be combined by `
|
|
287
|
+
# AND` or `OR` logical operators. * A restriction has the form of ``field` `
|
|
288
|
+
# operator` `value``. * The `updateTime` field must use the `GREATER THAN OR
|
|
289
|
+
# EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields
|
|
290
|
+
# must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `
|
|
291
|
+
# displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `
|
|
292
|
+
# YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `
|
|
293
|
+
# entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time
|
|
294
|
+
# less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="
|
|
295
|
+
# 2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or
|
|
296
|
+
# equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-
|
|
297
|
+
# 04T18:54:47Z"` The length of this field should be no more than 500 characters.
|
|
298
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
299
|
+
# filters) guide for more information.
|
|
297
300
|
# @param [String] order_by
|
|
298
301
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
299
302
|
# default) * `entityStatus` * `updateTime` The default sorting order is
|
|
@@ -431,17 +434,19 @@ module Google
|
|
|
431
434
|
# @param [Fixnum] campaign_id
|
|
432
435
|
# Required. The ID of the campaign to list assigned targeting options for.
|
|
433
436
|
# @param [String] filter
|
|
434
|
-
# Allows filtering by assigned targeting option
|
|
437
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
435
438
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
436
|
-
# be combined by the
|
|
437
|
-
#
|
|
438
|
-
#
|
|
439
|
-
#
|
|
440
|
-
# TARGETING_TYPE_GENDER `targetingType="TARGETING_TYPE_LANGUAGE" OR
|
|
441
|
-
# targetingType="TARGETING_TYPE_GENDER"` *
|
|
442
|
-
# inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
443
|
-
# NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
444
|
-
# field should be no more than 500 characters.
|
|
439
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
440
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
441
|
+
# Supported fields: * `targetingType` * `inheritance` Examples: * `
|
|
442
|
+
# AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE`
|
|
443
|
+
# or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR
|
|
444
|
+
# targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources
|
|
445
|
+
# with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
|
|
446
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
447
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
448
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
449
|
+
# more information.
|
|
445
450
|
# @param [String] order_by
|
|
446
451
|
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
|
447
452
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -595,21 +600,23 @@ module Google
|
|
|
595
600
|
# @param [Fixnum] advertiser_id
|
|
596
601
|
# The ID of the advertiser to list campaigns for.
|
|
597
602
|
# @param [String] filter
|
|
598
|
-
# Allows filtering by campaign
|
|
599
|
-
#
|
|
600
|
-
#
|
|
601
|
-
#
|
|
602
|
-
#
|
|
603
|
-
#
|
|
604
|
-
# Supported fields:
|
|
605
|
-
# updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: *
|
|
603
|
+
# Allows filtering by campaign fields. Supported syntax: * Filter expressions
|
|
604
|
+
# are made up of one or more restrictions. * Restrictions can be combined by `
|
|
605
|
+
# AND` or `OR` logical operators. A sequence of restrictions implicitly uses `
|
|
606
|
+
# AND`. * A restriction has the form of ``field` `operator` `value``. * The `
|
|
607
|
+
# updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN
|
|
608
|
+
# OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)`
|
|
609
|
+
# operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `
|
|
610
|
+
# updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: *
|
|
606
611
|
# All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an
|
|
607
612
|
# advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="
|
|
608
613
|
# ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal
|
|
609
|
-
# to
|
|
610
|
-
# 47Z"` * All campaigns with an update time greater than or equal to
|
|
611
|
-
# 04T18:54:47Z (format of ISO 8601)
|
|
612
|
-
# length of this field should be no more than 500 characters.
|
|
614
|
+
# to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:
|
|
615
|
+
# 47Z"` * All campaigns with an update time greater than or equal to 2020-11-
|
|
616
|
+
# 04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The
|
|
617
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
618
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
619
|
+
# more information.
|
|
613
620
|
# @param [String] order_by
|
|
614
621
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
615
622
|
# default) * `entityStatus` * `updateTime` The default sorting order is
|
|
@@ -766,16 +773,18 @@ module Google
|
|
|
766
773
|
# * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `
|
|
767
774
|
# TARGETING_TYPE_VIEWABILITY`
|
|
768
775
|
# @param [String] filter
|
|
769
|
-
# Allows filtering by assigned targeting option
|
|
776
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
770
777
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
771
|
-
# be combined by the logical operator
|
|
772
|
-
# field` `operator` `value``. *
|
|
773
|
-
# fields:
|
|
774
|
-
#
|
|
775
|
-
# assignedTargetingOptionId="2"` *
|
|
776
|
-
# status of NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
777
|
-
# OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
778
|
-
# more than 500 characters.
|
|
778
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
779
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
780
|
+
# Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `
|
|
781
|
+
# AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="
|
|
782
|
+
# 1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources
|
|
783
|
+
# with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `
|
|
784
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
785
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
786
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
787
|
+
# more information.
|
|
779
788
|
# @param [String] order_by
|
|
780
789
|
# Field by which to sort the list. Acceptable values are: * `
|
|
781
790
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
@@ -900,11 +909,13 @@ module Google
|
|
|
900
909
|
# The ID of the advertiser that owns the channels.
|
|
901
910
|
# @param [String] filter
|
|
902
911
|
# Allows filtering by channel fields. Supported syntax: * Filter expressions for
|
|
903
|
-
# channel
|
|
904
|
-
#
|
|
905
|
-
#
|
|
906
|
-
#
|
|
907
|
-
#
|
|
912
|
+
# channel can only contain at most one restriction. * A restriction has the form
|
|
913
|
+
# of ``field` `operator` `value``. * All fields must use the `HAS (:)` operator.
|
|
914
|
+
# Supported fields: * `displayName` Examples: * All channels for which the
|
|
915
|
+
# display name contains "google": `displayName : "google"`. The length of this
|
|
916
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
917
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
918
|
+
# information.
|
|
908
919
|
# @param [String] order_by
|
|
909
920
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
910
921
|
# default) * `channelId` The default sorting order is ascending. To specify
|
|
@@ -1118,10 +1129,13 @@ module Google
|
|
|
1118
1129
|
# Required. The ID of the parent channel to which the requested sites belong.
|
|
1119
1130
|
# @param [String] filter
|
|
1120
1131
|
# Allows filtering by site fields. Supported syntax: * Filter expressions for
|
|
1121
|
-
# site
|
|
1122
|
-
# the form of ``field` `operator` `value``. *
|
|
1123
|
-
# .
|
|
1124
|
-
# or app ID contains "google": `urlOrAppId : "google"`
|
|
1132
|
+
# site retrieval can only contain at most one restriction. * A restriction has
|
|
1133
|
+
# the form of ``field` `operator` `value``. * All fields must use the `HAS (:)`
|
|
1134
|
+
# operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the
|
|
1135
|
+
# URL or app ID contains "google": `urlOrAppId : "google"` The length of this
|
|
1136
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
1137
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
1138
|
+
# information.
|
|
1125
1139
|
# @param [String] order_by
|
|
1126
1140
|
# Field by which to sort the list. Acceptable values are: * `urlOrAppId` (
|
|
1127
1141
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -1316,41 +1330,38 @@ module Google
|
|
|
1316
1330
|
# @param [Fixnum] advertiser_id
|
|
1317
1331
|
# Required. The ID of the advertiser to list creatives for.
|
|
1318
1332
|
# @param [String] filter
|
|
1319
|
-
# Allows filtering by creative
|
|
1320
|
-
#
|
|
1321
|
-
#
|
|
1322
|
-
#
|
|
1323
|
-
#
|
|
1324
|
-
#
|
|
1325
|
-
#
|
|
1326
|
-
#
|
|
1327
|
-
#
|
|
1328
|
-
#
|
|
1329
|
-
#
|
|
1330
|
-
#
|
|
1331
|
-
#
|
|
1332
|
-
#
|
|
1333
|
-
#
|
|
1334
|
-
#
|
|
1335
|
-
#
|
|
1336
|
-
#
|
|
1337
|
-
#
|
|
1338
|
-
#
|
|
1339
|
-
#
|
|
1340
|
-
#
|
|
1341
|
-
#
|
|
1342
|
-
# creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or
|
|
1343
|
-
# 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="
|
|
1344
|
-
# 300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by
|
|
1345
|
-
# AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="
|
|
1346
|
-
# true" AND minDuration="5.2s" AND (exchangeReviewStatus="
|
|
1333
|
+
# Allows filtering by creative fields. Supported syntax: * Filter expressions
|
|
1334
|
+
# are made up of one or more restrictions. * Restrictions can be combined by `
|
|
1335
|
+
# AND` or `OR` logical operators. A sequence of restrictions implicitly uses `
|
|
1336
|
+
# AND`. * A restriction has the form of ``field` `operator` `value``. * The `
|
|
1337
|
+
# lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field
|
|
1338
|
+
# must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`
|
|
1339
|
+
# operators. * All other fields must use the `EQUALS (=)` operator. * For `
|
|
1340
|
+
# entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic`
|
|
1341
|
+
# fields, there may be at most one restriction. Supported Fields: * `
|
|
1342
|
+
# approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the
|
|
1343
|
+
# form of ``width`x`height``) * `dynamic` * `entityStatus` * `
|
|
1344
|
+
# exchangeReviewStatus` (input in the form of ``exchange`-`reviewStatus``) * `
|
|
1345
|
+
# lineItemIds` * `maxDuration` (input in the form of ``duration`s`. Only seconds
|
|
1346
|
+
# are supported) * `minDuration` (input in the form of ``duration`s`. Only
|
|
1347
|
+
# seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-
|
|
1348
|
+
# DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value
|
|
1349
|
+
# reflects the last time that a creative has been updated, which includes
|
|
1350
|
+
# updates made by the system (e.g. creative review updates). Examples: * All
|
|
1351
|
+
# native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives
|
|
1352
|
+
# with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (
|
|
1353
|
+
# dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are
|
|
1354
|
+
# approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `
|
|
1355
|
+
# dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="
|
|
1347
1356
|
# EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="
|
|
1348
1357
|
# EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are
|
|
1349
1358
|
# associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (
|
|
1350
1359
|
# lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `
|
|
1351
1360
|
# creativeId=1 OR creativeId=2` * All creatives with an update time greater than
|
|
1352
|
-
# or equal to
|
|
1361
|
+
# or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-
|
|
1353
1362
|
# 04T18:54:47Z"` The length of this field should be no more than 500 characters.
|
|
1363
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
1364
|
+
# filters) guide for more information.
|
|
1354
1365
|
# @param [String] order_by
|
|
1355
1366
|
# Field by which to sort the list. Acceptable values are: * `creativeId` (
|
|
1356
1367
|
# default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first,
|
|
@@ -1442,18 +1453,20 @@ module Google
|
|
|
1442
1453
|
# @param [Fixnum] insertion_order_id
|
|
1443
1454
|
# Required. The ID of the insertion order to list assigned targeting options for.
|
|
1444
1455
|
# @param [String] filter
|
|
1445
|
-
# Allows filtering by assigned targeting option
|
|
1456
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
1446
1457
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
1447
|
-
# be combined by the logical operator `OR
|
|
1448
|
-
#
|
|
1449
|
-
#
|
|
1450
|
-
#
|
|
1451
|
-
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `
|
|
1458
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
1459
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
1460
|
+
# Supported fields: * `targetingType` * `inheritance` Examples: * `
|
|
1461
|
+
# AssignedTargetingOption` resources of targeting type `
|
|
1462
|
+
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `
|
|
1452
1463
|
# targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="
|
|
1453
|
-
# TARGETING_TYPE_CHANNEL"` *
|
|
1454
|
-
# NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
1455
|
-
# inheritance="INHERITED_FROM_PARTNER"` The
|
|
1456
|
-
# more than 500 characters.
|
|
1464
|
+
# TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with
|
|
1465
|
+
# inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
|
|
1466
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
1467
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
1468
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
1469
|
+
# more information.
|
|
1457
1470
|
# @param [String] order_by
|
|
1458
1471
|
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
|
1459
1472
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -1609,26 +1622,27 @@ module Google
|
|
|
1609
1622
|
# @param [Fixnum] advertiser_id
|
|
1610
1623
|
# Required. The ID of the advertiser to list insertion orders for.
|
|
1611
1624
|
# @param [String] filter
|
|
1612
|
-
# Allows filtering by insertion order
|
|
1625
|
+
# Allows filtering by insertion order fields. Supported syntax: * Filter
|
|
1613
1626
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
1614
1627
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
1615
1628
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
1616
|
-
# value``. * The
|
|
1617
|
-
#
|
|
1618
|
-
#
|
|
1619
|
-
#
|
|
1620
|
-
#
|
|
1621
|
-
# input
|
|
1622
|
-
#
|
|
1623
|
-
#
|
|
1624
|
-
#
|
|
1625
|
-
#
|
|
1626
|
-
#
|
|
1627
|
-
#
|
|
1628
|
-
#
|
|
1629
|
-
#
|
|
1630
|
-
# 04T18:54:47Z
|
|
1631
|
-
#
|
|
1629
|
+
# value``. * The `budget.budget_segments.date_range.end_date` field must use the
|
|
1630
|
+
# `LESS THAN (<)` operator. * The `updateTime` field must use the `GREATER THAN
|
|
1631
|
+
# OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other
|
|
1632
|
+
# fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `
|
|
1633
|
+
# displayName` * `entityStatus` * `budget.budget_segments.date_range.end_date` (
|
|
1634
|
+
# input in the form of `YYYY-MM-DD`) **Deprecated. Not available after June 8,
|
|
1635
|
+
# 2023** * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`)
|
|
1636
|
+
# Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `
|
|
1637
|
+
# ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an
|
|
1638
|
+
# advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="
|
|
1639
|
+
# ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than
|
|
1640
|
+
# or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-
|
|
1641
|
+
# 04T18:54:47Z"` * All insertion orders with an update time greater than or
|
|
1642
|
+
# equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-
|
|
1643
|
+
# 04T18:54:47Z"` The length of this field should be no more than 500 characters.
|
|
1644
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
1645
|
+
# filters) guide for more information.
|
|
1632
1646
|
# @param [String] order_by
|
|
1633
1647
|
# Field by which to sort the list. Acceptable values are: * "displayName" (
|
|
1634
1648
|
# default) * "entityStatus" * "updateTime" The default sorting order is
|
|
@@ -1813,16 +1827,18 @@ module Google
|
|
|
1813
1827
|
# TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `
|
|
1814
1828
|
# TARGETING_TYPE_VIEWABILITY`
|
|
1815
1829
|
# @param [String] filter
|
|
1816
|
-
# Allows filtering by assigned targeting option
|
|
1830
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
1817
1831
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
1818
1832
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
1819
|
-
# field` `operator` `value``. *
|
|
1820
|
-
# fields:
|
|
1821
|
-
#
|
|
1822
|
-
# assignedTargetingOptionId="2"` *
|
|
1823
|
-
# status of NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
1824
|
-
# OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
1825
|
-
# more than 500 characters.
|
|
1833
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
1834
|
+
# Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `
|
|
1835
|
+
# AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="
|
|
1836
|
+
# 1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources
|
|
1837
|
+
# with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
|
|
1838
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
1839
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
1840
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
1841
|
+
# more information.
|
|
1826
1842
|
# @param [String] order_by
|
|
1827
1843
|
# Field by which to sort the list. Acceptable values are: * `
|
|
1828
1844
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
@@ -2004,18 +2020,20 @@ module Google
|
|
|
2004
2020
|
# @param [Fixnum] line_item_id
|
|
2005
2021
|
# Required. The ID of the line item to list assigned targeting options for.
|
|
2006
2022
|
# @param [String] filter
|
|
2007
|
-
# Allows filtering by assigned targeting option
|
|
2023
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
2008
2024
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
2009
|
-
# be combined by the logical operator `OR
|
|
2010
|
-
#
|
|
2011
|
-
#
|
|
2012
|
-
#
|
|
2013
|
-
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `
|
|
2025
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
2026
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
2027
|
+
# Supported fields: * `targetingType` * `inheritance` Examples: * `
|
|
2028
|
+
# AssignedTargetingOption` resources of targeting type `
|
|
2029
|
+
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `
|
|
2014
2030
|
# targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="
|
|
2015
|
-
# TARGETING_TYPE_CHANNEL"` *
|
|
2016
|
-
# NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
2017
|
-
# inheritance="INHERITED_FROM_PARTNER"` The
|
|
2018
|
-
# more than 500 characters.
|
|
2031
|
+
# TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with
|
|
2032
|
+
# inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
|
|
2033
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
2034
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
2035
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
2036
|
+
# more information.
|
|
2019
2037
|
# @param [String] order_by
|
|
2020
2038
|
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
|
2021
2039
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -2206,39 +2224,41 @@ module Google
|
|
|
2206
2224
|
# @param [Fixnum] advertiser_id
|
|
2207
2225
|
# Required. The ID of the advertiser to list line items for.
|
|
2208
2226
|
# @param [String] filter
|
|
2209
|
-
# Allows filtering by line item
|
|
2210
|
-
#
|
|
2211
|
-
#
|
|
2212
|
-
#
|
|
2213
|
-
#
|
|
2214
|
-
#
|
|
2215
|
-
#
|
|
2216
|
-
#
|
|
2217
|
-
#
|
|
2218
|
-
#
|
|
2219
|
-
#
|
|
2220
|
-
#
|
|
2221
|
-
#
|
|
2222
|
-
# items under an insertion order: `
|
|
2223
|
-
# ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`
|
|
2224
|
-
# LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(
|
|
2225
|
-
# "ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
|
|
2226
|
-
# lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose
|
|
2227
|
-
# dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"`
|
|
2228
|
-
# line items that have `NO_VALID_CREATIVE` in `warningMessages`: `
|
|
2227
|
+
# Allows filtering by line item fields. Supported syntax: * Filter expressions
|
|
2228
|
+
# are made up of one or more restrictions. * Restrictions can be combined by `
|
|
2229
|
+
# AND` or `OR` logical operators. A sequence of restrictions implicitly uses `
|
|
2230
|
+
# AND`. * A restriction has the form of ``field` `operator` `value``. * The `
|
|
2231
|
+
# flight.dateRange.endDate` field must use the `LESS THAN (<)` operator. * The `
|
|
2232
|
+
# updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN
|
|
2233
|
+
# OR EQUAL TO (<=)` operators. * The `warningMessages` field must use the `HAS (:
|
|
2234
|
+
# )` operator. * All other fields must use the `EQUALS (=)` operator. Supported
|
|
2235
|
+
# fields: * `campaignId` * `displayName` * `entityStatus` * `flight.dateRange.
|
|
2236
|
+
# endDate` (input formatted as `YYYY-MM-DD`) **Deprecated. Not available after
|
|
2237
|
+
# June 8, 2023** * `flight.triggerId` * `insertionOrderId` * `lineItemId` * `
|
|
2238
|
+
# lineItemType` * `targetedChannelId` * `targetedNegativeKeywordListId` * `
|
|
2239
|
+
# updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) * `
|
|
2240
|
+
# warningMessages` Examples: * All line items under an insertion order: `
|
|
2241
|
+
# insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`
|
|
2242
|
+
# and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(
|
|
2243
|
+
# entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
|
|
2244
|
+
# AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose
|
|
2245
|
+
# flight dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"`
|
|
2246
|
+
# * All line items that have `NO_VALID_CREATIVE` in `warningMessages`: `
|
|
2229
2247
|
# warningMessages:"NO_VALID_CREATIVE"` * All line items with an update time less
|
|
2230
|
-
# than or equal to
|
|
2231
|
-
#
|
|
2232
|
-
#
|
|
2233
|
-
#
|
|
2234
|
-
#
|
|
2235
|
-
#
|
|
2236
|
-
#
|
|
2248
|
+
# than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-
|
|
2249
|
+
# 11-04T18:54:47Z"` * All line items with an update time greater than or equal
|
|
2250
|
+
# to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:
|
|
2251
|
+
# 47Z"` * All line items that are using both the specified channel and specified
|
|
2252
|
+
# negative keyword list in their targeting: `targetedNegativeKeywordListId=789
|
|
2253
|
+
# AND targetedChannelId=12345` The length of this field should be no more than
|
|
2254
|
+
# 500 characters. Reference our [filter `LIST` requests](/display-video/api/
|
|
2255
|
+
# guides/how-tos/filters) guide for more information.
|
|
2237
2256
|
# @param [String] order_by
|
|
2238
2257
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
2239
|
-
# default) * `entityStatus` * `flight.dateRange.endDate`
|
|
2240
|
-
#
|
|
2241
|
-
#
|
|
2258
|
+
# default) * `entityStatus` * `flight.dateRange.endDate` **Deprecated. Not
|
|
2259
|
+
# available after June 8, 2023** * `updateTime` The default sorting order is
|
|
2260
|
+
# ascending. To specify descending order for a field, a suffix "desc" should be
|
|
2261
|
+
# added to the field name. Example: `displayName desc`.
|
|
2242
2262
|
# @param [Fixnum] page_size
|
|
2243
2263
|
# Requested page size. Must be between `1` and `200`. If unspecified will
|
|
2244
2264
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
@@ -2561,16 +2581,18 @@ module Google
|
|
|
2561
2581
|
# TARGETING_TYPE_YOUTUBE_VIDEO` (only for `
|
|
2562
2582
|
# LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)
|
|
2563
2583
|
# @param [String] filter
|
|
2564
|
-
# Allows filtering by assigned targeting option
|
|
2584
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
2565
2585
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
2566
2586
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
2567
|
-
# field` `operator` `value``. *
|
|
2568
|
-
# fields:
|
|
2569
|
-
#
|
|
2570
|
-
# assignedTargetingOptionId="2"` *
|
|
2571
|
-
# status of NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
2572
|
-
# OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
2573
|
-
# more than 500 characters.
|
|
2587
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
2588
|
+
# Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `
|
|
2589
|
+
# AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="
|
|
2590
|
+
# 1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources
|
|
2591
|
+
# with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
|
|
2592
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
2593
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
2594
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
2595
|
+
# more information.
|
|
2574
2596
|
# @param [String] order_by
|
|
2575
2597
|
# Field by which to sort the list. Acceptable values are: * `
|
|
2576
2598
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
@@ -2695,10 +2717,12 @@ module Google
|
|
|
2695
2717
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
2696
2718
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
2697
2719
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
2698
|
-
# value``. *
|
|
2720
|
+
# value``. * All fields must use the `EQUALS (=)` operator. Supported fields: * `
|
|
2699
2721
|
# locationType` Examples: * All regional location list: `locationType="
|
|
2700
2722
|
# TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `
|
|
2701
|
-
# locationType="TARGETING_LOCATION_TYPE_PROXIMITY"`
|
|
2723
|
+
# locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field
|
|
2724
|
+
# should be no more than 500 characters. Reference our [filter `LIST` requests](/
|
|
2725
|
+
# display-video/api/guides/how-tos/filters) guide for more information.
|
|
2702
2726
|
# @param [String] order_by
|
|
2703
2727
|
# Field by which to sort the list. Acceptable values are: * `locationListId` (
|
|
2704
2728
|
# default) * `displayName` The default sorting order is ascending. To specify
|
|
@@ -2902,10 +2926,11 @@ module Google
|
|
|
2902
2926
|
# @param [String] filter
|
|
2903
2927
|
# Allows filtering by location list assignment fields. Supported syntax: *
|
|
2904
2928
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
2905
|
-
# be combined by the logical operator
|
|
2906
|
-
# field` `operator` `value``. *
|
|
2907
|
-
# fields:
|
|
2908
|
-
# 500 characters.
|
|
2929
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
2930
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
2931
|
+
# Supported fields: * `assignedLocationId` The length of this field should be no
|
|
2932
|
+
# more than 500 characters. Reference our [filter `LIST` requests](/display-
|
|
2933
|
+
# video/api/guides/how-tos/filters) guide for more information.
|
|
2909
2934
|
# @param [String] order_by
|
|
2910
2935
|
# Field by which to sort the list. Acceptable values are: * `assignedLocationId`
|
|
2911
2936
|
# (default) The default sorting order is ascending. To specify descending order
|
|
@@ -2953,7 +2978,10 @@ module Google
|
|
|
2953
2978
|
end
|
|
2954
2979
|
|
|
2955
2980
|
# Activates a manual trigger. Each activation of the manual trigger must be at
|
|
2956
|
-
# least 5 minutes apart, otherwise an error will be returned.
|
|
2981
|
+
# least 5 minutes apart, otherwise an error will be returned. **Warning:** Line
|
|
2982
|
+
# Items using manual triggers will stop serving in Display & Video 360 on **May
|
|
2983
|
+
# 17, 2023**. Read our [feature deprecation announcement](/display-video/api/
|
|
2984
|
+
# deprecations#features.manual_triggers) for more information.
|
|
2957
2985
|
# @param [Fixnum] advertiser_id
|
|
2958
2986
|
# Required. The ID of the advertiser that the manual trigger belongs.
|
|
2959
2987
|
# @param [Fixnum] trigger_id
|
|
@@ -2990,7 +3018,10 @@ module Google
|
|
|
2990
3018
|
end
|
|
2991
3019
|
|
|
2992
3020
|
# Creates a new manual trigger. Returns the newly created manual trigger if
|
|
2993
|
-
# successful.
|
|
3021
|
+
# successful. **Warning:** Line Items using manual triggers will stop serving in
|
|
3022
|
+
# Display & Video 360 on **May 17, 2023**. Read our [feature deprecation
|
|
3023
|
+
# announcement](/display-video/api/deprecations#features.manual_triggers) for
|
|
3024
|
+
# more information.
|
|
2994
3025
|
# @param [Fixnum] advertiser_id
|
|
2995
3026
|
# Required. Immutable. The unique ID of the advertiser that the manual trigger
|
|
2996
3027
|
# belongs to.
|
|
@@ -3024,7 +3055,10 @@ module Google
|
|
|
3024
3055
|
execute_or_queue_command(command, &block)
|
|
3025
3056
|
end
|
|
3026
3057
|
|
|
3027
|
-
# Deactivates a manual trigger.
|
|
3058
|
+
# Deactivates a manual trigger. **Warning:** Line Items using manual triggers
|
|
3059
|
+
# will stop serving in Display & Video 360 on **May 17, 2023**. Read our [
|
|
3060
|
+
# feature deprecation announcement](/display-video/api/deprecations#features.
|
|
3061
|
+
# manual_triggers) for more information.
|
|
3028
3062
|
# @param [Fixnum] advertiser_id
|
|
3029
3063
|
# Required. The ID of the advertiser that the manual trigger belongs.
|
|
3030
3064
|
# @param [Fixnum] trigger_id
|
|
@@ -3060,7 +3094,10 @@ module Google
|
|
|
3060
3094
|
execute_or_queue_command(command, &block)
|
|
3061
3095
|
end
|
|
3062
3096
|
|
|
3063
|
-
# Gets a manual trigger.
|
|
3097
|
+
# Gets a manual trigger. **Warning:** Line Items using manual triggers will stop
|
|
3098
|
+
# serving in Display & Video 360 on **May 17, 2023**. Read our [feature
|
|
3099
|
+
# deprecation announcement](/display-video/api/deprecations#features.
|
|
3100
|
+
# manual_triggers) for more information.
|
|
3064
3101
|
# @param [Fixnum] advertiser_id
|
|
3065
3102
|
# Required. The ID of the advertiser this manual trigger belongs to.
|
|
3066
3103
|
# @param [Fixnum] trigger_id
|
|
@@ -3095,18 +3132,22 @@ module Google
|
|
|
3095
3132
|
|
|
3096
3133
|
# Lists manual triggers that are accessible to the current user for a given
|
|
3097
3134
|
# advertiser ID. The order is defined by the order_by parameter. A single
|
|
3098
|
-
# advertiser_id is required.
|
|
3135
|
+
# advertiser_id is required. **Warning:** Line Items using manual triggers will
|
|
3136
|
+
# stop serving in Display & Video 360 on **May 17, 2023**. Read our [feature
|
|
3137
|
+
# deprecation announcement](/display-video/api/deprecations#features.
|
|
3138
|
+
# manual_triggers) for more information.
|
|
3099
3139
|
# @param [Fixnum] advertiser_id
|
|
3100
3140
|
# Required. The ID of the advertiser that the fetched manual triggers belong to.
|
|
3101
3141
|
# @param [String] filter
|
|
3102
|
-
# Allows filtering by manual trigger
|
|
3142
|
+
# Allows filtering by manual trigger fields. Supported syntax: * Filter
|
|
3103
3143
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
3104
3144
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
3105
3145
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
3106
|
-
# value``. *
|
|
3107
|
-
# displayName`
|
|
3146
|
+
# value``. * All fields must use the `EQUALS (=)` operator. Supported fields: * `
|
|
3147
|
+
# displayName` * `state` Examples: * All active manual triggers under an
|
|
3108
3148
|
# advertiser: `state="ACTIVE"` The length of this field should be no more than
|
|
3109
|
-
# 500 characters.
|
|
3149
|
+
# 500 characters. Reference our [filter `LIST` requests](/display-video/api/
|
|
3150
|
+
# guides/how-tos/filters) guide for more information.
|
|
3110
3151
|
# @param [String] order_by
|
|
3111
3152
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
3112
3153
|
# default) * `state` The default sorting order is ascending. To specify
|
|
@@ -3151,7 +3192,10 @@ module Google
|
|
|
3151
3192
|
execute_or_queue_command(command, &block)
|
|
3152
3193
|
end
|
|
3153
3194
|
|
|
3154
|
-
# Updates a manual trigger. Returns the updated manual trigger if successful.
|
|
3195
|
+
# Updates a manual trigger. Returns the updated manual trigger if successful. **
|
|
3196
|
+
# Warning:** Line Items using manual triggers will stop serving in Display &
|
|
3197
|
+
# Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/
|
|
3198
|
+
# display-video/api/deprecations#features.manual_triggers) for more information.
|
|
3155
3199
|
# @param [Fixnum] advertiser_id
|
|
3156
3200
|
# Required. Immutable. The unique ID of the advertiser that the manual trigger
|
|
3157
3201
|
# belongs to.
|
|
@@ -3507,11 +3551,13 @@ module Google
|
|
|
3507
3551
|
# negative keywords belong.
|
|
3508
3552
|
# @param [String] filter
|
|
3509
3553
|
# Allows filtering by negative keyword fields. Supported syntax: * Filter
|
|
3510
|
-
# expressions for negative
|
|
3511
|
-
#
|
|
3512
|
-
#
|
|
3513
|
-
#
|
|
3514
|
-
# :
|
|
3554
|
+
# expressions for negative keywords can only contain at most one restriction. *
|
|
3555
|
+
# A restriction has the form of ``field` `operator` `value``. * All fields must
|
|
3556
|
+
# use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All
|
|
3557
|
+
# negative keywords for which the keyword value contains "google": `keywordValue
|
|
3558
|
+
# : "google"` The length of this field should be no more than 500 characters.
|
|
3559
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
3560
|
+
# filters) guide for more information.
|
|
3515
3561
|
# @param [String] order_by
|
|
3516
3562
|
# Field by which to sort the list. Acceptable values are: * `keywordValue` (
|
|
3517
3563
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -3728,13 +3774,15 @@ module Google
|
|
|
3728
3774
|
# TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` *
|
|
3729
3775
|
# `TARGETING_TYPE_YOUTUBE_CHANNEL`
|
|
3730
3776
|
# @param [String] filter
|
|
3731
|
-
# Allows filtering by assigned targeting option
|
|
3777
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
3732
3778
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
3733
|
-
# be combined by the logical operator
|
|
3734
|
-
# field` `operator` `value``. *
|
|
3735
|
-
# fields:
|
|
3736
|
-
# ID 123456 `assignedTargetingOptionId="123456"`
|
|
3737
|
-
# be no more than 500 characters.
|
|
3779
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
3780
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
3781
|
+
# Supported fields: * `assignedTargetingOptionId` Examples: * `
|
|
3782
|
+
# AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"`
|
|
3783
|
+
# The length of this field should be no more than 500 characters. Reference our [
|
|
3784
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
3785
|
+
# more information.
|
|
3738
3786
|
# @param [String] order_by
|
|
3739
3787
|
# Field by which to sort the list. Acceptable values are: * `
|
|
3740
3788
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
@@ -3822,12 +3870,13 @@ module Google
|
|
|
3822
3870
|
# The ID of the advertiser that has access to the fetched combined audiences.
|
|
3823
3871
|
# @param [String] filter
|
|
3824
3872
|
# Allows filtering by combined audience fields. Supported syntax: * Filter
|
|
3825
|
-
# expressions for combined audiences
|
|
3826
|
-
#
|
|
3827
|
-
#
|
|
3828
|
-
#
|
|
3829
|
-
#
|
|
3830
|
-
#
|
|
3873
|
+
# expressions for combined audiences can only contain at most one restriction. *
|
|
3874
|
+
# A restriction has the form of ``field` `operator` `value``. * All fields must
|
|
3875
|
+
# use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All
|
|
3876
|
+
# combined audiences for which the display name contains "Google": `displayName :
|
|
3877
|
+
# "Google"`. The length of this field should be no more than 500 characters.
|
|
3878
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
3879
|
+
# filters) guide for more information.
|
|
3831
3880
|
# @param [String] order_by
|
|
3832
3881
|
# Field by which to sort the list. Acceptable values are: * `combinedAudienceId`
|
|
3833
3882
|
# (default) * `displayName` The default sorting order is ascending. To specify
|
|
@@ -3951,18 +4000,17 @@ module Google
|
|
|
3951
4000
|
# @param [String] filter
|
|
3952
4001
|
# Allows filtering by custom bidding algorithm fields. Supported syntax: *
|
|
3953
4002
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
3954
|
-
# be combined by `AND`. A sequence of restrictions
|
|
3955
|
-
# restriction has the form of ``field` `operator` `value``. * The
|
|
3956
|
-
#
|
|
3957
|
-
#
|
|
3958
|
-
#
|
|
3959
|
-
#
|
|
3960
|
-
#
|
|
3961
|
-
#
|
|
3962
|
-
#
|
|
3963
|
-
# display
|
|
3964
|
-
#
|
|
3965
|
-
# SCRIPT_BASED` The length of this field should be no more than 500 characters.
|
|
4003
|
+
# be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A
|
|
4004
|
+
# restriction has the form of ``field` `operator` `value``. * The `
|
|
4005
|
+
# customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `
|
|
4006
|
+
# displayName` field must use the `HAS (:)` operator. Supported fields: * `
|
|
4007
|
+
# customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding
|
|
4008
|
+
# algorithms for which the display name contains "politics": `displayName:"
|
|
4009
|
+
# politics"`. * All custom bidding algorithms for which the type is "
|
|
4010
|
+
# SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this
|
|
4011
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
4012
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
4013
|
+
# information.
|
|
3966
4014
|
# @param [String] order_by
|
|
3967
4015
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
3968
4016
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -4262,11 +4310,13 @@ module Google
|
|
|
4262
4310
|
# The ID of the DV360 advertiser that has access to the fetched custom lists.
|
|
4263
4311
|
# @param [String] filter
|
|
4264
4312
|
# Allows filtering by custom list fields. Supported syntax: * Filter expressions
|
|
4265
|
-
# for custom lists
|
|
4266
|
-
#
|
|
4267
|
-
#
|
|
4268
|
-
#
|
|
4269
|
-
#
|
|
4313
|
+
# for custom lists can only contain at most one restriction. * A restriction has
|
|
4314
|
+
# the form of ``field` `operator` `value``. * All fields must use the `HAS (:)`
|
|
4315
|
+
# operator. Supported fields: * `displayName` Examples: * All custom lists for
|
|
4316
|
+
# which the display name contains "Google": `displayName:"Google"`. The length
|
|
4317
|
+
# of this field should be no more than 500 characters. Reference our [filter `
|
|
4318
|
+
# LIST` requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
4319
|
+
# information.
|
|
4270
4320
|
# @param [String] order_by
|
|
4271
4321
|
# Field by which to sort the list. Acceptable values are: * `customListId` (
|
|
4272
4322
|
# default) * `displayName` The default sorting order is ascending. To specify
|
|
@@ -4428,12 +4478,14 @@ module Google
|
|
|
4428
4478
|
# audiences.
|
|
4429
4479
|
# @param [String] filter
|
|
4430
4480
|
# Allows filtering by first and third party audience fields. Supported syntax: *
|
|
4431
|
-
# Filter expressions for first and third party audiences
|
|
4432
|
-
#
|
|
4433
|
-
#
|
|
4434
|
-
#
|
|
4435
|
-
# display name contains "Google": `displayName
|
|
4436
|
-
# field should be no more than 500 characters.
|
|
4481
|
+
# Filter expressions for first and third party audiences can only contain at
|
|
4482
|
+
# most one restriction. * A restriction has the form of ``field` `operator` `
|
|
4483
|
+
# value``. * All fields must use the `HAS (:)` operator. Supported fields: * `
|
|
4484
|
+
# displayName` Examples: * All first and third party audiences for which the
|
|
4485
|
+
# display name contains "Google": `displayName:"Google"`. The length of this
|
|
4486
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
4487
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
4488
|
+
# information.
|
|
4437
4489
|
# @param [String] order_by
|
|
4438
4490
|
# Field by which to sort the list. Acceptable values are: * `
|
|
4439
4491
|
# firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting
|
|
@@ -4642,12 +4694,13 @@ module Google
|
|
|
4642
4694
|
# The ID of the advertiser that has access to the fetched Google audiences.
|
|
4643
4695
|
# @param [String] filter
|
|
4644
4696
|
# Allows filtering by Google audience fields. Supported syntax: * Filter
|
|
4645
|
-
# expressions for Google audiences
|
|
4646
|
-
# restriction
|
|
4647
|
-
#
|
|
4648
|
-
#
|
|
4649
|
-
#
|
|
4650
|
-
#
|
|
4697
|
+
# expressions for Google audiences can only contain at most one restriction. * A
|
|
4698
|
+
# restriction has the form of ``field` `operator` `value``. * All fields must
|
|
4699
|
+
# use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All
|
|
4700
|
+
# Google audiences for which the display name contains "Google": `displayName:"
|
|
4701
|
+
# Google"`. The length of this field should be no more than 500 characters.
|
|
4702
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
4703
|
+
# filters) guide for more information.
|
|
4651
4704
|
# @param [String] order_by
|
|
4652
4705
|
# Field by which to sort the list. Acceptable values are: * `googleAudienceId` (
|
|
4653
4706
|
# default) * `displayName` The default sorting order is ascending. To specify
|
|
@@ -4811,16 +4864,18 @@ module Google
|
|
|
4811
4864
|
# @param [Fixnum] advertiser_id
|
|
4812
4865
|
# The ID of the advertiser that has access to the guaranteed order.
|
|
4813
4866
|
# @param [String] filter
|
|
4814
|
-
# Allows filtering by guaranteed order
|
|
4815
|
-
#
|
|
4867
|
+
# Allows filtering by guaranteed order fields. * Filter expressions are made up
|
|
4868
|
+
# of one or more restrictions. * Restrictions can be combined by `AND` or `OR`
|
|
4816
4869
|
# logical operators. A sequence of restrictions implicitly uses `AND`. * A
|
|
4817
|
-
# restriction has the form of ``field` `operator` `value``. *
|
|
4818
|
-
#
|
|
4819
|
-
# display_name`
|
|
4820
|
-
# `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed
|
|
4821
|
-
# Google Ad Manager or Rubicon exchanges: `exchange="
|
|
4822
|
-
# OR exchange="EXCHANGE_RUBICON"` The length of this
|
|
4823
|
-
# than 500 characters.
|
|
4870
|
+
# restriction has the form of ``field` `operator` `value``. * All fields must
|
|
4871
|
+
# use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `
|
|
4872
|
+
# exchange` * `display_name` * `status.entityStatus` Examples: * All active
|
|
4873
|
+
# guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed
|
|
4874
|
+
# orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="
|
|
4875
|
+
# EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this
|
|
4876
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
4877
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
4878
|
+
# information.
|
|
4824
4879
|
# @param [String] order_by
|
|
4825
4880
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
4826
4881
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -5036,12 +5091,13 @@ module Google
|
|
|
5036
5091
|
# inventory source group is partner-owned, only advertisers to which the group
|
|
5037
5092
|
# is explicitly shared can access the group.
|
|
5038
5093
|
# @param [String] filter
|
|
5039
|
-
# Allows filtering by inventory source group
|
|
5040
|
-
#
|
|
5041
|
-
#
|
|
5042
|
-
#
|
|
5043
|
-
# fields:
|
|
5044
|
-
# than 500 characters.
|
|
5094
|
+
# Allows filtering by inventory source group fields. Supported syntax: * Filter
|
|
5095
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
5096
|
+
# combined by the logical operator `OR`. * A restriction has the form of ``field`
|
|
5097
|
+
# `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
5098
|
+
# Supported fields: * `inventorySourceGroupId` The length of this field should
|
|
5099
|
+
# be no more than 500 characters. Reference our [filter `LIST` requests](/
|
|
5100
|
+
# display-video/api/guides/how-tos/filters) guide for more information.
|
|
5045
5101
|
# @param [String] order_by
|
|
5046
5102
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
5047
5103
|
# default) * `inventorySourceGroupId` The default sorting order is ascending. To
|
|
@@ -5272,10 +5328,11 @@ module Google
|
|
|
5272
5328
|
# @param [String] filter
|
|
5273
5329
|
# Allows filtering by assigned inventory source fields. Supported syntax: *
|
|
5274
5330
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
5275
|
-
# be combined by the logical operator
|
|
5276
|
-
# field` `operator` `value``. *
|
|
5277
|
-
# fields:
|
|
5278
|
-
# more than 500 characters.
|
|
5331
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
5332
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
5333
|
+
# Supported fields: * `assignedInventorySourceId` The length of this field
|
|
5334
|
+
# should be no more than 500 characters. Reference our [filter `LIST` requests](/
|
|
5335
|
+
# display-video/api/guides/how-tos/filters) guide for more information.
|
|
5279
5336
|
# @param [String] order_by
|
|
5280
5337
|
# Field by which to sort the list. Acceptable values are: * `
|
|
5281
5338
|
# assignedInventorySourceId` (default) The default sorting order is ascending.
|
|
@@ -5439,17 +5496,18 @@ module Google
|
|
|
5439
5496
|
# @param [Fixnum] advertiser_id
|
|
5440
5497
|
# The ID of the advertiser that has access to the inventory source.
|
|
5441
5498
|
# @param [String] filter
|
|
5442
|
-
# Allows filtering by inventory source
|
|
5499
|
+
# Allows filtering by inventory source fields. Supported syntax: * Filter
|
|
5443
5500
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
5444
5501
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
5445
5502
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
5446
|
-
# value``. *
|
|
5447
|
-
# entityStatus`
|
|
5448
|
-
# exchange` Examples: * All active inventory sources: `status.entityStatus="
|
|
5503
|
+
# value``. * All fields must use the `EQUALS (=)` operator. Supported fields: * `
|
|
5504
|
+
# status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType`
|
|
5505
|
+
# * `exchange` Examples: * All active inventory sources: `status.entityStatus="
|
|
5449
5506
|
# ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or
|
|
5450
5507
|
# Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="
|
|
5451
5508
|
# EXCHANGE_RUBICON"` The length of this field should be no more than 500
|
|
5452
|
-
# characters.
|
|
5509
|
+
# characters. Reference our [filter `LIST` requests](/display-video/api/guides/
|
|
5510
|
+
# how-tos/filters) guide for more information.
|
|
5453
5511
|
# @param [String] order_by
|
|
5454
5512
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
5455
5513
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -5694,13 +5752,15 @@ module Google
|
|
|
5694
5752
|
# Lists partners that are accessible to the current user. The order is defined
|
|
5695
5753
|
# by the order_by parameter.
|
|
5696
5754
|
# @param [String] filter
|
|
5697
|
-
# Allows filtering by partner
|
|
5698
|
-
#
|
|
5699
|
-
#
|
|
5700
|
-
#
|
|
5701
|
-
#
|
|
5755
|
+
# Allows filtering by partner fields. Supported syntax: * Filter expressions are
|
|
5756
|
+
# made up of one or more restrictions. * Restrictions can be combined by `AND`
|
|
5757
|
+
# or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. *
|
|
5758
|
+
# A restriction has the form of ``field` `operator` `value``. * All fields must
|
|
5759
|
+
# use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: *
|
|
5702
5760
|
# All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this
|
|
5703
|
-
# field should be no more than 500 characters.
|
|
5761
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
5762
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
5763
|
+
# information.
|
|
5704
5764
|
# @param [String] order_by
|
|
5705
5765
|
# Field by which to sort the list. Acceptable values are: * `displayName` The
|
|
5706
5766
|
# default sorting order is ascending. To specify descending order for a field, a
|
|
@@ -5823,11 +5883,13 @@ module Google
|
|
|
5823
5883
|
# The ID of the advertiser that owns the channels.
|
|
5824
5884
|
# @param [String] filter
|
|
5825
5885
|
# Allows filtering by channel fields. Supported syntax: * Filter expressions for
|
|
5826
|
-
# channel
|
|
5827
|
-
#
|
|
5828
|
-
#
|
|
5829
|
-
#
|
|
5830
|
-
#
|
|
5886
|
+
# channel can only contain at most one restriction. * A restriction has the form
|
|
5887
|
+
# of ``field` `operator` `value``. * All fields must use the `HAS (:)` operator.
|
|
5888
|
+
# Supported fields: * `displayName` Examples: * All channels for which the
|
|
5889
|
+
# display name contains "google": `displayName : "google"`. The length of this
|
|
5890
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
5891
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
5892
|
+
# information.
|
|
5831
5893
|
# @param [String] order_by
|
|
5832
5894
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
5833
5895
|
# default) * `channelId` The default sorting order is ascending. To specify
|
|
@@ -6041,10 +6103,13 @@ module Google
|
|
|
6041
6103
|
# The ID of the advertiser that owns the parent channel.
|
|
6042
6104
|
# @param [String] filter
|
|
6043
6105
|
# Allows filtering by site fields. Supported syntax: * Filter expressions for
|
|
6044
|
-
# site
|
|
6045
|
-
# the form of ``field` `operator` `value``. *
|
|
6046
|
-
# .
|
|
6047
|
-
# or app ID contains "google": `urlOrAppId : "google"`
|
|
6106
|
+
# site retrieval can only contain at most one restriction. * A restriction has
|
|
6107
|
+
# the form of ``field` `operator` `value``. * All fields must use the `HAS (:)`
|
|
6108
|
+
# operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the
|
|
6109
|
+
# URL or app ID contains "google": `urlOrAppId : "google"` The length of this
|
|
6110
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
6111
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
6112
|
+
# information.
|
|
6048
6113
|
# @param [String] order_by
|
|
6049
6114
|
# Field by which to sort the list. Acceptable values are: * `urlOrAppId` (
|
|
6050
6115
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -6250,13 +6315,15 @@ module Google
|
|
|
6250
6315
|
# Required. Identifies the type of assigned targeting options to list. Supported
|
|
6251
6316
|
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
|
6252
6317
|
# @param [String] filter
|
|
6253
|
-
# Allows filtering by assigned targeting option
|
|
6318
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
6254
6319
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
6255
6320
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
6256
|
-
# field` `operator` `value``. *
|
|
6257
|
-
# fields:
|
|
6258
|
-
# ID 123456 `assignedTargetingOptionId="
|
|
6259
|
-
# be no more than 500 characters.
|
|
6321
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
6322
|
+
# Supported fields: * `assignedTargetingOptionId` Examples: * `
|
|
6323
|
+
# AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="
|
|
6324
|
+
# 123456"` The length of this field should be no more than 500 characters.
|
|
6325
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
6326
|
+
# filters) guide for more information.
|
|
6260
6327
|
# @param [String] order_by
|
|
6261
6328
|
# Field by which to sort the list. Acceptable values are: * `
|
|
6262
6329
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
@@ -6442,18 +6509,20 @@ module Google
|
|
|
6442
6509
|
# @param [Fixnum] advertiser_id
|
|
6443
6510
|
# Required. The Advertiser this request is being made in the context of.
|
|
6444
6511
|
# @param [String] filter
|
|
6445
|
-
# Allows filtering by targeting option
|
|
6512
|
+
# Allows filtering by targeting option fields. Supported syntax: * Filter
|
|
6446
6513
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
6447
6514
|
# combined by `OR` logical operators. * A restriction has the form of ``field` `
|
|
6448
|
-
# operator` `value``. *
|
|
6449
|
-
# fields:
|
|
6515
|
+
# operator` `value``. * All fields must use the `EQUALS (=)` operator. Supported
|
|
6516
|
+
# fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `
|
|
6450
6517
|
# targetingOptionId` Examples: * All `GEO REGION` targeting options that belong
|
|
6451
6518
|
# to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `
|
|
6452
6519
|
# geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.
|
|
6453
6520
|
# geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting
|
|
6454
6521
|
# options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `
|
|
6455
|
-
# carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"
|
|
6456
|
-
# field should be no more than 500 characters.
|
|
6522
|
+
# carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this
|
|
6523
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
6524
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
6525
|
+
# information.
|
|
6457
6526
|
# @param [String] order_by
|
|
6458
6527
|
# Field by which to sort the list. Acceptable values are: * `targetingOptionId` (
|
|
6459
6528
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -6538,7 +6607,10 @@ module Google
|
|
|
6538
6607
|
# Bulk edits user roles for a user. The operation will delete the assigned user
|
|
6539
6608
|
# roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles
|
|
6540
6609
|
# and then assign the user roles provided in BulkEditAssignedUserRolesRequest.
|
|
6541
|
-
# createdAssignedUserRoles.
|
|
6610
|
+
# createdAssignedUserRoles. This method has unique authentication requirements.
|
|
6611
|
+
# Read the prerequisites in our [Managing Users guide](/display-video/api/guides/
|
|
6612
|
+
# users/overview#prerequisites) before using this method. The "Try this method"
|
|
6613
|
+
# feature does not work for this method.
|
|
6542
6614
|
# @param [Fixnum] user_id
|
|
6543
6615
|
# Required. The ID of the user to which the assigned user roles belong.
|
|
6544
6616
|
# @param [Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesRequest] bulk_edit_assigned_user_roles_request_object
|
|
@@ -6571,7 +6643,11 @@ module Google
|
|
|
6571
6643
|
execute_or_queue_command(command, &block)
|
|
6572
6644
|
end
|
|
6573
6645
|
|
|
6574
|
-
# Creates a new user. Returns the newly created user if successful.
|
|
6646
|
+
# Creates a new user. Returns the newly created user if successful. This method
|
|
6647
|
+
# has unique authentication requirements. Read the prerequisites in our [
|
|
6648
|
+
# Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
|
|
6649
|
+
# before using this method. The "Try this method" feature does not work for this
|
|
6650
|
+
# method.
|
|
6575
6651
|
# @param [Google::Apis::DisplayvideoV1::User] user_object
|
|
6576
6652
|
# @param [String] fields
|
|
6577
6653
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -6601,7 +6677,10 @@ module Google
|
|
|
6601
6677
|
execute_or_queue_command(command, &block)
|
|
6602
6678
|
end
|
|
6603
6679
|
|
|
6604
|
-
# Deletes a user.
|
|
6680
|
+
# Deletes a user. This method has unique authentication requirements. Read the
|
|
6681
|
+
# prerequisites in our [Managing Users guide](/display-video/api/guides/users/
|
|
6682
|
+
# overview#prerequisites) before using this method. The "Try this method"
|
|
6683
|
+
# feature does not work for this method.
|
|
6605
6684
|
# @param [Fixnum] user_id
|
|
6606
6685
|
# Required. The ID of the user to delete.
|
|
6607
6686
|
# @param [String] fields
|
|
@@ -6631,7 +6710,10 @@ module Google
|
|
|
6631
6710
|
execute_or_queue_command(command, &block)
|
|
6632
6711
|
end
|
|
6633
6712
|
|
|
6634
|
-
# Gets a user.
|
|
6713
|
+
# Gets a user. This method has unique authentication requirements. Read the
|
|
6714
|
+
# prerequisites in our [Managing Users guide](/display-video/api/guides/users/
|
|
6715
|
+
# overview#prerequisites) before using this method. The "Try this method"
|
|
6716
|
+
# feature does not work for this method.
|
|
6635
6717
|
# @param [Fixnum] user_id
|
|
6636
6718
|
# Required. The ID of the user to fetch.
|
|
6637
6719
|
# @param [String] fields
|
|
@@ -6662,29 +6744,35 @@ module Google
|
|
|
6662
6744
|
end
|
|
6663
6745
|
|
|
6664
6746
|
# Lists users that are accessible to the current user. If two users have user
|
|
6665
|
-
# roles on the same partner or advertiser, they can access each other.
|
|
6747
|
+
# roles on the same partner or advertiser, they can access each other. This
|
|
6748
|
+
# method has unique authentication requirements. Read the prerequisites in our [
|
|
6749
|
+
# Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
|
|
6750
|
+
# before using this method. The "Try this method" feature does not work for this
|
|
6751
|
+
# method.
|
|
6666
6752
|
# @param [String] filter
|
|
6667
|
-
# Allows filtering by user
|
|
6668
|
-
#
|
|
6753
|
+
# Allows filtering by user fields. Supported syntax: * Filter expressions are
|
|
6754
|
+
# made up of one or more restrictions. * Restrictions can be combined by the
|
|
6669
6755
|
# logical operator `AND`. * A restriction has the form of ``field` `operator` `
|
|
6670
|
-
# value``. * The
|
|
6671
|
-
#
|
|
6672
|
-
#
|
|
6673
|
-
#
|
|
6674
|
-
#
|
|
6675
|
-
#
|
|
6676
|
-
#
|
|
6677
|
-
#
|
|
6678
|
-
#
|
|
6679
|
-
#
|
|
6680
|
-
#
|
|
6681
|
-
#
|
|
6682
|
-
#
|
|
6683
|
-
#
|
|
6684
|
-
#
|
|
6685
|
-
# users with
|
|
6756
|
+
# value``. * The `budget.budget_segments.date_range.end_date` field must use the
|
|
6757
|
+
# `LESS THAN (<)` operator. * The `displayName and `email` field must use the `
|
|
6758
|
+
# HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator.
|
|
6759
|
+
# Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.
|
|
6760
|
+
# entityType` * This is synthetic field of `AssignedUserRole` used for filtering.
|
|
6761
|
+
# Identifies the type of entity to which the user role is assigned. Valid
|
|
6762
|
+
# values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId` *
|
|
6763
|
+
# This is a synthetic field of `AssignedUserRole` used for filtering. Identifies
|
|
6764
|
+
# the parent partner of the entity to which the user role is assigned. * `
|
|
6765
|
+
# assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `
|
|
6766
|
+
# email` Examples: * The user with `displayName` containing "foo": `displayName:"
|
|
6767
|
+
# foo"` * The user with `email` containing "bar": `email:"bar"` * All users with
|
|
6768
|
+
# standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with
|
|
6769
|
+
# user roles for partner 123: `assignedUserRole.partnerId="123"` * All users
|
|
6770
|
+
# with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` *
|
|
6771
|
+
# All users with partner level user roles: `entityType="PARTNER"` * All users
|
|
6772
|
+
# with user roles for partner 123 and advertisers under partner 123: `
|
|
6686
6773
|
# parentPartnerId="123"` The length of this field should be no more than 500
|
|
6687
|
-
# characters.
|
|
6774
|
+
# characters. Reference our [filter `LIST` requests](/display-video/api/guides/
|
|
6775
|
+
# how-tos/filters) guide for more information.
|
|
6688
6776
|
# @param [String] order_by
|
|
6689
6777
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
6690
6778
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -6728,7 +6816,11 @@ module Google
|
|
|
6728
6816
|
execute_or_queue_command(command, &block)
|
|
6729
6817
|
end
|
|
6730
6818
|
|
|
6731
|
-
# Updates an existing user. Returns the updated user if successful.
|
|
6819
|
+
# Updates an existing user. Returns the updated user if successful. This method
|
|
6820
|
+
# has unique authentication requirements. Read the prerequisites in our [
|
|
6821
|
+
# Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
|
|
6822
|
+
# before using this method. The "Try this method" feature does not work for this
|
|
6823
|
+
# method.
|
|
6732
6824
|
# @param [Fixnum] user_id
|
|
6733
6825
|
# Output only. The unique ID of the user. Assigned by the system.
|
|
6734
6826
|
# @param [Google::Apis::DisplayvideoV1::User] user_object
|
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.51.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: 2023-
|
|
11
|
+
date: 2023-05-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: google-apis-core
|
|
@@ -58,7 +58,7 @@ licenses:
|
|
|
58
58
|
metadata:
|
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v1/CHANGELOG.md
|
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v1/v0.
|
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-displayvideo_v1/v0.51.0
|
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-displayvideo_v1
|
|
63
63
|
post_install_message:
|
|
64
64
|
rdoc_options: []
|