Class: Google::Apis::RealtimebiddingV1::RealtimeBiddingService

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

Overview

Real-time Bidding API

Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive via pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.

Examples:

require 'google/apis/realtimebidding_v1'

Realtimebidding = Google::Apis::RealtimebiddingV1 # Alias the module
service = Realtimebidding::RealtimeBiddingService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ RealtimeBiddingService

Returns a new instance of RealtimeBiddingService.



48
49
50
51
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 48

def initialize
  super('https://realtimebidding.googleapis.com/', '')
  @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.



41
42
43
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 41

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.



46
47
48
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#activate_pretargeting_config(name, activate_pretargeting_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Activates a pretargeting configuration.

Parameters:

  • name (String) —

    Required. The name of the pretargeting configuration. Format: bidders/ bidderAccountId/pretargetingConfig/configId

  • activate_pretargeting_config_request_object (Google::Apis::RealtimebiddingV1::ActivatePretargetingConfigRequest) (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



177
178
179
180
181
182
183
184
185
186
187
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 177

def activate_pretargeting_config(name, activate_pretargeting_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:activate', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::ActivatePretargetingConfigRequest::Representation
  command.request_object = activate_pretargeting_config_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  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

#add_pretargeting_config_targeted_apps(pretargeting_config, add_targeted_apps_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Adds targeted apps to the pretargeting configuration.

Parameters:

  • pretargeting_config (String) —

    Required. The name of the pretargeting configuration. Format: bidders/ bidderAccountId/pretargetingConfig/configId

  • add_targeted_apps_request_object (Google::Apis::RealtimebiddingV1::AddTargetedAppsRequest) (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



211
212
213
214
215
216
217
218
219
220
221
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 211

def add_pretargeting_config_targeted_apps(pretargeting_config, add_targeted_apps_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+pretargetingConfig}:addTargetedApps', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::AddTargetedAppsRequest::Representation
  command.request_object = add_targeted_apps_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_pretargeting_config_targeted_publishers(pretargeting_config, add_targeted_publishers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Adds targeted publishers to the pretargeting config.

Parameters:

  • pretargeting_config (String) —

    Required. The name of the pretargeting configuration. Format: bidders/ bidderAccountId/pretargetingConfig/configId

  • add_targeted_publishers_request_object (Google::Apis::RealtimebiddingV1::AddTargetedPublishersRequest) (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



245
246
247
248
249
250
251
252
253
254
255
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 245

def add_pretargeting_config_targeted_publishers(pretargeting_config, add_targeted_publishers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+pretargetingConfig}:addTargetedPublishers', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::AddTargetedPublishersRequest::Representation
  command.request_object = add_targeted_publishers_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_pretargeting_config_targeted_sites(pretargeting_config, add_targeted_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Adds targeted sites to the pretargeting configuration.

Parameters:

  • pretargeting_config (String) —

    Required. The name of the pretargeting configuration. Format: bidders/ bidderAccountId/pretargetingConfig/configId

  • add_targeted_sites_request_object (Google::Apis::RealtimebiddingV1::AddTargetedSitesRequest) (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



279
280
281
282
283
284
285
286
287
288
289
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 279

def add_pretargeting_config_targeted_sites(pretargeting_config, add_targeted_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+pretargetingConfig}:addTargetedSites', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::AddTargetedSitesRequest::Representation
  command.request_object = add_targeted_sites_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#close_user_list(name, close_user_list_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::UserList

Change the status of a user list to CLOSED. This prevents new users from being added to the user list.

Parameters:

  • name (String) —

    Required. The name of the user list to close. See UserList.name

  • close_user_list_request_object (Google::Apis::RealtimebiddingV1::CloseUserListRequest) (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



839
840
841
842
843
844
845
846
847
848
849
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 839

def close_user_list(name, close_user_list_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:close', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::CloseUserListRequest::Representation
  command.request_object = close_user_list_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::UserList
  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

#create_bidder_pretargeting_config(parent, pretargeting_config_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Creates a pretargeting configuration. A pretargeting configuration's state ( PretargetingConfig.state) is active upon creation, and it will start to affect traffic shortly after. A bidder may create a maximum of 10 pretargeting configurations. Attempts to exceed this maximum results in a 400 bad request error.

Parameters:

  • parent (String) —

    Required. Name of the bidder to create the pretargeting configuration for. Format: bidders/bidderAccountId

  • pretargeting_config_object (Google::Apis::RealtimebiddingV1::PretargetingConfig) (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



317
318
319
320
321
322
323
324
325
326
327
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 317

def create_bidder_pretargeting_config(parent, pretargeting_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/pretargetingConfigs', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.request_object = pretargeting_config_object
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  command.params['parent'] = parent unless parent.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_buyer_creative(parent, creative_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::Creative

Creates a creative.

Parameters:

  • parent (String) —

    Required. The name of the parent buyer that the new creative belongs to that must follow the pattern buyers/buyerAccountId, wherebuyerAccountId represents the account ID of the buyer who owns a creative. For a bidder accessing creatives on behalf of a child seat buyer,buyerAccountId`` should represent the account ID of the child seat buyer.

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



667
668
669
670
671
672
673
674
675
676
677
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 667

def create_buyer_creative(parent, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/creatives', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::Creative
  command.params['parent'] = parent unless parent.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_buyer_user_list(parent, user_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::UserList

Create a new user list.

Parameters:

  • parent (String) —

    Required. The name of the parent buyer of the user list to be retrieved that must follow the pattern buyers/buyerAccountId, wherebuyerAccountId represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer ,buyerAccountId`` should represent the account ID of the child seat buyer.

  • user_list_object (Google::Apis::RealtimebiddingV1::UserList) (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



876
877
878
879
880
881
882
883
884
885
886
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 876

def create_buyer_user_list(parent, user_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/userLists', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
  command.request_object = user_list_object
  command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::UserList
  command.params['parent'] = parent unless parent.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_bidder_pretargeting_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::Empty

Deletes a pretargeting configuration.

Parameters:

  • name (String) —

    Required. The name of the pretargeting configuration to delete. Format: bidders/bidderAccountId/pretargetingConfig/configId

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



350
351
352
353
354
355
356
357
358
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 350

def delete_bidder_pretargeting_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::Empty::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::Empty
  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_bidder_pretargeting_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Gets a pretargeting configuration.

Parameters:

  • name (String) —

    Required. Name of the pretargeting configuration to get. Format: bidders/ bidderAccountId/pretargetingConfig/configId

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



381
382
383
384
385
386
387
388
389
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 381

def get_bidder_pretargeting_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  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_buyer_creative(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::Creative

Gets a creative.

Parameters:

  • name (String) —

    Required. Name of the creative to retrieve. See creative.name.

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

    Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource ( including the declared fields and the creative content) specify the view as " FULL".

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



704
705
706
707
708
709
710
711
712
713
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 704

def get_buyer_creative(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::Creative
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.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_buyer_remarketing_tag(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse

Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.

Parameters:

  • name (String) —

    Required. To fetch remarketing tag for an account, name must follow the pattern buyers/accountIdwhereaccountIdrepresents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer,accountIdshould represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/`accountId`/userLists/`userListId. See UserList.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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



632
633
634
635
636
637
638
639
640
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 632

def get_buyer_remarketing_tag(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:getRemarketingTag', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse
  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_buyer_user_list(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::UserList

Gets a user list by its name.

Parameters:

  • name (String) —

    Required. The name of the user list to be retrieved. See UserList.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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



908
909
910
911
912
913
914
915
916
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 908

def get_buyer_user_list(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::UserList
  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_buyer_user_list_remarketing_tag(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::GetRemarketingTagResponse

Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.

Parameters:

  • name (String) —

    Required. To fetch remarketing tag for an account, name must follow the pattern buyers/accountIdwhereaccountIdrepresents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer,accountIdshould represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/`accountId`/userLists/`userListId. See UserList.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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



945
946
947
948
949
950
951
952
953
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 945

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

#list_bidder_creatives(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::ListCreativesResponse

Lists creatives.

Parameters:

  • parent (String) —

    Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either buyers/buyerAccountIdor `bidders/`bidderAccountId` `. For `buyers/`buyerAccountId, the buyerAccountId can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (456) under bidder account ( 123), you would use the pattern: buyers/456. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (123), you would use buyers/ 123. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use bidders/bidderAccountId`, e.g. , for all creatives pertaining to bidder (123), usebidders/123`.

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

    Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus: DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes: IS_COOKIE_TARGETED'

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

    Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method.

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

    Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource ( including the declared fields and the creative content) specify the view as " FULL".

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 102

def list_bidder_creatives(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/creatives', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::ListCreativesResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::ListCreativesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.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_bidder_pretargeting_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse

Lists all pretargeting configurations for a single bidder.

Parameters:

  • parent (String) —

    Required. Name of the bidder whose pretargeting configurations will be listed. Format: bidders/bidderAccountId

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

    The maximum number of pretargeting configurations to return. If unspecified, at most 10 pretargeting configurations will be returned. The maximum value is 100; values above 100 will be coerced to 100.

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

    A token identifying a page of results the server should return. This value is received from a previous ListPretargetingConfigs call in ListPretargetingConfigsResponse.nextPageToken.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



420
421
422
423
424
425
426
427
428
429
430
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 420

def list_bidder_pretargeting_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/pretargetingConfigs', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse
  command.params['parent'] = parent unless parent.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_buyer_creatives(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::ListCreativesResponse

Lists creatives.

Parameters:

  • parent (String) —

    Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either buyers/buyerAccountIdor `bidders/`bidderAccountId` `. For `buyers/`buyerAccountId, the buyerAccountId can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (456) under bidder account ( 123), you would use the pattern: buyers/456. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (123), you would use buyers/ 123. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use bidders/bidderAccountId`, e.g. , for all creatives pertaining to bidder (123), usebidders/123`.

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

    Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus: DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes: IS_COOKIE_TARGETED'

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

    Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method.

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

    Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource ( including the declared fields and the creative content) specify the view as " FULL".

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 764

def list_buyer_creatives(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/creatives', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::ListCreativesResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::ListCreativesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.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_buyer_user_lists(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::ListUserListsResponse

Lists the user lists visible to the current user.

Parameters:

  • parent (String) —

    Required. The name of the parent buyer for the user lists to be returned that must follow the pattern buyers/buyerAccountId, wherebuyerAccountId represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer ,buyerAccountId`` should represent the account ID of the child seat buyer.

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

    The number of results to return per page.

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

    Continuation page token (as received from a previous response).

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



983
984
985
986
987
988
989
990
991
992
993
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 983

def list_buyer_user_lists(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/userLists', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::ListUserListsResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::ListUserListsResponse
  command.params['parent'] = parent unless parent.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

#open_user_list(name, open_user_list_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::UserList

Change the status of a user list to OPEN. This allows new users to be added to the user list.

Parameters:

  • name (String) —

    Required. The name of the user list to open. See UserList.name

  • open_user_list_request_object (Google::Apis::RealtimebiddingV1::OpenUserListRequest) (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



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 1017

def open_user_list(name, open_user_list_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:open', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::OpenUserListRequest::Representation
  command.request_object = open_user_list_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::UserList
  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

#patch_bidder_pretargeting_config(name, pretargeting_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Updates a pretargeting configuration.

Parameters:

  • name (String) —

    Output only. Name of the pretargeting configuration that must follow the pattern bidders/bidder_account_id/pretargetingConfigs/config_id``

  • pretargeting_config_object (Google::Apis::RealtimebiddingV1::PretargetingConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Field mask to use for partial in-place updates.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the 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
467
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 456

def patch_bidder_pretargeting_config(name, pretargeting_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.request_object = pretargeting_config_object
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  command.params['name'] = name unless name.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_buyer_creative(name, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::Creative

Updates a creative.

Parameters:

  • name (String) —

    Output only. Name of the creative. Follows the pattern buyers/buyer/ creatives/creative, wherebuyerrepresents the account ID of the buyer who owns the creative, andcreative`` is the buyer-specific creative ID that references this creative in the bid response.

  • creative_object (Google::Apis::RealtimebiddingV1::Creative) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Field mask to use for partial in-place updates.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the 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
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 804

def patch_buyer_creative(name, creative_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::RealtimebiddingV1::Creative::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::Creative
  command.params['name'] = name unless name.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

#remove_pretargeting_config_targeted_apps(pretargeting_config, remove_targeted_apps_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Removes targeted apps from the pretargeting configuration.

Parameters:

  • pretargeting_config (String) —

    Required. The name of the pretargeting configuration. Format: bidders/ bidderAccountId/pretargetingConfig/configId

  • remove_targeted_apps_request_object (Google::Apis::RealtimebiddingV1::RemoveTargetedAppsRequest) (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



491
492
493
494
495
496
497
498
499
500
501
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 491

def remove_pretargeting_config_targeted_apps(pretargeting_config, remove_targeted_apps_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+pretargetingConfig}:removeTargetedApps', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::RemoveTargetedAppsRequest::Representation
  command.request_object = remove_targeted_apps_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_pretargeting_config_targeted_publishers(pretargeting_config, remove_targeted_publishers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Removes targeted publishers from the pretargeting config.

Parameters:

  • pretargeting_config (String) —

    Required. The name of the pretargeting configuration. Format: bidders/ bidderAccountId/pretargetingConfig/configId

  • remove_targeted_publishers_request_object (Google::Apis::RealtimebiddingV1::RemoveTargetedPublishersRequest) (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



525
526
527
528
529
530
531
532
533
534
535
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 525

def remove_pretargeting_config_targeted_publishers(pretargeting_config, remove_targeted_publishers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+pretargetingConfig}:removeTargetedPublishers', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::RemoveTargetedPublishersRequest::Representation
  command.request_object = remove_targeted_publishers_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_pretargeting_config_targeted_sites(pretargeting_config, remove_targeted_sites_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Removes targeted sites from the pretargeting configuration.

Parameters:

  • pretargeting_config (String) —

    Required. The name of the pretargeting configuration. Format: bidders/ bidderAccountId/pretargetingConfig/configId

  • remove_targeted_sites_request_object (Google::Apis::RealtimebiddingV1::RemoveTargetedSitesRequest) (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



559
560
561
562
563
564
565
566
567
568
569
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 559

def remove_pretargeting_config_targeted_sites(pretargeting_config, remove_targeted_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+pretargetingConfig}:removeTargetedSites', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::RemoveTargetedSitesRequest::Representation
  command.request_object = remove_targeted_sites_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#suspend_pretargeting_config(name, suspend_pretargeting_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PretargetingConfig

Suspends a pretargeting configuration.

Parameters:

  • name (String) —

    Required. The name of the pretargeting configuration. Format: bidders/ bidderAccountId/pretargetingConfig/configId

  • suspend_pretargeting_config_request_object (Google::Apis::RealtimebiddingV1::SuspendPretargetingConfigRequest) (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



593
594
595
596
597
598
599
600
601
602
603
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 593

def suspend_pretargeting_config(name, suspend_pretargeting_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:suspend', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::SuspendPretargetingConfigRequest::Representation
  command.request_object = suspend_pretargeting_config_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig
  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

#update_buyer_user_list(name, user_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::UserList

Update the given user list. Only user lists with URLRestrictions can be updated.

Parameters:

  • name (String) —

    Output only. Name of the user list that must follow the pattern buyers/buyer /userLists/user_list, wherebuyerrepresents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer,buyerrepresents the account ID of the child seat buyer. user_list`` is an int64 identifier assigned by Google to uniquely identify a user list.

  • user_list_object (Google::Apis::RealtimebiddingV1::UserList) (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



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 1056

def update_buyer_user_list(name, user_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
  command.request_object = user_list_object
  command.response_representation = Google::Apis::RealtimebiddingV1::UserList::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::UserList
  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

#watch_creatives(parent, watch_creatives_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::WatchCreativesResponse

Watches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.

Parameters:

  • parent (String) —

    Required. To watch all creatives pertaining to the bidder and all its child seat accounts, the bidder must follow the pattern bidders/bidderAccountId``.

  • watch_creatives_request_object (Google::Apis::RealtimebiddingV1::WatchCreativesRequest) (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



143
144
145
146
147
148
149
150
151
152
153
 
# File 'generated/google/apis/realtimebidding_v1/service.rb', line 143

def watch_creatives(parent, watch_creatives_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/creatives:watch', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::WatchCreativesRequest::Representation
  command.request_object = watch_creatives_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::WatchCreativesResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::WatchCreativesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end