class Google::Apis::AdexchangebuyerV1_2::AdExchangeBuyerService

Ad Exchange Buyer API

Accesses your bidding-account information, submits creatives for validation,

finds available direct deals, and retrieves performance reports.

@example

require 'google/apis/adexchangebuyer_v1_2'

Adexchangebuyer = Google::Apis::AdexchangebuyerV1_2 # Alias the module
service = Adexchangebuyer::AdExchangeBuyerService.new

@see developers.google.com/ad-exchange/buyer-rest

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [String]

An opaque string that represents a user for quota purposes. Must not exceed 40
characters.
user_ip[RW]

@return [String]

Deprecated. Please use quotaUser instead.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/adexchangebuyer_v1_2/service.rb, line 50
def initialize
  super('https://www.googleapis.com/', 'adexchangebuyer/v1.2/',
        client_name: 'google-apis-adexchangebuyer_v1_2',
        client_version: Google::Apis::AdexchangebuyerV1_2::GEM_VERSION)
  @batch_path = 'batch/adexchangebuyer/v1.2'
end

Public Instance Methods

get_account(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

Gets one account by ID. @param [Fixnum] id

The account id

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

An opaque string that represents a user for quota purposes. Must not exceed 40
characters.

@param [String] user_ip

Deprecated. Please use quotaUser instead.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AdexchangebuyerV1_2::Account] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdexchangebuyerV1_2::Account]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/adexchangebuyer_v1_2/service.rb, line 79
def get_account(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{id}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_2::Account::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_2::Account
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end
get_creative(account_id, buyer_creative_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

Gets the status for a single creative. A creative will be available 30-40 minutes after submission. @param [Fixnum] account_id

The id for the account that will serve this creative.

@param [String] buyer_creative_id

The buyer-specific id for this creative.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

An opaque string that represents a user for quota purposes. Must not exceed 40
characters.

@param [String] user_ip

Deprecated. Please use quotaUser instead.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AdexchangebuyerV1_2::Creative] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdexchangebuyerV1_2::Creative]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/adexchangebuyer_v1_2/service.rb, line 217
def get_creative(account_id, buyer_creative_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'creatives/{accountId}/{buyerCreativeId}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_2::Creative::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_2::Creative
  command.params['accountId'] = account_id unless account_id.nil?
  command.params['buyerCreativeId'] = buyer_creative_id unless buyer_creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end
insert_creative(creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

Submit a new creative. @param [Google::Apis::AdexchangebuyerV1_2::Creative] creative_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

An opaque string that represents a user for quota purposes. Must not exceed 40
characters.

@param [String] user_ip

Deprecated. Please use quotaUser instead.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AdexchangebuyerV1_2::Creative] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdexchangebuyerV1_2::Creative]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/adexchangebuyer_v1_2/service.rb, line 250
def insert_creative(creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'creatives', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_2::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_2::Creative::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_2::Creative
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end
list_accounts(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

Retrieves the authenticated user's list of accounts. @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

An opaque string that represents a user for quota purposes. Must not exceed 40
characters.

@param [String] user_ip

Deprecated. Please use quotaUser instead.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AdexchangebuyerV1_2::AccountsList] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdexchangebuyerV1_2::AccountsList]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/adexchangebuyer_v1_2/service.rb, line 110
def list_accounts(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_2::AccountsList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_2::AccountsList
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end
list_creatives(max_results: nil, page_token: nil, status_filter: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission. @param [Fixnum] max_results

Maximum number of entries returned on one result page. If not set, the default
is 100. Optional.

@param [String] page_token

A continuation token, used to page through ad clients. To retrieve the next
page, set this parameter to the value of "nextPageToken" from the previous
response. Optional.

@param [String] status_filter

When specified, only creatives having the given status are returned.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

An opaque string that represents a user for quota purposes. Must not exceed 40
characters.

@param [String] user_ip

Deprecated. Please use quotaUser instead.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AdexchangebuyerV1_2::CreativesList] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdexchangebuyerV1_2::CreativesList]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/adexchangebuyer_v1_2/service.rb, line 292
def list_creatives(max_results: nil, page_token: nil, status_filter: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'creatives', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_2::CreativesList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_2::CreativesList
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['statusFilter'] = status_filter unless status_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end
patch_account(id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

Updates an existing account. This method supports patch semantics. @param [Fixnum] id

The account id

@param [Google::Apis::AdexchangebuyerV1_2::Account] account_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

An opaque string that represents a user for quota purposes. Must not exceed 40
characters.

@param [String] user_ip

Deprecated. Please use quotaUser instead.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AdexchangebuyerV1_2::Account] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdexchangebuyerV1_2::Account]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/adexchangebuyer_v1_2/service.rb, line 143
def patch_account(id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'accounts/{id}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_2::Account::Representation
  command.request_object = account_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_2::Account::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_2::Account
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end
update_account(id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

Updates an existing account. @param [Fixnum] id

The account id

@param [Google::Apis::AdexchangebuyerV1_2::Account] account_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

An opaque string that represents a user for quota purposes. Must not exceed 40
characters.

@param [String] user_ip

Deprecated. Please use quotaUser instead.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AdexchangebuyerV1_2::Account] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AdexchangebuyerV1_2::Account]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/adexchangebuyer_v1_2/service.rb, line 179
def update_account(id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'accounts/{id}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_2::Account::Representation
  command.request_object = account_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_2::Account::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_2::Account
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/adexchangebuyer_v1_2/service.rb, line 307
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
end