Class: Google::Apis::DisplayvideoV2::DisplayVideoService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/displayvideo_v2/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_v2'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeDisplayVideoService

Returns a new instance of DisplayVideoService.



47
48
49
50
51
52
# File 'lib/google/apis/displayvideo_v2/service.rb', line 47

def initialize
  super('https://displayvideo.googleapis.com/', '',
        client_name: 'google-apis-displayvideo_v2',
        client_version: Google::Apis::DisplayvideoV2::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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.



40
41
42
# File 'lib/google/apis/displayvideo_v2/service.rb', line 40

def key
  @key
end

#quota_userString

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.



45
46
47
# File 'lib/google/apis/displayvideo_v2/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#activate_manual_trigger(advertiser_id, trigger_id, activate_manual_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ManualTrigger

Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned.

Parameters:

  • advertiser_id (Fixnum)

    Required. The ID of the advertiser that the manual trigger belongs.

  • trigger_id (Fixnum)

    Required. The ID of the manual trigger to activate.

  • activate_manual_trigger_request_object (Google::Apis::DisplayvideoV2::ActivateManualTriggerRequest) (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



3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3006

def activate_manual_trigger(advertiser_id, trigger_id, activate_manual_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:activate', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ActivateManualTriggerRequest::Representation
  command.request_object = activate_manual_trigger_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ManualTrigger
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_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

#audit_advertiser(advertiser_id, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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



82
83
84
85
86
87
88
89
90
91
# File 'lib/google/apis/displayvideo_v2/service.rb', line 82

def audit_advertiser(advertiser_id, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}:audit', options)
  command.response_representation = Google::Apis::DisplayvideoV2::AuditAdvertiserResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_channel_site_edit(advertiser_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1023

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, 'v2/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkEditSitesRequest::Representation
  command.request_object = bulk_edit_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkEditSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 properties. 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. * The operator must be EQUALS (= ). * Supported fields: - targetingType - inheritance Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType=" TARGETING_TYPE_CHANNEL" * AssignedTargetingOptions 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.

  • 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



2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2111

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, 'v2/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::BulkListAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_advertiser_youtube_ad_group_list_ad_group_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, youtube_ad_group_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::BulkListAdGroupAssignedTargetingOptionsResponse

Lists assigned targeting options for multiple YouTube ad groups 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 properties. 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. * The operator must be EQUALS (= ). * Supported fields: - targetingType Examples: * AssignedTargetingOptions 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.

  • order_by (String) (defaults to: nil)

    Field by which to sort the list. Acceptable values are: * youtubeAdGroupId ( 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 BulkListAdGroupAssignedTargetingOptions method. If not specified, the first page of results will be returned.

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

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

  • 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



3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3950

def bulk_advertiser_youtube_ad_group_list_ad_group_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, youtube_ad_group_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups:bulkListAdGroupAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::BulkListAdGroupAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::BulkListAdGroupAssignedTargetingOptionsResponse
  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['youtubeAdGroupIds'] = youtube_ad_group_ids unless youtube_ad_group_ids.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::DisplayvideoV2::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::DisplayvideoV2::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



5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5558

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, 'v2/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkEditAssignedInventorySourcesRequest::Representation
  command.request_object = bulk_edit_assigned_inventory_sources_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkEditAssignedInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::BulkEditAssignedLocationsResponse

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

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::DisplayvideoV2::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



2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2839

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, 'v2/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkEditAssignedLocationsRequest::Representation
  command.request_object = bulk_edit_assigned_locations_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkEditAssignedLocationsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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.

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::DisplayvideoV2::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



6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6954

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, 'v2/users/{+userId}:bulkEditAssignedUserRoles', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkEditAssignedUserRolesRequest::Representation
  command.request_object = bulk_edit_assigned_user_roles_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkEditAssignedUserRolesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3439

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, 'v2/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkEditNegativeKeywordsRequest::Representation
  command.request_object = bulk_edit_negative_keywords_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkEditNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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: * BulkUpdate * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption

Parameters:

  • advertiser_id (Fixnum)

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

  • bulk_edit_assigned_targeting_options_request_object (Google::Apis::DisplayvideoV2::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



2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2049

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, 'v2/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkEditAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkEditAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6336

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, 'v2/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkEditSitesRequest::Representation
  command.request_object = bulk_edit_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkEditSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::BulkUpdateLineItemsResponse

Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption

Parameters:

  • advertiser_id (Fixnum)

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

  • bulk_update_line_items_request_object (Google::Apis::DisplayvideoV2::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



2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2150

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, 'v2/advertisers/{+advertiserId}/lineItems:bulkUpdate', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkUpdateLineItemsRequest::Representation
  command.request_object = bulk_update_line_items_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkUpdateLineItemsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Advertiser

Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete.

Parameters:

  • advertiser_object (Google::Apis::DisplayvideoV2::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



113
114
115
116
117
118
119
120
121
122
# File 'lib/google/apis/displayvideo_v2/service.rb', line 113

def create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DisplayvideoV2::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



449
450
451
452
453
454
455
456
457
458
459
# File 'lib/google/apis/displayvideo_v2/service.rb', line 449

def create_advertiser_campaign(advertiser_id, campaign_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/campaigns', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DisplayvideoV2::Campaign::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



849
850
851
852
853
854
855
856
857
858
859
860
# File 'lib/google/apis/displayvideo_v2/service.rb', line 849

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, 'v2/advertisers/{+advertiserId}/channels', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1061

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, 'v2/advertisers/{advertiserId}/channels/{+channelId}/sites', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DisplayvideoV2::Site::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::Creative

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

Parameters:

  • advertiser_id (Fixnum)

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

  • creative_object (Google::Apis::DisplayvideoV2::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



1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1233

def create_advertiser_creative(advertiser_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/creatives', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DisplayvideoV2::Creative::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1461

def create_advertiser_insertion_order(advertiser_id, insertion_order_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/insertionOrders', options)
  command.request_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
  command.request_object = insertion_order_object
  command.response_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::AssignedTargetingOption

Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT

  • TARGETING_TYPE_GENDER * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_VIEWABILITY

Parameters:

  • advertiser_id (Fixnum)

    Required. The ID of the advertiser the insertion order belongs to.

  • insertion_order_id (Fixnum)

    Required. The ID of the insertion order 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_BROWSER * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT

    • TARGETING_TYPE_GENDER * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_VIEWABILITY
  • assigned_targeting_option_object (Google::Apis::DisplayvideoV2::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



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1760

def create_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_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(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::LineItem

Creates a new line item. Returns the newly created line item if successful.

Parameters:

  • advertiser_id (Fixnum)

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

  • line_item_object (Google::Apis::DisplayvideoV2::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



2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2183

def create_advertiser_line_item(advertiser_id, line_item_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/lineItems', options)
  command.request_representation = Google::Apis::DisplayvideoV2::LineItem::Representation
  command.request_object = line_item_object
  command.response_representation = Google::Apis::DisplayvideoV2::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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: * BulkEditAssignedTargetingOptions * BulkUpdate * UpdateLineItem * DeleteLineItemAssignedTargetingOption

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.

  • assigned_targeting_option_object (Google::Apis::DisplayvideoV2::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



2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2487

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, 'v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_location_list(advertiser_id, location_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2670

def create_advertiser_location_list(advertiser_id, location_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/locationLists', options)
  command.request_representation = Google::Apis::DisplayvideoV2::LocationList::Representation
  command.request_object = location_list_object
  command.response_representation = Google::Apis::DisplayvideoV2::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2875

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, 'v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
  command.request_representation = Google::Apis::DisplayvideoV2::AssignedLocation::Representation
  command.request_object = assigned_location_object
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedLocation::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_manual_trigger(advertiser_id, manual_trigger_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ManualTrigger

Creates a new manual trigger. Returns the newly created manual trigger if successful.

Parameters:

  • advertiser_id (Fixnum)

    Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.

  • manual_trigger_object (Google::Apis::DisplayvideoV2::ManualTrigger) (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



3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3042

def create_advertiser_manual_trigger(advertiser_id, manual_trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/manualTriggers', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.request_object = manual_trigger_object
  command.response_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ManualTrigger
  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(advertiser_id, negative_keyword_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3244

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, 'v2/advertisers/{+advertiserId}/negativeKeywordLists', options)
  command.request_representation = Google::Apis::DisplayvideoV2::NegativeKeywordList::Representation
  command.request_object = negative_keyword_list_object
  command.response_representation = Google::Apis::DisplayvideoV2::NegativeKeywordList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3477

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, 'v2/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
  command.request_representation = Google::Apis::DisplayvideoV2::NegativeKeyword::Representation
  command.request_object = negative_keyword_object
  command.response_representation = Google::Apis::DisplayvideoV2::NegativeKeyword::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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

  • assigned_targeting_option_object (Google::Apis::DisplayvideoV2::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



3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3655

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, 'v2/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::CustomBiddingAlgorithm

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

Parameters:

  • custom_bidding_algorithm_object (Google::Apis::DisplayvideoV2::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



4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4291

def create_custom_bidding_algorithm(custom_bidding_algorithm_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/customBiddingAlgorithms', options)
  command.request_representation = Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm::Representation
  command.request_object = custom_bidding_algorithm_object
  command.response_representation = Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_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::DisplayvideoV2::CustomBiddingScript

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

Parameters:

  • custom_bidding_algorithm_id (Fixnum)

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

  • custom_bidding_script_object (Google::Apis::DisplayvideoV2::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



4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4511

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, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts', options)
  command.request_representation = Google::Apis::DisplayvideoV2::CustomBiddingScript::Representation
  command.request_object = custom_bidding_script_object
  command.response_representation = Google::Apis::DisplayvideoV2::CustomBiddingScript::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_and_third_party_audience(first_and_third_party_audience_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience

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

Parameters:

  • first_and_third_party_audience_object (Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil)

    Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience 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



4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4730

def create_first_and_third_party_audience(first_and_third_party_audience_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/firstAndThirdPartyAudiences', options)
  command.request_representation = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience::Representation
  command.request_object = first_and_third_party_audience_object
  command.response_representation = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience
  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::DisplayvideoV2::GuaranteedOrder

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

Parameters:

  • guaranteed_order_object (Google::Apis::DisplayvideoV2::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



5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5115

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, 'v2/guaranteedOrders', options)
  command.request_representation = Google::Apis::DisplayvideoV2::GuaranteedOrder::Representation
  command.request_object = guaranteed_order_object
  command.response_representation = Google::Apis::DisplayvideoV2::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::InventorySource

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

Parameters:

  • inventory_source_object (Google::Apis::DisplayvideoV2::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



5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5746

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, 'v2/inventorySources', options)
  command.request_representation = Google::Apis::DisplayvideoV2::InventorySource::Representation
  command.request_object = inventory_source_object
  command.response_representation = Google::Apis::DisplayvideoV2::InventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::InventorySourceGroup

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

Parameters:

  • inventory_source_group_object (Google::Apis::DisplayvideoV2::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



5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5334

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, 'v2/inventorySourceGroups', options)
  command.request_representation = Google::Apis::DisplayvideoV2::InventorySourceGroup::Representation
  command.request_object = inventory_source_group_object
  command.response_representation = Google::Apis::DisplayvideoV2::InventorySourceGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5599

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, 'v2/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
  command.request_representation = Google::Apis::DisplayvideoV2::AssignedInventorySource::Representation
  command.request_object = assigned_inventory_source_object
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedInventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6162

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, 'v2/partners/{+partnerId}/channels', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6374

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, 'v2/partners/{partnerId}/channels/{+channelId}/sites', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Site::Representation
  command.request_object = site_object
  command.response_representation = Google::Apis::DisplayvideoV2::Site::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6550

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, 'v2/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.request_object = assigned_targeting_option_object
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 sdfdownloadtask.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::DisplayvideoV2::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



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

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, 'v2/sdfdownloadtasks', options)
  command.request_representation = Google::Apis::DisplayvideoV2::CreateSdfDownloadTaskRequest::Representation
  command.request_object = create_sdf_download_task_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::Operation::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::User

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

Parameters:

  • user_object (Google::Apis::DisplayvideoV2::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



6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6985

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

#deactivate_manual_trigger(advertiser_id, trigger_id, deactivate_manual_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ManualTrigger

Deactivates a manual trigger.

Parameters:

  • advertiser_id (Fixnum)

    Required. The ID of the advertiser that the manual trigger belongs.

  • trigger_id (Fixnum)

    Required. The ID of the manual trigger to deactivate.

  • deactivate_manual_trigger_request_object (Google::Apis::DisplayvideoV2::DeactivateManualTriggerRequest) (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



3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3077

def deactivate_manual_trigger(advertiser_id, trigger_id, deactivate_manual_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:deactivate', options)
  command.request_representation = Google::Apis::DisplayvideoV2::DeactivateManualTriggerRequest::Representation
  command.request_object = deactivate_manual_trigger_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ManualTrigger
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_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(advertiser_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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



146
147
148
149
150
151
152
153
154
# File 'lib/google/apis/displayvideo_v2/service.rb', line 146

def delete_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/advertisers/{+advertiserId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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.

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



485
486
487
488
489
490
491
492
493
494
# File 'lib/google/apis/displayvideo_v2/service.rb', line 485

def delete_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1101

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, 'v2/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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.

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



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1269

def delete_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1497

def delete_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Empty

Deletes an assigned targeting option from an insertion order. Supported targeting types: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT

  • TARGETING_TYPE_GENDER * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_VIEWABILITY

Parameters:

  • advertiser_id (Fixnum)

    Required. The ID of the advertiser the insertion order belongs to.

  • insertion_order_id (Fixnum)

    Required. The ID of the insertion order 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_BROWSER * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT

    • TARGETING_TYPE_GENDER * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * 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



1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1817

def delete_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Empty
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_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(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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.

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



2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2219

def delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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: * BulkEditAssignedTargetingOptions * BulkUpdate * UpdateLineItem * CreateLineItemAssignedTargetingOption

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.

  • 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



2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2530

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, 'v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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



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

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, 'v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3280

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, 'v2/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3516

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, 'v2/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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

  • 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



3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3695

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, 'v2/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5373

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, 'v2/inventorySourceGroups/{+inventorySourceGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5643

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, 'v2/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6414

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, 'v2/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6588

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, 'v2/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::Empty

Deletes a user.

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



7016
7017
7018
7019
7020
7021
7022
7023
7024
# File 'lib/google/apis/displayvideo_v2/service.rb', line 7016

def delete_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/users/{+userId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Empty::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5959

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::DisplayvideoV2::GoogleBytestreamMedia::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::DuplicateLineItemResponse

Duplicates a line item. Returns the ID of the created line item if successful.

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::DisplayvideoV2::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



2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2253

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, 'v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate', options)
  command.request_representation = Google::Apis::DisplayvideoV2::DuplicateLineItemRequest::Representation
  command.request_object = duplicate_line_item_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::DuplicateLineItemResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



181
182
183
184
185
186
187
188
189
190
191
# File 'lib/google/apis/displayvideo_v2/service.rb', line 181

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, 'v2/advertisers/{+advertiserId}:editAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkEditAdvertiserAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_advertiser_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkEditAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_and_third_party_audience_customer_match_members(first_and_third_party_audience_id, edit_customer_match_members_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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_and_third_party_audience_id (Fixnum)

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

  • edit_customer_match_members_request_object (Google::Apis::DisplayvideoV2::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



4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4766

def edit_first_and_third_party_audience_customer_match_members(first_and_third_party_audience_id, edit_customer_match_members_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers', options)
  command.request_representation = Google::Apis::DisplayvideoV2::EditCustomerMatchMembersRequest::Representation
  command.request_object = edit_customer_match_members_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::EditCustomerMatchMembersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::EditCustomerMatchMembersResponse
  command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_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::DisplayvideoV2::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::DisplayvideoV2::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



5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5150

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, 'v2/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors', options)
  command.request_representation = Google::Apis::DisplayvideoV2::EditGuaranteedOrderReadAccessorsRequest::Representation
  command.request_object = edit_guaranteed_order_read_accessors_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::EditGuaranteedOrderReadAccessorsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5781

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, 'v2/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors', options)
  command.request_representation = Google::Apis::DisplayvideoV2::EditInventorySourceReadWriteAccessorsRequest::Representation
  command.request_object = edit_inventory_source_read_write_accessors_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::InventorySourceAccessors::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6044

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, 'v2/partners/{+partnerId}:editAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkEditPartnerAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_partner_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkEditPartnerAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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

#generate_default_line_item(advertiser_id, generate_default_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::LineItem

Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type

Parameters:

  • advertiser_id (Fixnum)

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

  • generate_default_line_item_request_object (Google::Apis::DisplayvideoV2::GenerateDefaultLineItemRequest) (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



2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2291

def generate_default_line_item(advertiser_id, generate_default_line_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/lineItems:generateDefault', options)
  command.request_representation = Google::Apis::DisplayvideoV2::GenerateDefaultLineItemRequest::Representation
  command.request_object = generate_default_line_item_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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

#get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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



213
214
215
216
217
218
219
220
221
# File 'lib/google/apis/displayvideo_v2/service.rb', line 213

def get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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



518
519
520
521
522
523
524
525
526
527
# File 'lib/google/apis/displayvideo_v2/service.rb', line 518

def get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Campaign::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_campaign_targeting_type_assigned_targeting_option(advertiser_id, campaign_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::AssignedTargetingOption

Gets a single targeting option assigned to a campaign.

Parameters:

  • advertiser_id (Fixnum)

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

  • campaign_id (Fixnum)

    Required. The ID of the campaign 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_AUTHORIZED_SELLER_STATUS * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * 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_LANGUAGE * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
    • TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_VIEWABILITY
  • assigned_targeting_option_id (String)

    Required. An identifier unique to the targeting type in this campaign 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



735
736
737
738
739
740
741
742
743
744
745
746
# File 'lib/google/apis/displayvideo_v2/service.rb', line 735

def get_advertiser_campaign_targeting_type_assigned_targeting_option(advertiser_id, campaign_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_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_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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



886
887
888
889
890
891
892
893
894
895
896
# File 'lib/google/apis/displayvideo_v2/service.rb', line 886

def get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/channels/{+channelId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1302

def get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Creative::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1531

def get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::AssignedTargetingOption

Gets a single targeting option assigned to an insertion order.

Parameters:

  • advertiser_id (Fixnum)

    Required. The ID of the advertiser the insertion order belongs to.

  • insertion_order_id (Fixnum)

    Required. The ID of the insertion order the assigned targeting option belongs to.

  • targeting_type (String)

    Required. Identifies the type of this assigned targeting option.

  • assigned_targeting_option_id (String)

    Required. An identifier unique to the targeting type in this insertion order 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



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1858

def get_advertiser_insertion_order_targeting_type_assigned_targeting_option(advertiser_id, insertion_order_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_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_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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



2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2325

def get_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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.

  • 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



2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2570

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, 'v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2705

def get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/locationLists/{+locationListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_manual_trigger(advertiser_id, trigger_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ManualTrigger

Gets a manual trigger.

Parameters:

  • advertiser_id (Fixnum)

    Required. The ID of the advertiser this manual trigger belongs to.

  • trigger_id (Fixnum)

    Required. The ID of the manual trigger 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



3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3112

def get_advertiser_manual_trigger(advertiser_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ManualTrigger
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_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::DisplayvideoV2::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



3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3315

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, 'v2/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::NegativeKeywordList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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

  • 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



3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3735

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, 'v2/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_advertiser_youtube_ad_group(advertiser_id, youtube_ad_group_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::YoutubeAdGroup

Gets a YouTube ad group.

Parameters:

  • advertiser_id (Fixnum)

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

  • youtube_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



3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3987

def get_advertiser_youtube_ad_group(advertiser_id, youtube_ad_group_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::YoutubeAdGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV2::YoutubeAdGroup
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['youtubeAdGroupId'] = youtube_ad_group_id unless youtube_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_youtube_ad_group_ad(advertiser_id, youtube_ad_group_ad_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::YoutubeAdGroupAd

Gets a YouTube ad group ad.

Parameters:

  • advertiser_id (Fixnum)

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

  • youtube_ad_group_ad_id (Fixnum)

    Required. The ID of the ad group 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



3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3831

def get_advertiser_youtube_ad_group_ad(advertiser_id, youtube_ad_group_ad_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroupAds/{+youtubeAdGroupAdId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::YoutubeAdGroupAd::Representation
  command.response_class = Google::Apis::DisplayvideoV2::YoutubeAdGroupAd
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['youtubeAdGroupAdId'] = youtube_ad_group_ad_id unless youtube_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_youtube_ad_group_targeting_type_assigned_targeting_option(advertiser_id, youtube_ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::AssignedTargetingOption

Gets a single targeting option assigned to a YouTube ad group. Inherited targeting is not included.

Parameters:

  • advertiser_id (Fixnum)

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

  • youtube_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_GENDER * TARGETING_TYPE_AGE_RANGE

    • TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_URL * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_SESSION_POSITION * 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



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4094

def get_advertiser_youtube_ad_group_targeting_type_assigned_targeting_option(advertiser_id, youtube_ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['youtubeAdGroupId'] = youtube_ad_group_id unless youtube_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_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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



4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4200

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, 'v2/combinedAudiences/{+combinedAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::CombinedAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4326

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, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_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::DisplayvideoV2::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



4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4552

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, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::CustomBiddingScript::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4641

def get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/customLists/{+customListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::CustomList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_and_third_party_audience(first_and_third_party_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience

Gets a first and third party audience.

Parameters:

  • first_and_third_party_audience_id (Fixnum)

    Required. The ID of the first and third party audience to fetch.

  • advertiser_id (Fixnum) (defaults to: nil)

    The ID of the advertiser that has access to the fetched first and third party audience.

  • partner_id (Fixnum) (defaults to: nil)

    The ID of the partner that has access to the fetched first and third party 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



4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4804

def get_first_and_third_party_audience(first_and_third_party_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience
  command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_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::DisplayvideoV2::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



4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4945

def get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/floodlightGroups/{+floodlightGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::FloodlightGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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



5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5020

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, 'v2/googleAudiences/{+googleAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::GoogleAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5187

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, 'v2/guaranteedOrders/{+guaranteedOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::InventorySource

Gets an inventory source.

Parameters:

  • inventory_source_id (Fixnum)

    Required. The ID of the inventory source to fetch.

  • 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



5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5816

def get_inventory_source(inventory_source_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/inventorySources/{+inventorySourceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::InventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV2::InventorySource
  command.params['inventorySourceId'] = inventory_source_id unless inventory_source_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::DisplayvideoV2::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



5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5412

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, 'v2/inventorySourceGroups/{+inventorySourceGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::InventorySourceGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



6076
6077
6078
6079
6080
6081
6082
6083
6084
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6076

def get_partner(partner_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/partners/{+partnerId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Partner::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6199

def get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/partners/{+partnerId}/channels/{+channelId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6626

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, 'v2/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



6755
6756
6757
6758
6759
6760
6761
6762
6763
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6755

def get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Operation::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6804

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, 'v2/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::TargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::User

Gets a user.

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



7046
7047
7048
7049
7050
7051
7052
7053
7054
# File 'lib/google/apis/displayvideo_v2/service.rb', line 7046

def get_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/users/{+userId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::User::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_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::DisplayvideoV2::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 properties. 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. * The operator must be EQUALS (=). * 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.

  • 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



330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/google/apis/displayvideo_v2/service.rb', line 330

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, 'v2/advertisers/{+advertiserId}:listAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::BulkListAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_campaign_assigned_targeting_options(advertiser_id, campaign_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse

Lists assigned targeting options of a campaign across targeting types.

Parameters:

  • advertiser_id (Fixnum)

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

  • campaign_id (Fixnum)

    Required. The ID of the campaign to list assigned targeting options for.

  • filter (String) (defaults to: nil)

    Allows filtering by assigned targeting option properties. 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. * The operator must be EQUALS (= ). * Supported fields: - targetingType - inheritance Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_LANGUAGE or TARGETING_TYPE_GENDER targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER" * AssignedTargetingOptions 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.

  • 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 BulkListCampaignAssignedTargetingOptions 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



642
643
644
645
646
647
648
649
650
651
652
653
654
655
# File 'lib/google/apis/displayvideo_v2/service.rb', line 642

def list_advertiser_campaign_assigned_targeting_options(advertiser_id, campaign_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::BulkListCampaignAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_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_campaign_targeting_type_assigned_targeting_options(advertiser_id, campaign_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse

Lists the targeting options assigned to a campaign for a specified targeting type.

Parameters:

  • advertiser_id (Fixnum)

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

  • campaign_id (Fixnum)

    Required. The ID of the campaign to list assigned targeting options for.

  • targeting_type (String)

    Required. Identifies the type of assigned targeting options to list. Supported targeting types: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * 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_LANGUAGE * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
    • TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_VIEWABILITY
  • filter (String) (defaults to: nil)

    Allows filtering by assigned targeting option properties. 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. * The operator must be EQUALS (=). * Supported fields: - assignedTargetingOptionId - inheritance Examples: * AssignedTargetingOptions with ID 1 or 2 assignedTargetingOptionId="1" OR assignedTargetingOptionId="2" * AssignedTargetingOptions 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.

  • 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 ListCampaignAssignedTargetingOptions 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



810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
# File 'lib/google/apis/displayvideo_v2/service.rb', line 810

def list_advertiser_campaign_targeting_type_assigned_targeting_options(advertiser_id, campaign_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListCampaignAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_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_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::DisplayvideoV2::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 properties. 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 operator used on updateTime must be GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=). * The operator must be EQUALS (=). * 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.

  • 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



580
581
582
583
584
585
586
587
588
589
590
591
592
# File 'lib/google/apis/displayvideo_v2/service.rb', line 580

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, 'v2/advertisers/{+advertiserId}/campaigns', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCampaignsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 currently can only contain at most one * restriction. * A restriction has the form of field` `operator` `value. * The operator must be CONTAINS (:) . * Supported fields: - urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google"

  • 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



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1158

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, 'v2/advertisers/{+advertiserId}/channels/{+channelId}/sites', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 currently can only contain at most one * restriction. * A restriction has the form of field` `operator` `value. * The operator must be CONTAINS (:). * 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.

  • 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



941
942
943
944
945
946
947
948
949
950
951
952
953
954
# File 'lib/google/apis/displayvideo_v2/service.rb', line 941

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, 'v2/advertisers/{+advertiserId}/channels', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListChannelsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by OR. * Restriction for different fields must be combined by AND. * Between ( and ) there can only be restrictions combined by OR for the same field. * A restriction has the form of field` ` operator` `value. * The operator must be EQUALS (=) for the following fields: - entityStatus - creativeType. - dimensions - minDuration - maxDuration - approvalStatus - exchangeReviewStatus - dynamic - creativeId * The operator must be HAS (:) for the following fields: - lineItemIds * The operator must be GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) for the following fields: - updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) * For entityStatus, minDuration, maxDuration, updateTime, and dynamic, there may be at most one restriction. * For dimensions, the value is in the form of "widthxheight ". * For exchangeReviewStatus, the value is in the form of exchange`-` reviewStatus. * For minDuration and maxDuration, the value is in the form of "durations". Only seconds are supported with millisecond granularity. * 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). * There may be multiple lineItemIds restrictions in order to search against multiple possible line item IDs. * There may be multiple creativeId restrictions in order to search against multiple possible creative IDs. 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.

  • 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



1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1386

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, 'v2/advertisers/{+advertiserId}/creatives', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCreativesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_order_assigned_targeting_options(advertiser_id, insertion_order_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse

Lists assigned targeting options of an insertion order across targeting types.

Parameters:

  • advertiser_id (Fixnum)

    Required. The ID of the advertiser the insertion order belongs to.

  • insertion_order_id (Fixnum)

    Required. The ID of the insertion order to list assigned targeting options for.

  • filter (String) (defaults to: nil)

    Allows filtering by assigned targeting option properties. 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. * The operator must be EQUALS (= ). * Supported fields: - targetingType - inheritance Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType=" TARGETING_TYPE_CHANNEL" * AssignedTargetingOptions 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.

  • 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 BulkListInsertionOrderAssignedTargetingOptions 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



1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1662

def list_advertiser_insertion_order_assigned_targeting_options(advertiser_id, insertion_order_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::BulkListInsertionOrderAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_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_order_targeting_type_assigned_targeting_options(advertiser_id, insertion_order_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse

Lists the targeting options assigned to an insertion order.

Parameters:

  • advertiser_id (Fixnum)

    Required. The ID of the advertiser the insertion order belongs to.

  • insertion_order_id (Fixnum)

    Required. The ID of the insertion order to list assigned targeting options for.

  • targeting_type (String)

    Required. Identifies the type of assigned targeting options to list.

  • filter (String) (defaults to: nil)

    Allows filtering by assigned targeting option properties. 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. * The operator must be EQUALS (=). * Supported fields: - assignedTargetingOptionId - inheritance Examples: * AssignedTargetingOptions with ID 1 or 2 assignedTargetingOptionId="1" OR assignedTargetingOptionId="2" * AssignedTargetingOptions 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.

  • 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 ListInsertionOrderAssignedTargetingOptions 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



1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1920

def list_advertiser_insertion_order_targeting_type_assigned_targeting_options(advertiser_id, insertion_order_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListInsertionOrderAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_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_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::DisplayvideoV2::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 properties. 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 operator used on budget.budget_segments.date_range.end_date must be LESS THAN (<). * The operator used on updateTime must be GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=). * The operators used on all other fields must be EQUALS (=). * Supported fields: - campaignId - displayName - entityStatus - budget.budget_segments.date_range.end_date ( input as YYYY-MM-DD) - 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 whose budget segments' dates end before March 28, 2019: budget.budget_segments.date_range.end_date<"2019- 03-28" * 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.

  • 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



1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1599

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, 'v2/advertisers/{+advertiserId}/insertionOrders', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1973

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, 'v2/advertisers/{+advertiserId}/invoices', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListInvoicesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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.

  • filter (String) (defaults to: nil)

    Allows filtering by assigned targeting option properties. 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. * The operator must be EQUALS (=). * Supported fields: - assignedTargetingOptionId - inheritance Examples: * AssignedTargetingOptions with ID 1 or 2 assignedTargetingOptionId="1" OR assignedTargetingOptionId="2" * AssignedTargetingOptions 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.

  • 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



2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2632

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, 'v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListLineItemAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_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::DisplayvideoV2::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 properties. 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 operator used on flight.dateRange.endDate must be LESS THAN (< ). * The operator used on updateTime must be GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=). * The operator used on warningMessages must be HAS (:). * The operators used on all other fields must be EQUALS (=). * Supported properties: - campaignId - displayName - insertionOrderId - entityStatus - lineItemId - lineItemType - flight.dateRange.endDate ( input formatted as YYYY-MM-DD) - warningMessages - flight.triggerId - updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) - targetedChannelId - targetedNegativeKeywordListId 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 whose flight dates end before March 28, 2019: flight.dateRange.endDate<"2019-03-28" * All line items that have NO_VALID_CREATIVE in warningMessages: warningMessages:"NO_VALID_CREATIVE" * 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" * All line items that are using both the specified channel and specified negative keyword list in their targeting: targetedNegativeKeywordListId=789 AND targetedChannelId=12345 The length of this field should be no more than 500 characters.

  • order_by (String) (defaults to: nil)

    Field by which to sort the list. Acceptable values are: * displayName ( default) * entityStatus * flight.dateRange.endDate * 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



2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2401

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, 'v2/advertisers/{+advertiserId}/lineItems', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListLineItemsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 logical operator OR. * A restriction has the form of field` `operator` `value. * The operator must be EQUALS (=). * Supported fields: - assignedLocationId The length of this field should be no more than 500 characters.

  • 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



2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2967

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, 'v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListAssignedLocationsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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. * The operator must be EQUALS (=). * Supported fields: - locationType Examples: * All regional location list: locationType=" TARGETING_LOCATION_TYPE_REGIONAL" * All proximity location list: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

  • 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



2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2759

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, 'v2/advertisers/{+advertiserId}/locationLists', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListLocationListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_manual_triggers(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListManualTriggersResponse

Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required.

Parameters:

  • advertiser_id (Fixnum)

    Required. The ID of the advertiser that the fetched manual triggers belong to.

  • filter (String) (defaults to: nil)

    Allows filtering by manual trigger properties. 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 operator must be EQUALS (=). * Supported fields: - displayName - state Examples: * All active manual triggers under an advertiser: state="ACTIVE" The length of this field should be no more than 500 characters.

  • order_by (String) (defaults to: nil)

    Field by which to sort the list. Acceptable values are: * displayName ( default) * state 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 ListManualTriggers 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



3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3167

def list_advertiser_manual_triggers(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, 'v2/advertisers/{+advertiserId}/manualTriggers', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListManualTriggersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListManualTriggersResponse
  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::DisplayvideoV2::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 keyword currently can only contain at most one * restriction. * A restriction has the form of field` `operator` `value. * The operator must be CONTAINS (:). * Supported fields: - keywordValue Examples: * All negative keywords for which the keyword value contains "google" : keywordValue : "google"

  • 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



3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3573

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, 'v2/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3355

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, 'v2/advertisers/{+advertiserId}/negativeKeywordLists', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListNegativeKeywordListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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

  • filter (String) (defaults to: nil)

    Allows filtering by assigned targeting option properties. 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. * The operator must be EQUALS (=). * Supported fields: - assignedTargetingOptionId Examples: * AssignedTargetingOption with ID 123456 assignedTargetingOptionId="123456" The length of this field should be no more than 500 characters.

  • 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



3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3794

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, 'v2/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_advertiser_youtube_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::DisplayvideoV2::ListYoutubeAdGroupAdsResponse

Lists YouTube ad group ads.

Parameters:

  • advertiser_id (Fixnum)

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

  • filter (String) (defaults to: nil)

    Allows filtering by custom YouTube ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND and OR. Only the restrictions for * the same field can be combined by OR. A sequence of restrictions * implicitly uses AND. * A restriction has the form of field` `operator` `value. * The operator must be EQUALS (=). * Supported properties: - adGroupId - displayName - entityStatus - adGroupAdId Examples: * All ad group ads under an ad group: adGroupId="1234" and its * entityStatus is 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.

  • order_by (String) (defaults to: nil)

    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)

    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 ListYoutubeAdGroupAds 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



3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3888

def list_advertiser_youtube_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, 'v2/advertisers/{+advertiserId}/youtubeAdGroupAds', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAdsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAdsResponse
  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_youtube_ad_group_targeting_type_assigned_targeting_options(advertiser_id, youtube_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::DisplayvideoV2::ListYoutubeAdGroupAssignedTargetingOptionsResponse

Lists the targeting options assigned to a YouTube ad group. Inherited targeting is not included.

Parameters:

  • advertiser_id (Fixnum)

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

  • youtube_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_GENDER * TARGETING_TYPE_AGE_RANGE

    • TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_URL * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_SESSION_POSITION * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_YOUTUBE_VIDEO
  • filter (String) (defaults to: nil)

    Allows filtering by assigned targeting option properties. 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. * The operator must be EQUALS (=). * Supported fields: - assignedTargetingOptionId Examples: * AssignedTargetingOptions with ID 1 or 2 assignedTargetingOptionId="1" OR assignedTargetingOptionId="2" The length of this field should be no more than 500 characters.

  • 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 ListYoutubeAdGroupAssignedTargetingOptions 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



4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4160

def list_advertiser_youtube_ad_group_targeting_type_assigned_targeting_options(advertiser_id, youtube_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, 'v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['youtubeAdGroupId'] = youtube_ad_group_id unless youtube_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_youtube_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::DisplayvideoV2::ListYoutubeAdGroupsResponse

Lists YouTube ad groups.

Parameters:

  • advertiser_id (Fixnum)

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

  • filter (String) (defaults to: nil)

    Allows filtering by custom YouTube ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND and OR. Only the restrictions for * the same field can be combined by OR. A sequence of restrictions * implicitly uses AND. * A restriction has the form of field` `operator` `value. * The operator must be EQUALS (=). * 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 and YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM ad groups under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat=" YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM" The length of this field should be no more than 500 characters.

  • order_by (String) (defaults to: nil)

    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)

    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 ListYoutubeAdGroups 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



4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4046

def list_advertiser_youtube_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, 'v2/advertisers/{+advertiserId}/youtubeAdGroups', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupsResponse
  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_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::DisplayvideoV2::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 properties. 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 operator used on updateTime must be GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=). * The operator must be EQUALS (=). * 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.

  • 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. 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



274
275
276
277
278
279
280
281
282
283
284
285
286
# File 'lib/google/apis/displayvideo_v2/service.rb', line 274

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, 'v2/advertisers', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListAdvertisersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 currently can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * The operator must be CONTAINS (:). * 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.

  • 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



4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4256

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, 'v2/combinedAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCombinedAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_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::DisplayvideoV2::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



4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4604

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, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCustomBiddingScriptsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 operator must be CONTAINS (:) or EQUALS (=). * The operator must be CONTAINS (:) for the following field: - displayName * The operator must be EQUALS (=) for the following field: - customBiddingAlgorithmType * For displayName, the value is a string. We return all custom bidding algorithms whose display_name contains such string. * For customBiddingAlgorithmType, the value is a string. We return all algorithms whose custom_bidding_algorithm_type is equal to the given type. 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.

  • 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



4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4391

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, 'v2/customBiddingAlgorithms', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCustomBiddingAlgorithmsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 currently can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * The operator must be CONTAINS (:). * 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.

  • 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



4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4693

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, 'v2/customLists', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCustomListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_and_third_party_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListFirstAndThirdPartyAudiencesResponse

Lists first and third party 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 and third party audiences.

  • filter (String) (defaults to: nil)

    Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences currently can only contain at most one restriction. * A restriction has the form of field` ` operator` `value. * The operator must be CONTAINS (:). * Supported fields:

    • displayName Examples: * All first and third party audiences for which the display name contains "Google": displayName : "Google". The length of this field should be no more than 500 characters.
  • order_by (String) (defaults to: nil)

    Field by which to sort the list. Acceptable values are: * firstAndThirdPartyAudienceId (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 ListFirstAndThirdPartyAudiences 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 and third party 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



4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4863

def list_first_and_third_party_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/firstAndThirdPartyAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListFirstAndThirdPartyAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListFirstAndThirdPartyAudiencesResponse
  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_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::DisplayvideoV2::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 currently can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * The operator must be CONTAINS (:). * 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.

  • 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



5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5076

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, 'v2/googleAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListGoogleAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 properties. * 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 operator must be EQUALS (=). * 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.

  • 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



5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5248

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, 'v2/guaranteedOrders', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListGuaranteedOrdersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 logical operator OR. * A restriction has the form of field` `operator` `value. * The operator must be EQUALS (=). * Supported fields: - assignedInventorySourceId The length of this field should be no more than 500 characters.

  • 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



5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5706

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, 'v2/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListAssignedInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 properties. 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. * The operator must be EQUALS (=). * Supported fields: - inventorySourceGroupId The length of this field should be no more than 500 characters.

  • 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



5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5470

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, 'v2/inventorySourceGroups', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListInventorySourceGroupsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 properties. 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 operator must be EQUALS (=). * 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.

  • 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



5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5877

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, 'v2/inventorySources', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 currently can only contain at most one * restriction. * A restriction has the form of field` `operator` `value. * The operator must be CONTAINS (:) . * Supported fields: - urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google"

  • 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



6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6471

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, 'v2/partners/{+partnerId}/channels/{+channelId}/sites', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 currently can only contain at most one * restriction. * A restriction has the form of field` `operator` `value. * The operator must be CONTAINS (:). * 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.

  • 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



6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6254

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, 'v2/partners/{+partnerId}/channels', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListChannelsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 properties. 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. * The operator must be EQUALS (=). * Supported fields: - assignedTargetingOptionId Examples: * AssignedTargetingOption with ID 123456 assignedTargetingOptionId="123456" The length of this field should be no more than 500 characters.

  • 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



6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6683

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, 'v2/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListPartnerAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 properties. 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 operator must be EQUALS (=). * Supported fields: - entityStatus Examples: * All active partners: entityStatus="ENTITY_STATUS_ACTIVE" The length of this field should be no more than 500 characters.

  • 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



6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6126

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, 'v2/partners', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListPartnersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 properties. 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. * The operator must be "=" (equal sign). * 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.

  • 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



6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6880

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, 'v2/targetingTypes/{+targetingType}/targetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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.

Parameters:

  • filter (String) (defaults to: nil)

    Allows filtering by user properties. 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 operator must be CONTAINS (:) or EQUALS (=). * The operator must be CONTAINS (:) for the following fields: - displayName - email * The operator must be EQUALS (=) for the following fields: - assignedUserRole.userRole - assignedUserRole.partnerId - assignedUserRole. advertiserId - assignedUserRole.entityType: A 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: A synthetic field of AssignedUserRole used for filtering. Identifies the parent partner of the entity to which the user role is assigned." 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" The length of this field should be no more than 500 characters.

  • 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



7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
# File 'lib/google/apis/displayvideo_v2/service.rb', line 7110

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, 'v2/users', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListUsersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2010

def lookup_advertiser_invoice_invoice_currency(advertiser_id, invoice_month: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency', options)
  command.response_representation = Google::Apis::DisplayvideoV2::LookupInvoiceCurrencyResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



367
368
369
370
371
372
373
374
375
376
377
378
# File 'lib/google/apis/displayvideo_v2/service.rb', line 367

def patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DisplayvideoV2::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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



682
683
684
685
686
687
688
689
690
691
692
693
694
# File 'lib/google/apis/displayvideo_v2/service.rb', line 682

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, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DisplayvideoV2::Campaign::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



983
984
985
986
987
988
989
990
991
992
993
994
995
996
# File 'lib/google/apis/displayvideo_v2/service.rb', line 983

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, 'v2/advertisers/{+advertiserId}/channels/{channelId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::Creative

Updates an existing creative. Returns the updated creative if successful.

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::DisplayvideoV2::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



1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1425

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, 'v2/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DisplayvideoV2::Creative::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1703

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, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
  command.request_object = insertion_order_object
  command.response_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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 * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption

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::DisplayvideoV2::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



2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2444

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, 'v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::LineItem::Representation
  command.request_object = line_item_object
  command.response_representation = Google::Apis::DisplayvideoV2::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2798

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, 'v2/advertisers/{+advertiserId}/locationLists/{locationListId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::LocationList::Representation
  command.request_object = location_list_object
  command.response_representation = Google::Apis::DisplayvideoV2::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_manual_trigger(advertiser_id, trigger_id, manual_trigger_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ManualTrigger

Updates a manual trigger. Returns the updated manual trigger if successful.

Parameters:

  • advertiser_id (Fixnum)

    Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.

  • trigger_id (Fixnum)

    Output only. The unique ID of the manual trigger.

  • manual_trigger_object (Google::Apis::DisplayvideoV2::ManualTrigger) (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



3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3207

def patch_advertiser_manual_trigger(advertiser_id, trigger_id, manual_trigger_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.request_object = manual_trigger_object
  command.response_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ManualTrigger
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_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::DisplayvideoV2::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::DisplayvideoV2::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



3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3395

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, 'v2/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::NegativeKeywordList::Representation
  command.request_object = negative_keyword_list_object
  command.response_representation = Google::Apis::DisplayvideoV2::NegativeKeywordList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::CustomBiddingAlgorithm

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.

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::DisplayvideoV2::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



4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4431

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, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm::Representation
  command.request_object = custom_bidding_algorithm_object
  command.response_representation = Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_and_third_party_audience(first_and_third_party_audience_id, first_and_third_party_audience_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience

Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

Parameters:

  • first_and_third_party_audience_id (Fixnum)

    Output only. The unique ID of the first and third party audience. Assigned by the system.

  • first_and_third_party_audience_object (Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil)

    Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.

  • 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



4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4909

def patch_first_and_third_party_audience(first_and_third_party_audience_id, first_and_third_party_audience_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience::Representation
  command.request_object = first_and_third_party_audience_object
  command.response_representation = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience
  command.params['firstAndThirdPartyAudienceId'] = first_and_third_party_audience_id unless first_and_third_party_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::DisplayvideoV2::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::DisplayvideoV2::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



4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4982

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, 'v2/floodlightGroups/{floodlightGroupId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::FloodlightGroup::Representation
  command.request_object = floodlight_group_object
  command.response_representation = Google::Apis::DisplayvideoV2::FloodlightGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5292

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, 'v2/guaranteedOrders/{+guaranteedOrderId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::GuaranteedOrder::Representation
  command.request_object = guaranteed_order_object
  command.response_representation = Google::Apis::DisplayvideoV2::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



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

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, 'v2/inventorySources/{+inventorySourceId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::InventorySource::Representation
  command.request_object = inventory_source_object
  command.response_representation = Google::Apis::DisplayvideoV2::InventorySource::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5516

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, 'v2/inventorySourceGroups/{inventorySourceGroupId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::InventorySourceGroup::Representation
  command.request_object = inventory_source_group_object
  command.response_representation = Google::Apis::DisplayvideoV2::InventorySourceGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



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

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, 'v2/partners/{+partnerId}/channels/{channelId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::User

Updates an existing user. Returns the updated user if successful.

Parameters:

  • user_id (Fixnum)

    Output only. The unique ID of the user. Assigned by the system.

  • user_object (Google::Apis::DisplayvideoV2::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



7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
# File 'lib/google/apis/displayvideo_v2/service.rb', line 7146

def patch_user(user_id, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/users/{+userId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::DisplayvideoV2::User::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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.

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::DisplayvideoV2::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



1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1199

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, 'v2/advertisers/{advertiserId}/channels/{+channelId}/sites:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ReplaceSitesRequest::Representation
  command.request_object = replace_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::ReplaceSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3615

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, 'v2/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ReplaceNegativeKeywordsRequest::Representation
  command.request_object = replace_negative_keywords_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::ReplaceNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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.

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::DisplayvideoV2::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



6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6512

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, 'v2/partners/{partnerId}/channels/{+channelId}/sites:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ReplaceSitesRequest::Representation
  command.request_object = replace_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::ReplaceSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6918

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, 'v2/targetingTypes/{+targetingType}/targetingOptions:search', options)
  command.request_representation = Google::Apis::DisplayvideoV2::SearchTargetingOptionsRequest::Representation
  command.request_object = search_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::SearchTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_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::DisplayvideoV2::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::DisplayvideoV2::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



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
# File 'lib/google/apis/displayvideo_v2/service.rb', line 410

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, 'v2/advertisers/{+advertiserId}/assets', options)
  else
    command = make_upload_command(:post, 'v2/advertisers/{+advertiserId}/assets', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DisplayvideoV2::CreateAssetRequest::Representation
  command.request_object = create_asset_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::CreateAssetResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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_script(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::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



4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4472

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, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript', options)
  command.response_representation = Google::Apis::DisplayvideoV2::CustomBiddingScriptRef::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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::DisplayvideoV2::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::DisplayvideoV2::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



6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6001

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::DisplayvideoV2::GoogleBytestreamMedia::Representation
  command.request_object = google_bytestream_media_object
  command.response_representation = Google::Apis::DisplayvideoV2::GoogleBytestreamMedia::Representation
  command.response_class = Google::Apis::DisplayvideoV2::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