google-apis-displayvideo_v2 0.17.0 → 0.18.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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 properties. Supported syntax: * Filter
228
- # expressions are made up of one or more restrictions. * Restrictions can be
229
- # combined by `AND` or `OR` logical operators. A sequence of restrictions
230
- # implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
231
- # value``. * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO
232
- # (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator must be `EQUALS (=)`. *
233
- # Supported fields: - `advertiserId` - `displayName` - `entityStatus` - `
234
- # updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: *
235
- # All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` *
236
- # All advertisers with an update time less than or equal to `2020-11-04T18:54:
237
- # 47Z (format of ISO 8601)`: `updateTime<="2020-11-04T18:54:47Z"` * All
238
- # advertisers with an update time greater than or equal to `2020-11-04T18:54:47Z
239
- # (format of ISO 8601)`: `updateTime>="2020-11-04T18:54:47Z"` The length of this
240
- # field should be no more than 500 characters.
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 properties. Supported syntax: *
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 `OR`.. * A restriction has the form of ``
295
- # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
296
- # fields: - `targetingType` Examples: * targetingType with value
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 properties. Supported syntax: * Filter
536
- # expressions are made up of one or more restrictions. * Restrictions can be
537
- # combined by `AND` or `OR` logical operators. A sequence of restrictions
538
- # implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
539
- # value``. * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO
540
- # (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator must be `EQUALS (=)`. *
541
- # Supported fields: - `campaignId` - `displayName` - `entityStatus` - `
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 `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<="2020-11-04T18:54:
547
- # 47Z"` * All campaigns with an update time greater than or equal to `2020-11-
548
- # 04T18:54:47Z (format of ISO 8601)`: `updateTime>="2020-11-04T18:54:47Z"` The
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 properties. Supported syntax: *
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 logical operator `OR` on the same field. * A restriction
603
- # has the form of ``field` `operator` `value``. * The operator must be `EQUALS (=
604
- # )`. * Supported fields: - `targetingType` - `inheritance` Examples: *
605
- # AssignedTargetingOptions of targeting type TARGETING_TYPE_LANGUAGE or
606
- # TARGETING_TYPE_GENDER `targetingType="TARGETING_TYPE_LANGUAGE" OR
607
- # targetingType="TARGETING_TYPE_GENDER"` * AssignedTargetingOptions with
608
- # inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="
609
- # NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this
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 properties. Supported syntax: *
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 `OR`. * A restriction has the form of ``
772
- # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
773
- # fields: - `assignedTargetingOptionId` - `inheritance` Examples: *
774
- # AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR
775
- # assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance
776
- # status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED"
777
- # OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
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 currently can only contain at most one * restriction. * A restriction
904
- # has the form of ``field` `operator` `value``. * The operator must be `CONTAINS
905
- # (:)`. * Supported fields: - `displayName` Examples: * All channels for which
906
- # the display name contains "google": `displayName : "google"`. The length of
907
- # this field should be no more than 500 characters.
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 currently can only contain at most one * restriction. * A restriction has
1122
- # the form of ``field` `operator` `value``. * The operator must be `CONTAINS (:)`
1123
- # . * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL
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 properties. Supported syntax: * Filter
1320
- # expressions are made up of one or more restrictions. * Restriction for the
1321
- # same field must be combined by `OR`. * Restriction for different fields must
1322
- # be combined by `AND`. * Between `(` and `)` there can only be restrictions
1323
- # combined by `OR` for the same field. * A restriction has the form of ``field` `
1324
- # operator` `value``. * The operator must be `EQUALS (=)` for the following
1325
- # fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `
1326
- # maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` - `
1327
- # creativeId` * The operator must be `HAS (:)` for the following fields: - `
1328
- # lineItemIds` * The operator must be `GREATER THAN OR EQUAL TO (>=)` or `LESS
1329
- # THAN OR EQUAL TO (<=)` for the following fields: - `updateTime` (input in ISO
1330
- # 8601 format, or YYYY-MM-DDTHH:MM:SSZ) * For `entityStatus`, `minDuration`, `
1331
- # maxDuration`, `updateTime`, and `dynamic`, there may be at most one
1332
- # restriction. * For `dimensions`, the value is in the form of `"`width`x`height`
1333
- # "`. * For `exchangeReviewStatus`, the value is in the form of ``exchange`-`
1334
- # reviewStatus``. * For `minDuration` and `maxDuration`, the value is in the
1335
- # form of `"`duration`s"`. Only seconds are supported with millisecond
1336
- # granularity. * For `updateTime`, a creative resource's field value reflects
1337
- # the last time that a creative has been updated, which includes updates made by
1338
- # the system (e.g. creative review updates). * There may be multiple `
1339
- # lineItemIds` restrictions in order to search against multiple possible line
1340
- # item IDs. * There may be multiple `creativeId` restrictions in order to search
1341
- # against multiple possible creative IDs. Examples: * All native creatives: `
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 `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>="2020-11-
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 properties. Supported syntax: * Filter
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 operator used on `budget.budget_segments.date_range.end_date`
1553
- # must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER
1554
- # THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operators used
1555
- # on all other fields must be `EQUALS (=)`. * Supported fields: - `campaignId` -
1556
- # `displayName` - `entityStatus` - `budget.budget_segments.date_range.end_date` (
1557
- # input as YYYY-MM-DD) - `updateTime` (input in ISO 8601 format, or YYYY-MM-
1558
- # DDTHH:MM:SSZ) Examples: * All insertion orders under a campaign: `campaignId="
1559
- # 1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders
1560
- # under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="
1561
- # ENTITY_STATUS_PAUSED")` * All insertion orders whose budget segments' dates
1562
- # end before March 28, 2019: `budget.budget_segments.date_range.end_date<"2019-
1563
- # 03-28"` * All insertion orders with an update time less than or equal to `2020-
1564
- # 11-04T18:54:47Z (format of ISO 8601)`: `updateTime<="2020-11-04T18:54:47Z"` *
1565
- # All insertion orders with an update time greater than or equal to `2020-11-
1566
- # 04T18:54:47Z (format of ISO 8601)`: `updateTime>="2020-11-04T18:54:47Z"` The
1567
- # length of this field should be no more than 500 characters.
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 properties. Supported syntax: *
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` on the same field. * A restriction
1622
- # has the form of ``field` `operator` `value``. * The operator must be `EQUALS (=
1623
- # )`. * Supported fields: - `targetingType` - `inheritance` Examples: *
1624
- # AssignedTargetingOptions of targeting type
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"` * AssignedTargetingOptions with inheritance status of
1628
- # NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR
1629
- # inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
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 properties. Supported syntax: *
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``. * The operator must be `EQUALS (=)`. * Supported
1933
- # fields: - `assignedTargetingOptionId` - `inheritance` Examples: *
1934
- # AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR
1935
- # assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance
1936
- # status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED"
1937
- # OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
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 properties. Supported syntax: *
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``. * The operator must be `EQUALS (=
2120
- # )`. * Supported fields: - `targetingType` - `inheritance` Examples: *
2121
- # AssignedTargetingOptions of targeting type
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"` * AssignedTargetingOptions with inheritance status of
2125
- # NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR
2126
- # inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
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 properties. Supported syntax: * Filter
2393
- # expressions are made up of one or more restrictions. * Restrictions can be
2394
- # combined by `AND` or `OR` logical operators. A sequence of restrictions
2395
- # implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
2396
- # value``. * The operator used on `flight.dateRange.endDate` must be LESS THAN (<
2397
- # ). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)`
2398
- # or `LESS THAN OR EQUAL TO (<=)`. * The operator used on `warningMessages` must
2399
- # be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. *
2400
- # Supported properties: - `campaignId` - `displayName` - `insertionOrderId` - `
2401
- # entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (
2402
- # input formatted as YYYY-MM-DD) - `warningMessages` - `flight.triggerId` - `
2403
- # updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) - `
2404
- # targetedChannelId` - `targetedNegativeKeywordListId` Examples: * All line
2405
- # items under an insertion order: `insertionOrderId="1234"` * All `
2406
- # ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `
2407
- # LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=
2408
- # "ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND
2409
- # lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose flight
2410
- # dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"` * All
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 `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<="
2414
- # 2020-11-04T18:54:47Z"` * All line items with an update time greater than or
2415
- # equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>="2020-11-
2416
- # 04T18:54:47Z"` * All line items that are using both the specified channel and
2417
- # specified negative keyword list in their targeting: `
2418
- # targetedNegativeKeywordListId=789 AND targetedChannelId=12345` The length of
2419
- # this field should be no more than 500 characters.
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` * `updateTime` The
2423
- # default sorting order is ascending. To specify descending order for a field, a
2424
- # suffix "desc" should be added to the field name. Example: `displayName desc`.
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 properties. Supported syntax: *
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``. * The operator must be `EQUALS (=)`. * Supported
2751
- # fields: - `assignedTargetingOptionId` - `inheritance` Examples: *
2752
- # AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR
2753
- # assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance
2754
- # status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED"
2755
- # OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no
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``. * The operator must be `EQUALS (=)`. * Supported fields: - `
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 `OR`. * A restriction has the form of ``
3089
- # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
3090
- # fields: - `assignedLocationId` The length of this field should be no more than
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
@@ -3297,14 +3322,15 @@ module Google
3297
3322
  # @param [Fixnum] advertiser_id
3298
3323
  # Required. The ID of the advertiser that the fetched manual triggers belong to.
3299
3324
  # @param [String] filter
3300
- # Allows filtering by manual trigger properties. Supported syntax: * Filter
3325
+ # Allows filtering by manual trigger fields. Supported syntax: * Filter
3301
3326
  # expressions are made up of one or more restrictions. * Restrictions can be
3302
3327
  # combined by `AND` or `OR` logical operators. A sequence of restrictions
3303
3328
  # implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
3304
- # value``. * The operator must be `EQUALS (=)`. * Supported fields: - `
3305
- # displayName` - `state` Examples: * All active manual triggers under an
3329
+ # value``. * All fields must use the `EQUALS (=)` operator. Supported fields: * `
3330
+ # displayName` * `state` Examples: * All active manual triggers under an
3306
3331
  # advertiser: `state="ACTIVE"` The length of this field should be no more than
3307
- # 500 characters.
3332
+ # 500 characters. Reference our [filter `LIST` requests](/display-video/api/
3333
+ # guides/how-tos/filters) guide for more information.
3308
3334
  # @param [String] order_by
3309
3335
  # Field by which to sort the list. Acceptable values are: * `displayName` (
3310
3336
  # default) * `state` The default sorting order is ascending. To specify
@@ -3708,11 +3734,13 @@ module Google
3708
3734
  # negative keywords belong.
3709
3735
  # @param [String] filter
3710
3736
  # Allows filtering by negative keyword fields. Supported syntax: * Filter
3711
- # expressions for negative keyword currently can only contain at most one *
3712
- # restriction. * A restriction has the form of ``field` `operator` `value``. *
3713
- # The operator must be `CONTAINS (:)`. * Supported fields: - `keywordValue`
3714
- # Examples: * All negative keywords for which the keyword value contains "google"
3715
- # : `keywordValue : "google"`
3737
+ # expressions for negative keywords can only contain at most one restriction. *
3738
+ # A restriction has the form of ``field` `operator` `value``. * All fields must
3739
+ # use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All
3740
+ # negative keywords for which the keyword value contains "google": `keywordValue
3741
+ # : "google"` The length of this field should be no more than 500 characters.
3742
+ # Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
3743
+ # filters) guide for more information.
3716
3744
  # @param [String] order_by
3717
3745
  # Field by which to sort the list. Acceptable values are: * `keywordValue` (
3718
3746
  # default) The default sorting order is ascending. To specify descending order
@@ -3929,13 +3957,15 @@ module Google
3929
3957
  # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` *
3930
3958
  # `TARGETING_TYPE_YOUTUBE_CHANNEL`
3931
3959
  # @param [String] filter
3932
- # Allows filtering by assigned targeting option properties. Supported syntax: *
3960
+ # Allows filtering by assigned targeting option fields. Supported syntax: *
3933
3961
  # Filter expressions are made up of one or more restrictions. * Restrictions can
3934
- # be combined by the logical operator `OR`. * A restriction has the form of ``
3935
- # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
3936
- # fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with
3937
- # ID 123456 `assignedTargetingOptionId="123456"` The length of this field should
3938
- # be no more than 500 characters.
3962
+ # be combined by the `OR` logical operator. * A restriction has the form of ``
3963
+ # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
3964
+ # Supported fields: * `assignedTargetingOptionId` Examples: * `
3965
+ # AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"`
3966
+ # The length of this field should be no more than 500 characters. Reference our [
3967
+ # filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
3968
+ # more information.
3939
3969
  # @param [String] order_by
3940
3970
  # Field by which to sort the list. Acceptable values are: * `
3941
3971
  # assignedTargetingOptionId` (default) The default sorting order is ascending.
@@ -4021,15 +4051,16 @@ module Google
4021
4051
  # @param [String] filter
4022
4052
  # Allows filtering by custom YouTube ad group ad fields. Supported syntax: *
4023
4053
  # Filter expressions are made up of one or more restrictions. * Restrictions can
4024
- # be combined by `AND` and `OR`. Only the restrictions for * the same field can
4025
- # be combined by `OR`. A sequence of restrictions * implicitly uses `AND`. * A
4026
- # restriction has the form of ``field` `operator` `value``. * The operator must
4027
- # be `EQUALS (=)`. * Supported properties: - `adGroupId` - `displayName` - `
4028
- # entityStatus` - `adGroupAdId` Examples: * All ad group ads under an ad group: `
4029
- # adGroupId="1234"` and its * entityStatus is `ENTITY_STATUS_ACTIVE` or `
4030
- # ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="
4031
- # ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should
4032
- # be no more than 500 characters.
4054
+ # be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`
4055
+ # . * A restriction has the form of ``field` `operator` `value``. * All fields
4056
+ # must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `
4057
+ # displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads
4058
+ # under an ad group: `adGroupId="1234"` * All ad group ads under an ad group
4059
+ # with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(
4060
+ # entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
4061
+ # AND adGroupId="12345"` The length of this field should be no more than 500
4062
+ # characters. Reference our [filter `LIST` requests](/display-video/api/guides/
4063
+ # how-tos/filters) guide for more information.
4033
4064
  # @param [String] order_by
4034
4065
  # Field by which to sort the list. Acceptable values are: * `displayName` (
4035
4066
  # default) * `entityStatus` The default sorting order is ascending. To specify
@@ -4080,15 +4111,16 @@ module Google
4080
4111
  # @param [Fixnum] advertiser_id
4081
4112
  # Required. The ID of the advertiser the line items belongs to.
4082
4113
  # @param [String] filter
4083
- # Allows filtering by assigned targeting option properties. Supported syntax: *
4114
+ # Allows filtering by assigned targeting option fields. Supported syntax: *
4084
4115
  # Filter expressions are made up of one or more restrictions. * Restrictions can
4085
- # be combined by the logical operator `OR` on the same field. * A restriction
4086
- # has the form of ``field` `operator` `value``. * The operator must be `EQUALS (=
4087
- # )`. * Supported fields: - `targetingType` Examples: * AssignedTargetingOptions
4088
- # of targeting type TARGETING_TYPE_YOUTUBE_VIDEO or
4089
- # TARGETING_TYPE_YOUTUBE_CHANNEL `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO"
4116
+ # be combined by the logical operator `OR`. * A restriction has the form of ``
4117
+ # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
4118
+ # Supported fields: * `targetingType` Examples: * `AssignedTargetingOption`
4119
+ # resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `
4120
+ # TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO"
4090
4121
  # OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field
4091
- # should be no more than 500 characters.
4122
+ # should be no more than 500 characters. Reference our [filter `LIST` requests](/
4123
+ # display-video/api/guides/how-tos/filters) guide for more information.
4092
4124
  # @param [String] order_by
4093
4125
  # Field by which to sort the list. Acceptable values are: * `youtubeAdGroupId` (
4094
4126
  # default) * `assignedTargetingOption.targetingType` The default sorting order
@@ -4177,17 +4209,17 @@ module Google
4177
4209
  # @param [String] filter
4178
4210
  # Allows filtering by custom YouTube ad group fields. Supported syntax: * Filter
4179
4211
  # expressions are made up of one or more restrictions. * Restrictions can be
4180
- # combined by `AND` and `OR`. Only the restrictions for * the same field can be
4181
- # combined by `OR`. A sequence of restrictions * implicitly uses `AND`. * A
4182
- # restriction has the form of ``field` `operator` `value``. * The operator must
4183
- # be `EQUALS (=)`. * Supported properties: - `adGroupId` - `displayName` - `
4184
- # entityStatus` - `lineItemId` - `adGroupFormat` Examples: * All ad groups under
4185
- # an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `
4186
- # ENTITY_STATUS_PAUSED` and `YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM` ad
4212
+ # combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. *
4213
+ # A restriction has the form of ``field` `operator` `value``. * All fields must
4214
+ # use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `
4215
+ # displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All
4216
+ # ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE`
4217
+ # or `ENTITY_STATUS_PAUSED` `YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM` ad
4187
4218
  # groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR
4188
4219
  # entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="
4189
4220
  # YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"` The length of this field
4190
- # should be no more than 500 characters.
4221
+ # should be no more than 500 characters. Reference our [filter `LIST` requests](/
4222
+ # display-video/api/guides/how-tos/filters) guide for more information.
4191
4223
  # @param [String] order_by
4192
4224
  # Field by which to sort the list. Acceptable values are: * `displayName` (
4193
4225
  # default) * `entityStatus` The default sorting order is ascending. To specify
@@ -4297,13 +4329,15 @@ module Google
4297
4329
  # TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `
4298
4330
  # TARGETING_TYPE_YOUTUBE_VIDEO`
4299
4331
  # @param [String] filter
4300
- # Allows filtering by assigned targeting option properties. Supported syntax: *
4332
+ # Allows filtering by assigned targeting option fields. Supported syntax: *
4301
4333
  # Filter expressions are made up of one or more restrictions. * Restrictions can
4302
4334
  # be combined by the logical operator `OR`. * A restriction has the form of ``
4303
- # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
4304
- # fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOptions
4305
- # with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"`
4306
- # The length of this field should be no more than 500 characters.
4335
+ # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
4336
+ # Supported fields: * `assignedTargetingOptionId` Examples: * `
4337
+ # AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="
4338
+ # 1" OR assignedTargetingOptionId="2"` The length of this field should be no
4339
+ # more than 500 characters. Reference our [filter `LIST` requests](/display-
4340
+ # video/api/guides/how-tos/filters) guide for more information.
4307
4341
  # @param [String] order_by
4308
4342
  # Field by which to sort the list. Acceptable values are: * `
4309
4343
  # assignedTargetingOptionId` (default) The default sorting order is ascending.
@@ -4392,12 +4426,13 @@ module Google
4392
4426
  # The ID of the advertiser that has access to the fetched combined audiences.
4393
4427
  # @param [String] filter
4394
4428
  # Allows filtering by combined audience fields. Supported syntax: * Filter
4395
- # expressions for combined audiences currently can only contain at most one
4396
- # restriction. * A restriction has the form of ``field` `operator` `value``. *
4397
- # The operator must be `CONTAINS (:)`. * Supported fields: - `displayName`
4398
- # Examples: * All combined audiences for which the display name contains "Google"
4399
- # : `displayName : "Google"`. The length of this field should be no more than
4400
- # 500 characters.
4429
+ # expressions for combined audiences can only contain at most one restriction. *
4430
+ # A restriction has the form of ``field` `operator` `value``. * All fields must
4431
+ # use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All
4432
+ # combined audiences for which the display name contains "Google": `displayName :
4433
+ # "Google"`. The length of this field should be no more than 500 characters.
4434
+ # Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
4435
+ # filters) guide for more information.
4401
4436
  # @param [String] order_by
4402
4437
  # Field by which to sort the list. Acceptable values are: * `combinedAudienceId`
4403
4438
  # (default) * `displayName` The default sorting order is ascending. To specify
@@ -4521,18 +4556,17 @@ module Google
4521
4556
  # @param [String] filter
4522
4557
  # Allows filtering by custom bidding algorithm fields. Supported syntax: *
4523
4558
  # Filter expressions are made up of one or more restrictions. * Restrictions can
4524
- # be combined by `AND`. A sequence of restrictions * implicitly uses `AND`. * A
4525
- # restriction has the form of ``field` `operator` `value``. * The operator must
4526
- # be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for
4527
- # the following field: - `displayName` * The operator must be `EQUALS (=)` for
4528
- # the following field: - `customBiddingAlgorithmType` * For `displayName`, the
4529
- # value is a string. We return all custom bidding algorithms whose display_name
4530
- # contains such string. * For `customBiddingAlgorithmType`, the value is a
4531
- # string. We return all algorithms whose custom_bidding_algorithm_type is equal
4532
- # to the given type. Examples: * All custom bidding algorithms for which the
4533
- # display name contains "politics": `displayName:politics`. * All custom bidding
4534
- # algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=
4535
- # SCRIPT_BASED` The length of this field should be no more than 500 characters.
4559
+ # be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A
4560
+ # restriction has the form of ``field` `operator` `value``. * The `
4561
+ # customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `
4562
+ # displayName` field must use the `HAS (:)` operator. Supported fields: * `
4563
+ # customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding
4564
+ # algorithms for which the display name contains "politics": `displayName:"
4565
+ # politics"`. * All custom bidding algorithms for which the type is "
4566
+ # SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this
4567
+ # field should be no more than 500 characters. Reference our [filter `LIST`
4568
+ # requests](/display-video/api/guides/how-tos/filters) guide for more
4569
+ # information.
4536
4570
  # @param [String] order_by
4537
4571
  # Field by which to sort the list. Acceptable values are: * `displayName` (
4538
4572
  # default) The default sorting order is ascending. To specify descending order
@@ -4832,11 +4866,13 @@ module Google
4832
4866
  # The ID of the DV360 advertiser that has access to the fetched custom lists.
4833
4867
  # @param [String] filter
4834
4868
  # Allows filtering by custom list fields. Supported syntax: * Filter expressions
4835
- # for custom lists currently can only contain at most one restriction. * A
4836
- # restriction has the form of ``field` `operator` `value``. * The operator must
4837
- # be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom
4838
- # lists for which the display name contains "Google": `displayName : "Google"`.
4839
- # The length of this field should be no more than 500 characters.
4869
+ # for custom lists can only contain at most one restriction. * A restriction has
4870
+ # the form of ``field` `operator` `value``. * All fields must use the `HAS (:)`
4871
+ # operator. Supported fields: * `displayName` Examples: * All custom lists for
4872
+ # which the display name contains "Google": `displayName:"Google"`. The length
4873
+ # of this field should be no more than 500 characters. Reference our [filter `
4874
+ # LIST` requests](/display-video/api/guides/how-tos/filters) guide for more
4875
+ # information.
4840
4876
  # @param [String] order_by
4841
4877
  # Field by which to sort the list. Acceptable values are: * `customListId` (
4842
4878
  # default) * `displayName` The default sorting order is ascending. To specify
@@ -4998,12 +5034,14 @@ module Google
4998
5034
  # audiences.
4999
5035
  # @param [String] filter
5000
5036
  # Allows filtering by first and third party audience fields. Supported syntax: *
5001
- # Filter expressions for first and third party audiences currently can only
5002
- # contain at most one restriction. * A restriction has the form of ``field` `
5003
- # operator` `value``. * The operator must be `CONTAINS (:)`. * Supported fields:
5004
- # - `displayName` Examples: * All first and third party audiences for which the
5005
- # display name contains "Google": `displayName : "Google"`. The length of this
5006
- # field should be no more than 500 characters.
5037
+ # Filter expressions for first and third party audiences can only contain at
5038
+ # most one restriction. * A restriction has the form of ``field` `operator` `
5039
+ # value``. * All fields must use the `HAS (:)` operator. Supported fields: * `
5040
+ # displayName` Examples: * All first and third party audiences for which the
5041
+ # display name contains "Google": `displayName:"Google"`. The length of this
5042
+ # field should be no more than 500 characters. Reference our [filter `LIST`
5043
+ # requests](/display-video/api/guides/how-tos/filters) guide for more
5044
+ # information.
5007
5045
  # @param [String] order_by
5008
5046
  # Field by which to sort the list. Acceptable values are: * `
5009
5047
  # firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting
@@ -5212,12 +5250,13 @@ module Google
5212
5250
  # The ID of the advertiser that has access to the fetched Google audiences.
5213
5251
  # @param [String] filter
5214
5252
  # Allows filtering by Google audience fields. Supported syntax: * Filter
5215
- # expressions for Google audiences currently can only contain at most one
5216
- # restriction. * A restriction has the form of ``field` `operator` `value``. *
5217
- # The operator must be `CONTAINS (:)`. * Supported fields: - `displayName`
5218
- # Examples: * All Google audiences for which the display name contains "Google":
5219
- # `displayName : "Google"`. The length of this field should be no more than 500
5220
- # characters.
5253
+ # expressions for Google audiences can only contain at most one restriction. * A
5254
+ # restriction has the form of ``field` `operator` `value``. * All fields must
5255
+ # use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All
5256
+ # Google audiences for which the display name contains "Google": `displayName:"
5257
+ # Google"`. The length of this field should be no more than 500 characters.
5258
+ # Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
5259
+ # filters) guide for more information.
5221
5260
  # @param [String] order_by
5222
5261
  # Field by which to sort the list. Acceptable values are: * `googleAudienceId` (
5223
5262
  # default) * `displayName` The default sorting order is ascending. To specify
@@ -5381,16 +5420,18 @@ module Google
5381
5420
  # @param [Fixnum] advertiser_id
5382
5421
  # The ID of the advertiser that has access to the guaranteed order.
5383
5422
  # @param [String] filter
5384
- # Allows filtering by guaranteed order properties. * Filter expressions are made
5385
- # up of one or more restrictions. * Restrictions can be combined by `AND` or `OR`
5423
+ # Allows filtering by guaranteed order fields. * Filter expressions are made up
5424
+ # of one or more restrictions. * Restrictions can be combined by `AND` or `OR`
5386
5425
  # logical operators. A sequence of restrictions implicitly uses `AND`. * A
5387
- # restriction has the form of ``field` `operator` `value``. * The operator must
5388
- # be `EQUALS (=)`. * Supported fields: - `guaranteed_order_id` - `exchange` - `
5389
- # display_name` - `status.entityStatus` Examples: * All active guaranteed orders:
5390
- # `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to
5391
- # Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER"
5392
- # OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more
5393
- # than 500 characters.
5426
+ # restriction has the form of ``field` `operator` `value``. * All fields must
5427
+ # use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `
5428
+ # exchange` * `display_name` * `status.entityStatus` Examples: * All active
5429
+ # guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed
5430
+ # orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="
5431
+ # EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this
5432
+ # field should be no more than 500 characters. Reference our [filter `LIST`
5433
+ # requests](/display-video/api/guides/how-tos/filters) guide for more
5434
+ # information.
5394
5435
  # @param [String] order_by
5395
5436
  # Field by which to sort the list. Acceptable values are: * `displayName` (
5396
5437
  # default) The default sorting order is ascending. To specify descending order
@@ -5606,12 +5647,13 @@ module Google
5606
5647
  # inventory source group is partner-owned, only advertisers to which the group
5607
5648
  # is explicitly shared can access the group.
5608
5649
  # @param [String] filter
5609
- # Allows filtering by inventory source group properties. Supported syntax: *
5610
- # Filter expressions are made up of one or more restrictions. * Restrictions can
5611
- # be combined by the logical operator `OR`. * A restriction has the form of ``
5612
- # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
5613
- # fields: - `inventorySourceGroupId` The length of this field should be no more
5614
- # than 500 characters.
5650
+ # Allows filtering by inventory source group fields. Supported syntax: * Filter
5651
+ # expressions are made up of one or more restrictions. * Restrictions can be
5652
+ # combined by the logical operator `OR`. * A restriction has the form of ``field`
5653
+ # `operator` `value``. * All fields must use the `EQUALS (=)` operator.
5654
+ # Supported fields: * `inventorySourceGroupId` The length of this field should
5655
+ # be no more than 500 characters. Reference our [filter `LIST` requests](/
5656
+ # display-video/api/guides/how-tos/filters) guide for more information.
5615
5657
  # @param [String] order_by
5616
5658
  # Field by which to sort the list. Acceptable values are: * `displayName` (
5617
5659
  # default) * `inventorySourceGroupId` The default sorting order is ascending. To
@@ -5842,10 +5884,11 @@ module Google
5842
5884
  # @param [String] filter
5843
5885
  # Allows filtering by assigned inventory source fields. Supported syntax: *
5844
5886
  # Filter expressions are made up of one or more restrictions. * Restrictions can
5845
- # be combined by the logical operator `OR`. * A restriction has the form of ``
5846
- # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
5847
- # fields: - `assignedInventorySourceId` The length of this field should be no
5848
- # more than 500 characters.
5887
+ # be combined by the `OR` logical operator. * A restriction has the form of ``
5888
+ # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
5889
+ # Supported fields: * `assignedInventorySourceId` The length of this field
5890
+ # should be no more than 500 characters. Reference our [filter `LIST` requests](/
5891
+ # display-video/api/guides/how-tos/filters) guide for more information.
5849
5892
  # @param [String] order_by
5850
5893
  # Field by which to sort the list. Acceptable values are: * `
5851
5894
  # assignedInventorySourceId` (default) The default sorting order is ascending.
@@ -6009,17 +6052,18 @@ module Google
6009
6052
  # @param [Fixnum] advertiser_id
6010
6053
  # The ID of the advertiser that has access to the inventory source.
6011
6054
  # @param [String] filter
6012
- # Allows filtering by inventory source properties. Supported syntax: * Filter
6055
+ # Allows filtering by inventory source fields. Supported syntax: * Filter
6013
6056
  # expressions are made up of one or more restrictions. * Restrictions can be
6014
6057
  # combined by `AND` or `OR` logical operators. A sequence of restrictions
6015
6058
  # implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
6016
- # value``. * The operator must be `EQUALS (=)`. * Supported fields: - `status.
6017
- # entityStatus` - `commitment` - `deliveryMethod` - `rateDetails.rateType` - `
6018
- # exchange` Examples: * All active inventory sources: `status.entityStatus="
6059
+ # value``. * All fields must use the `EQUALS (=)` operator. Supported fields: * `
6060
+ # status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType`
6061
+ # * `exchange` Examples: * All active inventory sources: `status.entityStatus="
6019
6062
  # ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or
6020
6063
  # Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="
6021
6064
  # EXCHANGE_RUBICON"` The length of this field should be no more than 500
6022
- # characters.
6065
+ # characters. Reference our [filter `LIST` requests](/display-video/api/guides/
6066
+ # how-tos/filters) guide for more information.
6023
6067
  # @param [String] order_by
6024
6068
  # Field by which to sort the list. Acceptable values are: * `displayName` (
6025
6069
  # default) The default sorting order is ascending. To specify descending order
@@ -6264,13 +6308,15 @@ module Google
6264
6308
  # Lists partners that are accessible to the current user. The order is defined
6265
6309
  # by the order_by parameter.
6266
6310
  # @param [String] filter
6267
- # Allows filtering by partner properties. Supported syntax: * Filter expressions
6268
- # are made up of one or more restrictions. * Restrictions can be combined by `
6269
- # AND` or `OR` logical operators. A sequence of restrictions implicitly uses `
6270
- # AND`. * A restriction has the form of ``field` `operator` `value``. * The
6271
- # operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: *
6311
+ # Allows filtering by partner fields. Supported syntax: * Filter expressions are
6312
+ # made up of one or more restrictions. * Restrictions can be combined by `AND`
6313
+ # or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. *
6314
+ # A restriction has the form of ``field` `operator` `value``. * All fields must
6315
+ # use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: *
6272
6316
  # All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this
6273
- # field should be no more than 500 characters.
6317
+ # field should be no more than 500 characters. Reference our [filter `LIST`
6318
+ # requests](/display-video/api/guides/how-tos/filters) guide for more
6319
+ # information.
6274
6320
  # @param [String] order_by
6275
6321
  # Field by which to sort the list. Acceptable values are: * `displayName` The
6276
6322
  # default sorting order is ascending. To specify descending order for a field, a
@@ -6393,11 +6439,13 @@ module Google
6393
6439
  # The ID of the advertiser that owns the channels.
6394
6440
  # @param [String] filter
6395
6441
  # Allows filtering by channel fields. Supported syntax: * Filter expressions for
6396
- # channel currently can only contain at most one * restriction. * A restriction
6397
- # has the form of ``field` `operator` `value``. * The operator must be `CONTAINS
6398
- # (:)`. * Supported fields: - `displayName` Examples: * All channels for which
6399
- # the display name contains "google": `displayName : "google"`. The length of
6400
- # this field should be no more than 500 characters.
6442
+ # channel can only contain at most one restriction. * A restriction has the form
6443
+ # of ``field` `operator` `value``. * All fields must use the `HAS (:)` operator.
6444
+ # Supported fields: * `displayName` Examples: * All channels for which the
6445
+ # display name contains "google": `displayName : "google"`. The length of this
6446
+ # field should be no more than 500 characters. Reference our [filter `LIST`
6447
+ # requests](/display-video/api/guides/how-tos/filters) guide for more
6448
+ # information.
6401
6449
  # @param [String] order_by
6402
6450
  # Field by which to sort the list. Acceptable values are: * `displayName` (
6403
6451
  # default) * `channelId` The default sorting order is ascending. To specify
@@ -6611,10 +6659,13 @@ module Google
6611
6659
  # The ID of the advertiser that owns the parent channel.
6612
6660
  # @param [String] filter
6613
6661
  # Allows filtering by site fields. Supported syntax: * Filter expressions for
6614
- # site currently can only contain at most one * restriction. * A restriction has
6615
- # the form of ``field` `operator` `value``. * The operator must be `CONTAINS (:)`
6616
- # . * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL
6617
- # or app ID contains "google": `urlOrAppId : "google"`
6662
+ # site retrieval can only contain at most one restriction. * A restriction has
6663
+ # the form of ``field` `operator` `value``. * All fields must use the `HAS (:)`
6664
+ # operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the
6665
+ # URL or app ID contains "google": `urlOrAppId : "google"` The length of this
6666
+ # field should be no more than 500 characters. Reference our [filter `LIST`
6667
+ # requests](/display-video/api/guides/how-tos/filters) guide for more
6668
+ # information.
6618
6669
  # @param [String] order_by
6619
6670
  # Field by which to sort the list. Acceptable values are: * `urlOrAppId` (
6620
6671
  # default) The default sorting order is ascending. To specify descending order
@@ -6820,13 +6871,15 @@ module Google
6820
6871
  # Required. Identifies the type of assigned targeting options to list. Supported
6821
6872
  # targeting types: * `TARGETING_TYPE_CHANNEL`
6822
6873
  # @param [String] filter
6823
- # Allows filtering by assigned targeting option properties. Supported syntax: *
6874
+ # Allows filtering by assigned targeting option fields. Supported syntax: *
6824
6875
  # Filter expressions are made up of one or more restrictions. * Restrictions can
6825
6876
  # be combined by the logical operator `OR`. * A restriction has the form of ``
6826
- # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported
6827
- # fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with
6828
- # ID 123456 `assignedTargetingOptionId="123456"` The length of this field should
6829
- # be no more than 500 characters.
6877
+ # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
6878
+ # Supported fields: * `assignedTargetingOptionId` Examples: * `
6879
+ # AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="
6880
+ # 123456"` The length of this field should be no more than 500 characters.
6881
+ # Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
6882
+ # filters) guide for more information.
6830
6883
  # @param [String] order_by
6831
6884
  # Field by which to sort the list. Acceptable values are: * `
6832
6885
  # assignedTargetingOptionId` (default) The default sorting order is ascending.
@@ -7012,18 +7065,20 @@ module Google
7012
7065
  # @param [Fixnum] advertiser_id
7013
7066
  # Required. The Advertiser this request is being made in the context of.
7014
7067
  # @param [String] filter
7015
- # Allows filtering by targeting option properties. Supported syntax: * Filter
7068
+ # Allows filtering by targeting option fields. Supported syntax: * Filter
7016
7069
  # expressions are made up of one or more restrictions. * Restrictions can be
7017
7070
  # combined by `OR` logical operators. * A restriction has the form of ``field` `
7018
- # operator` `value``. * The operator must be "=" (equal sign). * Supported
7019
- # fields: - `carrierAndIspDetails.type` - `geoRegionDetails.geoRegionType` - `
7071
+ # operator` `value``. * All fields must use the `EQUALS (=)` operator. Supported
7072
+ # fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `
7020
7073
  # targetingOptionId` Examples: * All `GEO REGION` targeting options that belong
7021
7074
  # to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `
7022
7075
  # geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.
7023
7076
  # geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting
7024
7077
  # options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `
7025
- # carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"`. The length of this
7026
- # field should be no more than 500 characters.
7078
+ # carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this
7079
+ # field should be no more than 500 characters. Reference our [filter `LIST`
7080
+ # requests](/display-video/api/guides/how-tos/filters) guide for more
7081
+ # information.
7027
7082
  # @param [String] order_by
7028
7083
  # Field by which to sort the list. Acceptable values are: * `targetingOptionId` (
7029
7084
  # default) The default sorting order is ascending. To specify descending order
@@ -7108,7 +7163,10 @@ module Google
7108
7163
  # Bulk edits user roles for a user. The operation will delete the assigned user
7109
7164
  # roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles
7110
7165
  # and then assign the user roles provided in BulkEditAssignedUserRolesRequest.
7111
- # createdAssignedUserRoles.
7166
+ # createdAssignedUserRoles. This method has unique authentication requirements.
7167
+ # Read the prerequisites in our [Managing Users guide](/display-video/api/guides/
7168
+ # users/overview#prerequisites) before using this method. The "Try this method"
7169
+ # feature does not work for this method.
7112
7170
  # @param [Fixnum] user_id
7113
7171
  # Required. The ID of the user to which the assigned user roles belong.
7114
7172
  # @param [Google::Apis::DisplayvideoV2::BulkEditAssignedUserRolesRequest] bulk_edit_assigned_user_roles_request_object
@@ -7141,7 +7199,11 @@ module Google
7141
7199
  execute_or_queue_command(command, &block)
7142
7200
  end
7143
7201
 
7144
- # Creates a new user. Returns the newly created user if successful.
7202
+ # Creates a new user. Returns the newly created user if successful. This method
7203
+ # has unique authentication requirements. Read the prerequisites in our [
7204
+ # Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
7205
+ # before using this method. The "Try this method" feature does not work for this
7206
+ # method.
7145
7207
  # @param [Google::Apis::DisplayvideoV2::User] user_object
7146
7208
  # @param [String] fields
7147
7209
  # Selector specifying which fields to include in a partial response.
@@ -7171,7 +7233,10 @@ module Google
7171
7233
  execute_or_queue_command(command, &block)
7172
7234
  end
7173
7235
 
7174
- # Deletes a user.
7236
+ # Deletes a user. This method has unique authentication requirements. Read the
7237
+ # prerequisites in our [Managing Users guide](/display-video/api/guides/users/
7238
+ # overview#prerequisites) before using this method. The "Try this method"
7239
+ # feature does not work for this method.
7175
7240
  # @param [Fixnum] user_id
7176
7241
  # Required. The ID of the user to delete.
7177
7242
  # @param [String] fields
@@ -7201,7 +7266,10 @@ module Google
7201
7266
  execute_or_queue_command(command, &block)
7202
7267
  end
7203
7268
 
7204
- # Gets a user.
7269
+ # Gets a user. This method has unique authentication requirements. Read the
7270
+ # prerequisites in our [Managing Users guide](/display-video/api/guides/users/
7271
+ # overview#prerequisites) before using this method. The "Try this method"
7272
+ # feature does not work for this method.
7205
7273
  # @param [Fixnum] user_id
7206
7274
  # Required. The ID of the user to fetch.
7207
7275
  # @param [String] fields
@@ -7232,29 +7300,35 @@ module Google
7232
7300
  end
7233
7301
 
7234
7302
  # 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.
7303
+ # roles on the same partner or advertiser, they can access each other. This
7304
+ # method has unique authentication requirements. Read the prerequisites in our [
7305
+ # Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
7306
+ # before using this method. The "Try this method" feature does not work for this
7307
+ # method.
7236
7308
  # @param [String] filter
7237
- # Allows filtering by user properties. Supported syntax: * Filter expressions
7238
- # are made up of one or more restrictions. * Restrictions can be combined by the
7309
+ # Allows filtering by user fields. Supported syntax: * Filter expressions are
7310
+ # made up of one or more restrictions. * Restrictions can be combined by the
7239
7311
  # logical operator `AND`. * A restriction has the form of ``field` `operator` `
7240
- # value``. * The operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator
7241
- # must be `CONTAINS (:)` for the following fields: - `displayName` - `email` *
7242
- # The operator must be `EQUALS (=)` for the following fields: - `
7243
- # assignedUserRole.userRole` - `assignedUserRole.partnerId` - `assignedUserRole.
7244
- # advertiserId` - `assignedUserRole.entityType`: A synthetic field of
7245
- # AssignedUserRole used for filtering. Identifies the type of entity to which
7246
- # the user role is assigned. Valid values are `Partner` and `Advertiser`. - `
7247
- # assignedUserRole.parentPartnerId`: A synthetic field of AssignedUserRole used
7248
- # for filtering. Identifies the parent partner of the entity to which the user
7249
- # role is assigned." Examples: * The user with displayName containing `foo`: `
7250
- # displayName:"foo"` * The user with email containing `bar`: `email:"bar"` * All
7251
- # users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All
7252
- # users with user roles for partner 123: `assignedUserRole.partnerId="123"` *
7253
- # All users with user roles for advertiser 123: `assignedUserRole.advertiserId="
7254
- # 123"` * All users with partner level user roles: `entityType="PARTNER"` * All
7255
- # users with user roles for partner 123 and advertisers under partner 123: `
7312
+ # value``. * The `budget.budget_segments.date_range.end_date` field must use the
7313
+ # `LESS THAN (<)` operator. * The `displayName and `email` field must use the `
7314
+ # HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator.
7315
+ # Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.
7316
+ # entityType` * This is synthetic field of `AssignedUserRole` used for filtering.
7317
+ # Identifies the type of entity to which the user role is assigned. Valid
7318
+ # values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId` *
7319
+ # This is a synthetic field of `AssignedUserRole` used for filtering. Identifies
7320
+ # the parent partner of the entity to which the user role is assigned. * `
7321
+ # assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `
7322
+ # email` Examples: * The user with `displayName` containing "foo": `displayName:"
7323
+ # foo"` * The user with `email` containing "bar": `email:"bar"` * All users with
7324
+ # standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with
7325
+ # user roles for partner 123: `assignedUserRole.partnerId="123"` * All users
7326
+ # with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` *
7327
+ # All users with partner level user roles: `entityType="PARTNER"` * All users
7328
+ # with user roles for partner 123 and advertisers under partner 123: `
7256
7329
  # parentPartnerId="123"` The length of this field should be no more than 500
7257
- # characters.
7330
+ # characters. Reference our [filter `LIST` requests](/display-video/api/guides/
7331
+ # how-tos/filters) guide for more information.
7258
7332
  # @param [String] order_by
7259
7333
  # Field by which to sort the list. Acceptable values are: * `displayName` (
7260
7334
  # default) The default sorting order is ascending. To specify descending order
@@ -7298,7 +7372,11 @@ module Google
7298
7372
  execute_or_queue_command(command, &block)
7299
7373
  end
7300
7374
 
7301
- # Updates an existing user. Returns the updated user if successful.
7375
+ # Updates an existing user. Returns the updated user if successful. This method
7376
+ # has unique authentication requirements. Read the prerequisites in our [
7377
+ # Managing Users guide](/display-video/api/guides/users/overview#prerequisites)
7378
+ # before using this method. The "Try this method" feature does not work for this
7379
+ # method.
7302
7380
  # @param [Fixnum] user_id
7303
7381
  # Output only. The unique ID of the user. Assigned by the system.
7304
7382
  # @param [Google::Apis::DisplayvideoV2::User] user_object