google-apis-displayvideo_v1 0.50.0 → 0.52.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 +30 -43
- data/lib/google/apis/displayvideo_v1/gem_version.rb +2 -2
- data/lib/google/apis/displayvideo_v1/service.rb +399 -323
- metadata +3 -3
@@ -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
|
@@ -2954,9 +2979,10 @@ module Google
|
|
2954
2979
|
|
2955
2980
|
# Activates a manual trigger. Each activation of the manual trigger must be at
|
2956
2981
|
# least 5 minutes apart, otherwise an error will be returned. **Warning:** Line
|
2957
|
-
# Items using manual triggers
|
2958
|
-
#
|
2959
|
-
# deprecations#features.manual_triggers) for
|
2982
|
+
# Items using manual triggers no longer serve in Display & Video 360. This
|
2983
|
+
# method will sunset on August 1, 2023. Read our [feature deprecation
|
2984
|
+
# announcement](/display-video/api/deprecations#features.manual_triggers) for
|
2985
|
+
# more information.
|
2960
2986
|
# @param [Fixnum] advertiser_id
|
2961
2987
|
# Required. The ID of the advertiser that the manual trigger belongs.
|
2962
2988
|
# @param [Fixnum] trigger_id
|
@@ -2993,10 +3019,10 @@ module Google
|
|
2993
3019
|
end
|
2994
3020
|
|
2995
3021
|
# Creates a new manual trigger. Returns the newly created manual trigger if
|
2996
|
-
# successful. **Warning:** Line Items using manual triggers
|
2997
|
-
# Display & Video 360 on
|
2998
|
-
# announcement](/display-video/api/deprecations#features.
|
2999
|
-
# more information.
|
3022
|
+
# successful. **Warning:** Line Items using manual triggers no longer serve in
|
3023
|
+
# Display & Video 360. This method will sunset on August 1, 2023. Read our [
|
3024
|
+
# feature deprecation announcement](/display-video/api/deprecations#features.
|
3025
|
+
# manual_triggers) for more information.
|
3000
3026
|
# @param [Fixnum] advertiser_id
|
3001
3027
|
# Required. Immutable. The unique ID of the advertiser that the manual trigger
|
3002
3028
|
# belongs to.
|
@@ -3030,10 +3056,10 @@ module Google
|
|
3030
3056
|
execute_or_queue_command(command, &block)
|
3031
3057
|
end
|
3032
3058
|
|
3033
|
-
# Deactivates a manual trigger. **Warning:** Line Items using manual triggers
|
3034
|
-
#
|
3035
|
-
# feature deprecation announcement](/display-video/api/deprecations#
|
3036
|
-
# manual_triggers) for more information.
|
3059
|
+
# Deactivates a manual trigger. **Warning:** Line Items using manual triggers no
|
3060
|
+
# longer serve in Display & Video 360. This method will sunset on August 1, 2023.
|
3061
|
+
# Read our [feature deprecation announcement](/display-video/api/deprecations#
|
3062
|
+
# features.manual_triggers) for more information.
|
3037
3063
|
# @param [Fixnum] advertiser_id
|
3038
3064
|
# Required. The ID of the advertiser that the manual trigger belongs.
|
3039
3065
|
# @param [Fixnum] trigger_id
|
@@ -3069,10 +3095,10 @@ module Google
|
|
3069
3095
|
execute_or_queue_command(command, &block)
|
3070
3096
|
end
|
3071
3097
|
|
3072
|
-
# Gets a manual trigger. **Warning:** Line Items using manual triggers
|
3073
|
-
#
|
3074
|
-
# deprecation announcement](/display-video/api/deprecations#
|
3075
|
-
# manual_triggers) for more information.
|
3098
|
+
# Gets a manual trigger. **Warning:** Line Items using manual triggers no longer
|
3099
|
+
# serve in Display & Video 360. This method will sunset on August 1, 2023. Read
|
3100
|
+
# our [feature deprecation announcement](/display-video/api/deprecations#
|
3101
|
+
# features.manual_triggers) for more information.
|
3076
3102
|
# @param [Fixnum] advertiser_id
|
3077
3103
|
# Required. The ID of the advertiser this manual trigger belongs to.
|
3078
3104
|
# @param [Fixnum] trigger_id
|
@@ -3107,21 +3133,22 @@ module Google
|
|
3107
3133
|
|
3108
3134
|
# Lists manual triggers that are accessible to the current user for a given
|
3109
3135
|
# advertiser ID. The order is defined by the order_by parameter. A single
|
3110
|
-
# advertiser_id is required. **Warning:** Line Items using manual triggers
|
3111
|
-
#
|
3112
|
-
# deprecation announcement](/display-video/api/deprecations#
|
3113
|
-
# manual_triggers) for more information.
|
3136
|
+
# advertiser_id is required. **Warning:** Line Items using manual triggers no
|
3137
|
+
# longer serve in Display & Video 360. This method will sunset on August 1, 2023.
|
3138
|
+
# Read our [feature deprecation announcement](/display-video/api/deprecations#
|
3139
|
+
# features.manual_triggers) for more information.
|
3114
3140
|
# @param [Fixnum] advertiser_id
|
3115
3141
|
# Required. The ID of the advertiser that the fetched manual triggers belong to.
|
3116
3142
|
# @param [String] filter
|
3117
|
-
# Allows filtering by manual trigger
|
3143
|
+
# Allows filtering by manual trigger fields. Supported syntax: * Filter
|
3118
3144
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
3119
3145
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
3120
3146
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
3121
|
-
# value``. *
|
3122
|
-
# displayName`
|
3147
|
+
# value``. * All fields must use the `EQUALS (=)` operator. Supported fields: * `
|
3148
|
+
# displayName` * `state` Examples: * All active manual triggers under an
|
3123
3149
|
# advertiser: `state="ACTIVE"` The length of this field should be no more than
|
3124
|
-
# 500 characters.
|
3150
|
+
# 500 characters. Reference our [filter `LIST` requests](/display-video/api/
|
3151
|
+
# guides/how-tos/filters) guide for more information.
|
3125
3152
|
# @param [String] order_by
|
3126
3153
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
3127
3154
|
# default) * `state` The default sorting order is ascending. To specify
|
@@ -3167,9 +3194,10 @@ module Google
|
|
3167
3194
|
end
|
3168
3195
|
|
3169
3196
|
# Updates a manual trigger. Returns the updated manual trigger if successful. **
|
3170
|
-
# Warning:** Line Items using manual triggers
|
3171
|
-
#
|
3172
|
-
# display-video/api/deprecations#features.manual_triggers) for
|
3197
|
+
# Warning:** Line Items using manual triggers no longer serve in Display & Video
|
3198
|
+
# 360. This method will sunset on August 1, 2023. Read our [feature deprecation
|
3199
|
+
# announcement](/display-video/api/deprecations#features.manual_triggers) for
|
3200
|
+
# more information.
|
3173
3201
|
# @param [Fixnum] advertiser_id
|
3174
3202
|
# Required. Immutable. The unique ID of the advertiser that the manual trigger
|
3175
3203
|
# belongs to.
|
@@ -3525,11 +3553,13 @@ module Google
|
|
3525
3553
|
# negative keywords belong.
|
3526
3554
|
# @param [String] filter
|
3527
3555
|
# Allows filtering by negative keyword fields. Supported syntax: * Filter
|
3528
|
-
# expressions for negative
|
3529
|
-
#
|
3530
|
-
#
|
3531
|
-
#
|
3532
|
-
# :
|
3556
|
+
# expressions for negative keywords can only contain at most one restriction. *
|
3557
|
+
# A restriction has the form of ``field` `operator` `value``. * All fields must
|
3558
|
+
# use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All
|
3559
|
+
# negative keywords for which the keyword value contains "google": `keywordValue
|
3560
|
+
# : "google"` The length of this field should be no more than 500 characters.
|
3561
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
3562
|
+
# filters) guide for more information.
|
3533
3563
|
# @param [String] order_by
|
3534
3564
|
# Field by which to sort the list. Acceptable values are: * `keywordValue` (
|
3535
3565
|
# default) The default sorting order is ascending. To specify descending order
|
@@ -3746,13 +3776,15 @@ module Google
|
|
3746
3776
|
# TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` *
|
3747
3777
|
# `TARGETING_TYPE_YOUTUBE_CHANNEL`
|
3748
3778
|
# @param [String] filter
|
3749
|
-
# Allows filtering by assigned targeting option
|
3779
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
3750
3780
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
3751
|
-
# be combined by the logical operator
|
3752
|
-
# field` `operator` `value``. *
|
3753
|
-
# fields:
|
3754
|
-
# ID 123456 `assignedTargetingOptionId="123456"`
|
3755
|
-
# be no more than 500 characters.
|
3781
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
3782
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
3783
|
+
# Supported fields: * `assignedTargetingOptionId` Examples: * `
|
3784
|
+
# AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"`
|
3785
|
+
# The length of this field should be no more than 500 characters. Reference our [
|
3786
|
+
# filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
|
3787
|
+
# more information.
|
3756
3788
|
# @param [String] order_by
|
3757
3789
|
# Field by which to sort the list. Acceptable values are: * `
|
3758
3790
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
@@ -3840,12 +3872,13 @@ module Google
|
|
3840
3872
|
# The ID of the advertiser that has access to the fetched combined audiences.
|
3841
3873
|
# @param [String] filter
|
3842
3874
|
# Allows filtering by combined audience fields. Supported syntax: * Filter
|
3843
|
-
# expressions for combined audiences
|
3844
|
-
#
|
3845
|
-
#
|
3846
|
-
#
|
3847
|
-
#
|
3848
|
-
#
|
3875
|
+
# expressions for combined audiences can only contain at most one restriction. *
|
3876
|
+
# A restriction has the form of ``field` `operator` `value``. * All fields must
|
3877
|
+
# use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All
|
3878
|
+
# combined audiences for which the display name contains "Google": `displayName :
|
3879
|
+
# "Google"`. The length of this field should be no more than 500 characters.
|
3880
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
3881
|
+
# filters) guide for more information.
|
3849
3882
|
# @param [String] order_by
|
3850
3883
|
# Field by which to sort the list. Acceptable values are: * `combinedAudienceId`
|
3851
3884
|
# (default) * `displayName` The default sorting order is ascending. To specify
|
@@ -3969,18 +4002,17 @@ module Google
|
|
3969
4002
|
# @param [String] filter
|
3970
4003
|
# Allows filtering by custom bidding algorithm fields. Supported syntax: *
|
3971
4004
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
3972
|
-
# be combined by `AND`. A sequence of restrictions
|
3973
|
-
# restriction has the form of ``field` `operator` `value``. * The
|
3974
|
-
#
|
3975
|
-
#
|
3976
|
-
#
|
3977
|
-
#
|
3978
|
-
#
|
3979
|
-
#
|
3980
|
-
#
|
3981
|
-
# display
|
3982
|
-
#
|
3983
|
-
# SCRIPT_BASED` The length of this field should be no more than 500 characters.
|
4005
|
+
# be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A
|
4006
|
+
# restriction has the form of ``field` `operator` `value``. * The `
|
4007
|
+
# customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `
|
4008
|
+
# displayName` field must use the `HAS (:)` operator. Supported fields: * `
|
4009
|
+
# customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding
|
4010
|
+
# algorithms for which the display name contains "politics": `displayName:"
|
4011
|
+
# politics"`. * All custom bidding algorithms for which the type is "
|
4012
|
+
# SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this
|
4013
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
4014
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
4015
|
+
# information.
|
3984
4016
|
# @param [String] order_by
|
3985
4017
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
3986
4018
|
# default) The default sorting order is ascending. To specify descending order
|
@@ -4280,11 +4312,13 @@ module Google
|
|
4280
4312
|
# The ID of the DV360 advertiser that has access to the fetched custom lists.
|
4281
4313
|
# @param [String] filter
|
4282
4314
|
# Allows filtering by custom list fields. Supported syntax: * Filter expressions
|
4283
|
-
# for custom lists
|
4284
|
-
#
|
4285
|
-
#
|
4286
|
-
#
|
4287
|
-
#
|
4315
|
+
# for custom lists can only contain at most one restriction. * A restriction has
|
4316
|
+
# the form of ``field` `operator` `value``. * All fields must use the `HAS (:)`
|
4317
|
+
# operator. Supported fields: * `displayName` Examples: * All custom lists for
|
4318
|
+
# which the display name contains "Google": `displayName:"Google"`. The length
|
4319
|
+
# of this field should be no more than 500 characters. Reference our [filter `
|
4320
|
+
# LIST` requests](/display-video/api/guides/how-tos/filters) guide for more
|
4321
|
+
# information.
|
4288
4322
|
# @param [String] order_by
|
4289
4323
|
# Field by which to sort the list. Acceptable values are: * `customListId` (
|
4290
4324
|
# default) * `displayName` The default sorting order is ascending. To specify
|
@@ -4446,12 +4480,14 @@ module Google
|
|
4446
4480
|
# audiences.
|
4447
4481
|
# @param [String] filter
|
4448
4482
|
# Allows filtering by first and third party audience fields. Supported syntax: *
|
4449
|
-
# Filter expressions for first and third party audiences
|
4450
|
-
#
|
4451
|
-
#
|
4452
|
-
#
|
4453
|
-
# display name contains "Google": `displayName
|
4454
|
-
# field should be no more than 500 characters.
|
4483
|
+
# Filter expressions for first and third party audiences can only contain at
|
4484
|
+
# most one restriction. * A restriction has the form of ``field` `operator` `
|
4485
|
+
# value``. * All fields must use the `HAS (:)` operator. Supported fields: * `
|
4486
|
+
# displayName` Examples: * All first and third party audiences for which the
|
4487
|
+
# display name contains "Google": `displayName:"Google"`. The length of this
|
4488
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
4489
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
4490
|
+
# information.
|
4455
4491
|
# @param [String] order_by
|
4456
4492
|
# Field by which to sort the list. Acceptable values are: * `
|
4457
4493
|
# firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting
|
@@ -4660,12 +4696,13 @@ module Google
|
|
4660
4696
|
# The ID of the advertiser that has access to the fetched Google audiences.
|
4661
4697
|
# @param [String] filter
|
4662
4698
|
# Allows filtering by Google audience fields. Supported syntax: * Filter
|
4663
|
-
# expressions for Google audiences
|
4664
|
-
# restriction
|
4665
|
-
#
|
4666
|
-
#
|
4667
|
-
#
|
4668
|
-
#
|
4699
|
+
# expressions for Google audiences can only contain at most one restriction. * A
|
4700
|
+
# restriction has the form of ``field` `operator` `value``. * All fields must
|
4701
|
+
# use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All
|
4702
|
+
# Google audiences for which the display name contains "Google": `displayName:"
|
4703
|
+
# Google"`. The length of this field should be no more than 500 characters.
|
4704
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
4705
|
+
# filters) guide for more information.
|
4669
4706
|
# @param [String] order_by
|
4670
4707
|
# Field by which to sort the list. Acceptable values are: * `googleAudienceId` (
|
4671
4708
|
# default) * `displayName` The default sorting order is ascending. To specify
|
@@ -4829,16 +4866,18 @@ module Google
|
|
4829
4866
|
# @param [Fixnum] advertiser_id
|
4830
4867
|
# The ID of the advertiser that has access to the guaranteed order.
|
4831
4868
|
# @param [String] filter
|
4832
|
-
# Allows filtering by guaranteed order
|
4833
|
-
#
|
4869
|
+
# Allows filtering by guaranteed order fields. * Filter expressions are made up
|
4870
|
+
# of one or more restrictions. * Restrictions can be combined by `AND` or `OR`
|
4834
4871
|
# logical operators. A sequence of restrictions implicitly uses `AND`. * A
|
4835
|
-
# restriction has the form of ``field` `operator` `value``. *
|
4836
|
-
#
|
4837
|
-
# display_name`
|
4838
|
-
# `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed
|
4839
|
-
# Google Ad Manager or Rubicon exchanges: `exchange="
|
4840
|
-
# OR exchange="EXCHANGE_RUBICON"` The length of this
|
4841
|
-
# than 500 characters.
|
4872
|
+
# restriction has the form of ``field` `operator` `value``. * All fields must
|
4873
|
+
# use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `
|
4874
|
+
# exchange` * `display_name` * `status.entityStatus` Examples: * All active
|
4875
|
+
# guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed
|
4876
|
+
# orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="
|
4877
|
+
# EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this
|
4878
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
4879
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
4880
|
+
# information.
|
4842
4881
|
# @param [String] order_by
|
4843
4882
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
4844
4883
|
# default) The default sorting order is ascending. To specify descending order
|
@@ -5054,12 +5093,13 @@ module Google
|
|
5054
5093
|
# inventory source group is partner-owned, only advertisers to which the group
|
5055
5094
|
# is explicitly shared can access the group.
|
5056
5095
|
# @param [String] filter
|
5057
|
-
# Allows filtering by inventory source group
|
5058
|
-
#
|
5059
|
-
#
|
5060
|
-
#
|
5061
|
-
# fields:
|
5062
|
-
# than 500 characters.
|
5096
|
+
# Allows filtering by inventory source group fields. Supported syntax: * Filter
|
5097
|
+
# expressions are made up of one or more restrictions. * Restrictions can be
|
5098
|
+
# combined by the logical operator `OR`. * A restriction has the form of ``field`
|
5099
|
+
# `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
5100
|
+
# Supported fields: * `inventorySourceGroupId` The length of this field should
|
5101
|
+
# be no more than 500 characters. Reference our [filter `LIST` requests](/
|
5102
|
+
# display-video/api/guides/how-tos/filters) guide for more information.
|
5063
5103
|
# @param [String] order_by
|
5064
5104
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
5065
5105
|
# default) * `inventorySourceGroupId` The default sorting order is ascending. To
|
@@ -5290,10 +5330,11 @@ module Google
|
|
5290
5330
|
# @param [String] filter
|
5291
5331
|
# Allows filtering by assigned inventory source fields. Supported syntax: *
|
5292
5332
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
5293
|
-
# be combined by the logical operator
|
5294
|
-
# field` `operator` `value``. *
|
5295
|
-
# fields:
|
5296
|
-
# more than 500 characters.
|
5333
|
+
# be combined by the `OR` logical operator. * A restriction has the form of ``
|
5334
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
5335
|
+
# Supported fields: * `assignedInventorySourceId` The length of this field
|
5336
|
+
# should be no more than 500 characters. Reference our [filter `LIST` requests](/
|
5337
|
+
# display-video/api/guides/how-tos/filters) guide for more information.
|
5297
5338
|
# @param [String] order_by
|
5298
5339
|
# Field by which to sort the list. Acceptable values are: * `
|
5299
5340
|
# assignedInventorySourceId` (default) The default sorting order is ascending.
|
@@ -5457,17 +5498,18 @@ module Google
|
|
5457
5498
|
# @param [Fixnum] advertiser_id
|
5458
5499
|
# The ID of the advertiser that has access to the inventory source.
|
5459
5500
|
# @param [String] filter
|
5460
|
-
# Allows filtering by inventory source
|
5501
|
+
# Allows filtering by inventory source fields. Supported syntax: * Filter
|
5461
5502
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
5462
5503
|
# combined by `AND` or `OR` logical operators. A sequence of restrictions
|
5463
5504
|
# implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
|
5464
|
-
# value``. *
|
5465
|
-
# entityStatus`
|
5466
|
-
# exchange` Examples: * All active inventory sources: `status.entityStatus="
|
5505
|
+
# value``. * All fields must use the `EQUALS (=)` operator. Supported fields: * `
|
5506
|
+
# status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType`
|
5507
|
+
# * `exchange` Examples: * All active inventory sources: `status.entityStatus="
|
5467
5508
|
# ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or
|
5468
5509
|
# Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="
|
5469
5510
|
# EXCHANGE_RUBICON"` The length of this field should be no more than 500
|
5470
|
-
# characters.
|
5511
|
+
# characters. Reference our [filter `LIST` requests](/display-video/api/guides/
|
5512
|
+
# how-tos/filters) guide for more information.
|
5471
5513
|
# @param [String] order_by
|
5472
5514
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
5473
5515
|
# default) The default sorting order is ascending. To specify descending order
|
@@ -5712,13 +5754,15 @@ module Google
|
|
5712
5754
|
# Lists partners that are accessible to the current user. The order is defined
|
5713
5755
|
# by the order_by parameter.
|
5714
5756
|
# @param [String] filter
|
5715
|
-
# Allows filtering by partner
|
5716
|
-
#
|
5717
|
-
#
|
5718
|
-
#
|
5719
|
-
#
|
5757
|
+
# Allows filtering by partner fields. Supported syntax: * Filter expressions are
|
5758
|
+
# made up of one or more restrictions. * Restrictions can be combined by `AND`
|
5759
|
+
# or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. *
|
5760
|
+
# A restriction has the form of ``field` `operator` `value``. * All fields must
|
5761
|
+
# use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: *
|
5720
5762
|
# All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this
|
5721
|
-
# field should be no more than 500 characters.
|
5763
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
5764
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
5765
|
+
# information.
|
5722
5766
|
# @param [String] order_by
|
5723
5767
|
# Field by which to sort the list. Acceptable values are: * `displayName` The
|
5724
5768
|
# default sorting order is ascending. To specify descending order for a field, a
|
@@ -5841,11 +5885,13 @@ module Google
|
|
5841
5885
|
# The ID of the advertiser that owns the channels.
|
5842
5886
|
# @param [String] filter
|
5843
5887
|
# Allows filtering by channel fields. Supported syntax: * Filter expressions for
|
5844
|
-
# channel
|
5845
|
-
#
|
5846
|
-
#
|
5847
|
-
#
|
5848
|
-
#
|
5888
|
+
# channel can only contain at most one restriction. * A restriction has the form
|
5889
|
+
# of ``field` `operator` `value``. * All fields must use the `HAS (:)` operator.
|
5890
|
+
# Supported fields: * `displayName` Examples: * All channels for which the
|
5891
|
+
# display name contains "google": `displayName : "google"`. The length of this
|
5892
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
5893
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
5894
|
+
# information.
|
5849
5895
|
# @param [String] order_by
|
5850
5896
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
5851
5897
|
# default) * `channelId` The default sorting order is ascending. To specify
|
@@ -6059,10 +6105,13 @@ module Google
|
|
6059
6105
|
# The ID of the advertiser that owns the parent channel.
|
6060
6106
|
# @param [String] filter
|
6061
6107
|
# Allows filtering by site fields. Supported syntax: * Filter expressions for
|
6062
|
-
# site
|
6063
|
-
# the form of ``field` `operator` `value``. *
|
6064
|
-
# .
|
6065
|
-
# or app ID contains "google": `urlOrAppId : "google"`
|
6108
|
+
# site retrieval can only contain at most one restriction. * A restriction has
|
6109
|
+
# the form of ``field` `operator` `value``. * All fields must use the `HAS (:)`
|
6110
|
+
# operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the
|
6111
|
+
# URL or app ID contains "google": `urlOrAppId : "google"` The length of this
|
6112
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
6113
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
6114
|
+
# information.
|
6066
6115
|
# @param [String] order_by
|
6067
6116
|
# Field by which to sort the list. Acceptable values are: * `urlOrAppId` (
|
6068
6117
|
# default) The default sorting order is ascending. To specify descending order
|
@@ -6268,13 +6317,15 @@ module Google
|
|
6268
6317
|
# Required. Identifies the type of assigned targeting options to list. Supported
|
6269
6318
|
# targeting types: * `TARGETING_TYPE_CHANNEL`
|
6270
6319
|
# @param [String] filter
|
6271
|
-
# Allows filtering by assigned targeting option
|
6320
|
+
# Allows filtering by assigned targeting option fields. Supported syntax: *
|
6272
6321
|
# Filter expressions are made up of one or more restrictions. * Restrictions can
|
6273
6322
|
# be combined by the logical operator `OR`. * A restriction has the form of ``
|
6274
|
-
# field` `operator` `value``. *
|
6275
|
-
# fields:
|
6276
|
-
# ID 123456 `assignedTargetingOptionId="
|
6277
|
-
# be no more than 500 characters.
|
6323
|
+
# field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
|
6324
|
+
# Supported fields: * `assignedTargetingOptionId` Examples: * `
|
6325
|
+
# AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="
|
6326
|
+
# 123456"` The length of this field should be no more than 500 characters.
|
6327
|
+
# Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
|
6328
|
+
# filters) guide for more information.
|
6278
6329
|
# @param [String] order_by
|
6279
6330
|
# Field by which to sort the list. Acceptable values are: * `
|
6280
6331
|
# assignedTargetingOptionId` (default) The default sorting order is ascending.
|
@@ -6460,18 +6511,20 @@ module Google
|
|
6460
6511
|
# @param [Fixnum] advertiser_id
|
6461
6512
|
# Required. The Advertiser this request is being made in the context of.
|
6462
6513
|
# @param [String] filter
|
6463
|
-
# Allows filtering by targeting option
|
6514
|
+
# Allows filtering by targeting option fields. Supported syntax: * Filter
|
6464
6515
|
# expressions are made up of one or more restrictions. * Restrictions can be
|
6465
6516
|
# combined by `OR` logical operators. * A restriction has the form of ``field` `
|
6466
|
-
# operator` `value``. *
|
6467
|
-
# fields:
|
6517
|
+
# operator` `value``. * All fields must use the `EQUALS (=)` operator. Supported
|
6518
|
+
# fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `
|
6468
6519
|
# targetingOptionId` Examples: * All `GEO REGION` targeting options that belong
|
6469
6520
|
# to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `
|
6470
6521
|
# geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.
|
6471
6522
|
# geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting
|
6472
6523
|
# options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `
|
6473
|
-
# carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"
|
6474
|
-
# field should be no more than 500 characters.
|
6524
|
+
# carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this
|
6525
|
+
# field should be no more than 500 characters. Reference our [filter `LIST`
|
6526
|
+
# requests](/display-video/api/guides/how-tos/filters) guide for more
|
6527
|
+
# information.
|
6475
6528
|
# @param [String] order_by
|
6476
6529
|
# Field by which to sort the list. Acceptable values are: * `targetingOptionId` (
|
6477
6530
|
# default) The default sorting order is ascending. To specify descending order
|
@@ -6556,7 +6609,10 @@ module Google
|
|
6556
6609
|
# Bulk edits user roles for a user. The operation will delete the assigned user
|
6557
6610
|
# roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles
|
6558
6611
|
# and then assign the user roles provided in BulkEditAssignedUserRolesRequest.
|
6559
|
-
# createdAssignedUserRoles.
|
6612
|
+
# createdAssignedUserRoles. This method has unique authentication requirements.
|
6613
|
+
# Read the prerequisites in our [Managing Users guide](/display-video/api/guides/
|
6614
|
+
# users/overview#prerequisites) before using this method. The "Try this method"
|
6615
|
+
# feature does not work for this method.
|
6560
6616
|
# @param [Fixnum] user_id
|
6561
6617
|
# Required. The ID of the user to which the assigned user roles belong.
|
6562
6618
|
# @param [Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesRequest] bulk_edit_assigned_user_roles_request_object
|
@@ -6589,7 +6645,11 @@ module Google
|
|
6589
6645
|
execute_or_queue_command(command, &block)
|
6590
6646
|
end
|
6591
6647
|
|
6592
|
-
# Creates a new user. Returns the newly created user if successful.
|
6648
|
+
# Creates a new user. Returns the newly created user if successful. This method
|
6649
|
+
# has unique authentication requirements. Read the prerequisites in our [
|
6650
|
+
# Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
|
6651
|
+
# before using this method. The "Try this method" feature does not work for this
|
6652
|
+
# method.
|
6593
6653
|
# @param [Google::Apis::DisplayvideoV1::User] user_object
|
6594
6654
|
# @param [String] fields
|
6595
6655
|
# Selector specifying which fields to include in a partial response.
|
@@ -6619,7 +6679,10 @@ module Google
|
|
6619
6679
|
execute_or_queue_command(command, &block)
|
6620
6680
|
end
|
6621
6681
|
|
6622
|
-
# Deletes a user.
|
6682
|
+
# Deletes a user. This method has unique authentication requirements. Read the
|
6683
|
+
# prerequisites in our [Managing Users guide](/display-video/api/guides/users/
|
6684
|
+
# overview#prerequisites) before using this method. The "Try this method"
|
6685
|
+
# feature does not work for this method.
|
6623
6686
|
# @param [Fixnum] user_id
|
6624
6687
|
# Required. The ID of the user to delete.
|
6625
6688
|
# @param [String] fields
|
@@ -6649,7 +6712,10 @@ module Google
|
|
6649
6712
|
execute_or_queue_command(command, &block)
|
6650
6713
|
end
|
6651
6714
|
|
6652
|
-
# Gets a user.
|
6715
|
+
# Gets a user. This method has unique authentication requirements. Read the
|
6716
|
+
# prerequisites in our [Managing Users guide](/display-video/api/guides/users/
|
6717
|
+
# overview#prerequisites) before using this method. The "Try this method"
|
6718
|
+
# feature does not work for this method.
|
6653
6719
|
# @param [Fixnum] user_id
|
6654
6720
|
# Required. The ID of the user to fetch.
|
6655
6721
|
# @param [String] fields
|
@@ -6680,29 +6746,35 @@ module Google
|
|
6680
6746
|
end
|
6681
6747
|
|
6682
6748
|
# Lists users that are accessible to the current user. If two users have user
|
6683
|
-
# roles on the same partner or advertiser, they can access each other.
|
6749
|
+
# roles on the same partner or advertiser, they can access each other. This
|
6750
|
+
# method has unique authentication requirements. Read the prerequisites in our [
|
6751
|
+
# Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
|
6752
|
+
# before using this method. The "Try this method" feature does not work for this
|
6753
|
+
# method.
|
6684
6754
|
# @param [String] filter
|
6685
|
-
# Allows filtering by user
|
6686
|
-
#
|
6755
|
+
# Allows filtering by user fields. Supported syntax: * Filter expressions are
|
6756
|
+
# made up of one or more restrictions. * Restrictions can be combined by the
|
6687
6757
|
# logical operator `AND`. * A restriction has the form of ``field` `operator` `
|
6688
|
-
# value``. * The
|
6689
|
-
#
|
6690
|
-
#
|
6691
|
-
#
|
6692
|
-
#
|
6693
|
-
#
|
6694
|
-
#
|
6695
|
-
#
|
6696
|
-
#
|
6697
|
-
#
|
6698
|
-
#
|
6699
|
-
#
|
6700
|
-
#
|
6701
|
-
#
|
6702
|
-
#
|
6703
|
-
# users with
|
6758
|
+
# value``. * The `budget.budget_segments.date_range.end_date` field must use the
|
6759
|
+
# `LESS THAN (<)` operator. * The `displayName and `email` field must use the `
|
6760
|
+
# HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator.
|
6761
|
+
# Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.
|
6762
|
+
# entityType` * This is synthetic field of `AssignedUserRole` used for filtering.
|
6763
|
+
# Identifies the type of entity to which the user role is assigned. Valid
|
6764
|
+
# values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId` *
|
6765
|
+
# This is a synthetic field of `AssignedUserRole` used for filtering. Identifies
|
6766
|
+
# the parent partner of the entity to which the user role is assigned. * `
|
6767
|
+
# assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `
|
6768
|
+
# email` Examples: * The user with `displayName` containing "foo": `displayName:"
|
6769
|
+
# foo"` * The user with `email` containing "bar": `email:"bar"` * All users with
|
6770
|
+
# standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with
|
6771
|
+
# user roles for partner 123: `assignedUserRole.partnerId="123"` * All users
|
6772
|
+
# with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` *
|
6773
|
+
# All users with partner level user roles: `entityType="PARTNER"` * All users
|
6774
|
+
# with user roles for partner 123 and advertisers under partner 123: `
|
6704
6775
|
# parentPartnerId="123"` The length of this field should be no more than 500
|
6705
|
-
# characters.
|
6776
|
+
# characters. Reference our [filter `LIST` requests](/display-video/api/guides/
|
6777
|
+
# how-tos/filters) guide for more information.
|
6706
6778
|
# @param [String] order_by
|
6707
6779
|
# Field by which to sort the list. Acceptable values are: * `displayName` (
|
6708
6780
|
# default) The default sorting order is ascending. To specify descending order
|
@@ -6746,7 +6818,11 @@ module Google
|
|
6746
6818
|
execute_or_queue_command(command, &block)
|
6747
6819
|
end
|
6748
6820
|
|
6749
|
-
# Updates an existing user. Returns the updated user if successful.
|
6821
|
+
# Updates an existing user. Returns the updated user if successful. This method
|
6822
|
+
# has unique authentication requirements. Read the prerequisites in our [
|
6823
|
+
# Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
|
6824
|
+
# before using this method. The "Try this method" feature does not work for this
|
6825
|
+
# method.
|
6750
6826
|
# @param [Fixnum] user_id
|
6751
6827
|
# Output only. The unique ID of the user. Assigned by the system.
|
6752
6828
|
# @param [Google::Apis::DisplayvideoV1::User] user_object
|