Class: Google::Apis::DisplayvideoV1::DisplayVideoService

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

Overview

Display & Video 360 API

Display & Video 360 API allows users to manage and create campaigns and reports.

Examples:

require 'google/apis/displayvideo_v1'

Displayvideo = Google::Apis::DisplayvideoV1 # 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.



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

def initialize
  super('https://displayvideo.googleapis.com/', '',
        client_name: 'google-apis-displayvideo_v1',
        client_version: Google::Apis::DisplayvideoV1::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.



39
40
41
# File 'lib/google/apis/displayvideo_v1/service.rb', line 39

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.



44
45
46
# File 'lib/google/apis/displayvideo_v1/service.rb', line 44

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



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

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, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:activate', options)
  command.request_representation = Google::Apis::DisplayvideoV1::ActivateManualTriggerRequest::Representation
  command.request_object = activate_manual_trigger_request_object
  command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



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

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



826
827
828
829
830
831
832
833
834
835
836
837
# File 'lib/google/apis/displayvideo_v1/service.rb', line 826

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, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV1::BulkEditSitesRequest::Representation
  command.request_object = bulk_edit_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV1::BulkEditSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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_insertion_order_list_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::DisplayvideoV1::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



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1246

def bulk_advertiser_insertion_order_list_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, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:bulkListInsertionOrderAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV1::BulkListInsertionOrderAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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

#bulk_advertiser_line_item_list_line_item_assigned_targeting_options(advertiser_id, line_item_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse

Lists assigned targeting options of a line item across targeting types.

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.

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



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1670

def bulk_advertiser_line_item_list_line_item_assigned_targeting_options(advertiser_id, line_item_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, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkListLineItemAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::BulkListLineItemAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_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

#bulk_advertiser_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::DisplayvideoV1::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



171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/google/apis/displayvideo_v1/service.rb', line 171

def bulk_advertiser_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, 'v1/advertisers/{+advertiserId}:bulkListAdvertiserAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV1::BulkListAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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

#bulk_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::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsResponse

Bulk 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::DisplayvideoV1::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



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

def bulk_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, 'v1/advertisers/{+advertiserId}:bulkEditAdvertiserAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_advertiser_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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

#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::DisplayvideoV1::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::DisplayvideoV1::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



4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4012

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



2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2276

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



5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
# File 'lib/google/apis/displayvideo_v1/service.rb', line 5180

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, 'v1/users/{+userId}:bulkEditAssignedUserRoles', options)
  command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesRequest::Representation
  command.request_object = bulk_edit_assigned_user_roles_request_object
  command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedUserRolesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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_line_item_assigned_targeting_options(advertiser_id, line_item_id, bulk_edit_line_item_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse

Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .

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.

  • bulk_edit_line_item_assigned_targeting_options_request_object (Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsRequest) (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



1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1608

def bulk_edit_line_item_assigned_targeting_options(advertiser_id, line_item_id, bulk_edit_line_item_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkEditLineItemAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_line_item_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::BulkEditLineItemAssignedTargetingOptionsResponse
  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

#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::DisplayvideoV1::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::DisplayvideoV1::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



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

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, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit', options)
  command.request_representation = Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsRequest::Representation
  command.request_object = bulk_edit_negative_keywords_request_object
  command.response_representation = Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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_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::DisplayvideoV1::BulkEditPartnerAssignedTargetingOptionsResponse

Bulk 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::DisplayvideoV1::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



4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4339

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

#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::DisplayvideoV1::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::DisplayvideoV1::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



4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4631

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

#create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



205
206
207
208
209
210
211
212
213
214
# File 'lib/google/apis/displayvideo_v1/service.rb', line 205

def create_advertiser(advertiser_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/advertisers', options)
  command.request_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DisplayvideoV1::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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::DisplayvideoV1::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



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

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



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

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



864
865
866
867
868
869
870
871
872
873
874
875
876
# File 'lib/google/apis/displayvideo_v1/service.rb', line 864

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



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File 'lib/google/apis/displayvideo_v1/service.rb', line 998

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



1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1283

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

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



1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1706

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

Assigns a targeting option to a line item. Returns the assigned targeting option if successful.

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



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1927

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



2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2107

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



2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2312

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, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
  command.request_representation = Google::Apis::DisplayvideoV1::AssignedLocation::Representation
  command.request_object = assigned_location_object
  command.response_representation = Google::Apis::DisplayvideoV1::AssignedLocation::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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::DisplayvideoV1::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



2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2479

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



2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2681

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



2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2914

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

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



3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3052

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

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

Parameters:

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



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

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



4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4053

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



4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4457

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



4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4669

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



4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4807

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



4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4980

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

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

Parameters:

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



5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
# File 'lib/google/apis/displayvideo_v1/service.rb', line 5211

def create_user(user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/users', options)
  command.request_representation = Google::Apis::DisplayvideoV1::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::DisplayvideoV1::User::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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::DisplayvideoV1::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



2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2514

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, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:deactivate', options)
  command.request_representation = Google::Apis::DisplayvideoV1::DeactivateManualTriggerRequest::Representation
  command.request_object = deactivate_manual_trigger_request_object
  command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



238
239
240
241
242
243
244
245
246
# File 'lib/google/apis/displayvideo_v1/service.rb', line 238

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



481
482
483
484
485
486
487
488
489
490
# File 'lib/google/apis/displayvideo_v1/service.rb', line 481

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



904
905
906
907
908
909
910
911
912
913
914
915
# File 'lib/google/apis/displayvideo_v1/service.rb', line 904

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



1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1034

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



1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1319

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

#delete_advertiser_line_item(advertiser_id, line_item_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV1::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 we need 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



1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1742

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

Deletes an assigned targeting option from 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. 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



1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1967

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



2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2349

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



2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2717

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



2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2953

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



3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3092

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



3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3827

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



4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4097

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



4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4709

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



4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4845

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



5242
5243
5244
5245
5246
5247
5248
5249
5250
# File 'lib/google/apis/displayvideo_v1/service.rb', line 5242

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



4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4299

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

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



268
269
270
271
272
273
274
275
276
# File 'lib/google/apis/displayvideo_v1/service.rb', line 268

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



514
515
516
517
518
519
520
521
522
523
# File 'lib/google/apis/displayvideo_v1/service.rb', line 514

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

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



689
690
691
692
693
694
695
696
697
698
699
# File 'lib/google/apis/displayvideo_v1/service.rb', line 689

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



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1067

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



1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1353

def get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV1::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1503

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



1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1775

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



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2007

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



2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2142

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



2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2549

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



2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2752

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



3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3132

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, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV1::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV1::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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



3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3230

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



3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3325

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, 'v1/customBiddingAlgorithms/{+customBiddingAlgorithmId}', options)
  command.response_representation = Google::Apis::DisplayvideoV1::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV1::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



3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3427

def get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/customLists/{+customListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV1::CustomList::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3519

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, 'v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



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

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



3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3690

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, 'v1/googleAudiences/{+googleAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV1::GoogleAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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_inventory_source(inventory_source_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV1::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



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

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



3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3866

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



4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4371

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



4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4494

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



4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4883

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



5012
5013
5014
5015
5016
5017
5018
5019
5020
# File 'lib/google/apis/displayvideo_v1/service.rb', line 5012

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

Gets a single targeting option.

Parameters:

  • targeting_type (String)

    Required. The type of targeting option to retrieve.

  • 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



5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'lib/google/apis/displayvideo_v1/service.rb', line 5046

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



5272
5273
5274
5275
5276
5277
5278
5279
5280
# File 'lib/google/apis/displayvideo_v1/service.rb', line 5272

def get_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/users/{+userId}', options)
  command.response_representation = Google::Apis::DisplayvideoV1::User::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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_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::DisplayvideoV1::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 100. 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



576
577
578
579
580
581
582
583
584
585
586
587
588
# File 'lib/google/apis/displayvideo_v1/service.rb', line 576

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, 'v1/advertisers/{+advertiserId}/campaigns', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListCampaignsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
# File 'lib/google/apis/displayvideo_v1/service.rb', line 961

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



744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'lib/google/apis/displayvideo_v1/service.rb', line 744

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, 'v1/advertisers/{+advertiserId}/channels', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListChannelsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 * For entityStatus, minDuration, maxDuration, 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. * 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 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 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 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



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1144

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, 'v1/advertisers/{+advertiserId}/creatives', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListCreativesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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_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::DisplayvideoV1::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 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 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



1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1565

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, 'v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListInsertionOrderAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1421

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



2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2069

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, 'v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListLineItemAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 fields: - 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) * The operator can be NO LESS THAN (>=) or NO GREATER THAN (<=). - updateTime (format of ISO 8601) 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" 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 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 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



1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1848

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, 'v1/advertisers/{+advertiserId}/lineItems', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListLineItemsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 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 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



2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2404

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, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 100. 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



2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2196

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, 'v1/advertisers/{+advertiserId}/locationLists', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListLocationListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 100. 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



2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2604

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, 'v1/advertisers/{+advertiserId}/manualTriggers', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListManualTriggersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3010

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



2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2792

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



3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3191

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, 'v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::ListAdvertiserAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV1::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 100. 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



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

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, 'v1/advertisers', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListAdvertisersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 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 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



3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3286

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



3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3390

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, 'v1/customBiddingAlgorithms', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListCustomBiddingAlgorithmsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 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 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



3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3479

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, 'v1/customLists', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListCustomListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 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 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



3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3578

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, 'v1/firstAndThirdPartyAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListFirstAndThirdPartyAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 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 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



3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3746

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, 'v1/googleAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListGoogleAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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_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::DisplayvideoV1::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



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

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, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 100. 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



3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3924

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, 'v1/inventorySourceGroups', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourceGroupsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 100. 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



4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4260

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, 'v1/inventorySources', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4766

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



4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4549

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, 'v1/partners/{+partnerId}/channels', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListChannelsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 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 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



4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4940

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, 'v1/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListPartnerAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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 100. 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



4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4421

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, 'v1/partners', options)
  command.response_representation = Google::Apis::DisplayvideoV1::ListPartnersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::ListTargetingOptionsResponse

Lists targeting options of a given type.

Parameters:

  • targeting_type (String)

    Required. The type of targeting option to be listed.

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



5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
# File 'lib/google/apis/displayvideo_v1/service.rb', line 5107

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



5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
# File 'lib/google/apis/displayvideo_v1/service.rb', line 5336

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

#patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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



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

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



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

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



786
787
788
789
790
791
792
793
794
795
796
797
798
799
# File 'lib/google/apis/displayvideo_v1/service.rb', line 786

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



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1183

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



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

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

Updates an existing line item. Returns the updated line item if successful.

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



1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
# File 'lib/google/apis/displayvideo_v1/service.rb', line 1887

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



2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2235

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, 'v1/advertisers/{+advertiserId}/locationLists/{locationListId}', options)
  command.request_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
  command.request_object = location_list_object
  command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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::DisplayvideoV1::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



2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2644

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, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}', options)
  command.request_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
  command.request_object = manual_trigger_object
  command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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::DisplayvideoV1::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::DisplayvideoV1::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



2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
# File 'lib/google/apis/displayvideo_v1/service.rb', line 2832

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



3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3652

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



3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
# File 'lib/google/apis/displayvideo_v1/service.rb', line 3970

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



4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
# File 'lib/google/apis/displayvideo_v1/service.rb', line 4591

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



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

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

#search_targeting_options(targeting_type, search_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV1::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

  • search_targeting_options_request_object (Google::Apis::DisplayvideoV1::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



5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
# File 'lib/google/apis/displayvideo_v1/service.rb', line 5144

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

Parameters:

  • advertiser_id (Fixnum)

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

  • create_asset_request_object (Google::Apis::DisplayvideoV1::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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'lib/google/apis/displayvideo_v1/service.rb', line 406

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, 'v1/advertisers/{+advertiserId}/assets', options)
  else
    command = make_upload_command(:post, 'v1/advertisers/{+advertiserId}/assets', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DisplayvideoV1::CreateAssetRequest::Representation
  command.request_object = create_asset_request_object
  command.response_representation = Google::Apis::DisplayvideoV1::CreateAssetResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV1::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