Class: Google::Apis::DisplayvideoV4::DisplayVideoService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/displayvideo_v4/service.rb

Overview

Display & Video 360 API

Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items.

Examples:

require 'google/apis/displayvideo_v4'

Displayvideo = Google::Apis::DisplayvideoV4 # Alias the module
service = Displayvideo::DisplayVideoService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://displayvideo.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DisplayVideoService

Returns a new instance of DisplayVideoService.



49
50
51
52
53
54
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 49

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-displayvideo_v4',
        client_version: Google::Apis::DisplayvideoV4::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



42
43
44
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 42

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



47
48
49
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#audit_advertiser(advertiser_id, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AuditAdvertiserResponse

Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to audit.

  • read_mask (String) (defaults to: nil) —

    Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



84
85
86
87
88
89
90
91
92
93
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 84

def audit_advertiser(advertiser_id, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}:audit', options)
  command.response_representation = Google::Apis::DisplayvideoV4::AuditAdvertiserResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AuditAdvertiserResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_advertiser_ad_group_edit_assigned_targeting_options(advertiser_id, bulk_edit_ad_group_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkEditAdGroupAssignedTargetingOptionsResponse

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method will begin rolling out to all partners on June 10, 2026 and be available to all partners on June 24, 2026 .

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad groups belong to.

  • bulk_edit_ad_group_assigned_targeting_options_request_object (Google::Apis::DisplayvideoV4::BulkEditAdGroupAssignedTargetingOptionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 829

def bulk_advertiser_ad_group_edit_assigned_targeting_options(advertiser_id, bulk_edit_ad_group_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkEditAdGroupAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_ad_group_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkEditAdGroupAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkEditAdGroupAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_advertiser_ad_group_list_assigned_targeting_options(advertiser_id, ad_group_ids: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkListAdGroupAssignedTargetingOptionsResponse

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the line items belongs to.

  • ad_group_ids (Array<Fixnum>, Fixnum) (defaults to: nil) —

    Required. The IDs of the ad groups to list assigned targeting options for.

  • filter (String) (defaults to: nil) —

    Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * targetingType Examples: * AssignedTargetingOption resources of targeting type TARGETING_TYPE_YOUTUBE_VIDEO or TARGETING_TYPE_YOUTUBE_CHANNEL: targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType=" TARGETING_TYPE_YOUTUBE_CHANNEL" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Optional. Field by which to sort the list. Acceptable values are: * adGroupId (default) * assignedTargetingOption.targetingType The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: targetingType desc.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. The size must be an integer between 1 and 5000. If unspecified, the default is 5000. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the BulkListAdGroupAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 890

def bulk_advertiser_ad_group_list_assigned_targeting_options(advertiser_id, ad_group_ids: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV4::BulkListAdGroupAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkListAdGroupAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['adGroupIds'] = ad_group_ids unless ad_group_ids.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_advertiser_channel_site_edit(advertiser_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkEditSitesResponse

Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel to which the sites belong.

  • bulk_edit_sites_request_object (Google::Apis::DisplayvideoV4::BulkEditSitesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1947

def bulk_advertiser_channel_site_edit(advertiser_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkEditSitesRequest::Representation
  command.request_object = bulk_edit_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkEditSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkEditSitesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_advertiser_line_item_list_assigned_targeting_options(advertiser_id, filter: nil, line_item_ids: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkListAssignedTargetingOptionsResponse

Lists assigned targeting options for multiple line items across targeting types.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the line items belongs to.

  • filter (String) (defaults to: nil) —

    Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR on the same field. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * targetingType * inheritance Examples: * AssignedTargetingOption resources of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL: targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType=" TARGETING_TYPE_CHANNEL" * AssignedTargetingOption resources with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER: inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • line_item_ids (Array<Fixnum>, Fixnum) (defaults to: nil) —

    Required. The IDs of the line items to list assigned targeting options for.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * lineItemId ( default) * assignedTargetingOption.targetingType The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: targetingType desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The size must be an integer between 1 and 5000. If unspecified, the default is 5000. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the BulkListAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2761

def bulk_advertiser_line_item_list_assigned_targeting_options(advertiser_id, filter: nil, line_item_ids: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV4::BulkListAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkListAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['lineItemIds'] = line_item_ids unless line_item_ids.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_create_ad_assets(advertiser_id, bulk_create_ad_assets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkCreateAdAssetsResponse

Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser these ad assets belong to.

  • bulk_create_ad_assets_request_object (Google::Apis::DisplayvideoV4::BulkCreateAdAssetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 410

def bulk_create_ad_assets(advertiser_id, bulk_create_ad_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adAssets:bulkCreate', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkCreateAdAssetsRequest::Representation
  command.request_object = bulk_create_ad_assets_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkCreateAdAssetsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkCreateAdAssetsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_edit_assigned_inventory_sources(inventory_source_group_id, bulk_edit_assigned_inventory_sources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkEditAssignedInventorySourcesResponse

Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest. deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest. created_assigned_inventory_sources.

Parameters:

  • inventory_source_group_id (Fixnum) —

    Required. The ID of the inventory source group to which the assignments are assigned.

  • bulk_edit_assigned_inventory_sources_request_object (Google::Apis::DisplayvideoV4::BulkEditAssignedInventorySourcesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6109

def bulk_edit_assigned_inventory_sources(inventory_source_group_id, bulk_edit_assigned_inventory_sources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkEditAssignedInventorySourcesRequest::Representation
  command.request_object = bulk_edit_assigned_inventory_sources_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkEditAssignedInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkEditAssignedInventorySourcesResponse
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_edit_assigned_locations(advertiser_id, location_list_id, bulk_edit_assigned_locations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkEditAssignedLocationsResponse

Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the location list belongs.

  • location_list_id (Fixnum) —

    Required. The ID of the location list to which these assignments are assigned.

  • bulk_edit_assigned_locations_request_object (Google::Apis::DisplayvideoV4::BulkEditAssignedLocationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3714

def bulk_edit_assigned_locations(advertiser_id, location_list_id, bulk_edit_assigned_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkEditAssignedLocationsRequest::Representation
  command.request_object = bulk_edit_assigned_locations_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkEditAssignedLocationsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkEditAssignedLocationsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_edit_assigned_user_roles(user_id, bulk_edit_assigned_user_roles_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkEditAssignedUserRolesResponse

Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest. createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

  • user_id (Fixnum) —

    Required. The ID of the user to which the assigned user roles belong.

  • bulk_edit_assigned_user_roles_request_object (Google::Apis::DisplayvideoV4::BulkEditAssignedUserRolesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7559

def bulk_edit_assigned_user_roles(user_id, bulk_edit_assigned_user_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/users/{+userId}:bulkEditAssignedUserRoles', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkEditAssignedUserRolesRequest::Representation
  command.request_object = bulk_edit_assigned_user_roles_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkEditAssignedUserRolesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkEditAssignedUserRolesResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_edit_negative_keywords(advertiser_id, negative_keyword_list_id, bulk_edit_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkEditNegativeKeywordsResponse

Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest. deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Required. The ID of the parent negative keyword list to which the negative keywords belong.

  • bulk_edit_negative_keywords_request_object (Google::Apis::DisplayvideoV4::BulkEditNegativeKeywordsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4076

def bulk_edit_negative_keywords(advertiser_id, negative_keyword_list_id, bulk_edit_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkEditNegativeKeywordsRequest::Representation
  command.request_object = bulk_edit_negative_keywords_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkEditNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkEditNegativeKeywordsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_line_item_edit_assigned_targeting_options(advertiser_id, bulk_edit_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkEditAssignedTargetingOptionsResponse

Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest. create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions. delete YouTube & Partners line items cannot be created or updated using the API.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the line items belong to.

  • bulk_edit_assigned_targeting_options_request_object (Google::Apis::DisplayvideoV4::BulkEditAssignedTargetingOptionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2697

def bulk_line_item_edit_assigned_targeting_options(advertiser_id, bulk_edit_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkEditAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkEditAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkEditAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_partner_channel_site_edit(partner_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkEditSitesResponse

Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel to which the sites belong.

  • bulk_edit_sites_request_object (Google::Apis::DisplayvideoV4::BulkEditSitesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6898

def bulk_partner_channel_site_edit(partner_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkEditSitesRequest::Representation
  command.request_object = bulk_edit_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkEditSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkEditSitesResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_update_line_items(advertiser_id, bulk_update_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkUpdateLineItemsResponse

Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions. create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this line item belongs to.

  • bulk_update_line_items_request_object (Google::Apis::DisplayvideoV4::BulkUpdateLineItemsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2801

def bulk_update_line_items(advertiser_id, bulk_update_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/lineItems:bulkUpdate', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkUpdateLineItemsRequest::Representation
  command.request_object = bulk_update_line_items_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkUpdateLineItemsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkUpdateLineItemsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_ad_asset(advertiser_id, create_ad_asset_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AdAsset

Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this ad asset belongs to.

  • create_ad_asset_request_object (Google::Apis::DisplayvideoV4::CreateAdAssetRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 444

def create_ad_asset(advertiser_id, create_ad_asset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adAssets', options)
  command.request_representation = Google::Apis::DisplayvideoV4::CreateAdAssetRequest::Representation
  command.request_object = create_ad_asset_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::AdAsset::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AdAsset
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Advertiser

Creates a new advertiser. Returns the newly created advertiser if successful. * This method regularly experiences high latency.* We recommend increasing your default timeout to avoid errors.

Parameters:

  • advertiser_object (Google::Apis::DisplayvideoV4::Advertiser) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 117

def create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DisplayvideoV4::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Advertiser
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_ad_group(advertiser_id, ad_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AdGroup

Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method will begin rolling out to all partners on June 10, 2026 and be available to all partners on June 24, 2026.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the ad group belongs to.

  • ad_group_object (Google::Apis::DisplayvideoV4::AdGroup) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



930
931
932
933
934
935
936
937
938
939
940
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 930

def create_advertiser_ad_group(advertiser_id, ad_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adGroups', options)
  command.request_representation = Google::Apis::DisplayvideoV4::AdGroup::Representation
  command.request_object = ad_group_object
  command.response_representation = Google::Apis::DisplayvideoV4::AdGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AdGroup
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_ad_group_ad(advertiser_id, ad_group_ad_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AdGroupAd

Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method will begin rolling out to all partners on June 10, 2026 and be available to all partners on June 24, 2026.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the ad belongs to.

  • ad_group_ad_object (Google::Apis::DisplayvideoV4::AdGroupAd) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 615

def create_advertiser_ad_group_ad(advertiser_id, ad_group_ad_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adGroupAds', options)
  command.request_representation = Google::Apis::DisplayvideoV4::AdGroupAd::Representation
  command.request_object = ad_group_ad_object
  command.response_representation = Google::Apis::DisplayvideoV4::AdGroupAd::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AdGroupAd
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_ad_group_targeting_type_assigned_targeting_option(advertiser_id, ad_group_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AssignedTargetingOption

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method will begin rolling out to all partners on June 10, 2026 and be available to all partners on June 24, 2026.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad group belongs to.

  • ad_group_id (Fixnum) —

    Required. The ID of the ad group the assigned targeting option will belong to.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_GENDER * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_URL * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_YOUTUBE_VIDEO

  • assigned_targeting_option_object (Google::Apis::DisplayvideoV4::AssignedTargetingOption) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1153

def create_advertiser_ad_group_targeting_type_assigned_targeting_option(advertiser_id, ad_group_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_ad_group_youtube_asset_type_youtube_asset_association(advertiser_id, ad_group_id, youtube_asset_type, youtube_asset_association_object = nil, linked_entity_line_item_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::YoutubeAssetAssociation

Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. Warning: This method is only available to an informed subset of users.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser that the linked entity belongs to.

  • ad_group_id (Fixnum) —

    The ID of an ad group.

  • youtube_asset_type (String) —

    Required. The type of YouTube asset associated with the resource.

  • youtube_asset_association_object (Google::Apis::DisplayvideoV4::YoutubeAssetAssociation) (defaults to: nil)
  • linked_entity_line_item_id (Fixnum) (defaults to: nil) —

    The ID of a line item.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1369

def create_advertiser_ad_group_youtube_asset_type_youtube_asset_association(advertiser_id, ad_group_id, youtube_asset_type, youtube_asset_association_object = nil, linked_entity_line_item_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations', options)
  command.request_representation = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation::Representation
  command.request_object = youtube_asset_association_object
  command.response_representation = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation::Representation
  command.response_class = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
  command.query['linkedEntity.lineItemId'] = linked_entity_line_item_id unless linked_entity_line_item_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Campaign

Creates a new campaign. Returns the newly created campaign if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the campaign belongs to.

  • campaign_object (Google::Apis::DisplayvideoV4::Campaign) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1559

def create_advertiser_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/campaigns', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DisplayvideoV4::Campaign::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Campaign
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_channel(advertiser_id, channel_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Channel

Creates a new channel. Returns the newly created channel if successful.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the created channel.

  • channel_object (Google::Apis::DisplayvideoV4::Channel) (defaults to: nil)
  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the created channel.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1771

def create_advertiser_channel(advertiser_id, channel_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/channels', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV4::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Channel
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_channel_site(advertiser_id, channel_id, site_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Site

Creates a site in a channel.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel in which the site will be created.

  • site_object (Google::Apis::DisplayvideoV4::Site) (defaults to: nil)
  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent channel.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1985

def create_advertiser_channel_site(advertiser_id, channel_id, site_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{advertiserId}/channels/{+channelId}/sites', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DisplayvideoV4::Site::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Site
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_creative(advertiser_id, creative_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Creative

Creates a new creative. Returns the newly created creative if successful. A " Standard" user role or greater for the parent advertiser or partner is required to make this request.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the creative belongs to.

  • creative_object (Google::Apis::DisplayvideoV4::Creative) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2164

def create_advertiser_creative(advertiser_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/creatives', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DisplayvideoV4::Creative::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Creative
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_insertion_order(advertiser_id, insertion_order_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::InsertionOrder

Creates a new insertion order. Returns the newly created insertion order if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the insertion order belongs to.

  • insertion_order_object (Google::Apis::DisplayvideoV4::InsertionOrder) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2393

def create_advertiser_insertion_order(advertiser_id, insertion_order_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/insertionOrders', options)
  command.request_representation = Google::Apis::DisplayvideoV4::InsertionOrder::Representation
  command.request_object = insertion_order_object
  command.response_representation = Google::Apis::DisplayvideoV4::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV4::InsertionOrder
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_line_item(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::LineItem

Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the line item belongs to.

  • line_item_object (Google::Apis::DisplayvideoV4::LineItem) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2835

def create_advertiser_line_item(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/lineItems', options)
  command.request_representation = Google::Apis::DisplayvideoV4::LineItem::Representation
  command.request_object = line_item_object
  command.response_representation = Google::Apis::DisplayvideoV4::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV4::LineItem
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AssignedTargetingOption

Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems. bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the line item belongs to.

  • line_item_id (Fixnum) —

    Required. The ID of the line item the assigned targeting option will belong to.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

    • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT
    • TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_INVENTORY_SOURCE * TARGETING_TYPE_INVENTORY_SOURCE_GROUP * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY
  • assigned_targeting_option_object (Google::Apis::DisplayvideoV4::AssignedTargetingOption) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3127

def create_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_line_item_youtube_asset_type_youtube_asset_association(advertiser_id, line_item_id, youtube_asset_type, youtube_asset_association_object = nil, linked_entity_ad_group_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::YoutubeAssetAssociation

Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. Warning: This method is only available to an informed subset of users.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser that the linked entity belongs to.

  • line_item_id (Fixnum) —

    The ID of a line item.

  • youtube_asset_type (String) —

    Required. The type of YouTube asset associated with the resource.

  • youtube_asset_association_object (Google::Apis::DisplayvideoV4::YoutubeAssetAssociation) (defaults to: nil)
  • linked_entity_ad_group_id (Fixnum) (defaults to: nil) —

    The ID of an ad group.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3401

def create_advertiser_line_item_youtube_asset_type_youtube_asset_association(advertiser_id, line_item_id, youtube_asset_type, youtube_asset_association_object = nil, linked_entity_ad_group_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations', options)
  command.request_representation = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation::Representation
  command.request_object = youtube_asset_association_object
  command.response_representation = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation::Representation
  command.response_class = Google::Apis::DisplayvideoV4::YoutubeAssetAssociation
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
  command.query['linkedEntity.adGroupId'] = linked_entity_ad_group_id unless linked_entity_ad_group_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_location_list(advertiser_id, location_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::LocationList

Creates a new location list. Returns the newly created location list if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the location list belongs.

  • location_list_object (Google::Apis::DisplayvideoV4::LocationList) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3544

def create_advertiser_location_list(advertiser_id, location_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/locationLists', options)
  command.request_representation = Google::Apis::DisplayvideoV4::LocationList::Representation
  command.request_object = location_list_object
  command.response_representation = Google::Apis::DisplayvideoV4::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV4::LocationList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AssignedLocation

Creates an assignment between a location and a location list.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the location list belongs.

  • location_list_id (Fixnum) —

    Required. The ID of the location list for which the assignment will be created.

  • assigned_location_object (Google::Apis::DisplayvideoV4::AssignedLocation) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3750

def create_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
  command.request_representation = Google::Apis::DisplayvideoV4::AssignedLocation::Representation
  command.request_object = assigned_location_object
  command.response_representation = Google::Apis::DisplayvideoV4::AssignedLocation::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AssignedLocation
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::NegativeKeywordList

Creates a new negative keyword list. Returns the newly created negative keyword list if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the negative keyword list will belong.

  • negative_keyword_list_object (Google::Apis::DisplayvideoV4::NegativeKeywordList) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3881

def create_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/negativeKeywordLists', options)
  command.request_representation = Google::Apis::DisplayvideoV4::NegativeKeywordList::Representation
  command.request_object = negative_keyword_list_object
  command.response_representation = Google::Apis::DisplayvideoV4::NegativeKeywordList::Representation
  command.response_class = Google::Apis::DisplayvideoV4::NegativeKeywordList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, negative_keyword_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::NegativeKeyword

Creates a negative keyword in a negative keyword list.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Required. The ID of the parent negative keyword list in which the negative keyword will be created.

  • negative_keyword_object (Google::Apis::DisplayvideoV4::NegativeKeyword) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4114

def create_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, negative_keyword_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
  command.request_representation = Google::Apis::DisplayvideoV4::NegativeKeyword::Representation
  command.request_object = negative_keyword_object
  command.response_representation = Google::Apis::DisplayvideoV4::NegativeKeyword::Representation
  command.response_class = Google::Apis::DisplayvideoV4::NegativeKeyword
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AssignedTargetingOption

Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_OMID * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_KEYWORD

  • assigned_targeting_option_object (Google::Apis::DisplayvideoV4::AssignedTargetingOption) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4294

def create_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_custom_bidding_algorithm(custom_bidding_algorithm_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm

Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.

Parameters:

  • custom_bidding_algorithm_object (Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4570

def create_custom_bidding_algorithm(custom_bidding_algorithm_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/customBiddingAlgorithms', options)
  command.request_representation = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm::Representation
  command.request_object = custom_bidding_algorithm_object
  command.response_representation = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_custom_bidding_algorithm_rule(custom_bidding_algorithm_id, custom_bidding_algorithm_rules_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRules

Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm that owns the rules resource.

  • custom_bidding_algorithm_rules_object (Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRules) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent custom bidding algorithm.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4830

def create_custom_bidding_algorithm_rule(custom_bidding_algorithm_id, custom_bidding_algorithm_rules_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules', options)
  command.request_representation = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRules::Representation
  command.request_object = custom_bidding_algorithm_rules_object
  command.response_representation = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRules::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRules
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CustomBiddingScript

Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm that owns the script.

  • custom_bidding_script_object (Google::Apis::DisplayvideoV4::CustomBiddingScript) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent custom bidding algorithm.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4964

def create_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts', options)
  command.request_representation = Google::Apis::DisplayvideoV4::CustomBiddingScript::Representation
  command.request_object = custom_bidding_script_object
  command.response_representation = Google::Apis::DisplayvideoV4::CustomBiddingScript::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CustomBiddingScript
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_first_party_and_partner_audience(first_party_and_partner_audience_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience

Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

Parameters:

  • first_party_and_partner_audience_object (Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5185

def create_first_party_and_partner_audience(first_party_and_partner_audience_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/firstPartyAndPartnerAudiences', options)
  command.request_representation = Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience::Representation
  command.request_object = first_party_and_partner_audience_object
  command.response_representation = Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_guaranteed_order(guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::GuaranteedOrder

Creates a new guaranteed order. Returns the newly created guaranteed order if successful.

Parameters:

  • guaranteed_order_object (Google::Apis::DisplayvideoV4::GuaranteedOrder) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that the request is being made within.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that the request is being made within.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5663

def create_guaranteed_order(guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/guaranteedOrders', options)
  command.request_representation = Google::Apis::DisplayvideoV4::GuaranteedOrder::Representation
  command.request_object = guaranteed_order_object
  command.response_representation = Google::Apis::DisplayvideoV4::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV4::GuaranteedOrder
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_inventory_source(inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::InventorySource

Creates a new inventory source. Returns the newly created inventory source if successful.

Parameters:

  • inventory_source_object (Google::Apis::DisplayvideoV4::InventorySource) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that the request is being made within.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that the request is being made within.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6298

def create_inventory_source(inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/inventorySources', options)
  command.request_representation = Google::Apis::DisplayvideoV4::InventorySource::Representation
  command.request_object = inventory_source_object
  command.response_representation = Google::Apis::DisplayvideoV4::InventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV4::InventorySource
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_inventory_source_group(inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::InventorySourceGroup

Creates a new inventory source group. Returns the newly created inventory source group if successful.

Parameters:

  • inventory_source_group_object (Google::Apis::DisplayvideoV4::InventorySourceGroup) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5884

def create_inventory_source_group(inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/inventorySourceGroups', options)
  command.request_representation = Google::Apis::DisplayvideoV4::InventorySourceGroup::Representation
  command.request_object = inventory_source_group_object
  command.response_representation = Google::Apis::DisplayvideoV4::InventorySourceGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV4::InventorySourceGroup
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AssignedInventorySource

Creates an assignment between an inventory source and an inventory source group.

Parameters:

  • inventory_source_group_id (Fixnum) —

    Required. The ID of the inventory source group to which the assignment will be assigned.

  • assigned_inventory_source_object (Google::Apis::DisplayvideoV4::AssignedInventorySource) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6150

def create_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
  command.request_representation = Google::Apis::DisplayvideoV4::AssignedInventorySource::Representation
  command.request_object = assigned_inventory_source_object
  command.response_representation = Google::Apis::DisplayvideoV4::AssignedInventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AssignedInventorySource
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_partner_channel(partner_id, channel_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Channel

Creates a new channel. Returns the newly created channel if successful.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the created channel.

  • channel_object (Google::Apis::DisplayvideoV4::Channel) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the created channel.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6722

def create_partner_channel(partner_id, channel_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/partners/{+partnerId}/channels', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV4::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Channel
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_partner_channel_site(partner_id, channel_id, site_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Site

Creates a site in a channel.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel in which the site will be created.

  • site_object (Google::Apis::DisplayvideoV4::Site) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent channel.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6936

def create_partner_channel_site(partner_id, channel_id, site_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/partners/{partnerId}/channels/{+channelId}/sites', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DisplayvideoV4::Site::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Site
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AssignedTargetingOption

Assigns a targeting option to a partner. Returns the assigned targeting option if successful.

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL

  • assigned_targeting_option_object (Google::Apis::DisplayvideoV4::AssignedTargetingOption) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7117

def create_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AssignedTargetingOption
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_sdfdownloadtask_sdf_download_task(create_sdf_download_task_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Operation

Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtasks.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.

Parameters:

  • create_sdf_download_task_request_object (Google::Apis::DisplayvideoV4::CreateSdfDownloadTaskRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7292

def create_sdfdownloadtask_sdf_download_task(create_sdf_download_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/sdfdownloadtasks', options)
  command.request_representation = Google::Apis::DisplayvideoV4::CreateSdfDownloadTaskRequest::Representation
  command.request_object = create_sdf_download_task_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::Operation::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user(user_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::User

Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

  • user_object (Google::Apis::DisplayvideoV4::User) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7594

def create_user(user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/users', options)
  command.request_representation = Google::Apis::DisplayvideoV4::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::DisplayvideoV4::User::Representation
  command.response_class = Google::Apis::DisplayvideoV4::User
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser we need to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



150
151
152
153
154
155
156
157
158
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 150

def delete_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_ad_group(advertiser_id, ad_group_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes a AdGroup. Returns error code NOT_FOUND if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method will begin rolling out to all partners on June 10, 2026 and be available to all partners on June 24, 2026.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this ad group belongs to.

  • ad_group_id (Fixnum) —

    Required. The ID of the ad group to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



968
969
970
971
972
973
974
975
976
977
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 968

def delete_advertiser_ad_group(advertiser_id, ad_group_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_ad_group_ad(advertiser_id, ad_group_ad_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method will begin rolling out to all partners on June 10, 2026 and be available to all partners on June 24, 2026.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad belongs to.

  • ad_group_ad_id (Fixnum) —

    Required. The ID of the ad to delete. Only Demand Gen ads are supported.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



652
653
654
655
656
657
658
659
660
661
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 652

def delete_advertiser_ad_group_ad(advertiser_id, ad_group_ad_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupAdId'] = ad_group_ad_id unless ad_group_ad_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_ad_group_targeting_type_assigned_targeting_option(advertiser_id, ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat AD_GROUP_FORMAT_DEMAND_GEN. Retrieval and management of Demand Gen resources is currently in beta. This method will begin rolling out to all partners on * June 10, 2026* and be available to all partners on June 24, 2026.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad group belongs to.

  • ad_group_id (Fixnum) —

    Required. The ID of the ad group the assigned targeting option belongs to.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_GENDER * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SESSION_POSITION * TARGETING_TYPE_URL * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_YOUTUBE_VIDEO

  • assigned_targeting_option_id (String) —

    Required. The ID of the assigned targeting option to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1205

def delete_advertiser_ad_group_targeting_type_assigned_targeting_option(advertiser_id, ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_ad_group_youtube_asset_type_youtube_asset_association(advertiser_id, ad_group_id, youtube_asset_type, youtube_asset_association_id, linked_entity_line_item_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes an existing association between the identified resource and a YouTube asset. Warning: This method is only available to an informed subset of users.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser that the linked entity belongs to.

  • ad_group_id (Fixnum) —

    The ID of an ad group.

  • youtube_asset_type (String) —

    Required. The type of YouTube asset associated with the resource.

  • youtube_asset_association_id (Fixnum) —

    Required. The ID of the YouTube asset in the association. For YOUTUBE_ASSET_TYPE_LOCATION and YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is DISABLED. For YOUTUBE_ASSET_TYPE_SITELINK associations: This should be the ID of the sitelink asset linked.

  • linked_entity_line_item_id (Fixnum) (defaults to: nil) —

    The ID of a line item.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1418

def delete_advertiser_ad_group_youtube_asset_type_youtube_asset_association(advertiser_id, ad_group_id, youtube_asset_type, youtube_asset_association_id, linked_entity_line_item_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
  command.params['youtubeAssetAssociationId'] = youtube_asset_association_id unless youtube_asset_association_id.nil?
  command.query['linkedEntity.lineItemId'] = linked_entity_line_item_id unless linked_entity_line_item_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser this campaign belongs to.

  • campaign_id (Fixnum) —

    The ID of the campaign we need to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1598

def delete_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_channel_site(advertiser_id, channel_id, url_or_app_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes a site from a channel.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel to which the site belongs.

  • url_or_app_id (String) —

    Required. The URL or app ID of the site to delete.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent channel.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2025

def delete_advertiser_channel_site(advertiser_id, channel_id, url_or_app_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.params['urlOrAppId'] = url_or_app_id unless url_or_app_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes a creative. Returns error code NOT_FOUND if the creative does not exist. The creative should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, before it can be deleted. A "Standard" user role or greater for the parent advertiser or partner is required to make this request.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser this creative belongs to.

  • creative_id (Fixnum) —

    The ID of the creative to be deleted.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2202

def delete_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes an insertion order. Returns error code NOT_FOUND if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser this insertion order belongs to.

  • insertion_order_id (Fixnum) —

    The ID of the insertion order to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2429

def delete_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes a line item. Returns error code NOT_FOUND if the line item does not exist. The line item should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser this line item belongs to.

  • line_item_id (Fixnum) —

    The ID of the line item to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2872

def delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems. bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the line item belongs to.

  • line_item_id (Fixnum) —

    Required. The ID of the line item the assigned targeting option belongs to.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

    • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT
    • TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_INVENTORY_SOURCE * TARGETING_TYPE_INVENTORY_SOURCE_GROUP * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY
  • assigned_targeting_option_id (String) —

    Required. The ID of the assigned targeting option to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3196

def delete_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_line_item_youtube_asset_type_youtube_asset_association(advertiser_id, line_item_id, youtube_asset_type, youtube_asset_association_id, linked_entity_ad_group_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes an existing association between the identified resource and a YouTube asset. Warning: This method is only available to an informed subset of users.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser that the linked entity belongs to.

  • line_item_id (Fixnum) —

    The ID of a line item.

  • youtube_asset_type (String) —

    Required. The type of YouTube asset associated with the resource.

  • youtube_asset_association_id (Fixnum) —

    Required. The ID of the YouTube asset in the association. For YOUTUBE_ASSET_TYPE_LOCATION and YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is DISABLED. For YOUTUBE_ASSET_TYPE_SITELINK associations: This should be the ID of the sitelink asset linked.

  • linked_entity_ad_group_id (Fixnum) (defaults to: nil) —

    The ID of an ad group.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3450

def delete_advertiser_line_item_youtube_asset_type_youtube_asset_association(advertiser_id, line_item_id, youtube_asset_type, youtube_asset_association_id, linked_entity_ad_group_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
  command.params['youtubeAssetAssociationId'] = youtube_asset_association_id unless youtube_asset_association_id.nil?
  command.query['linkedEntity.adGroupId'] = linked_entity_ad_group_id unless linked_entity_ad_group_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes the assignment between a location and a location list.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the location list belongs.

  • location_list_id (Fixnum) —

    Required. The ID of the location list to which this assignment is assigned.

  • assigned_location_id (Fixnum) —

    Required. The ID of the assigned location to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3787

def delete_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.params['assignedLocationId'] = assigned_location_id unless assigned_location_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Required. The ID of the negative keyword list to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3917

def delete_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, keyword_value, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes a negative keyword from a negative keyword list.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Required. The ID of the parent negative keyword list to which the negative keyword belongs.

  • keyword_value (String) —

    Required. The keyword value of the negative keyword to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4153

def delete_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, keyword_value, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.params['keywordValue'] = keyword_value unless keyword_value.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes an assigned targeting option from an advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_OMID * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_KEYWORD

  • assigned_targeting_option_id (String) —

    Required. The ID of the assigned targeting option to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4334

def delete_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes an inventory source group.

Parameters:

  • inventory_source_group_id (Fixnum) —

    Required. The ID of the inventory source group to delete.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the inventory source group. Only this partner has write access to this group.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5923

def delete_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/inventorySourceGroups/{+inventorySourceGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes the assignment between an inventory source and an inventory source group.

Parameters:

  • inventory_source_group_id (Fixnum) —

    Required. The ID of the inventory source group to which this assignment is assigned.

  • assigned_inventory_source_id (Fixnum) —

    Required. The ID of the assigned inventory source to delete.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6194

def delete_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.params['assignedInventorySourceId'] = assigned_inventory_source_id unless assigned_inventory_source_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_partner_channel_site(partner_id, channel_id, url_or_app_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes a site from a channel.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel to which the site belongs.

  • url_or_app_id (String) —

    Required. The URL or app ID of the site to delete.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent channel.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6976

def delete_partner_channel_site(partner_id, channel_id, url_or_app_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.params['urlOrAppId'] = url_or_app_id unless url_or_app_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes an assigned targeting option from a partner.

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL

  • assigned_targeting_option_id (String) —

    Required. The ID of the assigned targeting option to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7155

def delete_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Empty

Deletes a user. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

  • user_id (Fixnum) —

    Required. The ID of the user to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7628
7629
7630
7631
7632
7633
7634
7635
7636
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7628

def delete_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/users/{+userId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Empty
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::GoogleBytestreamMedia

Downloads media. Download is supported on the URI /download/resource_name= ?alt=media. **Note: Download requests will not be successful without including alt=media query string.

Parameters:

  • resource_name (String) —

    Name of the media that is being downloaded. See ReadRequest.resource_name.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • download_dest (IO, String) (defaults to: nil) —

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6517

def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'download/{+resourceName}', options)
  else
    command = make_download_command(:get, 'download/{+resourceName}', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::DisplayvideoV4::GoogleBytestreamMedia::Representation
  command.response_class = Google::Apis::DisplayvideoV4::GoogleBytestreamMedia
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#duplicate_line_item(advertiser_id, line_item_id, duplicate_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::DuplicateLineItemResponse

Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. ** This method regularly experiences high latency.** We recommend increasing your default timeout to avoid errors.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this line item belongs to.

  • line_item_id (Fixnum) —

    Required. The ID of the line item to duplicate.

  • duplicate_line_item_request_object (Google::Apis::DisplayvideoV4::DuplicateLineItemRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2910

def duplicate_line_item(advertiser_id, line_item_id, duplicate_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate', options)
  command.request_representation = Google::Apis::DisplayvideoV4::DuplicateLineItemRequest::Representation
  command.request_object = duplicate_line_item_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::DuplicateLineItemResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::DuplicateLineItemResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#edit_advertiser_assigned_targeting_options(advertiser_id, bulk_edit_advertiser_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkEditAdvertiserAssignedTargetingOptionsResponse

Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser.

  • bulk_edit_advertiser_assigned_targeting_options_request_object (Google::Apis::DisplayvideoV4::BulkEditAdvertiserAssignedTargetingOptionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 185

def edit_advertiser_assigned_targeting_options(advertiser_id, bulk_edit_advertiser_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}:editAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkEditAdvertiserAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_advertiser_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkEditAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkEditAdvertiserAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#edit_first_party_and_partner_audience_customer_match_members(first_party_and_partner_audience_id, edit_customer_match_members_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::EditCustomerMatchMembersResponse

Updates the member list of a Customer Match audience. Only supported for the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

Parameters:

  • first_party_and_partner_audience_id (Fixnum) —

    Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited.

  • edit_customer_match_members_request_object (Google::Apis::DisplayvideoV4::EditCustomerMatchMembersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5221

def edit_first_party_and_partner_audience_customer_match_members(first_party_and_partner_audience_id, edit_customer_match_members_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}:editCustomerMatchMembers', options)
  command.request_representation = Google::Apis::DisplayvideoV4::EditCustomerMatchMembersRequest::Representation
  command.request_object = edit_customer_match_members_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::EditCustomerMatchMembersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::EditCustomerMatchMembersResponse
  command.params['firstPartyAndPartnerAudienceId'] = first_party_and_partner_audience_id unless first_party_and_partner_audience_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#edit_guaranteed_order_read_accessors(guaranteed_order_id, edit_guaranteed_order_read_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::EditGuaranteedOrderReadAccessorsResponse

Edits read advertisers of a guaranteed order.

Parameters:

  • guaranteed_order_id (String) —

    Required. The ID of the guaranteed order to edit. The ID is of the format exchange`-`legacy_guaranteed_order_id

  • edit_guaranteed_order_read_accessors_request_object (Google::Apis::DisplayvideoV4::EditGuaranteedOrderReadAccessorsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5698

def edit_guaranteed_order_read_accessors(guaranteed_order_id, edit_guaranteed_order_read_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors', options)
  command.request_representation = Google::Apis::DisplayvideoV4::EditGuaranteedOrderReadAccessorsRequest::Representation
  command.request_object = edit_guaranteed_order_read_accessors_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::EditGuaranteedOrderReadAccessorsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::EditGuaranteedOrderReadAccessorsResponse
  command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#edit_inventory_source_read_write_accessors(inventory_source_id, edit_inventory_source_read_write_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::InventorySourceAccessors

Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.

Parameters:

  • inventory_source_id (Fixnum) —

    Required. The ID of inventory source to update.

  • edit_inventory_source_read_write_accessors_request_object (Google::Apis::DisplayvideoV4::EditInventorySourceReadWriteAccessorsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6333

def edit_inventory_source_read_write_accessors(inventory_source_id, edit_inventory_source_read_write_accessors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors', options)
  command.request_representation = Google::Apis::DisplayvideoV4::EditInventorySourceReadWriteAccessorsRequest::Representation
  command.request_object = edit_inventory_source_read_write_accessors_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::InventorySourceAccessors::Representation
  command.response_class = Google::Apis::DisplayvideoV4::InventorySourceAccessors
  command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#edit_partner_assigned_targeting_options(partner_id, bulk_edit_partner_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkEditPartnerAssignedTargetingOptionsResponse

Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner.

  • bulk_edit_partner_assigned_targeting_options_request_object (Google::Apis::DisplayvideoV4::BulkEditPartnerAssignedTargetingOptionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6602

def edit_partner_assigned_targeting_options(partner_id, bulk_edit_partner_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/partners/{+partnerId}:editAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV4::BulkEditPartnerAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_partner_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::BulkEditPartnerAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkEditPartnerAssignedTargetingOptionsResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Advertiser

Gets an advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



217
218
219
220
221
222
223
224
225
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 217

def get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Advertiser
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_ad_asset(advertiser_id, ad_asset_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AdAsset

Gets an ad asset. Only supports the retrieval of assets of AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this ad asset belongs to.

  • ad_asset_id (Fixnum) —

    Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



480
481
482
483
484
485
486
487
488
489
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 480

def get_advertiser_ad_asset(advertiser_id, ad_asset_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::AdAsset::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AdAsset
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adAssetId'] = ad_asset_id unless ad_asset_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_ad_group(advertiser_id, ad_group_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AdGroup

Gets an ad group.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this ad group belongs to.

  • ad_group_id (Fixnum) —

    Required. The ID of the ad group to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1001

def get_advertiser_ad_group(advertiser_id, ad_group_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::AdGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AdGroup
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_ad_group_ad(advertiser_id, ad_group_ad_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AdGroupAd

Gets an ad group ad.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this ad group ad belongs to.

  • ad_group_ad_id (Fixnum) —

    Required. The ID of the ad to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



685
686
687
688
689
690
691
692
693
694
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 685

def get_advertiser_ad_group_ad(advertiser_id, ad_group_ad_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::AdGroupAd::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AdGroupAd
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupAdId'] = ad_group_ad_id unless ad_group_ad_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_ad_group_targeting_type_assigned_targeting_option(advertiser_id, ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AssignedTargetingOption

Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad group belongs to.

  • ad_group_id (Fixnum) —

    Required. The ID of the ad group the assigned targeting option belongs to.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_GENDER * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SESSION_POSITION * TARGETING_TYPE_URL * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_YOUTUBE_VIDEO

  • assigned_targeting_option_id (String) —

    Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1254

def get_advertiser_ad_group_targeting_type_assigned_targeting_option(advertiser_id, ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Campaign

Gets a campaign.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this campaign belongs to.

  • campaign_id (Fixnum) —

    Required. The ID of the campaign to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1631

def get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Campaign::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Campaign
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Channel

Gets a channel for a partner or advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the fetched channel.

  • channel_id (Fixnum) —

    Required. The ID of the channel to fetch.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the fetched channel.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1808

def get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/channels/{+channelId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Channel
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Creative

Gets a creative.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this creative belongs to.

  • creative_id (Fixnum) —

    Required. The ID of the creative to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2235

def get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Creative::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Creative
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::InsertionOrder

Gets an insertion order. Returns error code NOT_FOUND if the insertion order does not exist.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this insertion order belongs to.

  • insertion_order_id (Fixnum) —

    Required. The ID of the insertion order to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2463

def get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV4::InsertionOrder
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::LineItem

Gets a line item.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this line item belongs to.

  • line_item_id (Fixnum) —

    Required. The ID of the line item to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2945

def get_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV4::LineItem
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AssignedTargetingOption

Gets a single targeting option assigned to a line item.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the line item belongs to.

  • line_item_id (Fixnum) —

    Required. The ID of the line item the assigned targeting option belongs to.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

    • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT
    • TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_INVENTORY_SOURCE * TARGETING_TYPE_INVENTORY_SOURCE_GROUP * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_YOUTUBE_CHANNEL (only for LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE line items) * TARGETING_TYPE_YOUTUBE_VIDEO (only for LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE line items)
  • assigned_targeting_option_id (String) —

    Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3264

def get_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::LocationList

Gets a location list.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the fetched location list belongs.

  • location_list_id (Fixnum) —

    Required. The ID of the location list to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3579

def get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/locationLists/{+locationListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV4::LocationList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::NegativeKeywordList

Gets a negative keyword list given an advertiser ID and a negative keyword list ID.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Required. The ID of the negative keyword list to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3952

def get_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::NegativeKeywordList::Representation
  command.response_class = Google::Apis::DisplayvideoV4::NegativeKeywordList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AssignedTargetingOption

Gets a single targeting option assigned to an advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_OMID * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_YOUTUBE_VIDEO * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_CONTENT_THEME_EXCLUSION

  • assigned_targeting_option_id (String) —

    Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4376

def get_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CombinedAudience

Gets a combined audience.

Parameters:

  • combined_audience_id (Fixnum) —

    Required. The ID of the combined audience to fetch.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the fetched combined audience.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the fetched combined audience.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4478

def get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/combinedAudiences/{+combinedAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::CombinedAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CombinedAudience
  command.params['combinedAudienceId'] = combined_audience_id unless combined_audience_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_bidding_algorithm(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm

Gets a custom bidding algorithm.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm to fetch.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the DV360 partner that has access to the custom bidding algorithm.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the DV360 partner that has access to the custom bidding algorithm.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4605

def get_custom_bidding_algorithm(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_bidding_algorithm_rule(custom_bidding_algorithm_id, custom_bidding_algorithm_rules_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRules

Retrieves a rules resource.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm that owns the rules resource.

  • custom_bidding_algorithm_rules_id (Fixnum) —

    Required. The ID of the rules resource to fetch.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent custom bidding algorithm.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent custom bidding algorithm.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4870

def get_custom_bidding_algorithm_rule(custom_bidding_algorithm_id, custom_bidding_algorithm_rules_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRules::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRules
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.params['customBiddingAlgorithmRulesId'] = custom_bidding_algorithm_rules_id unless custom_bidding_algorithm_rules_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CustomBiddingScript

Gets a custom bidding script.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm owns the script.

  • custom_bidding_script_id (Fixnum) —

    Required. The ID of the custom bidding script to fetch.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent custom bidding algorithm.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5005

def get_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::CustomBiddingScript::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CustomBiddingScript
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.params['customBiddingScriptId'] = custom_bidding_script_id unless custom_bidding_script_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CustomList

Gets a custom list.

Parameters:

  • custom_list_id (Fixnum) —

    Required. The ID of the custom list to fetch.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the DV360 advertiser that has access to the fetched custom lists.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5094

def get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/customLists/{+customListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::CustomList::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CustomList
  command.params['customListId'] = custom_list_id unless custom_list_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_first_party_and_partner_audience(first_party_and_partner_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience

Gets a first party or partner audience.

Parameters:

  • first_party_and_partner_audience_id (Fixnum) —

    Required. The ID of the first party and partner audience to fetch.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the fetched first party and partner audience.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the fetched first party and partner audience.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5259

def get_first_party_and_partner_audience(first_party_and_partner_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience
  command.params['firstPartyAndPartnerAudienceId'] = first_party_and_partner_audience_id unless first_party_and_partner_audience_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::FloodlightGroup

Gets a Floodlight group.

Parameters:

  • floodlight_group_id (Fixnum) —

    Required. The ID of the Floodlight group to fetch.

  • partner_id (Fixnum) (defaults to: nil) —

    Required. The partner context by which the Floodlight group is being accessed.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5402

def get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/floodlightGroups/{+floodlightGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::FloodlightGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV4::FloodlightGroup
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_floodlight_group_floodlight_activity(floodlight_group_id, floodlight_activity_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::FloodlightActivity

Gets a Floodlight activity.

Parameters:

  • floodlight_group_id (Fixnum) —

    Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.

  • floodlight_activity_id (Fixnum) —

    Required. The ID of the Floodlight activity to fetch.

  • partner_id (Fixnum) (defaults to: nil) —

    Required. The ID of the partner through which the Floodlight activity is being accessed.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5479

def get_floodlight_group_floodlight_activity(floodlight_group_id, floodlight_activity_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::FloodlightActivity::Representation
  command.response_class = Google::Apis::DisplayvideoV4::FloodlightActivity
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.params['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::GoogleAudience

Gets a Google audience.

Parameters:

  • google_audience_id (Fixnum) —

    Required. The ID of the Google audience to fetch.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the fetched Google audience.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the fetched Google audience.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5567

def get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/googleAudiences/{+googleAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::GoogleAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV4::GoogleAudience
  command.params['googleAudienceId'] = google_audience_id unless google_audience_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_guaranteed_order(guaranteed_order_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::GuaranteedOrder

Gets a guaranteed order.

Parameters:

  • guaranteed_order_id (String) —

    Required. The ID of the guaranteed order to fetch. The ID is of the format exchange`-`legacy_guaranteed_order_id

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the guaranteed order.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the guaranteed order.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5735

def get_guaranteed_order(guaranteed_order_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/guaranteedOrders/{+guaranteedOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV4::GuaranteedOrder
  command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_inventory_source(inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::InventorySource

Gets an inventory source.

Parameters:

  • inventory_source_id (Fixnum) —

    Required. The ID of the inventory source to fetch.

  • advertiser_id (Fixnum) (defaults to: nil) —

    Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.

  • partner_id (Fixnum) (defaults to: nil) —

    Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6372

def get_inventory_source(inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/inventorySources/{+inventorySourceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::InventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV4::InventorySource
  command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::InventorySourceGroup

Gets an inventory source group.

Parameters:

  • inventory_source_group_id (Fixnum) —

    Required. The ID of the inventory source group to fetch.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5962

def get_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/inventorySourceGroups/{+inventorySourceGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::InventorySourceGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV4::InventorySourceGroup
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_partner(partner_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Partner

Gets a partner.

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6634
6635
6636
6637
6638
6639
6640
6641
6642
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6634

def get_partner(partner_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/partners/{+partnerId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Partner::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Partner
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Channel

Gets a channel for a partner or advertiser.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the fetched channel.

  • channel_id (Fixnum) —

    Required. The ID of the channel to fetch.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the fetched channel.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6759

def get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/partners/{+partnerId}/channels/{+channelId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Channel
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AssignedTargetingOption

Gets a single targeting option assigned to a partner.

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner.

  • targeting_type (String) —

    Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL

  • assigned_targeting_option_id (String) —

    Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7193

def get_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AssignedTargetingOption
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Operation

Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7324
7325
7326
7327
7328
7329
7330
7331
7332
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7324

def get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/{+name}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Operation::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_sdfuploadtask_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Operation

Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7355
7356
7357
7358
7359
7360
7361
7362
7363
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7355

def get_sdfuploadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/{+name}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::Operation::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_targeting_type_targeting_option(targeting_type, targeting_option_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::TargetingOption

Gets a single targeting option.

Parameters:

  • targeting_type (String) —

    Required. The type of targeting option to retrieve. Accepted values are: * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_ENVIRONMENT * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_OMID

  • targeting_option_id (String) —

    Required. The ID of the of targeting option to retrieve.

  • advertiser_id (Fixnum) (defaults to: nil) —

    Required. The Advertiser this request is being made in the context of.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7404

def get_targeting_type_targeting_option(targeting_type, targeting_option_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::TargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV4::TargetingOption
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['targetingOptionId'] = targeting_option_id unless targeting_option_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::User

Gets a user. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

  • user_id (Fixnum) —

    Required. The ID of the user to fetch.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7661
7662
7663
7664
7665
7666
7667
7668
7669
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7661

def get_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/users/{+userId}', options)
  command.response_representation = Google::Apis::DisplayvideoV4::User::Representation
  command.response_class = Google::Apis::DisplayvideoV4::User
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_ad_assets(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListAdAssetsResponse

Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad assets belong to.

  • filter (String) (defaults to: nil) —

    Optional. Allows filtering of the results by ad asset fields. Supported syntax:

    • A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * youtubeVideoAsset. youtubeVideoId * entityStatus Examples: * All active YouTube video ad assets under an advertiser: entityStatus=ENTITY_STATUS_ACTIVE
  • order_by (String) (defaults to: nil) —

    Optional. Field by which to sort the list. Acceptable values are: * entityStatus * youtubeVideoAsset.youtubeVideoId * adAssetId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: adAssetId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. Must be between 1 and 5000. If unspecified will default to 5000. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdAssets method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 532

def list_advertiser_ad_assets(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adAssets', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListAdAssetsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListAdAssetsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_ad_group_ads(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListAdGroupAdsResponse

Lists ad group ads.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ads belong to.

  • filter (String) (defaults to: nil) —

    Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND and OR. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * adGroupId * displayName

    • entityStatus * adGroupAdId Examples: * All ad group ads under an ad group: adGroupId="1234" * All ad group ads under an ad group with an entityStatus of ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED: ( entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.
  • order_by (String) (defaults to: nil) —

    Optional. Field by which to sort the list. Acceptable values are: * displayName (default) * entityStatus The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdGroupAds method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 743

def list_advertiser_ad_group_ads(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adGroupAds', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListAdGroupAdsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListAdGroupAdsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_ad_group_targeting_type_assigned_targeting_options(advertiser_id, ad_group_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListAdGroupAssignedTargetingOptionsResponse

Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad group belongs to.

  • ad_group_id (Fixnum) —

    Required. The ID of the ad group to list assigned targeting options for.

  • targeting_type (String) —

    Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_GENDER * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SESSION_POSITION * TARGETING_TYPE_URL * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_YOUTUBE_VIDEO

  • filter (String) (defaults to: nil) —

    Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId Examples: * AssignedTargetingOption resources with ID 1 or 2: assignedTargetingOptionId=" 1" OR assignedTargetingOptionId="2" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Optional. Field by which to sort the list. Acceptable values are: * assignedTargetingOptionId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: assignedTargetingOptionId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. Must be between 1 and 5000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdGroupAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1324

def list_advertiser_ad_group_targeting_type_assigned_targeting_options(advertiser_id, ad_group_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListAdGroupAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListAdGroupAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_ad_group_youtube_asset_type_youtube_asset_associations(advertiser_id, ad_group_id, youtube_asset_type, linked_entity_line_item_id: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse

Lists the YouTube asset associations linked to the given resource.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser that the linked entity belongs to.

  • ad_group_id (Fixnum) —

    The ID of an ad group.

  • youtube_asset_type (String) —

    Required. The type of YouTube asset being associated with the resource.

  • linked_entity_line_item_id (Fixnum) (defaults to: nil) —

    The ID of a line item.

  • order_by (String) (defaults to: nil) —

    Optional. Field by which to sort the list. The only acceptable values are: * linkedYoutubeAsset.locationAssetFilter.assetSetId, * linkedYoutubeAsset. affiliateLocationAssetFilter.assetSetId, * linkedYoutubeAsset.sitelinkAsset. assetId The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: linkedYoutubeAsset.sitelinkAsset.assetId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListYoutubeAssetAssociations method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1474

def list_advertiser_ad_group_youtube_asset_type_youtube_asset_associations(advertiser_id, ad_group_id, youtube_asset_type, linked_entity_line_item_id: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
  command.query['linkedEntity.lineItemId'] = linked_entity_line_item_id unless linked_entity_line_item_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_ad_groups(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListAdGroupsResponse

Lists ad groups.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad groups belongs to.

  • filter (String) (defaults to: nil) —

    Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND and OR. A sequence of restrictions implicitly uses AND . * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported properties: * adGroupId * displayName * entityStatus * lineItemId * adGroupFormat Examples: * All ad groups under an line item: lineItemId="1234" * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM ad groups under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus=" ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Optional. Field by which to sort the list. Acceptable values are: * displayName (default) * entityStatus The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdGroups method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1060

def list_advertiser_ad_groups(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/adGroups', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListAdGroupsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListAdGroupsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::BulkListAdvertiserAssignedTargetingOptionsResponse

Lists assigned targeting options of an advertiser across targeting types.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the line item belongs to.

  • filter (String) (defaults to: nil) —

    Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * targetingType Examples: * targetingType with value TARGETING_TYPE_CHANNEL targetingType="TARGETING_TYPE_CHANNEL" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * targetingType ( default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: targetingType desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The size must be an integer between 1 and 5000. If unspecified, the default is '5000'. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to BulkListAdvertiserAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 337

def list_advertiser_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}:listAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV4::BulkListAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::BulkListAdvertiserAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_campaigns(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListCampaignsResponse

Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser to list campaigns for.

  • filter (String) (defaults to: nil) —

    Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. Supported fields: * campaignId * displayName * entityStatus * updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED campaigns under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus=" ENTITY_STATUS_PAUSED") * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54: 47Z" * All campaigns with an update time greater than or equal to 2020-11- 04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * entityStatus * updateTime The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCampaigns method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1695

def list_advertiser_campaigns(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/campaigns', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListCampaignsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListCampaignsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_channel_sites(advertiser_id, channel_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListSitesResponse

Lists sites in a channel.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel to which the requested sites belong.

  • filter (String) (defaults to: nil) —

    Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * urlOrAppId ( default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: urlOrAppId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListSites method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent channel.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2085

def list_advertiser_channel_sites(advertiser_id, channel_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/channels/{+channelId}/sites', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListSitesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_channels(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListChannelsResponse

Lists channels for a partner or advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the channels.

  • filter (String) (defaults to: nil) —

    Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All channels for which the display name contains "google": displayName : "google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * channelId The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListChannels method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the channels.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1865

def list_advertiser_channels(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/channels', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListChannelsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListChannelsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_creatives(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListCreativesResponse

Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to list creatives for.

  • filter (String) (defaults to: nil) —

    Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * The lineItemIds field must use the HAS (:) operator. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. * For entityStatus, minDuration, maxDuration, updateTime, and dynamic fields, there may be at most one restriction. Supported Fields: * approvalStatus * creativeId * creativeType * dimensions (input in the form of width`x`height) * dynamic * entityStatus * exchangeReviewStatus (input in the form of exchange`-`reviewStatus) * lineItemIds * maxDuration (input in the form of duration`s`. Only seconds are supported) * `minDuration` (input in the form ofdurations. Only seconds are supported) * updateTime (input in ISO 8601 format, or YYYY-MM- DDTHH:MM:SSZ) Notes: * For updateTime, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: creativeType="CREATIVE_TYPE_NATIVE" * All active creatives with 300x400 or 50x100 dimensions: entityStatus="ENTITY_STATUS_ACTIVE" AND ( dimensions="300x400" OR dimensions="50x100") * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus=" EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus=" EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED") * All video creatives that are associated with line item ID 1 or 2: creativeType="CREATIVE_TYPE_VIDEO" AND ( lineItemIds:1 OR lineItemIds:2) * Find creatives by multiple creative IDs: creativeId=1 OR creativeId=2 * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11- 04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * creativeId ( default) * createTime * mediaDuration * dimensions (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: createTime desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCreatives method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2316

def list_advertiser_creatives(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/creatives', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListCreativesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListCreativesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListInsertionOrdersResponse

Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to list insertion orders for.

  • filter (String) (defaults to: nil) —

    Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` ` value. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. Supported fields: * campaignId * displayName * entityStatus * updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM: SSZ) Examples: * All insertion orders under a campaign: campaignId="1234" * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED insertion orders under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus=" ENTITY_STATUS_PAUSED") * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11- 04T18:54:47Z" * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11- 04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * "displayName" ( default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListInsertionOrders method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2529

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)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/insertionOrders', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListInsertionOrdersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListInsertionOrdersResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_invoices(advertiser_id, issue_month: nil, loi_sapin_invoice_type: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListInvoicesResponse

Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to list invoices for.

  • issue_month (String) (defaults to: nil) —

    The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.

  • loi_sapin_invoice_type (String) (defaults to: nil) —

    Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListInvoices method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2620

def list_advertiser_invoices(advertiser_id, issue_month: nil, loi_sapin_invoice_type: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/invoices', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListInvoicesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListInvoicesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['issueMonth'] = issue_month unless issue_month.nil?
  command.query['loiSapinInvoiceType'] = loi_sapin_invoice_type unless loi_sapin_invoice_type.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_line_item_targeting_type_assigned_targeting_options(advertiser_id, line_item_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListLineItemAssignedTargetingOptionsResponse

Lists the targeting options assigned to a line item.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the line item belongs to.

  • line_item_id (Fixnum) —

    Required. The ID of the line item to list assigned targeting options for.

  • targeting_type (String) —

    Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

    • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT
    • TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_INVENTORY_SOURCE * TARGETING_TYPE_INVENTORY_SOURCE_GROUP * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_YOUTUBE_CHANNEL (only for LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE line items) * TARGETING_TYPE_YOUTUBE_VIDEO (only for LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE line items)
  • filter (String) (defaults to: nil) —

    Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId * inheritance Examples: * AssignedTargetingOption resources with ID 1 or 2: assignedTargetingOptionId=" 1" OR assignedTargetingOptionId="2" * AssignedTargetingOption resources with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER: inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedTargetingOptionId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: assignedTargetingOptionId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 5000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListLineItemAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3356

def list_advertiser_line_item_targeting_type_assigned_targeting_options(advertiser_id, line_item_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListLineItemAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListLineItemAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_line_item_youtube_asset_type_youtube_asset_associations(advertiser_id, line_item_id, youtube_asset_type, linked_entity_ad_group_id: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse

Lists the YouTube asset associations linked to the given resource.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser that the linked entity belongs to.

  • line_item_id (Fixnum) —

    The ID of a line item.

  • youtube_asset_type (String) —

    Required. The type of YouTube asset being associated with the resource.

  • linked_entity_ad_group_id (Fixnum) (defaults to: nil) —

    The ID of an ad group.

  • order_by (String) (defaults to: nil) —

    Optional. Field by which to sort the list. The only acceptable values are: * linkedYoutubeAsset.locationAssetFilter.assetSetId, * linkedYoutubeAsset. affiliateLocationAssetFilter.assetSetId, * linkedYoutubeAsset.sitelinkAsset. assetId The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: linkedYoutubeAsset.sitelinkAsset.assetId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListYoutubeAssetAssociations method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3506

def list_advertiser_line_item_youtube_asset_type_youtube_asset_associations(advertiser_id, line_item_id, youtube_asset_type, linked_entity_ad_group_id: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListYoutubeAssetAssociationsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['youtubeAssetType'] = youtube_asset_type unless youtube_asset_type.nil?
  command.query['linkedEntity.adGroupId'] = linked_entity_ad_group_id unless linked_entity_ad_group_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_line_items(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListLineItemsResponse

Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to list line items for.

  • filter (String) (defaults to: nil) —

    Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. Supported fields: * campaignId * displayName * entityStatus * insertionOrderId * lineItemId * lineItemType * updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All line items under an insertion order: insertionOrderId="1234" * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED and LINE_ITEM_TYPE_DISPLAY_DEFAULT line items under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus=" ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" * All line items with an update time less than or equal to 2020-11-04T18:54:47Z ( format of ISO 8601): updateTime<="2020-11-04T18:54:47Z" * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * entityStatus * updateTime The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListLineItems method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3012

def list_advertiser_line_items(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/lineItems', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListLineItemsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListLineItemsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_location_list_assigned_locations(advertiser_id, location_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListAssignedLocationsResponse

Lists locations assigned to a location list.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the location list belongs.

  • location_list_id (Fixnum) —

    Required. The ID of the location list to which these assignments are assigned.

  • filter (String) (defaults to: nil) —

    Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedLocationId The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedLocationId (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: assignedLocationId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAssignedLocations method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3843

def list_advertiser_location_list_assigned_locations(advertiser_id, location_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListAssignedLocationsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListAssignedLocationsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_location_lists(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListLocationListsResponse

Lists location lists based on a given advertiser id.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the fetched location lists belong.

  • filter (String) (defaults to: nil) —

    Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` ` value. * All fields must use the EQUALS (=) operator. Supported fields: * locationType Examples: * All regional location list: locationType=" TARGETING_LOCATION_TYPE_REGIONAL" * All proximity location list: locationType="TARGETING_LOCATION_TYPE_PROXIMITY" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * locationListId ( default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. Defaults to 100 if not set. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListLocationLists method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3635

def list_advertiser_location_lists(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/locationLists', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListLocationListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListLocationListsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_negative_keyword_list_negative_keywords(advertiser_id, negative_keyword_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListNegativeKeywordsResponse

Lists negative keywords in a negative keyword list.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Required. The ID of the parent negative keyword list to which the requested negative keywords belong.

  • filter (String) (defaults to: nil) —

    Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * keywordValue Examples: * All negative keywords for which the keyword value contains "google": keywordValue : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * keywordValue ( default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: keywordValue desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 1000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListNegativeKeywords method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4212

def list_advertiser_negative_keyword_list_negative_keywords(advertiser_id, negative_keyword_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListNegativeKeywordsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListNegativeKeywordListsResponse

Lists negative keyword lists based on a given advertiser id.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. Defaults to 100 if not set. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListNegativeKeywordLists method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3992

def list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/negativeKeywordLists', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListNegativeKeywordListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListNegativeKeywordListsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_targeting_type_assigned_targeting_options(advertiser_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListAdvertiserAssignedTargetingOptionsResponse

Lists the targeting options assigned to an advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser.

  • targeting_type (String) —

    Required. Identifies the type of assigned targeting options to list. Supported targeting types: * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_OMID * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_YOUTUBE_VIDEO * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_CONTENT_THEME_EXCLUSION

  • filter (String) (defaults to: nil) —

    Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId Examples: * AssignedTargetingOption with ID 123456: assignedTargetingOptionId="123456" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedTargetingOptionId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: assignedTargetingOptionId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 5000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdvertiserAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4439

def list_advertiser_targeting_type_assigned_targeting_options(advertiser_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListAdvertiserAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListAdvertisersResponse

Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross- partner listing is not supported.

Parameters:

  • filter (String) (defaults to: nil) —

    Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. * A restriction has the form of field` ` operator` `value. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. Supported fields: * advertiserId * displayName * entityStatus * updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All active advertisers under a partner: entityStatus="ENTITY_STATUS_ACTIVE" * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<=" 2020-11-04T18:54:47Z" * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11- 04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * advertiserId ( default) * displayName * entityStatus * updateTime The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdvertisers method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 279

def list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListAdvertisersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListAdvertisersResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_combined_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) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListCombinedAudiencesResponse

Lists combined audiences. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the fetched combined audiences.

  • filter (String) (defaults to: nil) —

    Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All combined audiences for which the display name contains "Google": displayName : "Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * combinedAudienceId (default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCombinedAudiences method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the fetched combined audiences.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4535

def list_combined_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)
  command = make_simple_command(:get, 'v4/combinedAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListCombinedAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListCombinedAudiencesResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_bidding_algorithm_rules(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListCustomBiddingAlgorithmRulesResponse

Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm that owns the rules resource.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent custom bidding algorithm.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * createTime desc ( default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: createTime.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCustomBiddingAlgorithmRules method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent custom bidding algorithm.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4921

def list_custom_bidding_algorithm_rules(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListCustomBiddingAlgorithmRulesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListCustomBiddingAlgorithmRulesResponse
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_bidding_algorithm_scripts(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListCustomBiddingScriptsResponse

Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm owns the script.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent custom bidding algorithm.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * createTime desc ( default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: createTime.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCustomBiddingScripts method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5057

def list_custom_bidding_algorithm_scripts(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListCustomBiddingScriptsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListCustomBiddingScriptsResponse
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_bidding_algorithms(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListCustomBiddingAlgorithmsResponse

Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the DV360 advertiser that has access to the custom bidding algorithm.

  • filter (String) (defaults to: nil) —

    Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * The customBiddingAlgorithmType field must use the EQUALS (=) operator. * The displayName field must use the HAS (:) operator. Supported fields: * customBiddingAlgorithmType * displayName Examples: * All custom bidding algorithms for which the display name contains "politics": displayName:" politics". * All custom bidding algorithms for which the type is " SCRIPT_BASED": customBiddingAlgorithmType=SCRIPT_BASED The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCustomBiddingAlgorithms method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the DV360 partner that has access to the custom bidding algorithm.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4669

def list_custom_bidding_algorithms(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)
  command = make_simple_command(:get, 'v4/customBiddingAlgorithms', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListCustomBiddingAlgorithmsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListCustomBiddingAlgorithmsResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_lists(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListCustomListsResponse

Lists custom lists. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the DV360 advertiser that has access to the fetched custom lists.

  • filter (String) (defaults to: nil) —

    Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All custom lists for which the display name contains "Google": displayName:"Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * customListId ( default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCustomLists method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5148

def list_custom_lists(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/customLists', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListCustomListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListCustomListsResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_first_party_and_partner_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) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListFirstPartyAndPartnerAudiencesResponse

Lists first party and partner audiences. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the fetched first party and partner audiences.

  • filter (String) (defaults to: nil) —

    Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner audiences can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All first party and partner audiences for which the display name contains "Google": displayName:"Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Optional. Field by which to sort the list. Acceptable values are: * FirstPartyAndPartnerAudienceId (default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. Must be between 1 and 5000. If unspecified, this value defaults to 5000. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListFirstPartyAndPartnerAudiences method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the fetched first party and partner audiences.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5320

def list_first_party_and_partner_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)
  command = make_simple_command(:get, 'v4/firstPartyAndPartnerAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListFirstPartyAndPartnerAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListFirstPartyAndPartnerAudiencesResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_floodlight_group_floodlight_activities(floodlight_group_id, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListFloodlightActivitiesResponse

Lists Floodlight activities in a Floodlight group.

Parameters:

  • floodlight_group_id (Fixnum) —

    Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.

  • order_by (String) (defaults to: nil) —

    Optional. Field by which to sort the list. Acceptable values are: * displayName (default) * floodlightActivityId The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListFloodlightActivities method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    Required. The ID of the partner through which the Floodlight activities are being accessed.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5529

def list_floodlight_group_floodlight_activities(floodlight_group_id, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListFloodlightActivitiesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListFloodlightActivitiesResponse
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_google_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) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListGoogleAudiencesResponse

Lists Google audiences. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the fetched Google audiences.

  • filter (String) (defaults to: nil) —

    Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All Google audiences for which the display name contains "Google": displayName:" Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * googleAudienceId ( default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListGoogleAudiences method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the fetched Google audiences.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5624

def list_google_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)
  command = make_simple_command(:get, 'v4/googleAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListGoogleAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListGoogleAudiencesResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_guaranteed_orders(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListGuaranteedOrdersResponse

Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the guaranteed order.

  • filter (String) (defaults to: nil) —

    Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * guaranteed_order_id * exchange * display_name * status.entityStatus Examples: * All active guaranteed orders: status.entityStatus="ENTITY_STATUS_ACTIVE" * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: exchange=" EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListGuaranteedOrders method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the guaranteed order.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5798

def list_guaranteed_orders(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)
  command = make_simple_command(:get, 'v4/guaranteedOrders', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListGuaranteedOrdersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListGuaranteedOrdersResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_inventory_source_group_assigned_inventory_sources(inventory_source_group_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListAssignedInventorySourcesResponse

Lists inventory sources assigned to an inventory source group.

Parameters:

  • inventory_source_group_id (Fixnum) —

    Required. The ID of the inventory source group to which these assignments are assigned.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.

  • filter (String) (defaults to: nil) —

    Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedInventorySourceId The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedInventorySourceId (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: assignedInventorySourceId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAssignedInventorySources method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6258

def list_inventory_source_group_assigned_inventory_sources(inventory_source_group_id, 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)
  command = make_simple_command(:get, 'v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListAssignedInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListAssignedInventorySourcesResponse
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_inventory_source_groups(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListInventorySourceGroupsResponse

Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

  • filter (String) (defaults to: nil) —

    Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * inventorySourceGroupId The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * inventorySourceGroupId The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListInventorySources method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6021

def list_inventory_source_groups(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)
  command = make_simple_command(:get, 'v4/inventorySourceGroups', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListInventorySourceGroupsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListInventorySourceGroupsResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_inventory_sources(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListInventorySourcesResponse

Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the inventory source.

  • filter (String) (defaults to: nil) —

    Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` ` value. * All fields must use the EQUALS (=) operator. Supported fields: * status.entityStatus * commitment * deliveryMethod * rateDetails.rateType

    • exchange Examples: * All active inventory sources: status.entityStatus=" ENTITY_STATUS_ACTIVE" * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange=" EXCHANGE_RUBICON" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.
  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListInventorySources method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the inventory source.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6435

def list_inventory_sources(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)
  command = make_simple_command(:get, 'v4/inventorySources', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListInventorySourcesResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partner_channel_sites(partner_id, channel_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListSitesResponse

Lists sites in a channel.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel to which the requested sites belong.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent channel.

  • filter (String) (defaults to: nil) —

    Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * urlOrAppId ( default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: urlOrAppId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListSites method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7036

def list_partner_channel_sites(partner_id, channel_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/partners/{+partnerId}/channels/{+channelId}/sites', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListSitesResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partner_channels(partner_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListChannelsResponse

Lists channels for a partner or advertiser.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the channels.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the channels.

  • filter (String) (defaults to: nil) —

    Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All channels for which the display name contains "google": displayName : "google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * channelId The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListChannels method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6816

def list_partner_channels(partner_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/partners/{+partnerId}/channels', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListChannelsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListChannelsResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partner_targeting_type_assigned_targeting_options(partner_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListPartnerAssignedTargetingOptionsResponse

Lists the targeting options assigned to a partner.

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner.

  • targeting_type (String) —

    Required. Identifies the type of assigned targeting options to list. Supported targeting types: * TARGETING_TYPE_CHANNEL

  • filter (String) (defaults to: nil) —

    Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId Examples: * AssignedTargetingOption resource with ID 123456: assignedTargetingOptionId=" 123456" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedTargetingOptionId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: assignedTargetingOptionId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListPartnerAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7252

def list_partner_targeting_type_assigned_targeting_options(partner_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListPartnerAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListPartnerAssignedTargetingOptionsResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partners(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListPartnersResponse

Lists partners that are accessible to the current user. The order is defined by the order_by parameter.

Parameters:

  • filter (String) (defaults to: nil) —

    Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * entityStatus Examples: * All active partners: entityStatus="ENTITY_STATUS_ACTIVE" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListPartners method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6686

def list_partners(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/partners', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListPartnersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListPartnersResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_targeting_type_targeting_options(targeting_type, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListTargetingOptionsResponse

Lists targeting options of a given type.

Parameters:

  • targeting_type (String) —

    Required. The type of targeting option to be listed. Accepted values are: * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_ENVIRONMENT * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_OMID

  • advertiser_id (Fixnum) (defaults to: nil) —

    Required. The Advertiser this request is being made in the context of.

  • filter (String) (defaults to: nil) —

    Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by OR logical operators. * A restriction has the form of field` ` operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * carrierAndIspDetails.type * geoRegionDetails.geoRegionType * targetingOptionId Examples: * All GEO REGION targeting options that belong to sub type GEO_REGION_TYPE_COUNTRY or GEO_REGION_TYPE_STATE: geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails. geoRegionType="GEO_REGION_TYPE_STATE" * All CARRIER AND ISP targeting options that belong to sub type CARRIER_AND_ISP_TYPE_CARRIER: carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * targetingOptionId ( default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: targetingOptionId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7482

def list_targeting_type_targeting_options(targeting_type, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/targetingTypes/{+targetingType}/targetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListTargetingOptionsResponse
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_users(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ListUsersResponse

Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

  • filter (String) (defaults to: nil) —

    Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator AND. * A restriction has the form of field` `operator` ` value. * The displayName and email fields must use the HAS (:) operator. * The lastLoginTime field must use either the LESS THAN OR EQUAL TO (<=) or GREATER THAN OR EQUAL TO (>=) operator. * All other fields must use the EQUALS (=) operator. Supported fields: * assignedUserRole. advertiserId * assignedUserRole.entityType: This is synthetic field of AssignedUserRole used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are Partner and Advertiser. * assignedUserRole.parentPartnerId: This is a synthetic field of AssignedUserRole used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * assignedUserRole.partnerId * assignedUserRole.userRole * displayName * email * lastLoginTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * The user with displayName containing "foo": displayName:"foo" * The user with email containing "bar": email:"bar" * All users with standard user roles: assignedUserRole.userRole="STANDARD" * All users with user roles for partner 123: assignedUserRole.partnerId="123" * All users with user roles for advertiser 123: assignedUserRole.advertiserId="123" * All users with partner level user roles: entityType="PARTNER" * All users with user roles for partner 123 and advertisers under partner 123: parentPartnerId="123" * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601) : lastLoginTime>="2023-01-01T00:00:00Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListUsers method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7734

def list_users(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/users', options)
  command.response_representation = Google::Apis::DisplayvideoV4::ListUsersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ListUsersResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_advertiser_invoice_invoice_currency(advertiser_id, invoice_month: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::LookupInvoiceCurrencyResponse

Retrieves the invoice currency used by an advertiser in a given month.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to lookup currency for.

  • invoice_month (String) (defaults to: nil) —

    Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2657

def lookup_advertiser_invoice_invoice_currency(advertiser_id, invoice_month: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency', options)
  command.response_representation = Google::Apis::DisplayvideoV4::LookupInvoiceCurrencyResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::LookupInvoiceCurrencyResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['invoiceMonth'] = invoice_month unless invoice_month.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Advertiser

Updates an existing advertiser. Returns the updated advertiser if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser. Assigned by the system.

  • advertiser_object (Google::Apis::DisplayvideoV4::Advertiser) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 374

def patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/advertisers/{+advertiserId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DisplayvideoV4::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Advertiser
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_ad_group(advertiser_id, ad_group_id, ad_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AdGroup

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method will begin rolling out to all partners on June 10, 2026 and be available to all partners on June 24, 2026.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the ad group belongs to.

  • ad_group_id (Fixnum) —

    Output only. The unique ID of the ad group. Assigned by the system.

  • ad_group_object (Google::Apis::DisplayvideoV4::AdGroup) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1103

def patch_advertiser_ad_group(advertiser_id, ad_group_id, ad_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::AdGroup::Representation
  command.request_object = ad_group_object
  command.response_representation = Google::Apis::DisplayvideoV4::AdGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AdGroup
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_ad_group_ad(advertiser_id, ad_group_ad_id, ad_group_ad_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::AdGroupAd

Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method will begin rolling out to all partners on June 10, 2026 and be available to all partners on June 24, 2026.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the ad belongs to.

  • ad_group_ad_id (Fixnum) —

    Output only. The unique ID of the ad. Assigned by the system.

  • ad_group_ad_object (Google::Apis::DisplayvideoV4::AdGroupAd) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



785
786
787
788
789
790
791
792
793
794
795
796
797
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 785

def patch_advertiser_ad_group_ad(advertiser_id, ad_group_ad_id, ad_group_ad_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::AdGroupAd::Representation
  command.request_object = ad_group_ad_object
  command.response_representation = Google::Apis::DisplayvideoV4::AdGroupAd::Representation
  command.response_class = Google::Apis::DisplayvideoV4::AdGroupAd
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['adGroupAdId'] = ad_group_ad_id unless ad_group_ad_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Campaign

Updates an existing campaign. Returns the updated campaign if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the campaign belongs to.

  • campaign_id (Fixnum) —

    Output only. The unique ID of the campaign. Assigned by the system.

  • campaign_object (Google::Apis::DisplayvideoV4::Campaign) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1734

def patch_advertiser_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DisplayvideoV4::Campaign::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Campaign
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_channel(advertiser_id, channel_id, channel_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Channel

Updates a channel. Returns the updated channel if successful.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the created channel.

  • channel_id (Fixnum) —

    Output only. The unique ID of the channel. Assigned by the system.

  • channel_object (Google::Apis::DisplayvideoV4::Channel) (defaults to: nil)
  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the created channel.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1907

def patch_advertiser_channel(advertiser_id, channel_id, channel_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/advertisers/{+advertiserId}/channels/{channelId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV4::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Channel
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_creative(advertiser_id, creative_id, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Creative

Updates an existing creative. Returns the updated creative if successful. A " Standard" user role or greater for the parent advertiser or partner is required to make this request.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the creative belongs to.

  • creative_id (Fixnum) —

    Output only. The unique ID of the creative. Assigned by the system.

  • creative_object (Google::Apis::DisplayvideoV4::Creative) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2357

def patch_advertiser_creative(advertiser_id, creative_id, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DisplayvideoV4::Creative::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Creative
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::InsertionOrder

Updates an existing insertion order. Returns the updated insertion order if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the insertion order belongs to.

  • insertion_order_id (Fixnum) —

    Output only. The unique ID of the insertion order. Assigned by the system.

  • insertion_order_object (Google::Apis::DisplayvideoV4::InsertionOrder) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2569

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)
  command = make_simple_command(:patch, 'v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::InsertionOrder::Representation
  command.request_object = insertion_order_object
  command.response_representation = Google::Apis::DisplayvideoV4::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV4::InsertionOrder
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_line_item(advertiser_id, line_item_id, line_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::LineItem

Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the line item belongs to.

  • line_item_id (Fixnum) —

    Output only. The unique ID of the line item. Assigned by the system.

  • line_item_object (Google::Apis::DisplayvideoV4::LineItem) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3058

def patch_advertiser_line_item(advertiser_id, line_item_id, line_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::LineItem::Representation
  command.request_object = line_item_object
  command.response_representation = Google::Apis::DisplayvideoV4::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV4::LineItem
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_location_list(advertiser_id, location_list_id, location_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::LocationList

Updates a location list. Returns the updated location list if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the location lists belongs.

  • location_list_id (Fixnum) —

    Output only. The unique ID of the location list. Assigned by the system.

  • location_list_object (Google::Apis::DisplayvideoV4::LocationList) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 3674

def patch_advertiser_location_list(advertiser_id, location_list_id, location_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/advertisers/{+advertiserId}/locationLists/{locationListId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::LocationList::Representation
  command.request_object = location_list_object
  command.response_representation = Google::Apis::DisplayvideoV4::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV4::LocationList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, negative_keyword_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::NegativeKeywordList

Updates a negative keyword list. Returns the updated negative keyword list if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Output only. The unique ID of the negative keyword list. Assigned by the system.

  • negative_keyword_list_object (Google::Apis::DisplayvideoV4::NegativeKeywordList) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4032

def patch_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, negative_keyword_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::NegativeKeywordList::Representation
  command.request_object = negative_keyword_list_object
  command.response_representation = Google::Apis::DisplayvideoV4::NegativeKeywordList::Representation
  command.response_class = Google::Apis::DisplayvideoV4::NegativeKeywordList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_custom_bidding_algorithm(custom_bidding_algorithm_id, custom_bidding_algorithm_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Output only. The unique ID of the custom bidding algorithm. Assigned by the system.

  • custom_bidding_algorithm_object (Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4710

def patch_custom_bidding_algorithm(custom_bidding_algorithm_id, custom_bidding_algorithm_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm::Representation
  command.request_object = custom_bidding_algorithm_object
  command.response_representation = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithm
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_first_party_and_partner_audience(first_party_and_partner_audience_id, first_party_and_partner_audience_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience

Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

Parameters:

  • first_party_and_partner_audience_id (Fixnum) —

    Identifier. The unique ID of the first party and partner audience. Assigned by the system.

  • first_party_and_partner_audience_object (Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update. Updates are only supported for the following fields: * displayName * description * membershipDurationDays

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5366

def patch_first_party_and_partner_audience(first_party_and_partner_audience_id, first_party_and_partner_audience_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience::Representation
  command.request_object = first_party_and_partner_audience_object
  command.response_representation = Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV4::FirstPartyAndPartnerAudience
  command.params['firstPartyAndPartnerAudienceId'] = first_party_and_partner_audience_id unless first_party_and_partner_audience_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_floodlight_group(floodlight_group_id, floodlight_group_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::FloodlightGroup

Updates an existing Floodlight group. Returns the updated Floodlight group if successful.

Parameters:

  • floodlight_group_id (Fixnum) —

    Output only. The unique ID of the Floodlight group. Assigned by the system.

  • floodlight_group_object (Google::Apis::DisplayvideoV4::FloodlightGroup) (defaults to: nil)
  • partner_id (Fixnum) (defaults to: nil) —

    Required. The partner context by which the Floodlight group is being accessed.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5439

def patch_floodlight_group(floodlight_group_id, floodlight_group_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/floodlightGroups/{floodlightGroupId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::FloodlightGroup::Representation
  command.request_object = floodlight_group_object
  command.response_representation = Google::Apis::DisplayvideoV4::FloodlightGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV4::FloodlightGroup
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_guaranteed_order(guaranteed_order_id, guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::GuaranteedOrder

Updates an existing guaranteed order. Returns the updated guaranteed order if successful.

Parameters:

  • guaranteed_order_id (String) —

    Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format exchange`-`legacy_guaranteed_order_id.

  • guaranteed_order_object (Google::Apis::DisplayvideoV4::GuaranteedOrder) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that the request is being made within.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that the request is being made within.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 5842

def patch_guaranteed_order(guaranteed_order_id, guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/guaranteedOrders/{+guaranteedOrderId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::GuaranteedOrder::Representation
  command.request_object = guaranteed_order_object
  command.response_representation = Google::Apis::DisplayvideoV4::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV4::GuaranteedOrder
  command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_inventory_source(inventory_source_id, inventory_source_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::InventorySource

Updates an existing inventory source. Returns the updated inventory source if successful.

Parameters:

  • inventory_source_id (Fixnum) —

    Output only. The unique ID of the inventory source. Assigned by the system.

  • inventory_source_object (Google::Apis::DisplayvideoV4::InventorySource) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that the request is being made within.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that the request is being made within.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6478

def patch_inventory_source(inventory_source_id, inventory_source_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/inventorySources/{+inventorySourceId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::InventorySource::Representation
  command.request_object = inventory_source_object
  command.response_representation = Google::Apis::DisplayvideoV4::InventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV4::InventorySource
  command.params['inventorySourceId'] = inventory_source_id unless inventory_source_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_inventory_source_group(inventory_source_group_id, inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::InventorySourceGroup

Updates an inventory source group. Returns the updated inventory source group if successful.

Parameters:

  • inventory_source_group_id (Fixnum) —

    Output only. The unique ID of the inventory source group. Assigned by the system.

  • inventory_source_group_object (Google::Apis::DisplayvideoV4::InventorySourceGroup) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the inventory source group. Only this partner has write access to this group.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6067

def patch_inventory_source_group(inventory_source_group_id, inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/inventorySourceGroups/{inventorySourceGroupId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::InventorySourceGroup::Representation
  command.request_object = inventory_source_group_object
  command.response_representation = Google::Apis::DisplayvideoV4::InventorySourceGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV4::InventorySourceGroup
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_partner_channel(partner_id, channel_id, channel_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::Channel

Updates a channel. Returns the updated channel if successful.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the created channel.

  • channel_id (Fixnum) —

    Output only. The unique ID of the channel. Assigned by the system.

  • channel_object (Google::Apis::DisplayvideoV4::Channel) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the created channel.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6858

def patch_partner_channel(partner_id, channel_id, channel_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/partners/{+partnerId}/channels/{channelId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV4::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV4::Channel
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_user(user_id, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::User

Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

  • user_id (Fixnum) —

    Output only. The unique ID of the user. Assigned by the system.

  • user_object (Google::Apis::DisplayvideoV4::User) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7774

def patch_user(user_id, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/users/{+userId}', options)
  command.request_representation = Google::Apis::DisplayvideoV4::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::DisplayvideoV4::User::Representation
  command.response_class = Google::Apis::DisplayvideoV4::User
  command.params['userId'] = user_id unless user_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_advertiser_channel_site(advertiser_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ReplaceSitesResponse

Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest. new_sites. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel whose sites will be replaced.

  • replace_sites_request_object (Google::Apis::DisplayvideoV4::ReplaceSitesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 2128

def replace_advertiser_channel_site(advertiser_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{advertiserId}/channels/{+channelId}/sites:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV4::ReplaceSitesRequest::Representation
  command.request_object = replace_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::ReplaceSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ReplaceSitesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_negative_keywords(advertiser_id, negative_keyword_list_id, replace_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ReplaceNegativeKeywordsResponse

Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Required. The ID of the parent negative keyword list to which the negative keywords belong.

  • replace_negative_keywords_request_object (Google::Apis::DisplayvideoV4::ReplaceNegativeKeywordsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4254

def replace_negative_keywords(advertiser_id, negative_keyword_list_id, replace_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV4::ReplaceNegativeKeywordsRequest::Representation
  command.request_object = replace_negative_keywords_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::ReplaceNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ReplaceNegativeKeywordsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_partner_channel_site(partner_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::ReplaceSitesResponse

Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest. new_sites. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel whose sites will be replaced.

  • replace_sites_request_object (Google::Apis::DisplayvideoV4::ReplaceSitesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7079

def replace_partner_channel_site(partner_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/partners/{partnerId}/channels/{+channelId}/sites:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV4::ReplaceSitesRequest::Representation
  command.request_object = replace_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::ReplaceSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::ReplaceSitesResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_targeting_options(targeting_type, search_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::SearchTargetingOptionsResponse

Searches for targeting options of a given type based on the given search terms.

Parameters:

  • targeting_type (String) —

    Required. The type of targeting options to retrieve. Accepted values are: * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_POI * TARGETING_TYPE_BUSINESS_CHAIN

  • search_targeting_options_request_object (Google::Apis::DisplayvideoV4::SearchTargetingOptionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 7520

def search_targeting_options(targeting_type, search_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/targetingTypes/{+targetingType}/targetingOptions:search', options)
  command.request_representation = Google::Apis::DisplayvideoV4::SearchTargetingOptionsRequest::Representation
  command.request_object = search_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::SearchTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::SearchTargetingOptionsResponse
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_ad_asset(advertiser_id, upload_ad_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::UploadAdAssetResponse

Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType AD_ASSET_TYPE_IMAGE.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this ad asset belongs to.

  • upload_ad_asset_request_object (Google::Apis::DisplayvideoV4::UploadAdAssetRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil) —

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 573

def upload_ad_asset(advertiser_id, upload_ad_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset', options)
  else
    command = make_upload_command(:post, 'v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DisplayvideoV4::UploadAdAssetRequest::Representation
  command.request_object = upload_ad_asset_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::UploadAdAssetResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::UploadAdAssetResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_advertiser_asset(advertiser_id, create_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CreateAssetResponse

Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the multipart media upload process. Examples using provided client libraries can be found in our Creating Creatives guide.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this asset belongs to.

  • create_asset_request_object (Google::Apis::DisplayvideoV4::CreateAssetRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil) —

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 1520

def upload_advertiser_asset(advertiser_id, create_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'v4/advertisers/{+advertiserId}/assets', options)
  else
    command = make_upload_command(:post, 'v4/advertisers/{+advertiserId}/assets', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DisplayvideoV4::CreateAssetRequest::Representation
  command.request_object = create_asset_request_object
  command.response_representation = Google::Apis::DisplayvideoV4::CreateAssetResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CreateAssetResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_custom_bidding_algorithm_rules(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRulesRef

Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm that owns the rules resource.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent custom bidding algorithm.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent custom bidding algorithm.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4750

def upload_custom_bidding_algorithm_rules(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules', options)
  command.response_representation = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRulesRef::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CustomBiddingAlgorithmRulesRef
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_custom_bidding_algorithm_script(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::CustomBiddingScriptRef

Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm owns the script.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent custom bidding algorithm.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 4790

def upload_custom_bidding_algorithm_script(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript', options)
  command.response_representation = Google::Apis::DisplayvideoV4::CustomBiddingScriptRef::Representation
  command.response_class = Google::Apis::DisplayvideoV4::CustomBiddingScriptRef
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV4::GoogleBytestreamMedia

Uploads media. Upload is supported on the URI /upload/media/resource_name= ?upload_type=media. **Note: Upload requests will not be successful without including upload_type=media query string.

Parameters:

  • resource_name (String) —

    Name of the media that is being downloaded. See ReadRequest.resource_name.

  • google_bytestream_media_object (Google::Apis::DisplayvideoV4::GoogleBytestreamMedia) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil) —

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
 
# File 'lib/google/apis/displayvideo_v4/service.rb', line 6559

def upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'media/{+resourceName}', options)
  else
    command = make_upload_command(:post, 'media/{+resourceName}', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DisplayvideoV4::GoogleBytestreamMedia::Representation
  command.request_object = google_bytestream_media_object
  command.response_representation = Google::Apis::DisplayvideoV4::GoogleBytestreamMedia::Representation
  command.response_class = Google::Apis::DisplayvideoV4::GoogleBytestreamMedia
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end