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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/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
52
53
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 48

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



41
42
43
 
# File 'lib/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 'lib/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



364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 364

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



398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 398

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



432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 432

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



466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 466

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

#batch_approve_publisher_connections(parent, batch_approve_publisher_connections_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsResponse

Batch approves multiple publisher connections.

Parameters:

  • parent (String) —

    Required. The bidder for whom publisher connections will be approved. Format: bidders/bidderwherebidder`` is the account ID of the bidder.

  • batch_approve_publisher_connections_request_object (Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsRequest) (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



814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 814

def batch_approve_publisher_connections(parent, batch_approve_publisher_connections_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/publisherConnections:batchApprove', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsRequest::Representation
  command.request_object = batch_approve_publisher_connections_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::BatchApprovePublisherConnectionsResponse
  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

#batch_reject_publisher_connections(parent, batch_reject_publisher_connections_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsResponse

Batch rejects multiple publisher connections.

Parameters:

  • parent (String) —

    Required. The bidder for whom publisher connections will be rejected. Format: bidders/bidderwherebidder`` is the account ID of the bidder.

  • batch_reject_publisher_connections_request_object (Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsRequest) (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



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

def batch_reject_publisher_connections(parent, batch_reject_publisher_connections_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/publisherConnections:batchReject', options)
  command.request_representation = Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsRequest::Representation
  command.request_object = batch_reject_publisher_connections_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::BatchRejectPublisherConnectionsResponse
  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

#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



1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1257

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



504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 504

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



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1078

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



1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1294

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



537
538
539
540
541
542
543
544
545
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 537

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(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::Bidder

Gets a bidder account by its name.

Parameters:

  • name (String) —

    Required. Name of the bidder to get. Format: bidders/bidderAccountId``

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



75
76
77
78
79
80
81
82
83
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 75

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

Gets a bidder endpoint by its name.

Parameters:

  • name (String) —

    Required. Name of the bidder endpoint to get. Format: bidders/ bidderAccountId/endpoints/endpointId``

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



252
253
254
255
256
257
258
259
260
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 252

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



568
569
570
571
572
573
574
575
576
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 568

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_bidder_publisher_connection(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::PublisherConnection

Gets a publisher connection.

Parameters:

  • name (String) —

    Required. Name of the publisher whose connection information is to be retrieved. In the pattern bidders/bidder/publisherConnections/publisher wherebidderis the account ID of the bidder, andpublisher`` is the ads. txt/app-ads.txt publisher ID. See publisherConnection.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



883
884
885
886
887
888
889
890
891
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 883

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

Gets a buyer account by its name.

Parameters:

  • name (String) —

    Required. Name of the buyer to get. Format: buyers/buyerId``

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1115

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



1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1006

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



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

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



1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1363

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 as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. lastStatusUpdate and creativeServingDecision may be outdated for creatives on sequential pages. We recommend Google Cloud Pub/Sub to view the latest status.

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. Page tokens for continued pages are valid for up to five hours, counting from the call to 'ListCreatives' for the first page.

  • 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



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 178

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_endpoints(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::ListEndpointsResponse

Lists all the bidder's endpoints.

Parameters:

  • parent (String) —

    Required. Name of the bidder whose endpoints will be listed. Format: bidders/ bidderAccountId``

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

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

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

    A token identifying a page of results the server should return. This value is received from a previous ListEndpoints call in ListEndpointsResponse. 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



291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 291

def list_bidder_endpoints(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/endpoints', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::ListEndpointsResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::ListEndpointsResponse
  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_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



607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 607

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_bidder_publisher_connections(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::ListPublisherConnectionsResponse

Lists publisher connections for a given bidder.

Parameters:

  • parent (String) —

    Required. Name of the bidder for which publishers have initiated connections. The pattern for this resource is bidders/bidderwherebidder`` represents the account ID of the bidder.

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

    Query string to filter publisher connections. Connections can be filtered by displayName, publisherPlatform, and biddingState. If no filter is specified, all publisher connections will be returned. Example: 'displayName=" Great Publisher*" AND publisherPlatform=ADMOB AND biddingState != PENDING' See https://google.aip.dev/160 for more information about filtering syntax.

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

    Order specification by which results should be sorted. If no sort order is specified, the results will be returned in alphabetic order based on the publisher's publisher code. Results can be sorted by createTime. Example: ' createTime DESC'.

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 935

def list_bidder_publisher_connections(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/publisherConnections', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::ListPublisherConnectionsResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::ListPublisherConnectionsResponse
  command.params['parent'] = parent unless parent.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_bidders(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::ListBiddersResponse

Lists all the bidder accounts that belong to the caller.

Parameters:

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

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

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

    A token identifying a page of results the server should return. This value is received from a previous ListBidders call in ListBiddersResponse. 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



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 111

def list_bidders(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/bidders', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::ListBiddersResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::ListBiddersResponse
  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 as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. lastStatusUpdate and creativeServingDecision may be outdated for creatives on sequential pages. We recommend Google Cloud Pub/Sub to view the latest status.

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. Page tokens for continued pages are valid for up to five hours, counting from the call to 'ListCreatives' for the first page.

  • 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



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

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



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1401

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

#list_buyers(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::ListBuyersResponse

Lists all buyer account information the calling buyer user or service account is permissioned to manage.

Parameters:

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

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

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

    A token identifying a page of results the server should return. This value is received from a previous ListBuyers call in ListBuyersResponse.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



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1042

def list_buyers(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/buyers', options)
  command.response_representation = Google::Apis::RealtimebiddingV1::ListBuyersResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::ListBuyersResponse
  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



1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1435

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_endpoint(name, endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1::Endpoint

Updates a bidder's endpoint.

Parameters:

  • name (String) —

    Output only. Name of the endpoint resource that must follow the pattern bidders/bidderAccountId/endpoints/endpointId`, wherebidderAccountIdis the account ID of the bidder who operates this endpoint, andendpointId` is a unique ID assigned by the server.

  • endpoint_object (Google::Apis::RealtimebiddingV1::Endpoint) (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



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

def patch_bidder_endpoint(name, endpoint_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::Endpoint::Representation
  command.request_object = endpoint_object
  command.response_representation = Google::Apis::RealtimebiddingV1::Endpoint::Representation
  command.response_class = Google::Apis::RealtimebiddingV1::Endpoint
  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_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



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

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



1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1222

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



678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 678

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



712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 712

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



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

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



780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 780

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



1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 1474

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



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/google/apis/realtimebidding_v1/service.rb', line 219

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