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

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

Overview

Display & Video 360 API

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

Examples:

require 'google/apis/displayvideo_v2'

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

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DisplayVideoService

Returns a new instance of DisplayVideoService.



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

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

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



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

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



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

def quota_user
  @quota_user
end

Instance Method Details

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

Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. Warning: Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our feature deprecation announcement for more information.

Parameters:

  • advertiser_id (Fixnum) —

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

  • trigger_id (Fixnum) —

    Required. The ID of the manual trigger to activate.

  • activate_manual_trigger_request_object (Google::Apis::DisplayvideoV2::ActivateManualTriggerRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def activate_manual_trigger(advertiser_id, trigger_id, activate_manual_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:activate', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ActivateManualTriggerRequest::Representation
  command.request_object = activate_manual_trigger_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ManualTrigger
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to audit.

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the parent channel.

  • channel_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 844

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

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

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

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

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

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

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1658

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

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

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

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

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

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

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3605

def bulk_advertiser_youtube_ad_group_list_ad_group_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, youtube_ad_group_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups:bulkListAdGroupAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::BulkListAdGroupAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::BulkListAdGroupAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['youtubeAdGroupIds'] = youtube_ad_group_ids unless youtube_ad_group_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • inventory_source_group_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5099

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

  • location_list_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2461

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

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

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

Parameters:

  • user_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

  • negative_keyword_list_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3083

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1594

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

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

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

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the parent channel.

  • channel_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5669

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1698

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

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

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

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 456

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the created channel.

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

    The ID of the partner that owns the created channel.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 668

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

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

Creates a site in a channel.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the parent channel.

  • channel_id (Fixnum) —

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

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

    The ID of the partner that owns the parent channel.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



882
883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 882

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1290

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1732

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

  • line_item_id (Fixnum) —

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

  • targeting_type (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

Creates an assignment between a location and a location list.

Parameters:

  • advertiser_id (Fixnum) —

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

  • location_list_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2497

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

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

Creates a new manual trigger. Returns the newly created manual trigger if successful. Warning: Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our feature deprecation announcement for more information.

Parameters:

  • advertiser_id (Fixnum) —

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

  • manual_trigger_object (Google::Apis::DisplayvideoV2::ManualTrigger) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def create_advertiser_manual_trigger(advertiser_id, manual_trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/manualTriggers', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.request_object = manual_trigger_object
  command.response_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ManualTrigger
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2888

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

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

Creates a negative keyword in a negative keyword list.

Parameters:

  • advertiser_id (Fixnum) —

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

  • negative_keyword_list_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3121

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser.

  • targeting_type (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3301

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

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

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

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

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

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4172

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

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

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

Parameters:

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4653

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

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

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

Parameters:

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4874

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

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

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

Parameters:

  • inventory_source_group_id (Fixnum) —

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5140

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

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

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

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the created channel.

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

    The ID of the advertiser that owns the created channel.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5493

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

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

Creates a site in a channel.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the parent channel.

  • channel_id (Fixnum) —

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

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

    The ID of the advertiser that owns the parent channel.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

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

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner.

  • targeting_type (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5888

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

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

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

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6063

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

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

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

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

Deactivates a manual trigger. Warning: Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our feature deprecation announcement for more information.

Parameters:

  • advertiser_id (Fixnum) —

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

  • trigger_id (Fixnum) —

    Required. The ID of the manual trigger to deactivate.

  • deactivate_manual_trigger_request_object (Google::Apis::DisplayvideoV2::DeactivateManualTriggerRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2710

def deactivate_manual_trigger(advertiser_id, trigger_id, deactivate_manual_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:deactivate', options)
  command.request_representation = Google::Apis::DisplayvideoV2::DeactivateManualTriggerRequest::Representation
  command.request_object = deactivate_manual_trigger_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ManualTrigger
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser we need to delete.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser this campaign belongs to.

  • campaign_id (Fixnum) —

    The ID of the campaign we need to delete.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



495
496
497
498
499
500
501
502
503
504
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 495

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

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

Deletes a site from a channel.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the parent channel.

  • channel_id (Fixnum) —

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

  • url_or_app_id (String) —

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

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

    The ID of the partner that owns the parent channel.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 922

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser this creative belongs to.

  • creative_id (Fixnum) —

    The ID of the creative to be deleted.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1099

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser this insertion order belongs to.

  • insertion_order_id (Fixnum) —

    The ID of the insertion order to delete.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1326

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser this line item belongs to.

  • line_item_id (Fixnum) —

    The ID of the line item to delete.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1769

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

  • line_item_id (Fixnum) —

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

  • targeting_type (String) —

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2093

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

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

Deletes the assignment between a location and a location list.

Parameters:

  • advertiser_id (Fixnum) —

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

  • location_list_id (Fixnum) —

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

  • assigned_location_id (Fixnum) —

    Required. The ID of the assigned location to delete.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2534

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

  • negative_keyword_list_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2924

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

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

Deletes a negative keyword from a negative keyword list.

Parameters:

  • advertiser_id (Fixnum) —

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

  • negative_keyword_list_id (Fixnum) —

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

  • keyword_value (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3160

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

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

Deletes an assigned targeting option from an advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser.

  • targeting_type (String) —

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

  • assigned_targeting_option_id (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3341

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

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

Deletes an inventory source group.

Parameters:

  • inventory_source_group_id (Fixnum) —

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4913

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

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

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

Parameters:

  • inventory_source_group_id (Fixnum) —

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

  • assigned_inventory_source_id (Fixnum) —

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

Deletes a site from a channel.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the parent channel.

  • channel_id (Fixnum) —

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

  • url_or_app_id (String) —

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

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

    The ID of the advertiser that owns the parent channel.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

Deletes an assigned targeting option from a partner.

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner.

  • targeting_type (String) —

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

  • assigned_targeting_option_id (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5926

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

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

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

Parameters:

  • user_id (Fixnum) —

    Required. The ID of the user to delete.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6368
6369
6370
6371
6372
6373
6374
6375
6376
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6368

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

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

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

Parameters:

  • resource_name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    IO stream or filename to receive content download

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5288

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

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

  • line_item_id (Fixnum) —

    Required. The ID of the line item to duplicate.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1807

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

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

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

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

Edits read advertisers of a guaranteed order.

Parameters:

  • guaranteed_order_id (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4688

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

#edit_partner_assigned_targeting_options(partner_id, bulk_edit_partner_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::BulkEditPartnerAssignedTargetingOptionsResponse

Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner.

  • bulk_edit_partner_assigned_targeting_options_request_object (Google::Apis::DisplayvideoV2::BulkEditPartnerAssignedTargetingOptionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def edit_partner_assigned_targeting_options(partner_id, bulk_edit_partner_assigned_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/partners/{+partnerId}:editAssignedTargetingOptions', options)
  command.request_representation = Google::Apis::DisplayvideoV2::BulkEditPartnerAssignedTargetingOptionsRequest::Representation
  command.request_object = bulk_edit_partner_assigned_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::BulkEditPartnerAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::BulkEditPartnerAssignedTargetingOptionsResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Advertiser

Gets an advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to fetch.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



217
218
219
220
221
222
223
224
225
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 217

def get_advertiser(advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Advertiser
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_campaign(advertiser_id, campaign_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Campaign

Gets a campaign.

Parameters:

  • advertiser_id (Fixnum) —

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

  • campaign_id (Fixnum) —

    Required. The ID of the campaign to fetch.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



528
529
530
531
532
533
534
535
536
537
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 528

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

#get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Channel

Gets a channel for a partner or advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the fetched channel.

  • channel_id (Fixnum) —

    Required. The ID of the channel to fetch.

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

    The ID of the partner that owns the fetched channel.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 705

def get_advertiser_channel(advertiser_id, channel_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/channels/{+channelId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Channel
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_creative(advertiser_id, creative_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Creative

Gets a creative.

Parameters:

  • advertiser_id (Fixnum) —

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

  • creative_id (Fixnum) —

    Required. The ID of the creative to fetch.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1132

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

#get_advertiser_insertion_order(advertiser_id, insertion_order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::InsertionOrder

Gets an insertion order. Returns error code NOT_FOUND if the insertion order does not exist.

Parameters:

  • advertiser_id (Fixnum) —

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

  • insertion_order_id (Fixnum) —

    Required. The ID of the insertion order to fetch.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1360

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

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

Gets a line item.

Parameters:

  • advertiser_id (Fixnum) —

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

  • line_item_id (Fixnum) —

    Required. The ID of the line item to fetch.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1842

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

#get_advertiser_line_item_targeting_type_assigned_targeting_option(advertiser_id, line_item_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::AssignedTargetingOption

Gets a single targeting option assigned to a line item.

Parameters:

  • advertiser_id (Fixnum) —

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

  • line_item_id (Fixnum) —

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

  • targeting_type (String) —

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

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

    Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2161

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

#get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::LocationList

Gets a location list.

Parameters:

  • advertiser_id (Fixnum) —

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

  • location_list_id (Fixnum) —

    Required. The ID of the location list to fetch.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def get_advertiser_location_list(advertiser_id, location_list_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/locationLists/{+locationListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::LocationList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Gets a manual trigger. Warning: Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our feature deprecation announcement for more information.

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



2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2748

def get_advertiser_manual_trigger(advertiser_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ManualTrigger
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::NegativeKeywordList

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

Parameters:

  • advertiser_id (Fixnum) —

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

  • negative_keyword_list_id (Fixnum) —

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2959

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

#get_advertiser_targeting_type_assigned_targeting_option(advertiser_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::AssignedTargetingOption

Gets a single targeting option assigned to an advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser.

  • targeting_type (String) —

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

  • assigned_targeting_option_id (String) —

    Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3383

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

#get_advertiser_youtube_ad_group(advertiser_id, youtube_ad_group_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::YoutubeAdGroup

Gets a YouTube ad group.

Parameters:

  • advertiser_id (Fixnum) —

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

  • youtube_ad_group_id (Fixnum) —

    Required. The ID of the ad group to fetch.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3642

def get_advertiser_youtube_ad_group(advertiser_id, youtube_ad_group_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::YoutubeAdGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV2::YoutubeAdGroup
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['youtubeAdGroupId'] = youtube_ad_group_id unless youtube_ad_group_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_youtube_ad_group_ad(advertiser_id, youtube_ad_group_ad_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::YoutubeAdGroupAd

Gets a YouTube ad group ad.

Parameters:

  • advertiser_id (Fixnum) —

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

  • youtube_ad_group_ad_id (Fixnum) —

    Required. The ID of the ad group ad to fetch.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3483

def get_advertiser_youtube_ad_group_ad(advertiser_id, youtube_ad_group_ad_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroupAds/{+youtubeAdGroupAdId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::YoutubeAdGroupAd::Representation
  command.response_class = Google::Apis::DisplayvideoV2::YoutubeAdGroupAd
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['youtubeAdGroupAdId'] = youtube_ad_group_ad_id unless youtube_ad_group_ad_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_advertiser_youtube_ad_group_targeting_type_assigned_targeting_option(advertiser_id, youtube_ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::AssignedTargetingOption

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

Parameters:

  • advertiser_id (Fixnum) —

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

  • youtube_ad_group_id (Fixnum) —

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

  • targeting_type (String) —

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

  • assigned_targeting_option_id (String) —

    Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def get_advertiser_youtube_ad_group_targeting_type_assigned_targeting_option(advertiser_id, youtube_ad_group_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::AssignedTargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::AssignedTargetingOption
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['youtubeAdGroupId'] = youtube_ad_group_id unless youtube_ad_group_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['assignedTargetingOptionId'] = assigned_targeting_option_id unless assigned_targeting_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::CombinedAudience

Gets a combined audience.

Parameters:

  • combined_audience_id (Fixnum) —

    Required. The ID of the combined audience to fetch.

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

    The ID of the advertiser that has access to the fetched combined audience.

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

    The ID of the partner that has access to the fetched combined audience.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3859

def get_combined_audience(combined_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/combinedAudiences/{+combinedAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::CombinedAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV2::CombinedAudience
  command.params['combinedAudienceId'] = combined_audience_id unless combined_audience_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_bidding_algorithm(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm

Gets a custom bidding algorithm.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm to fetch.

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

    The ID of the DV360 partner that has access to the custom bidding algorithm.

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

    The ID of the DV360 partner that has access to the custom bidding algorithm.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def get_custom_bidding_algorithm(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::CustomBiddingScript

Gets a custom bidding script.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

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

  • custom_bidding_script_id (Fixnum) —

    Required. The ID of the custom bidding script to fetch.

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4213

def get_custom_bidding_algorithm_script(custom_bidding_algorithm_id, custom_bidding_script_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::CustomBiddingScript::Representation
  command.response_class = Google::Apis::DisplayvideoV2::CustomBiddingScript
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.params['customBiddingScriptId'] = custom_bidding_script_id unless custom_bidding_script_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::CustomList

Gets a custom list.

Parameters:

  • custom_list_id (Fixnum) —

    Required. The ID of the custom list to fetch.

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

    The ID of the DV360 advertiser that has access to the fetched custom lists.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4302

def get_custom_list(custom_list_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/customLists/{+customListId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::CustomList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::CustomList
  command.params['customListId'] = custom_list_id unless custom_list_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::FloodlightGroup

Gets a Floodlight group.

Parameters:

  • floodlight_group_id (Fixnum) —

    Required. The ID of the Floodlight group to fetch.

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

    Required. The partner context by which the Floodlight group is being accessed.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def get_floodlight_group(floodlight_group_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/floodlightGroups/{+floodlightGroupId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::FloodlightGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV2::FloodlightGroup
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_floodlight_group_floodlight_activity(floodlight_group_id, floodlight_activity_id, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::FloodlightActivity

Gets a Floodlight activity.

Parameters:

  • floodlight_group_id (Fixnum) —

    Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.

  • floodlight_activity_id (Fixnum) —

    Required. The ID of the Floodlight activity to fetch.

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

    Required. The ID of the partner through which the Floodlight activity is being accessed.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4469

def get_floodlight_group_floodlight_activity(floodlight_group_id, floodlight_activity_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::FloodlightActivity::Representation
  command.response_class = Google::Apis::DisplayvideoV2::FloodlightActivity
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.params['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::GoogleAudience

Gets a Google audience.

Parameters:

  • google_audience_id (Fixnum) —

    Required. The ID of the Google audience to fetch.

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

    The ID of the advertiser that has access to the fetched Google audience.

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

    The ID of the partner that has access to the fetched Google audience.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4557

def get_google_audience(google_audience_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/googleAudiences/{+googleAudienceId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::GoogleAudience::Representation
  command.response_class = Google::Apis::DisplayvideoV2::GoogleAudience
  command.params['googleAudienceId'] = google_audience_id unless google_audience_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_guaranteed_order(guaranteed_order_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::GuaranteedOrder

Gets a guaranteed order.

Parameters:

  • guaranteed_order_id (String) —

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

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

    The ID of the advertiser that has access to the guaranteed order.

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

    The ID of the partner that has access to the guaranteed order.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4725

def get_guaranteed_order(guaranteed_order_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/guaranteedOrders/{+guaranteedOrderId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV2::GuaranteedOrder
  command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::InventorySourceGroup

Gets an inventory source group.

Parameters:

  • inventory_source_group_id (Fixnum) —

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

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

    The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

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

    The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4952

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

#get_partner(partner_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Partner

Gets a partner.

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner to fetch.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5405
5406
5407
5408
5409
5410
5411
5412
5413
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5405

def get_partner(partner_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/partners/{+partnerId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Partner::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Partner
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Channel

Gets a channel for a partner or advertiser.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the fetched channel.

  • channel_id (Fixnum) —

    Required. The ID of the channel to fetch.

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

    The ID of the advertiser that owns the fetched channel.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5530

def get_partner_channel(partner_id, channel_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/partners/{+partnerId}/channels/{+channelId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Channel
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_partner_targeting_type_assigned_targeting_option(partner_id, targeting_type, assigned_targeting_option_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::AssignedTargetingOption

Gets a single targeting option assigned to a partner.

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner.

  • targeting_type (String) —

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

  • assigned_targeting_option_id (String) —

    Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5964

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

#get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Operation

Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.

Parameters:

  • name (String) —

    The name of the operation resource.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6095
6096
6097
6098
6099
6100
6101
6102
6103
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6095

def get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::Operation::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_targeting_type_targeting_option(targeting_type, targeting_option_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::TargetingOption

Gets a single targeting option.

Parameters:

  • targeting_type (String) —

    Required. The type of targeting option to retrieve. Accepted values are: * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_ENVIRONMENT * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_OMID

  • targeting_option_id (String) —

    Required. The ID of the of targeting option to retrieve.

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

    Required. The Advertiser this request is being made in the context of.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6144

def get_targeting_type_targeting_option(targeting_type, targeting_option_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::TargetingOption::Representation
  command.response_class = Google::Apis::DisplayvideoV2::TargetingOption
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.params['targetingOptionId'] = targeting_option_id unless targeting_option_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::User

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

Parameters:

  • user_id (Fixnum) —

    Required. The ID of the user to fetch.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6401
6402
6403
6404
6405
6406
6407
6408
6409
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6401

def get_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/users/{+userId}', options)
  command.response_representation = Google::Apis::DisplayvideoV2::User::Representation
  command.response_class = Google::Apis::DisplayvideoV2::User
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::BulkListAdvertiserAssignedTargetingOptionsResponse

Lists assigned targeting options of an advertiser across targeting types.

Parameters:

  • advertiser_id (Fixnum) —

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

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

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

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

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 337

def list_advertiser_assigned_targeting_options(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}:listAssignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::BulkListAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::BulkListAdvertiserAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_campaigns(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListCampaignsResponse

Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser to list campaigns for.

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

    Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. Supported fields: * campaignId * displayName * entityStatus * updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED campaigns under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus=" ENTITY_STATUS_PAUSED") * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54: 47Z" * All campaigns with an update time greater than or equal to 2020-11- 04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

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

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

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

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

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

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCampaigns method. If not specified, the first page of results will be returned.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 592

def list_advertiser_campaigns(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/campaigns', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCampaignsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListCampaignsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_channel_sites(advertiser_id, channel_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListSitesResponse

Lists sites in a channel.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel to which the requested sites belong.

  • filter (String) (defaults to: nil) —

    Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * urlOrAppId ( default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: urlOrAppId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListSites method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent channel.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 982

def list_advertiser_channel_sites(advertiser_id, channel_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/channels/{+channelId}/sites', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListSitesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_channels(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListChannelsResponse

Lists channels for a partner or advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the channels.

  • filter (String) (defaults to: nil) —

    Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All channels for which the display name contains "google": displayName : "google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * channelId The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListChannels method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the channels.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 762

def list_advertiser_channels(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/channels', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListChannelsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListChannelsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_creatives(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListCreativesResponse

Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to list creatives for.

  • filter (String) (defaults to: nil) —

    Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * The lineItemIds field must use the HAS (:) operator. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. * For entityStatus, minDuration, maxDuration, updateTime, and dynamic fields, there may be at most one restriction. Supported Fields: * approvalStatus * creativeId * creativeType * dimensions (input in the form of width`x`height) * dynamic * entityStatus * exchangeReviewStatus (input in the form of exchange`-`reviewStatus) * lineItemIds * maxDuration (input in the form of duration`s`. Only seconds are supported) * `minDuration` (input in the form ofdurations. Only seconds are supported) * updateTime (input in ISO 8601 format, or YYYY-MM- DDTHH:MM:SSZ) Notes: * For updateTime, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: creativeType="CREATIVE_TYPE_NATIVE" * All active creatives with 300x400 or 50x100 dimensions: entityStatus="ENTITY_STATUS_ACTIVE" AND ( dimensions="300x400" OR dimensions="50x100") * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus=" EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus=" EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED") * All video creatives that are associated with line item ID 1 or 2: creativeType="CREATIVE_TYPE_VIDEO" AND ( lineItemIds:1 OR lineItemIds:2) * Find creatives by multiple creative IDs: creativeId=1 OR creativeId=2 * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11- 04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * creativeId ( default) * createTime * mediaDuration * dimensions (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: createTime desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCreatives method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1213

def list_advertiser_creatives(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/creatives', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCreativesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListCreativesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse

Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to list insertion orders for.

  • filter (String) (defaults to: nil) —

    Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` ` value. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. Supported fields: * campaignId * displayName * entityStatus * updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM: SSZ) Examples: * All insertion orders under a campaign: campaignId="1234" * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED insertion orders under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus=" ENTITY_STATUS_PAUSED") * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11- 04T18:54:47Z" * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11- 04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * "displayName" ( default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListInsertionOrders method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1426

def list_advertiser_insertion_orders(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/insertionOrders', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListInsertionOrdersResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_invoices(advertiser_id, issue_month: nil, loi_sapin_invoice_type: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListInvoicesResponse

Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to list invoices for.

  • issue_month (String) (defaults to: nil) —

    The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.

  • loi_sapin_invoice_type (String) (defaults to: nil) —

    Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListInvoices method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1517

def list_advertiser_invoices(advertiser_id, issue_month: nil, loi_sapin_invoice_type: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/invoices', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListInvoicesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListInvoicesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['issueMonth'] = issue_month unless issue_month.nil?
  command.query['loiSapinInvoiceType'] = loi_sapin_invoice_type unless loi_sapin_invoice_type.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_line_item_targeting_type_assigned_targeting_options(advertiser_id, line_item_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListLineItemAssignedTargetingOptionsResponse

Lists the targeting options assigned to a line item.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the line item belongs to.

  • line_item_id (Fixnum) —

    Required. The ID of the line item to list assigned targeting options for.

  • targeting_type (String) —

    Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS

    • TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT
    • TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_INVENTORY_SOURCE * TARGETING_TYPE_INVENTORY_SOURCE_GROUP * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_YOUTUBE_CHANNEL (only for LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE line items) * TARGETING_TYPE_YOUTUBE_VIDEO (only for LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE line items)
  • filter (String) (defaults to: nil) —

    Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId * inheritance Examples: * AssignedTargetingOption resources with ID 1 or 2: assignedTargetingOptionId=" 1" OR assignedTargetingOptionId="2" * AssignedTargetingOption resources with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER: inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedTargetingOptionId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: assignedTargetingOptionId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 5000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListLineItemAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2253

def list_advertiser_line_item_targeting_type_assigned_targeting_options(advertiser_id, line_item_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListLineItemAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListLineItemAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_line_items(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListLineItemsResponse

Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to list line items for.

  • filter (String) (defaults to: nil) —

    Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. Supported fields: * campaignId * displayName * entityStatus * insertionOrderId * lineItemId * lineItemType * updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All line items under an insertion order: insertionOrderId="1234" * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED and LINE_ITEM_TYPE_DISPLAY_DEFAULT line items under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus=" ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" * All line items with an update time less than or equal to 2020-11-04T18:54:47Z ( format of ISO 8601): updateTime<="2020-11-04T18:54:47Z" * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * entityStatus * updateTime The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListLineItems method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1909

def list_advertiser_line_items(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/lineItems', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListLineItemsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListLineItemsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_location_list_assigned_locations(advertiser_id, location_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListAssignedLocationsResponse

Lists locations assigned to a location list.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the location list belongs.

  • location_list_id (Fixnum) —

    Required. The ID of the location list to which these assignments are assigned.

  • filter (String) (defaults to: nil) —

    Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedLocationId The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedLocationId (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: assignedLocationId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAssignedLocations method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2590

def list_advertiser_location_list_assigned_locations(advertiser_id, location_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListAssignedLocationsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListAssignedLocationsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_location_lists(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListLocationListsResponse

Lists location lists based on a given advertiser id.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the fetched location lists belong.

  • filter (String) (defaults to: nil) —

    Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` ` value. * All fields must use the EQUALS (=) operator. Supported fields: * locationType Examples: * All regional location list: locationType=" TARGETING_LOCATION_TYPE_REGIONAL" * All proximity location list: locationType="TARGETING_LOCATION_TYPE_PROXIMITY" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * locationListId ( default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. Defaults to 100 if not set. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListLocationLists method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2382

def list_advertiser_location_lists(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/locationLists', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListLocationListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListLocationListsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_manual_triggers(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListManualTriggersResponse

Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required. Warning: Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our feature deprecation announcement for more information.

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 fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` ` value. * All fields must use the EQUALS (=) operator. Supported fields: * displayName * state Examples: * All active manual triggers under an advertiser: state="ACTIVE" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * state The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListManualTriggers method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2807

def list_advertiser_manual_triggers(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/manualTriggers', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListManualTriggersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListManualTriggersResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_negative_keyword_list_negative_keywords(advertiser_id, negative_keyword_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListNegativeKeywordsResponse

Lists negative keywords in a negative keyword list.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Required. The ID of the parent negative keyword list to which the requested negative keywords belong.

  • filter (String) (defaults to: nil) —

    Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * keywordValue Examples: * All negative keywords for which the keyword value contains "google": keywordValue : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * keywordValue ( default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: keywordValue desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 1000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListNegativeKeywords method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3219

def list_advertiser_negative_keyword_list_negative_keywords(advertiser_id, negative_keyword_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListNegativeKeywordsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListNegativeKeywordListsResponse

Lists negative keyword lists based on a given advertiser id.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. Defaults to 100 if not set. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListNegativeKeywordLists method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2999

def list_advertiser_negative_keyword_lists(advertiser_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/negativeKeywordLists', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListNegativeKeywordListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListNegativeKeywordListsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_targeting_type_assigned_targeting_options(advertiser_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListAdvertiserAssignedTargetingOptionsResponse

Lists the targeting options assigned to an advertiser.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser.

  • targeting_type (String) —

    Required. Identifies the type of assigned targeting options to list. Supported targeting types: * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_OMID * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_YOUTUBE_VIDEO * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_CONTENT_THEME_EXCLUSION

  • filter (String) (defaults to: nil) —

    Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId Examples: * AssignedTargetingOption with ID 123456: assignedTargetingOptionId="123456" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedTargetingOptionId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: assignedTargetingOptionId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 5000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdvertiserAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3446

def list_advertiser_targeting_type_assigned_targeting_options(advertiser_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListAdvertiserAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListAdvertiserAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_youtube_ad_group_ads(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAdsResponse

Lists YouTube ad group ads.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad groups belongs to.

  • filter (String) (defaults to: nil) —

    Allows filtering by custom YouTube ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND and OR. A sequence of restrictions implicitly uses AND . * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * adGroupId * displayName * entityStatus * adGroupAdId Examples: * All ad group ads under an ad group: adGroupId="1234" * All ad group ads under an ad group with an entityStatus of ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED: ( entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * entityStatus The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListYoutubeAdGroupAds method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3541

def list_advertiser_youtube_ad_group_ads(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroupAds', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAdsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAdsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_youtube_ad_group_targeting_type_assigned_targeting_options(advertiser_id, youtube_ad_group_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAssignedTargetingOptionsResponse

Lists the targeting options assigned to a YouTube ad group. Inherited assigned targeting options are not included.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad group belongs to.

  • youtube_ad_group_id (Fixnum) —

    Required. The ID of the ad group to list assigned targeting options for.

  • targeting_type (String) —

    Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_GENDER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SESSION_POSITION * TARGETING_TYPE_URL * TARGETING_TYPE_YOUTUBE_CHANNEL * TARGETING_TYPE_YOUTUBE_VIDEO

  • filter (String) (defaults to: nil) —

    Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId Examples: * AssignedTargetingOption resources with ID 1 or 2: assignedTargetingOptionId=" 1" OR assignedTargetingOptionId="2" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedTargetingOptionId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: assignedTargetingOptionId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 5000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListYoutubeAdGroupAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3819

def list_advertiser_youtube_ad_group_targeting_type_assigned_targeting_options(advertiser_id, youtube_ad_group_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupAssignedTargetingOptionsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['youtubeAdGroupId'] = youtube_ad_group_id unless youtube_ad_group_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertiser_youtube_ad_groups(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListYoutubeAdGroupsResponse

Lists YouTube ad groups.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser the ad groups belongs to.

  • filter (String) (defaults to: nil) —

    Allows filtering by custom YouTube ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND and OR. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported properties: * adGroupId * displayName * entityStatus * lineItemId * adGroupFormat Examples: * All ad groups under an line item: lineItemId="1234" * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM ad groups under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat=" YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * entityStatus The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListYoutubeAdGroups method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3701

def list_advertiser_youtube_ad_groups(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/youtubeAdGroups', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListYoutubeAdGroupsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListAdvertisersResponse

Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross- partner listing is not supported.

Parameters:

  • filter (String) (defaults to: nil) —

    Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. * A restriction has the form of field` ` operator` `value. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators. * All other fields must use the EQUALS (=) operator. Supported fields: * advertiserId * displayName * entityStatus * updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All active advertisers under a partner: entityStatus="ENTITY_STATUS_ACTIVE" * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<=" 2020-11-04T18:54:47Z" * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11- 04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * advertiserId ( default) * displayName * entityStatus * updateTime The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdvertisers method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 279

def list_advertisers(filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListAdvertisersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListAdvertisersResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_combined_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListCombinedAudiencesResponse

Lists combined audiences. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the fetched combined audiences.

  • filter (String) (defaults to: nil) —

    Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All combined audiences for which the display name contains "Google": displayName : "Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * combinedAudienceId (default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCombinedAudiences method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the fetched combined audiences.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3916

def list_combined_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/combinedAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCombinedAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListCombinedAudiencesResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_bidding_algorithm_scripts(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListCustomBiddingScriptsResponse

Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm owns the script.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent custom bidding algorithm.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * createTime desc ( default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: createTime.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCustomBiddingScripts method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4265

def list_custom_bidding_algorithm_scripts(custom_bidding_algorithm_id, advertiser_id: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCustomBiddingScriptsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListCustomBiddingScriptsResponse
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_bidding_algorithms(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListCustomBiddingAlgorithmsResponse

Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the DV360 advertiser that has access to the custom bidding algorithm.

  • filter (String) (defaults to: nil) —

    Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * The customBiddingAlgorithmType field must use the EQUALS (=) operator. * The displayName field must use the HAS (:) operator. Supported fields: * customBiddingAlgorithmType * displayName Examples: * All custom bidding algorithms for which the display name contains "politics": displayName:" politics". * All custom bidding algorithms for which the type is " SCRIPT_BASED": customBiddingAlgorithmType=SCRIPT_BASED The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCustomBiddingAlgorithms method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the DV360 partner that has access to the custom bidding algorithm.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4050

def list_custom_bidding_algorithms(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/customBiddingAlgorithms', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCustomBiddingAlgorithmsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListCustomBiddingAlgorithmsResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_lists(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListCustomListsResponse

Lists custom lists. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the DV360 advertiser that has access to the fetched custom lists.

  • filter (String) (defaults to: nil) —

    Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All custom lists for which the display name contains "Google": displayName:"Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * customListId ( default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCustomLists method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4356

def list_custom_lists(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/customLists', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListCustomListsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListCustomListsResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_floodlight_group_floodlight_activities(floodlight_group_id, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListFloodlightActivitiesResponse

Lists Floodlight activities in a Floodlight group.

Parameters:

  • floodlight_group_id (Fixnum) —

    Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.

  • order_by (String) (defaults to: nil) —

    Optional. Field by which to sort the list. Acceptable values are: * displayName (default) * floodlightActivityId The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListFloodlightActivities method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    Required. The ID of the partner through which the Floodlight activities are being accessed.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4519

def list_floodlight_group_floodlight_activities(floodlight_group_id, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/floodlightGroups/{+floodlightGroupId}/floodlightActivities', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListFloodlightActivitiesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListFloodlightActivitiesResponse
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_google_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListGoogleAudiencesResponse

Lists Google audiences. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the fetched Google audiences.

  • filter (String) (defaults to: nil) —

    Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All Google audiences for which the display name contains "Google": displayName:" Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * googleAudienceId ( default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListGoogleAudiences method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the fetched Google audiences.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4614

def list_google_audiences(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/googleAudiences', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListGoogleAudiencesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListGoogleAudiencesResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_guaranteed_orders(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListGuaranteedOrdersResponse

Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status ENTITY_STATUS_ARCHIVED will not be included in the results.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the guaranteed order.

  • filter (String) (defaults to: nil) —

    Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * guaranteed_order_id * exchange * display_name * status.entityStatus Examples: * All active guaranteed orders: status.entityStatus="ENTITY_STATUS_ACTIVE" * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: exchange=" EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListGuaranteedOrders method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the guaranteed order.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4788

def list_guaranteed_orders(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/guaranteedOrders', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListGuaranteedOrdersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListGuaranteedOrdersResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_inventory_source_group_assigned_inventory_sources(inventory_source_group_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListAssignedInventorySourcesResponse

Lists inventory sources assigned to an inventory source group.

Parameters:

  • inventory_source_group_id (Fixnum) —

    Required. The ID of the inventory source group to which these assignments are assigned.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.

  • filter (String) (defaults to: nil) —

    Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedInventorySourceId The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedInventorySourceId (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: assignedInventorySourceId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAssignedInventorySources method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5248

def list_inventory_source_group_assigned_inventory_sources(inventory_source_group_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListAssignedInventorySourcesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListAssignedInventorySourcesResponse
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_inventory_source_groups(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListInventorySourceGroupsResponse

Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.

Parameters:

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.

  • filter (String) (defaults to: nil) —

    Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * inventorySourceGroupId The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * inventorySourceGroupId The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListInventorySources method. If not specified, the first page of results will be returned.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5011

def list_inventory_source_groups(advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/inventorySourceGroups', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListInventorySourceGroupsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListInventorySourceGroupsResponse
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partner_channel_sites(partner_id, channel_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListSitesResponse

Lists sites in a channel.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel to which the requested sites belong.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent channel.

  • filter (String) (defaults to: nil) —

    Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * urlOrAppId ( default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: urlOrAppId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListSites method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5807

def list_partner_channel_sites(partner_id, channel_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/partners/{+partnerId}/channels/{+channelId}/sites', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListSitesResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partner_channels(partner_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListChannelsResponse

Lists channels for a partner or advertiser.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the channels.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the channels.

  • filter (String) (defaults to: nil) —

    Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of field` `operator` `value. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All channels for which the display name contains "google": displayName : "google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) * channelId The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListChannels method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5587

def list_partner_channels(partner_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/partners/{+partnerId}/channels', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListChannelsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListChannelsResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partner_targeting_type_assigned_targeting_options(partner_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListPartnerAssignedTargetingOptionsResponse

Lists the targeting options assigned to a partner.

Parameters:

  • partner_id (Fixnum) —

    Required. The ID of the partner.

  • targeting_type (String) —

    Required. Identifies the type of assigned targeting options to list. Supported targeting types: * TARGETING_TYPE_CHANNEL

  • filter (String) (defaults to: nil) —

    Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator OR. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * assignedTargetingOptionId Examples: * AssignedTargetingOption resource with ID 123456: assignedTargetingOptionId=" 123456" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * assignedTargetingOptionId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: assignedTargetingOptionId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListPartnerAssignedTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6023

def list_partner_targeting_type_assigned_targeting_options(partner_id, targeting_type, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListPartnerAssignedTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListPartnerAssignedTargetingOptionsResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partners(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListPartnersResponse

Lists partners that are accessible to the current user. The order is defined by the order_by parameter.

Parameters:

  • filter (String) (defaults to: nil) —

    Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of field` `operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * entityStatus Examples: * All active partners: entityStatus="ENTITY_STATUS_ACTIVE" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListPartners method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5457

def list_partners(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/partners', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListPartnersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListPartnersResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_targeting_type_targeting_options(targeting_type, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListTargetingOptionsResponse

Lists targeting options of a given type.

Parameters:

  • targeting_type (String) —

    Required. The type of targeting option to be listed. Accepted values are: * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_ENVIRONMENT * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_OMID

  • advertiser_id (Fixnum) (defaults to: nil) —

    Required. The Advertiser this request is being made in the context of.

  • filter (String) (defaults to: nil) —

    Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by OR logical operators. * A restriction has the form of field` ` operator` `value. * All fields must use the EQUALS (=) operator. Supported fields: * carrierAndIspDetails.type * geoRegionDetails.geoRegionType * targetingOptionId Examples: * All GEO REGION targeting options that belong to sub type GEO_REGION_TYPE_COUNTRY or GEO_REGION_TYPE_STATE: geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails. geoRegionType="GEO_REGION_TYPE_STATE" * All CARRIER AND ISP targeting options that belong to sub type CARRIER_AND_ISP_TYPE_CARRIER: carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * targetingOptionId ( default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: targetingOptionId desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListTargetingOptions method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6222

def list_targeting_type_targeting_options(targeting_type, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/targetingTypes/{+targetingType}/targetingOptions', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListTargetingOptionsResponse
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_users(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ListUsersResponse

Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

  • filter (String) (defaults to: nil) —

    Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator AND. * A restriction has the form of field` `operator` ` value. * The displayName and email fields must use the HAS (:) operator. * The lastLoginTime field must use either the LESS THAN OR EQUAL TO (<=) or GREATER THAN OR EQUAL TO (>=) operator. * All other fields must use the EQUALS (=) operator. Supported fields: * assignedUserRole. advertiserId * assignedUserRole.entityType: This is synthetic field of AssignedUserRole used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are Partner and Advertiser. * assignedUserRole.parentPartnerId: This is a synthetic field of AssignedUserRole used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * assignedUserRole.partnerId * assignedUserRole.userRole * displayName * email * lastLoginTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * The user with displayName containing "foo": displayName:"foo" * The user with email containing "bar": email:"bar" * All users with standard user roles: assignedUserRole.userRole="STANDARD" * All users with user roles for partner 123: assignedUserRole.partnerId="123" * All users with user roles for advertiser 123: assignedUserRole.advertiserId="123" * All users with partner level user roles: entityType="PARTNER" * All users with user roles for partner 123 and advertisers under partner 123: parentPartnerId="123" * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601) : lastLoginTime>="2023-01-01T00:00:00Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

  • order_by (String) (defaults to: nil) —

    Field by which to sort the list. Acceptable values are: * displayName ( default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Must be between 1 and 200. If unspecified will default to 100.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListUsers method. If not specified, the first page of results will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6474

def list_users(filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/users', options)
  command.response_representation = Google::Apis::DisplayvideoV2::ListUsersResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ListUsersResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_advertiser_invoice_invoice_currency(advertiser_id, invoice_month: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::LookupInvoiceCurrencyResponse

Retrieves the invoice currency used by an advertiser in a given month.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser to lookup currency for.

  • invoice_month (String) (defaults to: nil) —

    Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1554

def lookup_advertiser_invoice_invoice_currency(advertiser_id, invoice_month: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency', options)
  command.response_representation = Google::Apis::DisplayvideoV2::LookupInvoiceCurrencyResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::LookupInvoiceCurrencyResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['invoiceMonth'] = invoice_month unless invoice_month.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Advertiser

Updates an existing advertiser. Returns the updated advertiser if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser. Assigned by the system.

  • advertiser_object (Google::Apis::DisplayvideoV2::Advertiser) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 374

def patch_advertiser(advertiser_id, advertiser_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Advertiser::Representation
  command.request_object = advertiser_object
  command.response_representation = Google::Apis::DisplayvideoV2::Advertiser::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Advertiser
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Campaign

Updates an existing campaign. Returns the updated campaign if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the campaign belongs to.

  • campaign_id (Fixnum) —

    Output only. The unique ID of the campaign. Assigned by the system.

  • campaign_object (Google::Apis::DisplayvideoV2::Campaign) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



631
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 631

def patch_advertiser_campaign(advertiser_id, campaign_id, campaign_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/campaigns/{+campaignId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Campaign::Representation
  command.request_object = campaign_object
  command.response_representation = Google::Apis::DisplayvideoV2::Campaign::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Campaign
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_channel(advertiser_id, channel_id, channel_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Channel

Updates a channel. Returns the updated channel if successful.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the created channel.

  • channel_id (Fixnum) —

    Output only. The unique ID of the channel. Assigned by the system.

  • channel_object (Google::Apis::DisplayvideoV2::Channel) (defaults to: nil)
  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the created channel.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 804

def patch_advertiser_channel(advertiser_id, channel_id, channel_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/channels/{channelId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Channel
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_creative(advertiser_id, creative_id, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Creative

Updates an existing creative. Returns the updated creative if successful. A " Standard" user role or greater for the parent advertiser or partner is required to make this request.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the creative belongs to.

  • creative_id (Fixnum) —

    Output only. The unique ID of the creative. Assigned by the system.

  • creative_object (Google::Apis::DisplayvideoV2::Creative) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1254

def patch_advertiser_creative(advertiser_id, creative_id, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/creatives/{+creativeId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::DisplayvideoV2::Creative::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Creative
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::InsertionOrder

Updates an existing insertion order. Returns the updated insertion order if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the insertion order belongs to.

  • insertion_order_id (Fixnum) —

    Output only. The unique ID of the insertion order. Assigned by the system.

  • insertion_order_object (Google::Apis::DisplayvideoV2::InsertionOrder) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1466

def patch_advertiser_insertion_order(advertiser_id, insertion_order_id, insertion_order_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
  command.request_object = insertion_order_object
  command.response_representation = Google::Apis::DisplayvideoV2::InsertionOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV2::InsertionOrder
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['insertionOrderId'] = insertion_order_id unless insertion_order_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_line_item(advertiser_id, line_item_id, line_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::LineItem

Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Parameters:

  • advertiser_id (Fixnum) —

    Output only. The unique ID of the advertiser the line item belongs to.

  • line_item_id (Fixnum) —

    Output only. The unique ID of the line item. Assigned by the system.

  • line_item_object (Google::Apis::DisplayvideoV2::LineItem) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1955

def patch_advertiser_line_item(advertiser_id, line_item_id, line_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::LineItem::Representation
  command.request_object = line_item_object
  command.response_representation = Google::Apis::DisplayvideoV2::LineItem::Representation
  command.response_class = Google::Apis::DisplayvideoV2::LineItem
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['lineItemId'] = line_item_id unless line_item_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_location_list(advertiser_id, location_list_id, location_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::LocationList

Updates a location list. Returns the updated location list if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the location lists belongs.

  • location_list_id (Fixnum) —

    Output only. The unique ID of the location list. Assigned by the system.

  • location_list_object (Google::Apis::DisplayvideoV2::LocationList) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2421

def patch_advertiser_location_list(advertiser_id, location_list_id, location_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/locationLists/{locationListId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::LocationList::Representation
  command.request_object = location_list_object
  command.response_representation = Google::Apis::DisplayvideoV2::LocationList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::LocationList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['locationListId'] = location_list_id unless location_list_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_manual_trigger(advertiser_id, trigger_id, manual_trigger_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ManualTrigger

Updates a manual trigger. Returns the updated manual trigger if successful. ** Warning:** Line Items using manual triggers no longer serve in Display & Video

  1. This method will sunset on August 1, 2023. Read our feature deprecation announcement for more information.

Parameters:

  • advertiser_id (Fixnum) —

    Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.

  • trigger_id (Fixnum) —

    Output only. The unique ID of the manual trigger.

  • manual_trigger_object (Google::Apis::DisplayvideoV2::ManualTrigger) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 2851

def patch_advertiser_manual_trigger(advertiser_id, trigger_id, manual_trigger_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.request_object = manual_trigger_object
  command.response_representation = Google::Apis::DisplayvideoV2::ManualTrigger::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ManualTrigger
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, negative_keyword_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::NegativeKeywordList

Updates a negative keyword list. Returns the updated negative keyword list if successful.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Output only. The unique ID of the negative keyword list. Assigned by the system.

  • negative_keyword_list_object (Google::Apis::DisplayvideoV2::NegativeKeywordList) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3039

def patch_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, negative_keyword_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::NegativeKeywordList::Representation
  command.request_object = negative_keyword_list_object
  command.response_representation = Google::Apis::DisplayvideoV2::NegativeKeywordList::Representation
  command.response_class = Google::Apis::DisplayvideoV2::NegativeKeywordList
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_custom_bidding_algorithm(custom_bidding_algorithm_id, custom_bidding_algorithm_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Output only. The unique ID of the custom bidding algorithm. Assigned by the system.

  • custom_bidding_algorithm_object (Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4091

def patch_custom_bidding_algorithm(custom_bidding_algorithm_id, custom_bidding_algorithm_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm::Representation
  command.request_object = custom_bidding_algorithm_object
  command.response_representation = Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm::Representation
  command.response_class = Google::Apis::DisplayvideoV2::CustomBiddingAlgorithm
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_floodlight_group(floodlight_group_id, floodlight_group_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::FloodlightGroup

Updates an existing Floodlight group. Returns the updated Floodlight group if successful.

Parameters:

  • floodlight_group_id (Fixnum) —

    Output only. The unique ID of the Floodlight group. Assigned by the system.

  • floodlight_group_object (Google::Apis::DisplayvideoV2::FloodlightGroup) (defaults to: nil)
  • partner_id (Fixnum) (defaults to: nil) —

    Required. The partner context by which the Floodlight group is being accessed.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4429

def patch_floodlight_group(floodlight_group_id, floodlight_group_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/floodlightGroups/{floodlightGroupId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::FloodlightGroup::Representation
  command.request_object = floodlight_group_object
  command.response_representation = Google::Apis::DisplayvideoV2::FloodlightGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV2::FloodlightGroup
  command.params['floodlightGroupId'] = floodlight_group_id unless floodlight_group_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_guaranteed_order(guaranteed_order_id, guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::GuaranteedOrder

Updates an existing guaranteed order. Returns the updated guaranteed order if successful.

Parameters:

  • guaranteed_order_id (String) —

    Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format exchange`-`legacy_guaranteed_order_id.

  • guaranteed_order_object (Google::Apis::DisplayvideoV2::GuaranteedOrder) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that the request is being made within.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that the request is being made within.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4832

def patch_guaranteed_order(guaranteed_order_id, guaranteed_order_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/guaranteedOrders/{+guaranteedOrderId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::GuaranteedOrder::Representation
  command.request_object = guaranteed_order_object
  command.response_representation = Google::Apis::DisplayvideoV2::GuaranteedOrder::Representation
  command.response_class = Google::Apis::DisplayvideoV2::GuaranteedOrder
  command.params['guaranteedOrderId'] = guaranteed_order_id unless guaranteed_order_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_inventory_source_group(inventory_source_group_id, inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::InventorySourceGroup

Updates an inventory source group. Returns the updated inventory source group if successful.

Parameters:

  • inventory_source_group_id (Fixnum) —

    Output only. The unique ID of the inventory source group. Assigned by the system.

  • inventory_source_group_object (Google::Apis::DisplayvideoV2::InventorySourceGroup) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the inventory source group. Only this partner has write access to this group.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5057

def patch_inventory_source_group(inventory_source_group_id, inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/inventorySourceGroups/{inventorySourceGroupId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::InventorySourceGroup::Representation
  command.request_object = inventory_source_group_object
  command.response_representation = Google::Apis::DisplayvideoV2::InventorySourceGroup::Representation
  command.response_class = Google::Apis::DisplayvideoV2::InventorySourceGroup
  command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_partner_channel(partner_id, channel_id, channel_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::Channel

Updates a channel. Returns the updated channel if successful.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the created channel.

  • channel_id (Fixnum) —

    Output only. The unique ID of the channel. Assigned by the system.

  • channel_object (Google::Apis::DisplayvideoV2::Channel) (defaults to: nil)
  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the created channel.

  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5629

def patch_partner_channel(partner_id, channel_id, channel_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/partners/{+partnerId}/channels/{channelId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DisplayvideoV2::Channel::Representation
  command.response_class = Google::Apis::DisplayvideoV2::Channel
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_user(user_id, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::User

Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.

Parameters:

  • user_id (Fixnum) —

    Output only. The unique ID of the user. Assigned by the system.

  • user_object (Google::Apis::DisplayvideoV2::User) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6514

def patch_user(user_id, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/users/{+userId}', options)
  command.request_representation = Google::Apis::DisplayvideoV2::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::DisplayvideoV2::User::Representation
  command.response_class = Google::Apis::DisplayvideoV2::User
  command.params['userId'] = user_id unless user_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_advertiser_channel_site(advertiser_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ReplaceSitesResponse

Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest. new_sites. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Parameters:

  • advertiser_id (Fixnum) —

    The ID of the advertiser that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel whose sites will be replaced.

  • replace_sites_request_object (Google::Apis::DisplayvideoV2::ReplaceSitesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 1025

def replace_advertiser_channel_site(advertiser_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{advertiserId}/channels/{+channelId}/sites:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ReplaceSitesRequest::Representation
  command.request_object = replace_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::ReplaceSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ReplaceSitesResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_negative_keywords(advertiser_id, negative_keyword_list_id, replace_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ReplaceNegativeKeywordsResponse

Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

  • negative_keyword_list_id (Fixnum) —

    Required. The ID of the parent negative keyword list to which the negative keywords belong.

  • replace_negative_keywords_request_object (Google::Apis::DisplayvideoV2::ReplaceNegativeKeywordsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 3261

def replace_negative_keywords(advertiser_id, negative_keyword_list_id, replace_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ReplaceNegativeKeywordsRequest::Representation
  command.request_object = replace_negative_keywords_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::ReplaceNegativeKeywordsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ReplaceNegativeKeywordsResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_partner_channel_site(partner_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::ReplaceSitesResponse

Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest. new_sites. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner that owns the parent channel.

  • channel_id (Fixnum) —

    Required. The ID of the parent channel whose sites will be replaced.

  • replace_sites_request_object (Google::Apis::DisplayvideoV2::ReplaceSitesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5850

def replace_partner_channel_site(partner_id, channel_id, replace_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/partners/{partnerId}/channels/{+channelId}/sites:replace', options)
  command.request_representation = Google::Apis::DisplayvideoV2::ReplaceSitesRequest::Representation
  command.request_object = replace_sites_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::ReplaceSitesResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::ReplaceSitesResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.params['channelId'] = channel_id unless channel_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_targeting_options(targeting_type, search_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::SearchTargetingOptionsResponse

Searches for targeting options of a given type based on the given search terms.

Parameters:

  • targeting_type (String) —

    Required. The type of targeting options to retrieve. Accepted values are: * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_POI * TARGETING_TYPE_BUSINESS_CHAIN

  • search_targeting_options_request_object (Google::Apis::DisplayvideoV2::SearchTargetingOptionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 6260

def search_targeting_options(targeting_type, search_targeting_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/targetingTypes/{+targetingType}/targetingOptions:search', options)
  command.request_representation = Google::Apis::DisplayvideoV2::SearchTargetingOptionsRequest::Representation
  command.request_object = search_targeting_options_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::SearchTargetingOptionsResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::SearchTargetingOptionsResponse
  command.params['targetingType'] = targeting_type unless targeting_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_advertiser_asset(advertiser_id, create_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::CreateAssetResponse

Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the multipart media upload process. Examples using provided client libraries can be found in our Creating Creatives guide.

Parameters:

  • advertiser_id (Fixnum) —

    Required. The ID of the advertiser this asset belongs to.

  • create_asset_request_object (Google::Apis::DisplayvideoV2::CreateAssetRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil) —

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 417

def upload_advertiser_asset(advertiser_id, create_asset_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'v2/advertisers/{+advertiserId}/assets', options)
  else
    command = make_upload_command(:post, 'v2/advertisers/{+advertiserId}/assets', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DisplayvideoV2::CreateAssetRequest::Representation
  command.request_object = create_asset_request_object
  command.response_representation = Google::Apis::DisplayvideoV2::CreateAssetResponse::Representation
  command.response_class = Google::Apis::DisplayvideoV2::CreateAssetResponse
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_custom_bidding_algorithm_script(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::CustomBiddingScriptRef

Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.

Parameters:

  • custom_bidding_algorithm_id (Fixnum) —

    Required. The ID of the custom bidding algorithm owns the script.

  • advertiser_id (Fixnum) (defaults to: nil) —

    The ID of the advertiser that owns the parent custom bidding algorithm.

  • partner_id (Fixnum) (defaults to: nil) —

    The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 4132

def upload_custom_bidding_algorithm_script(custom_bidding_algorithm_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript', options)
  command.response_representation = Google::Apis::DisplayvideoV2::CustomBiddingScriptRef::Representation
  command.response_class = Google::Apis::DisplayvideoV2::CustomBiddingScriptRef
  command.params['customBiddingAlgorithmId'] = custom_bidding_algorithm_id unless custom_bidding_algorithm_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DisplayvideoV2::GoogleBytestreamMedia

Uploads media. Upload is supported on the URI /upload/media/resource_name= ?upload_type=media. **Note: Upload requests will not be successful without including upload_type=media query string.

Parameters:

  • resource_name (String) —

    Name of the media that is being downloaded. See ReadRequest.resource_name.

  • google_bytestream_media_object (Google::Apis::DisplayvideoV2::GoogleBytestreamMedia) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil) —

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
 
# File 'lib/google/apis/displayvideo_v2/service.rb', line 5330

def upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'media/{+resourceName}', options)
  else
    command = make_upload_command(:post, 'media/{+resourceName}', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DisplayvideoV2::GoogleBytestreamMedia::Representation
  command.request_object = google_bytestream_media_object
  command.response_representation = Google::Apis::DisplayvideoV2::GoogleBytestreamMedia::Representation
  command.response_class = Google::Apis::DisplayvideoV2::GoogleBytestreamMedia
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end