google-api-ruby-client/generated/google/apis/doubleclickbidmanager_v1/service.rb

378 lines
21 KiB
Ruby
Raw Normal View History

2015-06-23 23:05:46 +00:00
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module DoubleclickbidmanagerV1
# DoubleClick Bid Manager API
#
# API for viewing and managing your reports in DoubleClick Bid Manager.
#
# @example
# require 'google/apis/doubleclickbidmanager_v1'
#
# Doubleclickbidmanager = Google::Apis::DoubleclickbidmanagerV1 # Alias the module
# service = Doubleclickbidmanager::DoubleClickBidManagerService.new
#
# @see https://developers.google.com/bid-manager/
class DoubleClickBidManagerService < Google::Apis::Core::BaseService
# @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.
attr_accessor :key
# @return [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.
attr_accessor :quota_user
# @return [String]
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'doubleclickbidmanager/v1/')
2017-04-03 20:18:48 +00:00
@batch_path = 'batch'
2015-06-23 23:05:46 +00:00
end
# Retrieves line items in CSV format.
# @param [Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsRequest] download_line_items_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse]
#
# @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
def download_line_items(download_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2015-12-03 01:10:07 +00:00
command = make_simple_command(:post, 'lineitems/downloadlineitems', options)
2015-06-23 23:05:46 +00:00
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
# Uploads line items in CSV format.
# @param [Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsRequest] upload_line_items_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse]
#
# @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
def upload_line_items(upload_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2015-12-03 01:10:07 +00:00
command = make_simple_command(:post, 'lineitems/uploadlineitems', options)
2015-06-23 23:05:46 +00:00
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
# Creates a query.
# @param [Google::Apis::DoubleclickbidmanagerV1::Query] query_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::Query] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DoubleclickbidmanagerV1::Query]
#
# @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
def create_query(query_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2015-12-03 01:10:07 +00:00
command = make_simple_command(:post, 'query', options)
2015-06-23 23:05:46 +00:00
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
# Deletes a stored query as well as the associated stored reports.
2017-04-03 20:18:48 +00:00
# @param [Fixnum] query_id
2015-06-23 23:05:46 +00:00
# Query ID to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @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
def deletequery(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2015-12-03 01:10:07 +00:00
command = make_simple_command(:delete, 'query/{queryId}', options)
2015-06-23 23:05:46 +00:00
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
# Retrieves a stored query.
2017-04-03 20:18:48 +00:00
# @param [Fixnum] query_id
2015-06-23 23:05:46 +00:00
# Query ID to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::Query] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DoubleclickbidmanagerV1::Query]
#
# @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
def get_query(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2015-12-03 01:10:07 +00:00
command = make_simple_command(:get, 'query/{queryId}', options)
2015-06-23 23:05:46 +00:00
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
# Retrieves stored queries.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse]
#
# @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
def list_queries(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2015-12-03 01:10:07 +00:00
command = make_simple_command(:get, 'queries', options)
2015-06-23 23:05:46 +00:00
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
# Runs a stored query to generate a report.
2017-04-03 20:18:48 +00:00
# @param [Fixnum] query_id
2015-06-23 23:05:46 +00:00
# Query ID to run.
# @param [Google::Apis::DoubleclickbidmanagerV1::RunQueryRequest] run_query_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @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
def run_query(query_id, run_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2015-12-03 01:10:07 +00:00
command = make_simple_command(:post, 'query/{queryId}', options)
2015-06-23 23:05:46 +00:00
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
# Retrieves stored reports.
2017-04-03 20:18:48 +00:00
# @param [Fixnum] query_id
2015-06-23 23:05:46 +00:00
# Query ID with which the reports are associated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse]
#
# @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
def list_reports(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2015-12-03 01:10:07 +00:00
command = make_simple_command(:get, 'queries/{queryId}/reports', options)
2015-06-23 23:05:46 +00:00
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
2016-01-22 19:23:05 +00:00
2016-10-04 00:27:26 +00:00
# Retrieves entities in SDF format.
# @param [Google::Apis::DoubleclickbidmanagerV1::DownloadRequest] download_request_object
2016-01-22 19:23:05 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2016-10-04 00:27:26 +00:00
# @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::DownloadResponse] parsed result object
2016-01-22 19:23:05 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2016-10-04 00:27:26 +00:00
# @return [Google::Apis::DoubleclickbidmanagerV1::DownloadResponse]
2016-01-22 19:23:05 +00:00
#
# @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
2016-10-04 00:27:26 +00:00
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
2016-01-22 19:23:05 +00:00
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
2015-06-23 23:05:46 +00:00
protected
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
end
end
end
end