google-apis-displayvideo_v2 0.42.0 → 0.43.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -603,71 +603,6 @@ module Google
603
603
  execute_or_queue_command(command, &block)
604
604
  end
605
605
 
606
- # Lists assigned targeting options of a campaign across targeting types.
607
- # @param [Fixnum] advertiser_id
608
- # Required. The ID of the advertiser the campaign belongs to.
609
- # @param [Fixnum] campaign_id
610
- # Required. The ID of the campaign to list assigned targeting options for.
611
- # @param [String] filter
612
- # Allows filtering by assigned targeting option fields. Supported syntax: *
613
- # Filter expressions are made up of one or more restrictions. * Restrictions can
614
- # be combined by the `OR` logical operator. * A restriction has the form of ``
615
- # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
616
- # Supported fields: * `targetingType` * `inheritance` Examples: * `
617
- # AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE`
618
- # or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR
619
- # targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources
620
- # with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
621
- # inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
622
- # length of this field should be no more than 500 characters. Reference our [
623
- # filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
624
- # more information.
625
- # @param [String] order_by
626
- # Field by which to sort the list. Acceptable values are: * `targetingType` (
627
- # default) The default sorting order is ascending. To specify descending order
628
- # for a field, a suffix "desc" should be added to the field name. Example: `
629
- # targetingType desc`.
630
- # @param [Fixnum] page_size
631
- # Requested page size. The size must be an integer between `1` and `5000`. If
632
- # unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if
633
- # an invalid value is specified.
634
- # @param [String] page_token
635
- # A token that lets the client fetch the next page of results. Typically, this
636
- # is the value of next_page_token returned from the previous call to `
637
- # BulkListCampaignAssignedTargetingOptions` method. If not specified, the first
638
- # page of results will be returned.
639
- # @param [String] fields
640
- # Selector specifying which fields to include in a partial response.
641
- # @param [String] quota_user
642
- # Available to use for quota purposes for server-side applications. Can be any
643
- # arbitrary string assigned to a user, but should not exceed 40 characters.
644
- # @param [Google::Apis::RequestOptions] options
645
- # Request-specific options
646
- #
647
- # @yield [result, err] Result & error if block supplied
648
- # @yieldparam result [Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse] parsed result object
649
- # @yieldparam err [StandardError] error object if request failed
650
- #
651
- # @return [Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse]
652
- #
653
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
654
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
655
- # @raise [Google::Apis::AuthorizationError] Authorization is required
656
- def list_advertiser_campaign_assigned_targeting_options(advertiser_id, campaign_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
657
- command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions', options)
658
- command.response_representation = Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse::Representation
659
- command.response_class = Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse
660
- command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
661
- command.params['campaignId'] = campaign_id unless campaign_id.nil?
662
- command.query['filter'] = filter unless filter.nil?
663
- command.query['orderBy'] = order_by unless order_by.nil?
664
- command.query['pageSize'] = page_size unless page_size.nil?
665
- command.query['pageToken'] = page_token unless page_token.nil?
666
- command.query['fields'] = fields unless fields.nil?
667
- command.query['quotaUser'] = quota_user unless quota_user.nil?
668
- execute_or_queue_command(command, &block)
669
- end
670
-
671
606
  # Updates an existing campaign. Returns the updated campaign if successful.
672
607
  # @param [Fixnum] advertiser_id
673
608
  # Output only. The unique ID of the advertiser the campaign belongs to.
@@ -707,138 +642,6 @@ module Google
707
642
  execute_or_queue_command(command, &block)
708
643
  end
709
644
 
710
- # Gets a single targeting option assigned to a campaign.
711
- # @param [Fixnum] advertiser_id
712
- # Required. The ID of the advertiser the campaign belongs to.
713
- # @param [Fixnum] campaign_id
714
- # Required. The ID of the campaign the assigned targeting option belongs to.
715
- # @param [String] targeting_type
716
- # Required. Identifies the type of this assigned targeting option. Supported
717
- # targeting types: * `TARGETING_TYPE_AGE_RANGE` * `
718
- # TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `
719
- # TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
720
- # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
721
- # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
722
- # * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
723
- # TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
724
- # TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
725
- # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `
726
- # TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
727
- # * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `
728
- # TARGETING_TYPE_VIEWABILITY`
729
- # @param [String] assigned_targeting_option_id
730
- # Required. An identifier unique to the targeting type in this campaign that
731
- # identifies the assigned targeting option being requested.
732
- # @param [String] fields
733
- # Selector specifying which fields to include in a partial response.
734
- # @param [String] quota_user
735
- # Available to use for quota purposes for server-side applications. Can be any
736
- # arbitrary string assigned to a user, but should not exceed 40 characters.
737
- # @param [Google::Apis::RequestOptions] options
738
- # Request-specific options
739
- #
740
- # @yield [result, err] Result & error if block supplied
741
- # @yieldparam result [Google::Apis::DisplayvideoV2::AssignedTargetingOption] parsed result object
742
- # @yieldparam err [StandardError] error object if request failed
743
- #
744
- # @return [Google::Apis::DisplayvideoV2::AssignedTargetingOption]
745
- #
746
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
747
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
748
- # @raise [Google::Apis::AuthorizationError] Authorization is required
749
- def get_advertiser_campaign_targeting_type_assigned_targeting_option(advertiser_id, campaign_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
750
- command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
751
- command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
752
- command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
753
- command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
754
- command.params['campaignId'] = campaign_id unless campaign_id.nil?
755
- command.params['targetingType'] = targeting_type unless targeting_type.nil?
756
- command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
757
- command.query['fields'] = fields unless fields.nil?
758
- command.query['quotaUser'] = quota_user unless quota_user.nil?
759
- execute_or_queue_command(command, &block)
760
- end
761
-
762
- # Lists the targeting options assigned to a campaign for a specified targeting
763
- # type.
764
- # @param [Fixnum] advertiser_id
765
- # Required. The ID of the advertiser the campaign belongs to.
766
- # @param [Fixnum] campaign_id
767
- # Required. The ID of the campaign to list assigned targeting options for.
768
- # @param [String] targeting_type
769
- # Required. Identifies the type of assigned targeting options to list. Supported
770
- # targeting types: * `TARGETING_TYPE_AGE_RANGE` * `
771
- # TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `
772
- # TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
773
- # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
774
- # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
775
- # * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
776
- # TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
777
- # TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
778
- # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `
779
- # TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
780
- # * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `
781
- # TARGETING_TYPE_VIEWABILITY`
782
- # @param [String] filter
783
- # Allows filtering by assigned targeting option fields. Supported syntax: *
784
- # Filter expressions are made up of one or more restrictions. * Restrictions can
785
- # be combined by the `OR` logical operator. * A restriction has the form of ``
786
- # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
787
- # Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `
788
- # AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="
789
- # 1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources
790
- # with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `
791
- # inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
792
- # length of this field should be no more than 500 characters. Reference our [
793
- # filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
794
- # more information.
795
- # @param [String] order_by
796
- # Field by which to sort the list. Acceptable values are: * `
797
- # assignedTargetingOptionId` (default) The default sorting order is ascending.
798
- # To specify descending order for a field, a suffix "desc" should be added to
799
- # the field name. Example: `assignedTargetingOptionId desc`.
800
- # @param [Fixnum] page_size
801
- # Requested page size. Must be between `1` and `5000`. If unspecified will
802
- # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
803
- # specified.
804
- # @param [String] page_token
805
- # A token identifying a page of results the server should return. Typically,
806
- # this is the value of next_page_token returned from the previous call to `
807
- # ListCampaignAssignedTargetingOptions` method. If not specified, the first page
808
- # of results will be returned.
809
- # @param [String] fields
810
- # Selector specifying which fields to include in a partial response.
811
- # @param [String] quota_user
812
- # Available to use for quota purposes for server-side applications. Can be any
813
- # arbitrary string assigned to a user, but should not exceed 40 characters.
814
- # @param [Google::Apis::RequestOptions] options
815
- # Request-specific options
816
- #
817
- # @yield [result, err] Result & error if block supplied
818
- # @yieldparam result [Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse] parsed result object
819
- # @yieldparam err [StandardError] error object if request failed
820
- #
821
- # @return [Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse]
822
- #
823
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
824
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
825
- # @raise [Google::Apis::AuthorizationError] Authorization is required
826
- def list_advertiser_campaign_targeting_type_assigned_targeting_options(advertiser_id, campaign_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
827
- command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
828
- command.response_representation = Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse::Representation
829
- command.response_class = Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse
830
- command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
831
- command.params['campaignId'] = campaign_id unless campaign_id.nil?
832
- command.params['targetingType'] = targeting_type unless targeting_type.nil?
833
- command.query['filter'] = filter unless filter.nil?
834
- command.query['orderBy'] = order_by unless order_by.nil?
835
- command.query['pageSize'] = page_size unless page_size.nil?
836
- command.query['pageToken'] = page_token unless page_token.nil?
837
- command.query['fields'] = fields unless fields.nil?
838
- command.query['quotaUser'] = quota_user unless quota_user.nil?
839
- execute_or_queue_command(command, &block)
840
- end
841
-
842
645
  # Creates a new channel. Returns the newly created channel if successful.
843
646
  # @param [Fixnum] advertiser_id
844
647
  # The ID of the advertiser that owns the created channel.
@@ -1571,324 +1374,38 @@ module Google
1571
1374
  # @param [Fixnum] advertiser_id
1572
1375
  # Required. The ID of the advertiser to list insertion orders for.
1573
1376
  # @param [String] filter
1574
- # Allows filtering by insertion order fields. Supported syntax: * Filter
1575
- # expressions are made up of one or more restrictions. * Restrictions can be
1576
- # combined by `AND` or `OR` logical operators. A sequence of restrictions
1577
- # implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
1578
- # value``. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)`
1579
- # or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `
1580
- # EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `
1581
- # entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:
1582
- # SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` *
1583
- # All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an
1584
- # advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="
1585
- # ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than
1586
- # or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-
1587
- # 04T18:54:47Z"` * All insertion orders with an update time greater than or
1588
- # equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-
1589
- # 04T18:54:47Z"` The length of this field should be no more than 500 characters.
1590
- # Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
1591
- # filters) guide for more information.
1592
- # @param [String] order_by
1593
- # Field by which to sort the list. Acceptable values are: * "displayName" (
1594
- # default) * "entityStatus" * "updateTime" The default sorting order is
1595
- # ascending. To specify descending order for a field, a suffix "desc" should be
1596
- # added to the field name. Example: `displayName desc`.
1597
- # @param [Fixnum] page_size
1598
- # Requested page size. Must be between `1` and `100`. If unspecified will
1599
- # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
1600
- # specified.
1601
- # @param [String] page_token
1602
- # A token identifying a page of results the server should return. Typically,
1603
- # this is the value of next_page_token returned from the previous call to `
1604
- # ListInsertionOrders` method. If not specified, the first page of results will
1605
- # be returned.
1606
- # @param [String] fields
1607
- # Selector specifying which fields to include in a partial response.
1608
- # @param [String] quota_user
1609
- # Available to use for quota purposes for server-side applications. Can be any
1610
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1611
- # @param [Google::Apis::RequestOptions] options
1612
- # Request-specific options
1613
- #
1614
- # @yield [result, err] Result & error if block supplied
1615
- # @yieldparam result [Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse] parsed result object
1616
- # @yieldparam err [StandardError] error object if request failed
1617
- #
1618
- # @return [Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse]
1619
- #
1620
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1621
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1622
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1623
- def list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1624
- command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders', options)
1625
- command.response_representation = Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse::Representation
1626
- command.response_class = Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse
1627
- command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1628
- command.query['filter'] = filter unless filter.nil?
1629
- command.query['orderBy'] = order_by unless order_by.nil?
1630
- command.query['pageSize'] = page_size unless page_size.nil?
1631
- command.query['pageToken'] = page_token unless page_token.nil?
1632
- command.query['fields'] = fields unless fields.nil?
1633
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1634
- execute_or_queue_command(command, &block)
1635
- end
1636
-
1637
- # Lists assigned targeting options of an insertion order across targeting types.
1638
- # @param [Fixnum] advertiser_id
1639
- # Required. The ID of the advertiser the insertion order belongs to.
1640
- # @param [Fixnum] insertion_order_id
1641
- # Required. The ID of the insertion order to list assigned targeting options for.
1642
- # @param [String] filter
1643
- # Allows filtering by assigned targeting option fields. Supported syntax: *
1644
- # Filter expressions are made up of one or more restrictions. * Restrictions can
1645
- # be combined by the logical operator `OR`. * A restriction has the form of ``
1646
- # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
1647
- # Supported fields: * `targetingType` * `inheritance` Examples: * `
1648
- # AssignedTargetingOption` resources of targeting type `
1649
- # TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `
1650
- # targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="
1651
- # TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with
1652
- # inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
1653
- # inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
1654
- # length of this field should be no more than 500 characters. Reference our [
1655
- # filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
1656
- # more information.
1657
- # @param [String] order_by
1658
- # Field by which to sort the list. Acceptable values are: * `targetingType` (
1659
- # default) The default sorting order is ascending. To specify descending order
1660
- # for a field, a suffix "desc" should be added to the field name. Example: `
1661
- # targetingType desc`.
1662
- # @param [Fixnum] page_size
1663
- # Requested page size. The size must be an integer between `1` and `5000`. If
1664
- # unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if
1665
- # an invalid value is specified.
1666
- # @param [String] page_token
1667
- # A token that lets the client fetch the next page of results. Typically, this
1668
- # is the value of next_page_token returned from the previous call to `
1669
- # BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the
1670
- # first page of results will be returned.
1671
- # @param [String] fields
1672
- # Selector specifying which fields to include in a partial response.
1673
- # @param [String] quota_user
1674
- # Available to use for quota purposes for server-side applications. Can be any
1675
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1676
- # @param [Google::Apis::RequestOptions] options
1677
- # Request-specific options
1678
- #
1679
- # @yield [result, err] Result & error if block supplied
1680
- # @yieldparam result [Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse] parsed result object
1681
- # @yieldparam err [StandardError] error object if request failed
1682
- #
1683
- # @return [Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse]
1684
- #
1685
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1686
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1687
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1688
- def list_advertiser_insertion_order_assigned_targeting_options(advertiser_id, insertion_order_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1689
- command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions', options)
1690
- command.response_representation = Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse::Representation
1691
- command.response_class = Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse
1692
- command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1693
- command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
1694
- command.query['filter'] = filter unless filter.nil?
1695
- command.query['orderBy'] = order_by unless order_by.nil?
1696
- command.query['pageSize'] = page_size unless page_size.nil?
1697
- command.query['pageToken'] = page_token unless page_token.nil?
1698
- command.query['fields'] = fields unless fields.nil?
1699
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1700
- execute_or_queue_command(command, &block)
1701
- end
1702
-
1703
- # Updates an existing insertion order. Returns the updated insertion order if
1704
- # successful.
1705
- # @param [Fixnum] advertiser_id
1706
- # Output only. The unique ID of the advertiser the insertion order belongs to.
1707
- # @param [Fixnum] insertion_order_id
1708
- # Output only. The unique ID of the insertion order. Assigned by the system.
1709
- # @param [Google::Apis::DisplayvideoV2::InsertionOrder] insertion_order_object
1710
- # @param [String] update_mask
1711
- # Required. The mask to control which fields to update.
1712
- # @param [String] fields
1713
- # Selector specifying which fields to include in a partial response.
1714
- # @param [String] quota_user
1715
- # Available to use for quota purposes for server-side applications. Can be any
1716
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1717
- # @param [Google::Apis::RequestOptions] options
1718
- # Request-specific options
1719
- #
1720
- # @yield [result, err] Result & error if block supplied
1721
- # @yieldparam result [Google::Apis::DisplayvideoV2::InsertionOrder] parsed result object
1722
- # @yieldparam err [StandardError] error object if request failed
1723
- #
1724
- # @return [Google::Apis::DisplayvideoV2::InsertionOrder]
1725
- #
1726
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1727
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1728
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1729
- def patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1730
- command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
1731
- command.request_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
1732
- command.request_object = insertion_order_object
1733
- command.response_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
1734
- command.response_class = Google::Apis::DisplayvideoV2::InsertionOrder
1735
- command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1736
- command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
1737
- command.query['updateMask'] = update_mask unless update_mask.nil?
1738
- command.query['fields'] = fields unless fields.nil?
1739
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1740
- execute_or_queue_command(command, &block)
1741
- end
1742
-
1743
- # Assigns a targeting option to an insertion order. Returns the assigned
1744
- # targeting option if successful. Supported targeting types: * `
1745
- # TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `
1746
- # TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `
1747
- # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `
1748
- # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1749
- # * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `
1750
- # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `
1751
- # TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `
1752
- # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
1753
- # @param [Fixnum] advertiser_id
1754
- # Required. The ID of the advertiser the insertion order belongs to.
1755
- # @param [Fixnum] insertion_order_id
1756
- # Required. The ID of the insertion order the assigned targeting option will
1757
- # belong to.
1758
- # @param [String] targeting_type
1759
- # Required. Identifies the type of this assigned targeting option. Supported
1760
- # targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `
1761
- # TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `
1762
- # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `
1763
- # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1764
- # * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `
1765
- # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `
1766
- # TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `
1767
- # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
1768
- # @param [Google::Apis::DisplayvideoV2::AssignedTargetingOption] assigned_targeting_option_object
1769
- # @param [String] fields
1770
- # Selector specifying which fields to include in a partial response.
1771
- # @param [String] quota_user
1772
- # Available to use for quota purposes for server-side applications. Can be any
1773
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1774
- # @param [Google::Apis::RequestOptions] options
1775
- # Request-specific options
1776
- #
1777
- # @yield [result, err] Result & error if block supplied
1778
- # @yieldparam result [Google::Apis::DisplayvideoV2::AssignedTargetingOption] parsed result object
1779
- # @yieldparam err [StandardError] error object if request failed
1780
- #
1781
- # @return [Google::Apis::DisplayvideoV2::AssignedTargetingOption]
1782
- #
1783
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1784
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1785
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1786
- def create_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1787
- command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
1788
- command.request_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
1789
- command.request_object = assigned_targeting_option_object
1790
- command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
1791
- command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
1792
- command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1793
- command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
1794
- command.params['targetingType'] = targeting_type unless targeting_type.nil?
1795
- command.query['fields'] = fields unless fields.nil?
1796
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1797
- execute_or_queue_command(command, &block)
1798
- end
1799
-
1800
- # Deletes an assigned targeting option from an insertion order. Supported
1801
- # targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `
1802
- # TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `
1803
- # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `
1804
- # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1805
- # * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `
1806
- # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `
1807
- # TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `
1808
- # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
1809
- # @param [Fixnum] advertiser_id
1810
- # Required. The ID of the advertiser the insertion order belongs to.
1811
- # @param [Fixnum] insertion_order_id
1812
- # Required. The ID of the insertion order the assigned targeting option belongs
1813
- # to.
1814
- # @param [String] targeting_type
1815
- # Required. Identifies the type of this assigned targeting option. Supported
1816
- # targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `
1817
- # TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `
1818
- # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `
1819
- # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1820
- # * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `
1821
- # TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `
1822
- # TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `
1823
- # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
1824
- # @param [String] assigned_targeting_option_id
1825
- # Required. The ID of the assigned targeting option to delete.
1826
- # @param [String] fields
1827
- # Selector specifying which fields to include in a partial response.
1828
- # @param [String] quota_user
1829
- # Available to use for quota purposes for server-side applications. Can be any
1830
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1831
- # @param [Google::Apis::RequestOptions] options
1832
- # Request-specific options
1833
- #
1834
- # @yield [result, err] Result & error if block supplied
1835
- # @yieldparam result [Google::Apis::DisplayvideoV2::Empty] parsed result object
1836
- # @yieldparam err [StandardError] error object if request failed
1837
- #
1838
- # @return [Google::Apis::DisplayvideoV2::Empty]
1839
- #
1840
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1841
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1842
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1843
- def delete_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
1844
- command = make_simple_command(:delete, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
1845
- command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
1846
- command.response_class = Google::Apis::DisplayvideoV2::Empty
1847
- command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1848
- command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
1849
- command.params['targetingType'] = targeting_type unless targeting_type.nil?
1850
- command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
1851
- command.query['fields'] = fields unless fields.nil?
1852
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1853
- execute_or_queue_command(command, &block)
1854
- end
1855
-
1856
- # Gets a single targeting option assigned to an insertion order.
1857
- # @param [Fixnum] advertiser_id
1858
- # Required. The ID of the advertiser the insertion order belongs to.
1859
- # @param [Fixnum] insertion_order_id
1860
- # Required. The ID of the insertion order the assigned targeting option belongs
1861
- # to.
1862
- # @param [String] targeting_type
1863
- # Required. Identifies the type of this assigned targeting option. Supported
1864
- # targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` *
1865
- # `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `
1866
- # TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`
1867
- # * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `
1868
- # TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `
1869
- # TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `
1870
- # TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
1871
- # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
1872
- # TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `
1873
- # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `
1874
- # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1875
- # * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
1876
- # TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
1877
- # TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
1878
- # TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `
1879
- # TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `
1880
- # TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `
1881
- # TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `
1882
- # TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `
1883
- # TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `
1884
- # TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `
1885
- # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` *
1886
- # `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `
1887
- # TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `
1888
- # TARGETING_TYPE_VIEWABILITY`
1889
- # @param [String] assigned_targeting_option_id
1890
- # Required. An identifier unique to the targeting type in this insertion order
1891
- # that identifies the assigned targeting option being requested.
1377
+ # Allows filtering by insertion order fields. Supported syntax: * Filter
1378
+ # expressions are made up of one or more restrictions. * Restrictions can be
1379
+ # combined by `AND` or `OR` logical operators. A sequence of restrictions
1380
+ # implicitly uses `AND`. * A restriction has the form of ``field` `operator` `
1381
+ # value``. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)`
1382
+ # or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `
1383
+ # EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `
1384
+ # entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:
1385
+ # SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` *
1386
+ # All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an
1387
+ # advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="
1388
+ # ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than
1389
+ # or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-
1390
+ # 04T18:54:47Z"` * All insertion orders with an update time greater than or
1391
+ # equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-
1392
+ # 04T18:54:47Z"` The length of this field should be no more than 500 characters.
1393
+ # Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/
1394
+ # filters) guide for more information.
1395
+ # @param [String] order_by
1396
+ # Field by which to sort the list. Acceptable values are: * "displayName" (
1397
+ # default) * "entityStatus" * "updateTime" The default sorting order is
1398
+ # ascending. To specify descending order for a field, a suffix "desc" should be
1399
+ # added to the field name. Example: `displayName desc`.
1400
+ # @param [Fixnum] page_size
1401
+ # Requested page size. Must be between `1` and `100`. If unspecified will
1402
+ # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
1403
+ # specified.
1404
+ # @param [String] page_token
1405
+ # A token identifying a page of results the server should return. Typically,
1406
+ # this is the value of next_page_token returned from the previous call to `
1407
+ # ListInsertionOrders` method. If not specified, the first page of results will
1408
+ # be returned.
1892
1409
  # @param [String] fields
1893
1410
  # Selector specifying which fields to include in a partial response.
1894
1411
  # @param [String] quota_user
@@ -1898,86 +1415,37 @@ module Google
1898
1415
  # Request-specific options
1899
1416
  #
1900
1417
  # @yield [result, err] Result & error if block supplied
1901
- # @yieldparam result [Google::Apis::DisplayvideoV2::AssignedTargetingOption] parsed result object
1418
+ # @yieldparam result [Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse] parsed result object
1902
1419
  # @yieldparam err [StandardError] error object if request failed
1903
1420
  #
1904
- # @return [Google::Apis::DisplayvideoV2::AssignedTargetingOption]
1421
+ # @return [Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse]
1905
1422
  #
1906
1423
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1907
1424
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1908
1425
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1909
- def get_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
1910
- command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
1911
- command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
1912
- command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
1426
+ def list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1427
+ command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders', options)
1428
+ command.response_representation = Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse::Representation
1429
+ command.response_class = Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse
1913
1430
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
1914
- command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
1915
- command.params['targetingType'] = targeting_type unless targeting_type.nil?
1916
- command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
1431
+ command.query['filter'] = filter unless filter.nil?
1432
+ command.query['orderBy'] = order_by unless order_by.nil?
1433
+ command.query['pageSize'] = page_size unless page_size.nil?
1434
+ command.query['pageToken'] = page_token unless page_token.nil?
1917
1435
  command.query['fields'] = fields unless fields.nil?
1918
1436
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1919
1437
  execute_or_queue_command(command, &block)
1920
1438
  end
1921
1439
 
1922
- # Lists the targeting options assigned to an insertion order.
1440
+ # Updates an existing insertion order. Returns the updated insertion order if
1441
+ # successful.
1923
1442
  # @param [Fixnum] advertiser_id
1924
- # Required. The ID of the advertiser the insertion order belongs to.
1443
+ # Output only. The unique ID of the advertiser the insertion order belongs to.
1925
1444
  # @param [Fixnum] insertion_order_id
1926
- # Required. The ID of the insertion order to list assigned targeting options for.
1927
- # @param [String] targeting_type
1928
- # Required. Identifies the type of assigned targeting options to list. Supported
1929
- # targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` *
1930
- # `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `
1931
- # TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`
1932
- # * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `
1933
- # TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `
1934
- # TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `
1935
- # TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `
1936
- # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `
1937
- # TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `
1938
- # TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `
1939
- # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT`
1940
- # * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `
1941
- # TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `
1942
- # TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `
1943
- # TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `
1944
- # TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `
1945
- # TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `
1946
- # TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `
1947
- # TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `
1948
- # TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `
1949
- # TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `
1950
- # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` *
1951
- # `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `
1952
- # TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `
1953
- # TARGETING_TYPE_VIEWABILITY`
1954
- # @param [String] filter
1955
- # Allows filtering by assigned targeting option fields. Supported syntax: *
1956
- # Filter expressions are made up of one or more restrictions. * Restrictions can
1957
- # be combined by the logical operator `OR`. * A restriction has the form of ``
1958
- # field` `operator` `value``. * All fields must use the `EQUALS (=)` operator.
1959
- # Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `
1960
- # AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="
1961
- # 1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources
1962
- # with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `
1963
- # inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The
1964
- # length of this field should be no more than 500 characters. Reference our [
1965
- # filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for
1966
- # more information.
1967
- # @param [String] order_by
1968
- # Field by which to sort the list. Acceptable values are: * `
1969
- # assignedTargetingOptionId` (default) The default sorting order is ascending.
1970
- # To specify descending order for a field, a suffix "desc" should be added to
1971
- # the field name. Example: `assignedTargetingOptionId desc`.
1972
- # @param [Fixnum] page_size
1973
- # Requested page size. Must be between `1` and `5000`. If unspecified will
1974
- # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
1975
- # specified.
1976
- # @param [String] page_token
1977
- # A token identifying a page of results the server should return. Typically,
1978
- # this is the value of next_page_token returned from the previous call to `
1979
- # ListInsertionOrderAssignedTargetingOptions` method. If not specified, the
1980
- # first page of results will be returned.
1445
+ # Output only. The unique ID of the insertion order. Assigned by the system.
1446
+ # @param [Google::Apis::DisplayvideoV2::InsertionOrder] insertion_order_object
1447
+ # @param [String] update_mask
1448
+ # Required. The mask to control which fields to update.
1981
1449
  # @param [String] fields
1982
1450
  # Selector specifying which fields to include in a partial response.
1983
1451
  # @param [String] quota_user
@@ -1987,25 +1455,23 @@ module Google
1987
1455
  # Request-specific options
1988
1456
  #
1989
1457
  # @yield [result, err] Result & error if block supplied
1990
- # @yieldparam result [Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse] parsed result object
1458
+ # @yieldparam result [Google::Apis::DisplayvideoV2::InsertionOrder] parsed result object
1991
1459
  # @yieldparam err [StandardError] error object if request failed
1992
1460
  #
1993
- # @return [Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse]
1461
+ # @return [Google::Apis::DisplayvideoV2::InsertionOrder]
1994
1462
  #
1995
1463
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1996
1464
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1997
1465
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1998
- def list_advertiser_insertion_order_targeting_type_assigned_targeting_options(advertiser_id, insertion_order_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1999
- command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
2000
- command.response_representation = Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse::Representation
2001
- command.response_class = Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse
1466
+ def patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1467
+ command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
1468
+ command.request_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
1469
+ command.request_object = insertion_order_object
1470
+ command.response_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
1471
+ command.response_class = Google::Apis::DisplayvideoV2::InsertionOrder
2002
1472
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
2003
1473
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
2004
- command.params['targetingType'] = targeting_type unless targeting_type.nil?
2005
- command.query['filter'] = filter unless filter.nil?
2006
- command.query['orderBy'] = order_by unless order_by.nil?
2007
- command.query['pageSize'] = page_size unless page_size.nil?
2008
- command.query['pageToken'] = page_token unless page_token.nil?
1474
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2009
1475
  command.query['fields'] = fields unless fields.nil?
2010
1476
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2011
1477
  execute_or_queue_command(command, &block)
@@ -4633,7 +4099,10 @@ module Google
4633
4099
  end
4634
4100
 
4635
4101
  # Updates an existing custom bidding algorithm. Returns the updated custom
4636
- # bidding algorithm if successful.
4102
+ # bidding algorithm if successful. *Warning*: Starting **April 1, 2025**,
4103
+ # requests updating custom bidding algorithms that are assigned to line items
4104
+ # will return an error. [Read more about this announced change](/display-video/
4105
+ # api/deprecations#features.custom_bidding_floodlight).
4637
4106
  # @param [Fixnum] custom_bidding_algorithm_id
4638
4107
  # Output only. The unique ID of the custom bidding algorithm. Assigned by the
4639
4108
  # system.
@@ -4711,7 +4180,10 @@ module Google
4711
4180
  end
4712
4181
 
4713
4182
  # Creates a new custom bidding script. Returns the newly created script if
4714
- # successful.
4183
+ # successful. *Warning*: Starting **April 1, 2025**, requests updating custom
4184
+ # bidding algorithms that are assigned to line items will return an error. [Read
4185
+ # more about this announced change](/display-video/api/deprecations#features.
4186
+ # custom_bidding_floodlight).
4715
4187
  # @param [Fixnum] custom_bidding_algorithm_id
4716
4188
  # Required. The ID of the custom bidding algorithm that owns the script.
4717
4189
  # @param [Google::Apis::DisplayvideoV2::CustomBiddingScript] custom_bidding_script_object
@@ -4935,224 +4407,6 @@ module Google
4935
4407
  execute_or_queue_command(command, &block)
4936
4408
  end
4937
4409
 
4938
- # Creates a FirstAndThirdPartyAudience. Only supported for the following
4939
- # audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
4940
- # @param [Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience] first_and_third_party_audience_object
4941
- # @param [Fixnum] advertiser_id
4942
- # Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience
4943
- # will be created.
4944
- # @param [String] fields
4945
- # Selector specifying which fields to include in a partial response.
4946
- # @param [String] quota_user
4947
- # Available to use for quota purposes for server-side applications. Can be any
4948
- # arbitrary string assigned to a user, but should not exceed 40 characters.
4949
- # @param [Google::Apis::RequestOptions] options
4950
- # Request-specific options
4951
- #
4952
- # @yield [result, err] Result & error if block supplied
4953
- # @yieldparam result [Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience] parsed result object
4954
- # @yieldparam err [StandardError] error object if request failed
4955
- #
4956
- # @return [Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience]
4957
- #
4958
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4959
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4960
- # @raise [Google::Apis::AuthorizationError] Authorization is required
4961
- def create_first_and_third_party_audience(first_and_third_party_audience_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
4962
- command = make_simple_command(:post, 'v2/firstAndThirdPartyAudiences', options)
4963
- command.request_representation = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience::Representation
4964
- command.request_object = first_and_third_party_audience_object
4965
- command.response_representation = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience::Representation
4966
- command.response_class = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience
4967
- command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
4968
- command.query['fields'] = fields unless fields.nil?
4969
- command.query['quotaUser'] = quota_user unless quota_user.nil?
4970
- execute_or_queue_command(command, &block)
4971
- end
4972
-
4973
- # Updates the member list of a Customer Match audience. Only supported for the
4974
- # following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `
4975
- # CUSTOMER_MATCH_DEVICE_ID`
4976
- # @param [Fixnum] first_and_third_party_audience_id
4977
- # Required. The ID of the Customer Match FirstAndThirdPartyAudience whose
4978
- # members will be edited.
4979
- # @param [Google::Apis::DisplayvideoV2::EditCustomerMatchMembersRequest] edit_customer_match_members_request_object
4980
- # @param [String] fields
4981
- # Selector specifying which fields to include in a partial response.
4982
- # @param [String] quota_user
4983
- # Available to use for quota purposes for server-side applications. Can be any
4984
- # arbitrary string assigned to a user, but should not exceed 40 characters.
4985
- # @param [Google::Apis::RequestOptions] options
4986
- # Request-specific options
4987
- #
4988
- # @yield [result, err] Result & error if block supplied
4989
- # @yieldparam result [Google::Apis::DisplayvideoV2::EditCustomerMatchMembersResponse] parsed result object
4990
- # @yieldparam err [StandardError] error object if request failed
4991
- #
4992
- # @return [Google::Apis::DisplayvideoV2::EditCustomerMatchMembersResponse]
4993
- #
4994
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4995
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4996
- # @raise [Google::Apis::AuthorizationError] Authorization is required
4997
- def edit_first_and_third_party_audience_customer_match_members(first_and_third_party_audience_id, edit_customer_match_members_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4998
- command = make_simple_command(:post, 'v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers', options)
4999
- command.request_representation = Google::Apis::DisplayvideoV2::EditCustomerMatchMembersRequest::Representation
5000
- command.request_object = edit_customer_match_members_request_object
5001
- command.response_representation = Google::Apis::DisplayvideoV2::EditCustomerMatchMembersResponse::Representation
5002
- command.response_class = Google::Apis::DisplayvideoV2::EditCustomerMatchMembersResponse
5003
- command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_audience_id.nil?
5004
- command.query['fields'] = fields unless fields.nil?
5005
- command.query['quotaUser'] = quota_user unless quota_user.nil?
5006
- execute_or_queue_command(command, &block)
5007
- end
5008
-
5009
- # Gets a first and third party audience.
5010
- # @param [Fixnum] first_and_third_party_audience_id
5011
- # Required. The ID of the first and third party audience to fetch.
5012
- # @param [Fixnum] advertiser_id
5013
- # The ID of the advertiser that has access to the fetched first and third party
5014
- # audience.
5015
- # @param [Fixnum] partner_id
5016
- # The ID of the partner that has access to the fetched first and third party
5017
- # audience.
5018
- # @param [String] fields
5019
- # Selector specifying which fields to include in a partial response.
5020
- # @param [String] quota_user
5021
- # Available to use for quota purposes for server-side applications. Can be any
5022
- # arbitrary string assigned to a user, but should not exceed 40 characters.
5023
- # @param [Google::Apis::RequestOptions] options
5024
- # Request-specific options
5025
- #
5026
- # @yield [result, err] Result & error if block supplied
5027
- # @yieldparam result [Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience] parsed result object
5028
- # @yieldparam err [StandardError] error object if request failed
5029
- #
5030
- # @return [Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience]
5031
- #
5032
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5033
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5034
- # @raise [Google::Apis::AuthorizationError] Authorization is required
5035
- def get_first_and_third_party_audience(first_and_third_party_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
5036
- command = make_simple_command(:get, 'v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
5037
- command.response_representation = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience::Representation
5038
- command.response_class = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience
5039
- command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_audience_id.nil?
5040
- command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
5041
- command.query['partnerId'] = partner_id unless partner_id.nil?
5042
- command.query['fields'] = fields unless fields.nil?
5043
- command.query['quotaUser'] = quota_user unless quota_user.nil?
5044
- execute_or_queue_command(command, &block)
5045
- end
5046
-
5047
- # Lists first and third party audiences. The order is defined by the order_by
5048
- # parameter.
5049
- # @param [Fixnum] advertiser_id
5050
- # The ID of the advertiser that has access to the fetched first and third party
5051
- # audiences.
5052
- # @param [String] filter
5053
- # Allows filtering by first and third party audience fields. Supported syntax: *
5054
- # Filter expressions for first and third party audiences can only contain at
5055
- # most one restriction. * A restriction has the form of ``field` `operator` `
5056
- # value``. * All fields must use the `HAS (:)` operator. Supported fields: * `
5057
- # displayName` Examples: * All first and third party audiences for which the
5058
- # display name contains "Google": `displayName:"Google"`. The length of this
5059
- # field should be no more than 500 characters. Reference our [filter `LIST`
5060
- # requests](/display-video/api/guides/how-tos/filters) guide for more
5061
- # information.
5062
- # @param [String] order_by
5063
- # Field by which to sort the list. Acceptable values are: * `
5064
- # firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting
5065
- # order is ascending. To specify descending order for a field, a suffix "desc"
5066
- # should be added to the field name. Example: `displayName desc`.
5067
- # @param [Fixnum] page_size
5068
- # Requested page size. Must be between `1` and `5000`. If unspecified, this
5069
- # value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid
5070
- # value is specified.
5071
- # @param [String] page_token
5072
- # A token identifying a page of results the server should return. Typically,
5073
- # this is the value of next_page_token returned from the previous call to `
5074
- # ListFirstAndThirdPartyAudiences` method. If not specified, the first page of
5075
- # results will be returned.
5076
- # @param [Fixnum] partner_id
5077
- # The ID of the partner that has access to the fetched first and third party
5078
- # audiences.
5079
- # @param [String] fields
5080
- # Selector specifying which fields to include in a partial response.
5081
- # @param [String] quota_user
5082
- # Available to use for quota purposes for server-side applications. Can be any
5083
- # arbitrary string assigned to a user, but should not exceed 40 characters.
5084
- # @param [Google::Apis::RequestOptions] options
5085
- # Request-specific options
5086
- #
5087
- # @yield [result, err] Result & error if block supplied
5088
- # @yieldparam result [Google::Apis::DisplayvideoV2::ListFirstAndThirdPartyAudiencesResponse] parsed result object
5089
- # @yieldparam err [StandardError] error object if request failed
5090
- #
5091
- # @return [Google::Apis::DisplayvideoV2::ListFirstAndThirdPartyAudiencesResponse]
5092
- #
5093
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5094
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5095
- # @raise [Google::Apis::AuthorizationError] Authorization is required
5096
- def list_first_and_third_party_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
5097
- command = make_simple_command(:get, 'v2/firstAndThirdPartyAudiences', options)
5098
- command.response_representation = Google::Apis::DisplayvideoV2::ListFirstAndThirdPartyAudiencesResponse::Representation
5099
- command.response_class = Google::Apis::DisplayvideoV2::ListFirstAndThirdPartyAudiencesResponse
5100
- command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
5101
- command.query['filter'] = filter unless filter.nil?
5102
- command.query['orderBy'] = order_by unless order_by.nil?
5103
- command.query['pageSize'] = page_size unless page_size.nil?
5104
- command.query['pageToken'] = page_token unless page_token.nil?
5105
- command.query['partnerId'] = partner_id unless partner_id.nil?
5106
- command.query['fields'] = fields unless fields.nil?
5107
- command.query['quotaUser'] = quota_user unless quota_user.nil?
5108
- execute_or_queue_command(command, &block)
5109
- end
5110
-
5111
- # Updates an existing FirstAndThirdPartyAudience. Only supported for the
5112
- # following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `
5113
- # CUSTOMER_MATCH_DEVICE_ID`
5114
- # @param [Fixnum] first_and_third_party_audience_id
5115
- # Output only. The unique ID of the first and third party audience. Assigned by
5116
- # the system.
5117
- # @param [Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience] first_and_third_party_audience_object
5118
- # @param [Fixnum] advertiser_id
5119
- # Required. The ID of the owner advertiser of the updated
5120
- # FirstAndThirdPartyAudience.
5121
- # @param [String] update_mask
5122
- # Required. The mask to control which fields to update. Updates are only
5123
- # supported for the following fields: * `displayName` * `description` * `
5124
- # membershipDurationDays`
5125
- # @param [String] fields
5126
- # Selector specifying which fields to include in a partial response.
5127
- # @param [String] quota_user
5128
- # Available to use for quota purposes for server-side applications. Can be any
5129
- # arbitrary string assigned to a user, but should not exceed 40 characters.
5130
- # @param [Google::Apis::RequestOptions] options
5131
- # Request-specific options
5132
- #
5133
- # @yield [result, err] Result & error if block supplied
5134
- # @yieldparam result [Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience] parsed result object
5135
- # @yieldparam err [StandardError] error object if request failed
5136
- #
5137
- # @return [Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience]
5138
- #
5139
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5140
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5141
- # @raise [Google::Apis::AuthorizationError] Authorization is required
5142
- def patch_first_and_third_party_audience(first_and_third_party_audience_id, first_and_third_party_audience_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
5143
- command = make_simple_command(:patch, 'v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
5144
- command.request_representation = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience::Representation
5145
- command.request_object = first_and_third_party_audience_object
5146
- command.response_representation = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience::Representation
5147
- command.response_class = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience
5148
- command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_audience_id.nil?
5149
- command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
5150
- command.query['updateMask'] = update_mask unless update_mask.nil?
5151
- command.query['fields'] = fields unless fields.nil?
5152
- command.query['quotaUser'] = quota_user unless quota_user.nil?
5153
- execute_or_queue_command(command, &block)
5154
- end
5155
-
5156
4410
  # Gets a Floodlight group.
5157
4411
  # @param [Fixnum] floodlight_group_id
5158
4412
  # Required. The ID of the Floodlight group to fetch.