google-apis-displayvideo_v2 0.17.0 → 0.19.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_v2/classes.rb +28 -46
- data/lib/google/apis/displayvideo_v2/gem_version.rb +2 -2
- data/lib/google/apis/displayvideo_v2/service.rb +431 -351
- metadata +3 -3
|
@@ -224,20 +224,21 @@ module Google
|
|
|
224
224
|
# defined by the order_by parameter. A single partner_id is required. Cross-
|
|
225
225
|
# partner listing is not supported.
|
|
226
226
|
# @param [String] filter
|
|
227
|
-
# Allows filtering by advertiser
|
|
228
|
-
#
|
|
229
|
-
#
|
|
230
|
-
#
|
|
231
|
-
#
|
|
232
|
-
#
|
|
233
|
-
#
|
|
234
|
-
#
|
|
235
|
-
#
|
|
236
|
-
#
|
|
237
|
-
#
|
|
238
|
-
#
|
|
239
|
-
#
|
|
240
|
-
#
|
|
227
|
+
# Allows filtering by advertiser fields. Supported syntax: * Filter expressions
|
|
228
|
+
# are made up of one or more restrictions. * Restrictions can be combined by `
|
|
229
|
+
# AND` or `OR` logical operators. * A restriction has the form of ``field` `
|
|
230
|
+
# operator` `value``. * The `updateTime` field must use the `GREATER THAN OR
|
|
231
|
+
# EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields
|
|
232
|
+
# must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `
|
|
233
|
+
# displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `
|
|
234
|
+
# YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `
|
|
235
|
+
# entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time
|
|
236
|
+
# less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="
|
|
237
|
+
# 2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or
|
|
238
|
+
# equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-
|
|
239
|
+
# 04T18:54:47Z"` The length of this field should be no more than 500 characters.
|
|
240
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
241
|
+
# filters) guide for more information.
|
|
241
242
|
# @param [String] order_by
|
|
242
243
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
243
244
|
# default) * `entityStatus` * `updateTime` The default sorting order is
|
|
@@ -289,13 +290,15 @@ module Google
|
|
|
289
290
|
# @param [Fixnum] advertiser_id
|
|
290
291
|
# Required. The ID of the advertiser the line item belongs to.
|
|
291
292
|
# @param [String] filter
|
|
292
|
-
# Allows filtering by assigned targeting option
|
|
293
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
293
294
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
294
|
-
# be combined by the logical operator
|
|
295
|
-
# field` `operator` `value``. *
|
|
296
|
-
# fields:
|
|
295
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
296
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=) operator`.
|
|
297
|
+
# Supported fields: * `targetingType` Examples: * targetingType with value
|
|
297
298
|
# TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of
|
|
298
|
-
# this field should be no more than 500 characters.
|
|
299
|
+
# this field should be no more than 500 characters. Reference our [filter `LIST`
|
|
300
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
301
|
+
# information.
|
|
299
302
|
# @param [String] order_by
|
|
300
303
|
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
|
301
304
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -532,21 +535,23 @@ module Google
|
|
|
532
535
|
# @param [Fixnum] advertiser_id
|
|
533
536
|
# The ID of the advertiser to list campaigns for.
|
|
534
537
|
# @param [String] filter
|
|
535
|
-
# Allows filtering by campaign
|
|
536
|
-
#
|
|
537
|
-
#
|
|
538
|
-
#
|
|
539
|
-
#
|
|
540
|
-
#
|
|
541
|
-
# Supported fields:
|
|
542
|
-
# updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: *
|
|
538
|
+
# Allows filtering by campaign fields. Supported syntax: * Filter expressions
|
|
539
|
+
# are made up of one or more restrictions. * Restrictions can be combined by `
|
|
540
|
+
# AND` or `OR` logical operators. A sequence of restrictions implicitly uses `
|
|
541
|
+
# AND`. * A restriction has the form of ``field` `operator` `value``. * The `
|
|
542
|
+
# updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN
|
|
543
|
+
# OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)`
|
|
544
|
+
# operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `
|
|
545
|
+
# updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: *
|
|
543
546
|
# All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an
|
|
544
547
|
# advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="
|
|
545
548
|
# ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal
|
|
546
|
-
# to
|
|
547
|
-
# 47Z"` * All campaigns with an update time greater than or equal to
|
|
548
|
-
# 04T18:54:47Z (format of ISO 8601)
|
|
549
|
-
# length of this field should be no more than 500 characters.
|
|
549
|
+
# to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:
|
|
550
|
+
# 47Z"` * All campaigns with an update time greater than or equal to 2020-11-
|
|
551
|
+
# 04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The
|
|
552
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
553
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
554
|
+
# more information.
|
|
550
555
|
# @param [String] order_by
|
|
551
556
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
552
557
|
# default) * `entityStatus` * `updateTime` The default sorting order is
|
|
@@ -597,17 +602,19 @@ module Google
|
|
|
597
602
|
# @param [Fixnum] campaign_id
|
|
598
603
|
# Required. The ID of the campaign to list assigned targeting options for.
|
|
599
604
|
# @param [String] filter
|
|
600
|
-
# Allows filtering by assigned targeting option
|
|
605
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
601
606
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
602
|
-
# be combined by the
|
|
603
|
-
#
|
|
604
|
-
#
|
|
605
|
-
#
|
|
606
|
-
# TARGETING_TYPE_GENDER `targetingType="TARGETING_TYPE_LANGUAGE" OR
|
|
607
|
-
# targetingType="TARGETING_TYPE_GENDER"` *
|
|
608
|
-
# inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
609
|
-
# NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
610
|
-
# field should be no more than 500 characters.
|
|
607
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
608
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
609
|
+
# Supported fields: * `targetingType` * `inheritance` Examples: * `
|
|
610
|
+
# AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE`
|
|
611
|
+
# or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR
|
|
612
|
+
# targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources
|
|
613
|
+
# with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
|
|
614
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
615
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
616
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
617
|
+
# more information.
|
|
611
618
|
# @param [String] order_by
|
|
612
619
|
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
|
613
620
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -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,
|
|
@@ -1545,26 +1556,27 @@ module Google
|
|
|
1545
1556
|
# @param [Fixnum] advertiser_id
|
|
1546
1557
|
# Required. The ID of the advertiser to list insertion orders for.
|
|
1547
1558
|
# @param [String] filter
|
|
1548
|
-
# Allows filtering by insertion order
|
|
1559
|
+
# Allows filtering by insertion order fields. Supported syntax: * Filter
|
|
1549
1560
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
1550
1561
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
1551
1562
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
1552
|
-
# value``. * The
|
|
1553
|
-
#
|
|
1554
|
-
#
|
|
1555
|
-
#
|
|
1556
|
-
#
|
|
1557
|
-
# input
|
|
1558
|
-
#
|
|
1559
|
-
#
|
|
1560
|
-
#
|
|
1561
|
-
#
|
|
1562
|
-
#
|
|
1563
|
-
#
|
|
1564
|
-
#
|
|
1565
|
-
#
|
|
1566
|
-
# 04T18:54:47Z
|
|
1567
|
-
#
|
|
1563
|
+
# value``. * The `budget.budget_segments.date_range.end_date` field must use the
|
|
1564
|
+
# `LESS THAN (<)` operator. * The `updateTime` field must use the `GREATER THAN
|
|
1565
|
+
# OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other
|
|
1566
|
+
# fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `
|
|
1567
|
+
# displayName` * `entityStatus` * `budget.budget_segments.date_range.end_date` (
|
|
1568
|
+
# input in the form of `YYYY-MM-DD`) **Deprecated. Not available after June 8,
|
|
1569
|
+
# 2023** * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`)
|
|
1570
|
+
# Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `
|
|
1571
|
+
# ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an
|
|
1572
|
+
# advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="
|
|
1573
|
+
# ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than
|
|
1574
|
+
# or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-
|
|
1575
|
+
# 04T18:54:47Z"` * All insertion orders with an update time greater than or
|
|
1576
|
+
# equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-
|
|
1577
|
+
# 04T18:54:47Z"` The length of this field should be no more than 500 characters.
|
|
1578
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
1579
|
+
# filters) guide for more information.
|
|
1568
1580
|
# @param [String] order_by
|
|
1569
1581
|
# Field by which to sort the list. Acceptable values are: * "displayName" (
|
|
1570
1582
|
# default) * "entityStatus" * "updateTime" The default sorting order is
|
|
@@ -1616,18 +1628,20 @@ module Google
|
|
|
1616
1628
|
# @param [Fixnum] insertion_order_id
|
|
1617
1629
|
# Required. The ID of the insertion order to list assigned targeting options for.
|
|
1618
1630
|
# @param [String] filter
|
|
1619
|
-
# Allows filtering by assigned targeting option
|
|
1631
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
1620
1632
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
1621
|
-
# be combined by the logical operator `OR
|
|
1622
|
-
#
|
|
1623
|
-
#
|
|
1624
|
-
#
|
|
1625
|
-
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `
|
|
1633
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
1634
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
1635
|
+
# Supported fields: * `targetingType` * `inheritance` Examples: * `
|
|
1636
|
+
# AssignedTargetingOption` resources of targeting type `
|
|
1637
|
+
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `
|
|
1626
1638
|
# targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="
|
|
1627
|
-
# TARGETING_TYPE_CHANNEL"` *
|
|
1628
|
-
# NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
1629
|
-
# inheritance="INHERITED_FROM_PARTNER"` The
|
|
1630
|
-
# more than 500 characters.
|
|
1639
|
+
# TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with
|
|
1640
|
+
# inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
|
|
1641
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
1642
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
1643
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
1644
|
+
# more information.
|
|
1631
1645
|
# @param [String] order_by
|
|
1632
1646
|
# Field by which to sort the list. Acceptable values are: * `targetingType` (
|
|
1633
1647
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -1926,16 +1940,18 @@ module Google
|
|
|
1926
1940
|
# TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `
|
|
1927
1941
|
# TARGETING_TYPE_VIEWABILITY`
|
|
1928
1942
|
# @param [String] filter
|
|
1929
|
-
# Allows filtering by assigned targeting option
|
|
1943
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
1930
1944
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
1931
1945
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
1932
|
-
# field` `operator` `value``. *
|
|
1933
|
-
# fields:
|
|
1934
|
-
#
|
|
1935
|
-
# assignedTargetingOptionId="2"` *
|
|
1936
|
-
# status of NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
1937
|
-
# OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
1938
|
-
# more than 500 characters.
|
|
1946
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
1947
|
+
# Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `
|
|
1948
|
+
# AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="
|
|
1949
|
+
# 1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources
|
|
1950
|
+
# with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
|
|
1951
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
1952
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
1953
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
1954
|
+
# more information.
|
|
1939
1955
|
# @param [String] order_by
|
|
1940
1956
|
# Field by which to sort the list. Acceptable values are: * `
|
|
1941
1957
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
@@ -2113,18 +2129,20 @@ module Google
|
|
|
2113
2129
|
# @param [Fixnum] advertiser_id
|
|
2114
2130
|
# Required. The ID of the advertiser the line items belongs to.
|
|
2115
2131
|
# @param [String] filter
|
|
2116
|
-
# Allows filtering by assigned targeting option
|
|
2132
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
2117
2133
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
2118
2134
|
# be combined by the logical operator `OR` on the same field. * A restriction
|
|
2119
|
-
# has the form of ``field` `operator` `value``. *
|
|
2120
|
-
# )
|
|
2121
|
-
#
|
|
2122
|
-
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `
|
|
2135
|
+
# has the form of ``field` `operator` `value``. * All fields must use the `
|
|
2136
|
+
# EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance`
|
|
2137
|
+
# Examples: * `AssignedTargetingOption` resources of targeting type `
|
|
2138
|
+
# TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `
|
|
2123
2139
|
# targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="
|
|
2124
|
-
# TARGETING_TYPE_CHANNEL"` *
|
|
2125
|
-
# NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
2126
|
-
# inheritance="INHERITED_FROM_PARTNER"` The
|
|
2127
|
-
# more than 500 characters.
|
|
2140
|
+
# TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with
|
|
2141
|
+
# inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
|
|
2142
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
2143
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
2144
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
2145
|
+
# more information.
|
|
2128
2146
|
# @param [Array<Fixnum>, Fixnum] line_item_ids
|
|
2129
2147
|
# Required. The IDs of the line items to list assigned targeting options for.
|
|
2130
2148
|
# @param [String] order_by
|
|
@@ -2389,39 +2407,41 @@ module Google
|
|
|
2389
2407
|
# @param [Fixnum] advertiser_id
|
|
2390
2408
|
# Required. The ID of the advertiser to list line items for.
|
|
2391
2409
|
# @param [String] filter
|
|
2392
|
-
# Allows filtering by line item
|
|
2393
|
-
#
|
|
2394
|
-
#
|
|
2395
|
-
#
|
|
2396
|
-
#
|
|
2397
|
-
#
|
|
2398
|
-
#
|
|
2399
|
-
#
|
|
2400
|
-
#
|
|
2401
|
-
#
|
|
2402
|
-
#
|
|
2403
|
-
#
|
|
2404
|
-
#
|
|
2405
|
-
# items under an insertion order: `
|
|
2406
|
-
# ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`
|
|
2407
|
-
# LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(
|
|
2408
|
-
# "ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
|
|
2409
|
-
# lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose
|
|
2410
|
-
# dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"`
|
|
2411
|
-
# line items that have `NO_VALID_CREATIVE` in `warningMessages`: `
|
|
2410
|
+
# Allows filtering by line item fields. Supported syntax: * Filter expressions
|
|
2411
|
+
# are made up of one or more restrictions. * Restrictions can be combined by `
|
|
2412
|
+
# AND` or `OR` logical operators. A sequence of restrictions implicitly uses `
|
|
2413
|
+
# AND`. * A restriction has the form of ``field` `operator` `value``. * The `
|
|
2414
|
+
# flight.dateRange.endDate` field must use the `LESS THAN (<)` operator. * The `
|
|
2415
|
+
# updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN
|
|
2416
|
+
# OR EQUAL TO (<=)` operators. * The `warningMessages` field must use the `HAS (:
|
|
2417
|
+
# )` operator. * All other fields must use the `EQUALS (=)` operator. Supported
|
|
2418
|
+
# fields: * `campaignId` * `displayName` * `entityStatus` * `flight.dateRange.
|
|
2419
|
+
# endDate` (input formatted as `YYYY-MM-DD`) **Deprecated. Not available after
|
|
2420
|
+
# June 8, 2023** * `flight.triggerId` * `insertionOrderId` * `lineItemId` * `
|
|
2421
|
+
# lineItemType` * `targetedChannelId` * `targetedNegativeKeywordListId` * `
|
|
2422
|
+
# updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) * `
|
|
2423
|
+
# warningMessages` Examples: * All line items under an insertion order: `
|
|
2424
|
+
# insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`
|
|
2425
|
+
# and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(
|
|
2426
|
+
# entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
|
|
2427
|
+
# AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose
|
|
2428
|
+
# flight dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"`
|
|
2429
|
+
# * All line items that have `NO_VALID_CREATIVE` in `warningMessages`: `
|
|
2412
2430
|
# warningMessages:"NO_VALID_CREATIVE"` * All line items with an update time less
|
|
2413
|
-
# than or equal to
|
|
2414
|
-
#
|
|
2415
|
-
#
|
|
2416
|
-
#
|
|
2417
|
-
#
|
|
2418
|
-
#
|
|
2419
|
-
#
|
|
2431
|
+
# than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-
|
|
2432
|
+
# 11-04T18:54:47Z"` * All line items with an update time greater than or equal
|
|
2433
|
+
# to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:
|
|
2434
|
+
# 47Z"` * All line items that are using both the specified channel and specified
|
|
2435
|
+
# negative keyword list in their targeting: `targetedNegativeKeywordListId=789
|
|
2436
|
+
# AND targetedChannelId=12345` The length of this field should be no more than
|
|
2437
|
+
# 500 characters. Reference our [filter `LIST` requests](/display-video/api/
|
|
2438
|
+
# guides/how-tos/filters) guide for more information.
|
|
2420
2439
|
# @param [String] order_by
|
|
2421
2440
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
2422
|
-
# default) * `entityStatus` * `flight.dateRange.endDate`
|
|
2423
|
-
#
|
|
2424
|
-
#
|
|
2441
|
+
# default) * `entityStatus` * `flight.dateRange.endDate` **Deprecated. Not
|
|
2442
|
+
# available after June 8, 2023** * `updateTime` The default sorting order is
|
|
2443
|
+
# ascending. To specify descending order for a field, a suffix "desc" should be
|
|
2444
|
+
# added to the field name. Example: `displayName desc`.
|
|
2425
2445
|
# @param [Fixnum] page_size
|
|
2426
2446
|
# Requested page size. Must be between `1` and `200`. If unspecified will
|
|
2427
2447
|
# default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
|
|
@@ -2744,16 +2764,18 @@ module Google
|
|
|
2744
2764
|
# TARGETING_TYPE_YOUTUBE_VIDEO` (only for `
|
|
2745
2765
|
# LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)
|
|
2746
2766
|
# @param [String] filter
|
|
2747
|
-
# Allows filtering by assigned targeting option
|
|
2767
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
2748
2768
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
2749
2769
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
2750
|
-
# field` `operator` `value``. *
|
|
2751
|
-
# fields:
|
|
2752
|
-
#
|
|
2753
|
-
# assignedTargetingOptionId="2"` *
|
|
2754
|
-
# status of NOT_INHERITED or INHERITED_FROM_PARTNER `
|
|
2755
|
-
# OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
2756
|
-
# more than 500 characters.
|
|
2770
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
2771
|
+
# Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `
|
|
2772
|
+
# AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="
|
|
2773
|
+
# 1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources
|
|
2774
|
+
# with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
|
|
2775
|
+
# inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
|
|
2776
|
+
# length of this field should be no more than 500 characters. Reference our [
|
|
2777
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
2778
|
+
# more information.
|
|
2757
2779
|
# @param [String] order_by
|
|
2758
2780
|
# Field by which to sort the list. Acceptable values are: * `
|
|
2759
2781
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
@@ -2878,10 +2900,12 @@ module Google
|
|
|
2878
2900
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
2879
2901
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
2880
2902
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
2881
|
-
# value``. *
|
|
2903
|
+
# value``. * All fields must use the `EQUALS (=)` operator. Supported fields: * `
|
|
2882
2904
|
# locationType` Examples: * All regional location list: `locationType="
|
|
2883
2905
|
# TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `
|
|
2884
|
-
# locationType="TARGETING_LOCATION_TYPE_PROXIMITY"`
|
|
2906
|
+
# locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field
|
|
2907
|
+
# should be no more than 500 characters. Reference our [filter `LIST` requests](/
|
|
2908
|
+
# display-video/api/guides/how-tos/filters) guide for more information.
|
|
2885
2909
|
# @param [String] order_by
|
|
2886
2910
|
# Field by which to sort the list. Acceptable values are: * `locationListId` (
|
|
2887
2911
|
# default) * `displayName` The default sorting order is ascending. To specify
|
|
@@ -3085,10 +3109,11 @@ module Google
|
|
|
3085
3109
|
# @param [String] filter
|
|
3086
3110
|
# Allows filtering by location list assignment fields. Supported syntax: *
|
|
3087
3111
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
3088
|
-
# be combined by the logical operator
|
|
3089
|
-
# field` `operator` `value``. *
|
|
3090
|
-
# fields:
|
|
3091
|
-
# 500 characters.
|
|
3112
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
3113
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
3114
|
+
# Supported fields: * `assignedLocationId` The length of this field should be no
|
|
3115
|
+
# more than 500 characters. Reference our [filter `LIST` requests](/display-
|
|
3116
|
+
# video/api/guides/how-tos/filters) guide for more information.
|
|
3092
3117
|
# @param [String] order_by
|
|
3093
3118
|
# Field by which to sort the list. Acceptable values are: * `assignedLocationId`
|
|
3094
3119
|
# (default) The default sorting order is ascending. To specify descending order
|
|
@@ -3137,9 +3162,10 @@ module Google
|
|
|
3137
3162
|
|
|
3138
3163
|
# Activates a manual trigger. Each activation of the manual trigger must be at
|
|
3139
3164
|
# least 5 minutes apart, otherwise an error will be returned. **Warning:** Line
|
|
3140
|
-
# Items using manual triggers
|
|
3141
|
-
#
|
|
3142
|
-
# deprecations#features.manual_triggers) for
|
|
3165
|
+
# Items using manual triggers no longer serve in Display & Video 360. This
|
|
3166
|
+
# method will sunset on August 1, 2023. Read our [feature deprecation
|
|
3167
|
+
# announcement](/display-video/api/deprecations#features.manual_triggers) for
|
|
3168
|
+
# more information.
|
|
3143
3169
|
# @param [Fixnum] advertiser_id
|
|
3144
3170
|
# Required. The ID of the advertiser that the manual trigger belongs.
|
|
3145
3171
|
# @param [Fixnum] trigger_id
|
|
@@ -3176,10 +3202,10 @@ module Google
|
|
|
3176
3202
|
end
|
|
3177
3203
|
|
|
3178
3204
|
# Creates a new manual trigger. Returns the newly created manual trigger if
|
|
3179
|
-
# successful. **Warning:** Line Items using manual triggers
|
|
3180
|
-
# Display & Video 360 on
|
|
3181
|
-
# announcement](/display-video/api/deprecations#features.
|
|
3182
|
-
# more information.
|
|
3205
|
+
# successful. **Warning:** Line Items using manual triggers no longer serve in
|
|
3206
|
+
# Display & Video 360. This method will sunset on August 1, 2023. Read our [
|
|
3207
|
+
# feature deprecation announcement](/display-video/api/deprecations#features.
|
|
3208
|
+
# manual_triggers) for more information.
|
|
3183
3209
|
# @param [Fixnum] advertiser_id
|
|
3184
3210
|
# Required. Immutable. The unique ID of the advertiser that the manual trigger
|
|
3185
3211
|
# belongs to.
|
|
@@ -3213,10 +3239,10 @@ module Google
|
|
|
3213
3239
|
execute_or_queue_command(command, &block)
|
|
3214
3240
|
end
|
|
3215
3241
|
|
|
3216
|
-
# Deactivates a manual trigger. **Warning:** Line Items using manual triggers
|
|
3217
|
-
#
|
|
3218
|
-
# feature deprecation announcement](/display-video/api/deprecations#
|
|
3219
|
-
# manual_triggers) for more information.
|
|
3242
|
+
# Deactivates a manual trigger. **Warning:** Line Items using manual triggers no
|
|
3243
|
+
# longer serve in Display & Video 360. This method will sunset on August 1, 2023.
|
|
3244
|
+
# Read our [feature deprecation announcement](/display-video/api/deprecations#
|
|
3245
|
+
# features.manual_triggers) for more information.
|
|
3220
3246
|
# @param [Fixnum] advertiser_id
|
|
3221
3247
|
# Required. The ID of the advertiser that the manual trigger belongs.
|
|
3222
3248
|
# @param [Fixnum] trigger_id
|
|
@@ -3252,10 +3278,10 @@ module Google
|
|
|
3252
3278
|
execute_or_queue_command(command, &block)
|
|
3253
3279
|
end
|
|
3254
3280
|
|
|
3255
|
-
# Gets a manual trigger. **Warning:** Line Items using manual triggers
|
|
3256
|
-
#
|
|
3257
|
-
# deprecation announcement](/display-video/api/deprecations#
|
|
3258
|
-
# manual_triggers) for more information.
|
|
3281
|
+
# Gets a manual trigger. **Warning:** Line Items using manual triggers no longer
|
|
3282
|
+
# serve in Display & Video 360. This method will sunset on August 1, 2023. Read
|
|
3283
|
+
# our [feature deprecation announcement](/display-video/api/deprecations#
|
|
3284
|
+
# features.manual_triggers) for more information.
|
|
3259
3285
|
# @param [Fixnum] advertiser_id
|
|
3260
3286
|
# Required. The ID of the advertiser this manual trigger belongs to.
|
|
3261
3287
|
# @param [Fixnum] trigger_id
|
|
@@ -3290,21 +3316,22 @@ module Google
|
|
|
3290
3316
|
|
|
3291
3317
|
# Lists manual triggers that are accessible to the current user for a given
|
|
3292
3318
|
# advertiser ID. The order is defined by the order_by parameter. A single
|
|
3293
|
-
# advertiser_id is required. **Warning:** Line Items using manual triggers
|
|
3294
|
-
#
|
|
3295
|
-
# deprecation announcement](/display-video/api/deprecations#
|
|
3296
|
-
# manual_triggers) for more information.
|
|
3319
|
+
# advertiser_id is required. **Warning:** Line Items using manual triggers no
|
|
3320
|
+
# longer serve in Display & Video 360. This method will sunset on August 1, 2023.
|
|
3321
|
+
# Read our [feature deprecation announcement](/display-video/api/deprecations#
|
|
3322
|
+
# features.manual_triggers) for more information.
|
|
3297
3323
|
# @param [Fixnum] advertiser_id
|
|
3298
3324
|
# Required. The ID of the advertiser that the fetched manual triggers belong to.
|
|
3299
3325
|
# @param [String] filter
|
|
3300
|
-
# Allows filtering by manual trigger
|
|
3326
|
+
# Allows filtering by manual trigger fields. Supported syntax: * Filter
|
|
3301
3327
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
3302
3328
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
3303
3329
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
3304
|
-
# value``. *
|
|
3305
|
-
# displayName`
|
|
3330
|
+
# value``. * All fields must use the `EQUALS (=)` operator. Supported fields: * `
|
|
3331
|
+
# displayName` * `state` Examples: * All active manual triggers under an
|
|
3306
3332
|
# advertiser: `state="ACTIVE"` The length of this field should be no more than
|
|
3307
|
-
# 500 characters.
|
|
3333
|
+
# 500 characters. Reference our [filter `LIST` requests](/display-video/api/
|
|
3334
|
+
# guides/how-tos/filters) guide for more information.
|
|
3308
3335
|
# @param [String] order_by
|
|
3309
3336
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
3310
3337
|
# default) * `state` The default sorting order is ascending. To specify
|
|
@@ -3350,9 +3377,10 @@ module Google
|
|
|
3350
3377
|
end
|
|
3351
3378
|
|
|
3352
3379
|
# Updates a manual trigger. Returns the updated manual trigger if successful. **
|
|
3353
|
-
# Warning:** Line Items using manual triggers
|
|
3354
|
-
#
|
|
3355
|
-
# display-video/api/deprecations#features.manual_triggers) for
|
|
3380
|
+
# Warning:** Line Items using manual triggers no longer serve in Display & Video
|
|
3381
|
+
# 360. This method will sunset on August 1, 2023. Read our [feature deprecation
|
|
3382
|
+
# announcement](/display-video/api/deprecations#features.manual_triggers) for
|
|
3383
|
+
# more information.
|
|
3356
3384
|
# @param [Fixnum] advertiser_id
|
|
3357
3385
|
# Required. Immutable. The unique ID of the advertiser that the manual trigger
|
|
3358
3386
|
# belongs to.
|
|
@@ -3708,11 +3736,13 @@ module Google
|
|
|
3708
3736
|
# negative keywords belong.
|
|
3709
3737
|
# @param [String] filter
|
|
3710
3738
|
# Allows filtering by negative keyword fields. Supported syntax: * Filter
|
|
3711
|
-
# expressions for negative
|
|
3712
|
-
#
|
|
3713
|
-
#
|
|
3714
|
-
#
|
|
3715
|
-
# :
|
|
3739
|
+
# expressions for negative keywords can only contain at most one restriction. *
|
|
3740
|
+
# A restriction has the form of ``field` `operator` `value``. * All fields must
|
|
3741
|
+
# use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All
|
|
3742
|
+
# negative keywords for which the keyword value contains "google": `keywordValue
|
|
3743
|
+
# : "google"` The length of this field should be no more than 500 characters.
|
|
3744
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
3745
|
+
# filters) guide for more information.
|
|
3716
3746
|
# @param [String] order_by
|
|
3717
3747
|
# Field by which to sort the list. Acceptable values are: * `keywordValue` (
|
|
3718
3748
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -3929,13 +3959,15 @@ module Google
|
|
|
3929
3959
|
# TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` *
|
|
3930
3960
|
# `TARGETING_TYPE_YOUTUBE_CHANNEL`
|
|
3931
3961
|
# @param [String] filter
|
|
3932
|
-
# Allows filtering by assigned targeting option
|
|
3962
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
3933
3963
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
3934
|
-
# be combined by the logical operator
|
|
3935
|
-
# field` `operator` `value``. *
|
|
3936
|
-
# fields:
|
|
3937
|
-
# ID 123456 `assignedTargetingOptionId="123456"`
|
|
3938
|
-
# be no more than 500 characters.
|
|
3964
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
3965
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
3966
|
+
# Supported fields: * `assignedTargetingOptionId` Examples: * `
|
|
3967
|
+
# AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"`
|
|
3968
|
+
# The length of this field should be no more than 500 characters. Reference our [
|
|
3969
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
|
3970
|
+
# more information.
|
|
3939
3971
|
# @param [String] order_by
|
|
3940
3972
|
# Field by which to sort the list. Acceptable values are: * `
|
|
3941
3973
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
@@ -4021,15 +4053,16 @@ module Google
|
|
|
4021
4053
|
# @param [String] filter
|
|
4022
4054
|
# Allows filtering by custom YouTube ad group ad fields. Supported syntax: *
|
|
4023
4055
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
4024
|
-
# be combined by `AND` and `OR`.
|
|
4025
|
-
#
|
|
4026
|
-
#
|
|
4027
|
-
#
|
|
4028
|
-
#
|
|
4029
|
-
#
|
|
4030
|
-
#
|
|
4031
|
-
#
|
|
4032
|
-
#
|
|
4056
|
+
# be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`
|
|
4057
|
+
# . * A restriction has the form of ``field` `operator` `value``. * All fields
|
|
4058
|
+
# must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `
|
|
4059
|
+
# displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads
|
|
4060
|
+
# under an ad group: `adGroupId="1234"` * All ad group ads under an ad group
|
|
4061
|
+
# with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(
|
|
4062
|
+
# entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
|
|
4063
|
+
# AND adGroupId="12345"` The length of this field should be no more than 500
|
|
4064
|
+
# characters. Reference our [filter `LIST` requests](/display-video/api/guides/
|
|
4065
|
+
# how-tos/filters) guide for more information.
|
|
4033
4066
|
# @param [String] order_by
|
|
4034
4067
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
4035
4068
|
# default) * `entityStatus` The default sorting order is ascending. To specify
|
|
@@ -4080,15 +4113,16 @@ module Google
|
|
|
4080
4113
|
# @param [Fixnum] advertiser_id
|
|
4081
4114
|
# Required. The ID of the advertiser the line items belongs to.
|
|
4082
4115
|
# @param [String] filter
|
|
4083
|
-
# Allows filtering by assigned targeting option
|
|
4116
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
4084
4117
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
4085
|
-
# be combined by the logical operator `OR
|
|
4086
|
-
#
|
|
4087
|
-
#
|
|
4088
|
-
# of targeting type TARGETING_TYPE_YOUTUBE_VIDEO or
|
|
4089
|
-
# TARGETING_TYPE_YOUTUBE_CHANNEL `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO"
|
|
4118
|
+
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
4119
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
4120
|
+
# Supported fields: * `targetingType` Examples: * `AssignedTargetingOption`
|
|
4121
|
+
# resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `
|
|
4122
|
+
# TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO"
|
|
4090
4123
|
# OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field
|
|
4091
|
-
# should be no more than 500 characters.
|
|
4124
|
+
# should be no more than 500 characters. Reference our [filter `LIST` requests](/
|
|
4125
|
+
# display-video/api/guides/how-tos/filters) guide for more information.
|
|
4092
4126
|
# @param [String] order_by
|
|
4093
4127
|
# Field by which to sort the list. Acceptable values are: * `youtubeAdGroupId` (
|
|
4094
4128
|
# default) * `assignedTargetingOption.targetingType` The default sorting order
|
|
@@ -4177,17 +4211,17 @@ module Google
|
|
|
4177
4211
|
# @param [String] filter
|
|
4178
4212
|
# Allows filtering by custom YouTube ad group fields. Supported syntax: * Filter
|
|
4179
4213
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
4180
|
-
# combined by `AND` and `OR`.
|
|
4181
|
-
#
|
|
4182
|
-
#
|
|
4183
|
-
#
|
|
4184
|
-
#
|
|
4185
|
-
#
|
|
4186
|
-
# ENTITY_STATUS_PAUSED` and `YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM` ad
|
|
4214
|
+
# combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. *
|
|
4215
|
+
# A restriction has the form of ``field` `operator` `value``. * All fields must
|
|
4216
|
+
# use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `
|
|
4217
|
+
# displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All
|
|
4218
|
+
# ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE`
|
|
4219
|
+
# or `ENTITY_STATUS_PAUSED` `YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM` ad
|
|
4187
4220
|
# groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR
|
|
4188
4221
|
# entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="
|
|
4189
4222
|
# YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"` The length of this field
|
|
4190
|
-
# should be no more than 500 characters.
|
|
4223
|
+
# should be no more than 500 characters. Reference our [filter `LIST` requests](/
|
|
4224
|
+
# display-video/api/guides/how-tos/filters) guide for more information.
|
|
4191
4225
|
# @param [String] order_by
|
|
4192
4226
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
4193
4227
|
# default) * `entityStatus` The default sorting order is ascending. To specify
|
|
@@ -4297,13 +4331,15 @@ module Google
|
|
|
4297
4331
|
# TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `
|
|
4298
4332
|
# TARGETING_TYPE_YOUTUBE_VIDEO`
|
|
4299
4333
|
# @param [String] filter
|
|
4300
|
-
# Allows filtering by assigned targeting option
|
|
4334
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
4301
4335
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
4302
4336
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
4303
|
-
# field` `operator` `value``. *
|
|
4304
|
-
# fields:
|
|
4305
|
-
# with ID 1 or 2 `assignedTargetingOptionId="
|
|
4306
|
-
# The length of this field should be no
|
|
4337
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
4338
|
+
# Supported fields: * `assignedTargetingOptionId` Examples: * `
|
|
4339
|
+
# AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="
|
|
4340
|
+
# 1" OR assignedTargetingOptionId="2"` The length of this field should be no
|
|
4341
|
+
# more than 500 characters. Reference our [filter `LIST` requests](/display-
|
|
4342
|
+
# video/api/guides/how-tos/filters) guide for more information.
|
|
4307
4343
|
# @param [String] order_by
|
|
4308
4344
|
# Field by which to sort the list. Acceptable values are: * `
|
|
4309
4345
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
@@ -4392,12 +4428,13 @@ module Google
|
|
|
4392
4428
|
# The ID of the advertiser that has access to the fetched combined audiences.
|
|
4393
4429
|
# @param [String] filter
|
|
4394
4430
|
# Allows filtering by combined audience fields. Supported syntax: * Filter
|
|
4395
|
-
# expressions for combined audiences
|
|
4396
|
-
#
|
|
4397
|
-
#
|
|
4398
|
-
#
|
|
4399
|
-
#
|
|
4400
|
-
#
|
|
4431
|
+
# expressions for combined audiences can only contain at most one restriction. *
|
|
4432
|
+
# A restriction has the form of ``field` `operator` `value``. * All fields must
|
|
4433
|
+
# use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All
|
|
4434
|
+
# combined audiences for which the display name contains "Google": `displayName :
|
|
4435
|
+
# "Google"`. The length of this field should be no more than 500 characters.
|
|
4436
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
4437
|
+
# filters) guide for more information.
|
|
4401
4438
|
# @param [String] order_by
|
|
4402
4439
|
# Field by which to sort the list. Acceptable values are: * `combinedAudienceId`
|
|
4403
4440
|
# (default) * `displayName` The default sorting order is ascending. To specify
|
|
@@ -4521,18 +4558,17 @@ module Google
|
|
|
4521
4558
|
# @param [String] filter
|
|
4522
4559
|
# Allows filtering by custom bidding algorithm fields. Supported syntax: *
|
|
4523
4560
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
4524
|
-
# be combined by `AND`. A sequence of restrictions
|
|
4525
|
-
# restriction has the form of ``field` `operator` `value``. * The
|
|
4526
|
-
#
|
|
4527
|
-
#
|
|
4528
|
-
#
|
|
4529
|
-
#
|
|
4530
|
-
#
|
|
4531
|
-
#
|
|
4532
|
-
#
|
|
4533
|
-
# display
|
|
4534
|
-
#
|
|
4535
|
-
# SCRIPT_BASED` The length of this field should be no more than 500 characters.
|
|
4561
|
+
# be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A
|
|
4562
|
+
# restriction has the form of ``field` `operator` `value``. * The `
|
|
4563
|
+
# customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `
|
|
4564
|
+
# displayName` field must use the `HAS (:)` operator. Supported fields: * `
|
|
4565
|
+
# customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding
|
|
4566
|
+
# algorithms for which the display name contains "politics": `displayName:"
|
|
4567
|
+
# politics"`. * All custom bidding algorithms for which the type is "
|
|
4568
|
+
# SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this
|
|
4569
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
4570
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
4571
|
+
# information.
|
|
4536
4572
|
# @param [String] order_by
|
|
4537
4573
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
4538
4574
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -4832,11 +4868,13 @@ module Google
|
|
|
4832
4868
|
# The ID of the DV360 advertiser that has access to the fetched custom lists.
|
|
4833
4869
|
# @param [String] filter
|
|
4834
4870
|
# Allows filtering by custom list fields. Supported syntax: * Filter expressions
|
|
4835
|
-
# for custom lists
|
|
4836
|
-
#
|
|
4837
|
-
#
|
|
4838
|
-
#
|
|
4839
|
-
#
|
|
4871
|
+
# for custom lists can only contain at most one restriction. * A restriction has
|
|
4872
|
+
# the form of ``field` `operator` `value``. * All fields must use the `HAS (:)`
|
|
4873
|
+
# operator. Supported fields: * `displayName` Examples: * All custom lists for
|
|
4874
|
+
# which the display name contains "Google": `displayName:"Google"`. The length
|
|
4875
|
+
# of this field should be no more than 500 characters. Reference our [filter `
|
|
4876
|
+
# LIST` requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
4877
|
+
# information.
|
|
4840
4878
|
# @param [String] order_by
|
|
4841
4879
|
# Field by which to sort the list. Acceptable values are: * `customListId` (
|
|
4842
4880
|
# default) * `displayName` The default sorting order is ascending. To specify
|
|
@@ -4998,12 +5036,14 @@ module Google
|
|
|
4998
5036
|
# audiences.
|
|
4999
5037
|
# @param [String] filter
|
|
5000
5038
|
# Allows filtering by first and third party audience fields. Supported syntax: *
|
|
5001
|
-
# Filter expressions for first and third party audiences
|
|
5002
|
-
#
|
|
5003
|
-
#
|
|
5004
|
-
#
|
|
5005
|
-
# display name contains "Google": `displayName
|
|
5006
|
-
# field should be no more than 500 characters.
|
|
5039
|
+
# Filter expressions for first and third party audiences can only contain at
|
|
5040
|
+
# most one restriction. * A restriction has the form of ``field` `operator` `
|
|
5041
|
+
# value``. * All fields must use the `HAS (:)` operator. Supported fields: * `
|
|
5042
|
+
# displayName` Examples: * All first and third party audiences for which the
|
|
5043
|
+
# display name contains "Google": `displayName:"Google"`. The length of this
|
|
5044
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
5045
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
5046
|
+
# information.
|
|
5007
5047
|
# @param [String] order_by
|
|
5008
5048
|
# Field by which to sort the list. Acceptable values are: * `
|
|
5009
5049
|
# firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting
|
|
@@ -5212,12 +5252,13 @@ module Google
|
|
|
5212
5252
|
# The ID of the advertiser that has access to the fetched Google audiences.
|
|
5213
5253
|
# @param [String] filter
|
|
5214
5254
|
# Allows filtering by Google audience fields. Supported syntax: * Filter
|
|
5215
|
-
# expressions for Google audiences
|
|
5216
|
-
# restriction
|
|
5217
|
-
#
|
|
5218
|
-
#
|
|
5219
|
-
#
|
|
5220
|
-
#
|
|
5255
|
+
# expressions for Google audiences can only contain at most one restriction. * A
|
|
5256
|
+
# restriction has the form of ``field` `operator` `value``. * All fields must
|
|
5257
|
+
# use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All
|
|
5258
|
+
# Google audiences for which the display name contains "Google": `displayName:"
|
|
5259
|
+
# Google"`. The length of this field should be no more than 500 characters.
|
|
5260
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
5261
|
+
# filters) guide for more information.
|
|
5221
5262
|
# @param [String] order_by
|
|
5222
5263
|
# Field by which to sort the list. Acceptable values are: * `googleAudienceId` (
|
|
5223
5264
|
# default) * `displayName` The default sorting order is ascending. To specify
|
|
@@ -5381,16 +5422,18 @@ module Google
|
|
|
5381
5422
|
# @param [Fixnum] advertiser_id
|
|
5382
5423
|
# The ID of the advertiser that has access to the guaranteed order.
|
|
5383
5424
|
# @param [String] filter
|
|
5384
|
-
# Allows filtering by guaranteed order
|
|
5385
|
-
#
|
|
5425
|
+
# Allows filtering by guaranteed order fields. * Filter expressions are made up
|
|
5426
|
+
# of one or more restrictions. * Restrictions can be combined by `AND` or `OR`
|
|
5386
5427
|
# logical operators. A sequence of restrictions implicitly uses `AND`. * A
|
|
5387
|
-
# restriction has the form of ``field` `operator` `value``. *
|
|
5388
|
-
#
|
|
5389
|
-
# display_name`
|
|
5390
|
-
# `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed
|
|
5391
|
-
# Google Ad Manager or Rubicon exchanges: `exchange="
|
|
5392
|
-
# OR exchange="EXCHANGE_RUBICON"` The length of this
|
|
5393
|
-
# than 500 characters.
|
|
5428
|
+
# restriction has the form of ``field` `operator` `value``. * All fields must
|
|
5429
|
+
# use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `
|
|
5430
|
+
# exchange` * `display_name` * `status.entityStatus` Examples: * All active
|
|
5431
|
+
# guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed
|
|
5432
|
+
# orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="
|
|
5433
|
+
# EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this
|
|
5434
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
5435
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
5436
|
+
# information.
|
|
5394
5437
|
# @param [String] order_by
|
|
5395
5438
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
5396
5439
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -5606,12 +5649,13 @@ module Google
|
|
|
5606
5649
|
# inventory source group is partner-owned, only advertisers to which the group
|
|
5607
5650
|
# is explicitly shared can access the group.
|
|
5608
5651
|
# @param [String] filter
|
|
5609
|
-
# Allows filtering by inventory source group
|
|
5610
|
-
#
|
|
5611
|
-
#
|
|
5612
|
-
#
|
|
5613
|
-
# fields:
|
|
5614
|
-
# than 500 characters.
|
|
5652
|
+
# Allows filtering by inventory source group fields. Supported syntax: * Filter
|
|
5653
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
5654
|
+
# combined by the logical operator `OR`. * A restriction has the form of ``field`
|
|
5655
|
+
# `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
5656
|
+
# Supported fields: * `inventorySourceGroupId` The length of this field should
|
|
5657
|
+
# be no more than 500 characters. Reference our [filter `LIST` requests](/
|
|
5658
|
+
# display-video/api/guides/how-tos/filters) guide for more information.
|
|
5615
5659
|
# @param [String] order_by
|
|
5616
5660
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
5617
5661
|
# default) * `inventorySourceGroupId` The default sorting order is ascending. To
|
|
@@ -5842,10 +5886,11 @@ module Google
|
|
|
5842
5886
|
# @param [String] filter
|
|
5843
5887
|
# Allows filtering by assigned inventory source fields. Supported syntax: *
|
|
5844
5888
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
5845
|
-
# be combined by the logical operator
|
|
5846
|
-
# field` `operator` `value``. *
|
|
5847
|
-
# fields:
|
|
5848
|
-
# more than 500 characters.
|
|
5889
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
|
5890
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
5891
|
+
# Supported fields: * `assignedInventorySourceId` The length of this field
|
|
5892
|
+
# should be no more than 500 characters. Reference our [filter `LIST` requests](/
|
|
5893
|
+
# display-video/api/guides/how-tos/filters) guide for more information.
|
|
5849
5894
|
# @param [String] order_by
|
|
5850
5895
|
# Field by which to sort the list. Acceptable values are: * `
|
|
5851
5896
|
# assignedInventorySourceId` (default) The default sorting order is ascending.
|
|
@@ -6009,17 +6054,18 @@ module Google
|
|
|
6009
6054
|
# @param [Fixnum] advertiser_id
|
|
6010
6055
|
# The ID of the advertiser that has access to the inventory source.
|
|
6011
6056
|
# @param [String] filter
|
|
6012
|
-
# Allows filtering by inventory source
|
|
6057
|
+
# Allows filtering by inventory source fields. Supported syntax: * Filter
|
|
6013
6058
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
6014
6059
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
|
6015
6060
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
|
6016
|
-
# value``. *
|
|
6017
|
-
# entityStatus`
|
|
6018
|
-
# exchange` Examples: * All active inventory sources: `status.entityStatus="
|
|
6061
|
+
# value``. * All fields must use the `EQUALS (=)` operator. Supported fields: * `
|
|
6062
|
+
# status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType`
|
|
6063
|
+
# * `exchange` Examples: * All active inventory sources: `status.entityStatus="
|
|
6019
6064
|
# ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or
|
|
6020
6065
|
# Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="
|
|
6021
6066
|
# EXCHANGE_RUBICON"` The length of this field should be no more than 500
|
|
6022
|
-
# characters.
|
|
6067
|
+
# characters. Reference our [filter `LIST` requests](/display-video/api/guides/
|
|
6068
|
+
# how-tos/filters) guide for more information.
|
|
6023
6069
|
# @param [String] order_by
|
|
6024
6070
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
6025
6071
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -6264,13 +6310,15 @@ module Google
|
|
|
6264
6310
|
# Lists partners that are accessible to the current user. The order is defined
|
|
6265
6311
|
# by the order_by parameter.
|
|
6266
6312
|
# @param [String] filter
|
|
6267
|
-
# Allows filtering by partner
|
|
6268
|
-
#
|
|
6269
|
-
#
|
|
6270
|
-
#
|
|
6271
|
-
#
|
|
6313
|
+
# Allows filtering by partner fields. Supported syntax: * Filter expressions are
|
|
6314
|
+
# made up of one or more restrictions. * Restrictions can be combined by `AND`
|
|
6315
|
+
# or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. *
|
|
6316
|
+
# A restriction has the form of ``field` `operator` `value``. * All fields must
|
|
6317
|
+
# use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: *
|
|
6272
6318
|
# All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this
|
|
6273
|
-
# field should be no more than 500 characters.
|
|
6319
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
6320
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
6321
|
+
# information.
|
|
6274
6322
|
# @param [String] order_by
|
|
6275
6323
|
# Field by which to sort the list. Acceptable values are: * `displayName` The
|
|
6276
6324
|
# default sorting order is ascending. To specify descending order for a field, a
|
|
@@ -6393,11 +6441,13 @@ module Google
|
|
|
6393
6441
|
# The ID of the advertiser that owns the channels.
|
|
6394
6442
|
# @param [String] filter
|
|
6395
6443
|
# Allows filtering by channel fields. Supported syntax: * Filter expressions for
|
|
6396
|
-
# channel
|
|
6397
|
-
#
|
|
6398
|
-
#
|
|
6399
|
-
#
|
|
6400
|
-
#
|
|
6444
|
+
# channel can only contain at most one restriction. * A restriction has the form
|
|
6445
|
+
# of ``field` `operator` `value``. * All fields must use the `HAS (:)` operator.
|
|
6446
|
+
# Supported fields: * `displayName` Examples: * All channels for which the
|
|
6447
|
+
# display name contains "google": `displayName : "google"`. The length of this
|
|
6448
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
6449
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
6450
|
+
# information.
|
|
6401
6451
|
# @param [String] order_by
|
|
6402
6452
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
6403
6453
|
# default) * `channelId` The default sorting order is ascending. To specify
|
|
@@ -6611,10 +6661,13 @@ module Google
|
|
|
6611
6661
|
# The ID of the advertiser that owns the parent channel.
|
|
6612
6662
|
# @param [String] filter
|
|
6613
6663
|
# Allows filtering by site fields. Supported syntax: * Filter expressions for
|
|
6614
|
-
# site
|
|
6615
|
-
# the form of ``field` `operator` `value``. *
|
|
6616
|
-
# .
|
|
6617
|
-
# or app ID contains "google": `urlOrAppId : "google"`
|
|
6664
|
+
# site retrieval can only contain at most one restriction. * A restriction has
|
|
6665
|
+
# the form of ``field` `operator` `value``. * All fields must use the `HAS (:)`
|
|
6666
|
+
# operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the
|
|
6667
|
+
# URL or app ID contains "google": `urlOrAppId : "google"` The length of this
|
|
6668
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
6669
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
6670
|
+
# information.
|
|
6618
6671
|
# @param [String] order_by
|
|
6619
6672
|
# Field by which to sort the list. Acceptable values are: * `urlOrAppId` (
|
|
6620
6673
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -6820,13 +6873,15 @@ module Google
|
|
|
6820
6873
|
# Required. Identifies the type of assigned targeting options to list. Supported
|
|
6821
6874
|
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
|
6822
6875
|
# @param [String] filter
|
|
6823
|
-
# Allows filtering by assigned targeting option
|
|
6876
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
|
6824
6877
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
|
6825
6878
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
|
6826
|
-
# field` `operator` `value``. *
|
|
6827
|
-
# fields:
|
|
6828
|
-
# ID 123456 `assignedTargetingOptionId="
|
|
6829
|
-
# be no more than 500 characters.
|
|
6879
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
|
6880
|
+
# Supported fields: * `assignedTargetingOptionId` Examples: * `
|
|
6881
|
+
# AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="
|
|
6882
|
+
# 123456"` The length of this field should be no more than 500 characters.
|
|
6883
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
|
6884
|
+
# filters) guide for more information.
|
|
6830
6885
|
# @param [String] order_by
|
|
6831
6886
|
# Field by which to sort the list. Acceptable values are: * `
|
|
6832
6887
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
|
@@ -7012,18 +7067,20 @@ module Google
|
|
|
7012
7067
|
# @param [Fixnum] advertiser_id
|
|
7013
7068
|
# Required. The Advertiser this request is being made in the context of.
|
|
7014
7069
|
# @param [String] filter
|
|
7015
|
-
# Allows filtering by targeting option
|
|
7070
|
+
# Allows filtering by targeting option fields. Supported syntax: * Filter
|
|
7016
7071
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
|
7017
7072
|
# combined by `OR` logical operators. * A restriction has the form of ``field` `
|
|
7018
|
-
# operator` `value``. *
|
|
7019
|
-
# fields:
|
|
7073
|
+
# operator` `value``. * All fields must use the `EQUALS (=)` operator. Supported
|
|
7074
|
+
# fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `
|
|
7020
7075
|
# targetingOptionId` Examples: * All `GEO REGION` targeting options that belong
|
|
7021
7076
|
# to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `
|
|
7022
7077
|
# geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.
|
|
7023
7078
|
# geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting
|
|
7024
7079
|
# options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `
|
|
7025
|
-
# carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"
|
|
7026
|
-
# field should be no more than 500 characters.
|
|
7080
|
+
# carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this
|
|
7081
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
|
7082
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
|
7083
|
+
# information.
|
|
7027
7084
|
# @param [String] order_by
|
|
7028
7085
|
# Field by which to sort the list. Acceptable values are: * `targetingOptionId` (
|
|
7029
7086
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -7108,7 +7165,10 @@ module Google
|
|
|
7108
7165
|
# Bulk edits user roles for a user. The operation will delete the assigned user
|
|
7109
7166
|
# roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles
|
|
7110
7167
|
# and then assign the user roles provided in BulkEditAssignedUserRolesRequest.
|
|
7111
|
-
# createdAssignedUserRoles.
|
|
7168
|
+
# createdAssignedUserRoles. This method has unique authentication requirements.
|
|
7169
|
+
# Read the prerequisites in our [Managing Users guide](/display-video/api/guides/
|
|
7170
|
+
# users/overview#prerequisites) before using this method. The "Try this method"
|
|
7171
|
+
# feature does not work for this method.
|
|
7112
7172
|
# @param [Fixnum] user_id
|
|
7113
7173
|
# Required. The ID of the user to which the assigned user roles belong.
|
|
7114
7174
|
# @param [Google::Apis::DisplayvideoV2::BulkEditAssignedUserRolesRequest] bulk_edit_assigned_user_roles_request_object
|
|
@@ -7141,7 +7201,11 @@ module Google
|
|
|
7141
7201
|
execute_or_queue_command(command, &block)
|
|
7142
7202
|
end
|
|
7143
7203
|
|
|
7144
|
-
# Creates a new user. Returns the newly created user if successful.
|
|
7204
|
+
# Creates a new user. Returns the newly created user if successful. This method
|
|
7205
|
+
# has unique authentication requirements. Read the prerequisites in our [
|
|
7206
|
+
# Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
|
|
7207
|
+
# before using this method. The "Try this method" feature does not work for this
|
|
7208
|
+
# method.
|
|
7145
7209
|
# @param [Google::Apis::DisplayvideoV2::User] user_object
|
|
7146
7210
|
# @param [String] fields
|
|
7147
7211
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -7171,7 +7235,10 @@ module Google
|
|
|
7171
7235
|
execute_or_queue_command(command, &block)
|
|
7172
7236
|
end
|
|
7173
7237
|
|
|
7174
|
-
# Deletes a user.
|
|
7238
|
+
# Deletes a user. This method has unique authentication requirements. Read the
|
|
7239
|
+
# prerequisites in our [Managing Users guide](/display-video/api/guides/users/
|
|
7240
|
+
# overview#prerequisites) before using this method. The "Try this method"
|
|
7241
|
+
# feature does not work for this method.
|
|
7175
7242
|
# @param [Fixnum] user_id
|
|
7176
7243
|
# Required. The ID of the user to delete.
|
|
7177
7244
|
# @param [String] fields
|
|
@@ -7201,7 +7268,10 @@ module Google
|
|
|
7201
7268
|
execute_or_queue_command(command, &block)
|
|
7202
7269
|
end
|
|
7203
7270
|
|
|
7204
|
-
# Gets a user.
|
|
7271
|
+
# Gets a user. This method has unique authentication requirements. Read the
|
|
7272
|
+
# prerequisites in our [Managing Users guide](/display-video/api/guides/users/
|
|
7273
|
+
# overview#prerequisites) before using this method. The "Try this method"
|
|
7274
|
+
# feature does not work for this method.
|
|
7205
7275
|
# @param [Fixnum] user_id
|
|
7206
7276
|
# Required. The ID of the user to fetch.
|
|
7207
7277
|
# @param [String] fields
|
|
@@ -7232,29 +7302,35 @@ module Google
|
|
|
7232
7302
|
end
|
|
7233
7303
|
|
|
7234
7304
|
# Lists users that are accessible to the current user. If two users have user
|
|
7235
|
-
# roles on the same partner or advertiser, they can access each other.
|
|
7305
|
+
# roles on the same partner or advertiser, they can access each other. This
|
|
7306
|
+
# method has unique authentication requirements. Read the prerequisites in our [
|
|
7307
|
+
# Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
|
|
7308
|
+
# before using this method. The "Try this method" feature does not work for this
|
|
7309
|
+
# method.
|
|
7236
7310
|
# @param [String] filter
|
|
7237
|
-
# Allows filtering by user
|
|
7238
|
-
#
|
|
7311
|
+
# Allows filtering by user fields. Supported syntax: * Filter expressions are
|
|
7312
|
+
# made up of one or more restrictions. * Restrictions can be combined by the
|
|
7239
7313
|
# logical operator `AND`. * A restriction has the form of ``field` `operator` `
|
|
7240
|
-
# value``. * The
|
|
7241
|
-
#
|
|
7242
|
-
#
|
|
7243
|
-
#
|
|
7244
|
-
#
|
|
7245
|
-
#
|
|
7246
|
-
#
|
|
7247
|
-
#
|
|
7248
|
-
#
|
|
7249
|
-
#
|
|
7250
|
-
#
|
|
7251
|
-
#
|
|
7252
|
-
#
|
|
7253
|
-
#
|
|
7254
|
-
#
|
|
7255
|
-
# users with
|
|
7314
|
+
# value``. * The `budget.budget_segments.date_range.end_date` field must use the
|
|
7315
|
+
# `LESS THAN (<)` operator. * The `displayName and `email` field must use the `
|
|
7316
|
+
# HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator.
|
|
7317
|
+
# Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.
|
|
7318
|
+
# entityType` * This is synthetic field of `AssignedUserRole` used for filtering.
|
|
7319
|
+
# Identifies the type of entity to which the user role is assigned. Valid
|
|
7320
|
+
# values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId` *
|
|
7321
|
+
# This is a synthetic field of `AssignedUserRole` used for filtering. Identifies
|
|
7322
|
+
# the parent partner of the entity to which the user role is assigned. * `
|
|
7323
|
+
# assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `
|
|
7324
|
+
# email` Examples: * The user with `displayName` containing "foo": `displayName:"
|
|
7325
|
+
# foo"` * The user with `email` containing "bar": `email:"bar"` * All users with
|
|
7326
|
+
# standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with
|
|
7327
|
+
# user roles for partner 123: `assignedUserRole.partnerId="123"` * All users
|
|
7328
|
+
# with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` *
|
|
7329
|
+
# All users with partner level user roles: `entityType="PARTNER"` * All users
|
|
7330
|
+
# with user roles for partner 123 and advertisers under partner 123: `
|
|
7256
7331
|
# parentPartnerId="123"` The length of this field should be no more than 500
|
|
7257
|
-
# characters.
|
|
7332
|
+
# characters. Reference our [filter `LIST` requests](/display-video/api/guides/
|
|
7333
|
+
# how-tos/filters) guide for more information.
|
|
7258
7334
|
# @param [String] order_by
|
|
7259
7335
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
|
7260
7336
|
# default) The default sorting order is ascending. To specify descending order
|
|
@@ -7298,7 +7374,11 @@ module Google
|
|
|
7298
7374
|
execute_or_queue_command(command, &block)
|
|
7299
7375
|
end
|
|
7300
7376
|
|
|
7301
|
-
# Updates an existing user. Returns the updated user if successful.
|
|
7377
|
+
# Updates an existing user. Returns the updated user if successful. This method
|
|
7378
|
+
# has unique authentication requirements. Read the prerequisites in our [
|
|
7379
|
+
# Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
|
|
7380
|
+
# before using this method. The "Try this method" feature does not work for this
|
|
7381
|
+
# method.
|
|
7302
7382
|
# @param [Fixnum] user_id
|
|
7303
7383
|
# Output only. The unique ID of the user. Assigned by the system.
|
|
7304
7384
|
# @param [Google::Apis::DisplayvideoV2::User] user_object
|