Class: Google::Apis::DoubleclickbidmanagerV1::DoubleClickBidManagerService

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

Overview

DoubleClick Bid Manager API

API for viewing and managing your reports in DoubleClick Bid Manager.

Examples:

require 'google/apis/doubleclickbidmanager_v1'

Doubleclickbidmanager = Google::Apis::DoubleclickbidmanagerV1 # Alias the module
service = Doubleclickbidmanager::DoubleClickBidManagerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initializeDoubleClickBidManagerService

Returns a new instance of DoubleClickBidManagerService.


51
52
53
# File 'generated/google/apis/doubleclickbidmanager_v1/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'doubleclickbidmanager/v1/')
end

Instance Attribute Details

#keyString

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.


38
39
40
# File 'generated/google/apis/doubleclickbidmanager_v1/service.rb', line 38

def key
  @key
end

#quota_userString

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. Overrides userIp if both are provided.

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. Overrides userIp if both are provided.


44
45
46
# File 'generated/google/apis/doubleclickbidmanager_v1/service.rb', line 44

def quota_user
  @quota_user
end

#user_ipString

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.


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

def user_ip
  @user_ip
end

Instance Method Details

#create_query(query_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1::Query

Creates a query.

Parameters:

  • query_object (Google::Apis::DoubleclickbidmanagerV1::Query) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def create_query(query_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'query', options)
  command.request_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation
  command.request_object = query_object
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1::Query
  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

#deletequery(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a stored query as well as the associated stored reports.

Parameters:

  • query_id (String)

    Query ID to delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


184
185
186
187
188
189
190
191
# File 'generated/google/apis/doubleclickbidmanager_v1/service.rb', line 184

def deletequery(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'query/{queryId}', options)
  command.params['queryId'] = query_id unless query_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

#download_line_items(download_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse

Retrieves line items in CSV format.

Parameters:

  • download_line_items_request_object (Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsRequest) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def download_line_items(download_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'lineitems/downloadlineitems', options)
  command.request_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsRequest::Representation
  command.request_object = download_line_items_request_object
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse
  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

#download_sdf(download_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1::DownloadResponse

Retrieves entities in SDF format.

Parameters:

  • download_request_object (Google::Apis::DoubleclickbidmanagerV1::DownloadRequest) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


354
355
356
357
358
359
360
361
362
363
364
# File 'generated/google/apis/doubleclickbidmanager_v1/service.rb', line 354

def download_sdf(download_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'sdf/download', options)
  command.request_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadRequest::Representation
  command.request_object = download_request_object
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadResponse::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1::DownloadResponse
  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_query(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1::Query

Retrieves a stored query.

Parameters:

  • query_id (String)

    Query ID to retrieve.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def get_query(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'query/{queryId}', options)
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1::Query
  command.params['queryId'] = query_id unless query_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

#list_queries(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse

Retrieves stored queries.

Parameters:

  • 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


250
251
252
253
254
255
256
257
258
# File 'generated/google/apis/doubleclickbidmanager_v1/service.rb', line 250

def list_queries(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'queries', options)
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse
  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_reports(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse

Retrieves stored reports.

Parameters:

  • query_id (String)

    Query ID with which the reports are associated.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


320
321
322
323
324
325
326
327
328
329
# File 'generated/google/apis/doubleclickbidmanager_v1/service.rb', line 320

def list_reports(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'queries/{queryId}/reports', options)
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse
  command.params['queryId'] = query_id unless query_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

#run_query(query_id, run_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Runs a stored query to generate a report.

Parameters:

  • query_id (String)

    Query ID to run.

  • run_query_request_object (Google::Apis::DoubleclickbidmanagerV1::RunQueryRequest) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


285
286
287
288
289
290
291
292
293
294
# File 'generated/google/apis/doubleclickbidmanager_v1/service.rb', line 285

def run_query(query_id, run_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'query/{queryId}', options)
  command.request_representation = Google::Apis::DoubleclickbidmanagerV1::RunQueryRequest::Representation
  command.request_object = run_query_request_object
  command.params['queryId'] = query_id unless query_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

#upload_line_items(upload_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse

Uploads line items in CSV format.

Parameters:

  • upload_line_items_request_object (Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsRequest) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


113
114
115
116
117
118
119
120
121
122
123
# File 'generated/google/apis/doubleclickbidmanager_v1/service.rb', line 113

def upload_line_items(upload_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'lineitems/uploadlineitems', options)
  command.request_representation = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsRequest::Representation
  command.request_object = upload_line_items_request_object
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse
  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