Class: Google::Apis::DoubleclickbidmanagerV1_1::DoubleClickBidManagerService

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

Overview

DoubleClick Bid Manager API

DoubleClick Bid Manager API allows users to manage and create campaigns and reports.

Examples:

require 'google/apis/doubleclickbidmanager_v1_1'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DoubleClickBidManagerService

Returns a new instance of DoubleClickBidManagerService.



46
47
48
49
50
51
 
# File 'lib/google/apis/doubleclickbidmanager_v1_1/service.rb', line 46

def initialize
  super('https://doubleclickbidmanager.googleapis.com/', 'doubleclickbidmanager/v1.1/',
        client_name: 'google-apis-doubleclickbidmanager_v1_1',
        client_version: Google::Apis::DoubleclickbidmanagerV1_1::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.



39
40
41
 
# File 'lib/google/apis/doubleclickbidmanager_v1_1/service.rb', line 39

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.



44
45
46
 
# File 'lib/google/apis/doubleclickbidmanager_v1_1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#createquery_query(query_object = nil, asynchronous: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1_1::Query

Creates a query.

Parameters:

  • query_object (Google::Apis::DoubleclickbidmanagerV1_1::Query) (defaults to: nil)
  • asynchronous (Boolean) (defaults to: nil) —

    If true, tries to run the query asynchronously. Only applicable when the frequency is ONE_TIME.

  • 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



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/apis/doubleclickbidmanager_v1_1/service.rb', line 137

def createquery_query(query_object = nil, asynchronous: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'query', options)
  command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation
  command.request_object = query_object
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::Query
  command.query['asynchronous'] = asynchronous unless asynchronous.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deletequery_query(query_id, fields: nil, quota_user: 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 (Fixnum) —

    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.

  • 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:

  • (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



169
170
171
172
173
174
175
 
# File 'lib/google/apis/doubleclickbidmanager_v1_1/service.rb', line 169

def deletequery_query(query_id, fields: nil, quota_user: 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?
  execute_or_queue_command(command, &block)
end

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

Retrieves entities in SDF format.

Parameters:

  • download_request_object (Google::Apis::DoubleclickbidmanagerV1_1::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.

  • 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



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

def download_sdf(download_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'sdf/download', options)
  command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadRequest::Representation
  command.request_object = download_request_object
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadResponse::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::DownloadResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves line items in CSV format. YouTube & partners line items are not supported.

Parameters:

  • download_line_items_request_object (Google::Apis::DoubleclickbidmanagerV1_1::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.

  • 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



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

def downloadlineitems_lineitem(download_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'lineitems/downloadlineitems', options)
  command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadLineItemsRequest::Representation
  command.request_object = download_line_items_request_object
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadLineItemsResponse::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::DownloadLineItemsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#getquery_query(query_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1_1::Query

Retrieves a stored query.

Parameters:

  • query_id (Fixnum) —

    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.

  • 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



197
198
199
200
201
202
203
204
205
 
# File 'lib/google/apis/doubleclickbidmanager_v1_1/service.rb', line 197

def getquery_query(query_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'query/{queryId}', options)
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::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?
  execute_or_queue_command(command, &block)
end

#listqueries_query(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1_1::ListQueriesResponse

Retrieves stored queries.

Parameters:

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

    Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.

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

    Optional pagination token.

  • 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



230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/apis/doubleclickbidmanager_v1_1/service.rb', line 230

def listqueries_query(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'queries', options)
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::ListQueriesResponse::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::ListQueriesResponse
  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

#listreports_report(query_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclickbidmanagerV1_1::ListReportsResponse

Retrieves stored reports.

Parameters:

  • query_id (Fixnum) —

    Query ID with which the reports are associated.

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

    Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.

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

    Optional pagination token.

  • 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



300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/google/apis/doubleclickbidmanager_v1_1/service.rb', line 300

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

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

This method returns an undefined value.

Runs a stored query to generate a report.

Parameters:

  • query_id (Fixnum) —

    Query ID to run.

  • run_query_request_object (Google::Apis::DoubleclickbidmanagerV1_1::RunQueryRequest) (defaults to: nil)
  • asynchronous (Boolean) (defaults to: nil) —

    If true, tries to run the query asynchronously.

  • 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:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

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



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/google/apis/doubleclickbidmanager_v1_1/service.rb', line 264

def runquery_query(query_id, run_query_request_object = nil, asynchronous: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'query/{queryId}', options)
  command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::RunQueryRequest::Representation
  command.request_object = run_query_request_object
  command.params['queryId'] = query_id unless query_id.nil?
  command.query['asynchronous'] = asynchronous unless asynchronous.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Uploads line items in CSV format. YouTube & partners line items are not supported.

Parameters:

  • upload_line_items_request_object (Google::Apis::DoubleclickbidmanagerV1_1::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.

  • 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



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/google/apis/doubleclickbidmanager_v1_1/service.rb', line 104

def uploadlineitems_lineitem(upload_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'lineitems/uploadlineitems', options)
  command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::UploadLineItemsRequest::Representation
  command.request_object = upload_line_items_request_object
  command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::UploadLineItemsResponse::Representation
  command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::UploadLineItemsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end