Class: Google::Apis::RealtimebiddingV1alpha::RealtimeBiddingService

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

Realtimebidding = Google::Apis::RealtimebiddingV1alpha # 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_v1alpha/service.rb', line 48

def initialize
  super('https://realtimebidding.googleapis.com/', '',
        client_name: 'google-apis-realtimebidding_v1alpha',
        client_version: Google::Apis::RealtimebiddingV1alpha::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_v1alpha/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_v1alpha/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#activate_bidding_function(name, activate_bidding_function_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1alpha::BiddingFunction

Activates an existing bidding function. An activated function is available for invocation for the server-side TURTLEDOVE simulations.

Parameters:

  • name (String) —

    Required. The name of the bidding function to activate. Format: bidders/ bidder_account_id/biddingFunction/bidding_function_name``

  • activate_bidding_function_request_object (Google::Apis::RealtimebiddingV1alpha::ActivateBiddingFunctionRequest) (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



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/apis/realtimebidding_v1alpha/service.rb', line 78

def activate_bidding_function(name, activate_bidding_function_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:activate', options)
  command.request_representation = Google::Apis::RealtimebiddingV1alpha::ActivateBiddingFunctionRequest::Representation
  command.request_object = activate_bidding_function_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1alpha::BiddingFunction::Representation
  command.response_class = Google::Apis::RealtimebiddingV1alpha::BiddingFunction
  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

#archive_bidding_function(name, archive_bidding_function_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1alpha::BiddingFunction

Archives an existing bidding function. An archived function will not be available for function invocation for the server-side TURTLEDOVE simulations unless it is activated.

Parameters:

  • name (String) —

    Required. The name of the bidding function to archive. Format: bidders/ bidder_account_id/biddingFunction/bidding_function_name``

  • archive_bidding_function_request_object (Google::Apis::RealtimebiddingV1alpha::ArchiveBiddingFunctionRequest) (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



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

def archive_bidding_function(name, archive_bidding_function_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:archive', options)
  command.request_representation = Google::Apis::RealtimebiddingV1alpha::ArchiveBiddingFunctionRequest::Representation
  command.request_object = archive_bidding_function_request_object
  command.response_representation = Google::Apis::RealtimebiddingV1alpha::BiddingFunction::Representation
  command.response_class = Google::Apis::RealtimebiddingV1alpha::BiddingFunction
  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_bidding_function(parent, bidding_function_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1alpha::BiddingFunction

Creates a new bidding function.

Parameters:

  • parent (String) —

    Required. The name of the bidder for which to create the bidding function. Format: bidders/bidderAccountId``

  • bidding_function_object (Google::Apis::RealtimebiddingV1alpha::BiddingFunction) (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



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

def create_bidder_bidding_function(parent, bidding_function_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/biddingFunctions', options)
  command.request_representation = Google::Apis::RealtimebiddingV1alpha::BiddingFunction::Representation
  command.request_object = bidding_function_object
  command.response_representation = Google::Apis::RealtimebiddingV1alpha::BiddingFunction::Representation
  command.response_class = Google::Apis::RealtimebiddingV1alpha::BiddingFunction
  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

#list_bidder_bidding_functions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RealtimebiddingV1alpha::ListBiddingFunctionsResponse

Lists the bidding functions that a bidder currently has registered.

Parameters:

  • parent (String) —

    Required. Name of the bidder whose bidding functions will be listed. Format: bidders/bidder_account_id``

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

    The maximum number of bidding functions to return.

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

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



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/google/apis/realtimebidding_v1alpha/service.rb', line 187

def list_bidder_bidding_functions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/biddingFunctions', options)
  command.response_representation = Google::Apis::RealtimebiddingV1alpha::ListBiddingFunctionsResponse::Representation
  command.response_class = Google::Apis::RealtimebiddingV1alpha::ListBiddingFunctionsResponse
  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