generated/google/apis/doubleclickbidmanager_v1/service.rb in google-api-client-0.43.0 vs generated/google/apis/doubleclickbidmanager_v1/service.rb in google-api-client-0.44.0

- old
+ new

@@ -20,11 +20,12 @@ module Google module Apis module DoubleclickbidmanagerV1 # DoubleClick Bid Manager API # - # API for viewing and managing your reports in DoubleClick Bid Manager. + # DoubleClick Bid Manager API allows users to manage and create campaigns and + # reports. # # @example # require 'google/apis/doubleclickbidmanager_v1' # # Doubleclickbidmanager = Google::Apis::DoubleclickbidmanagerV1 # Alias the module @@ -36,33 +37,27 @@ # 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] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # 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. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'doubleclickbidmanager/v1/') - @batch_path = 'batch/doubleclickbidmanager/v1' + super('https://doubleclickbidmanager.googleapis.com/', 'doubleclickbidmanager/v1/') + @batch_path = 'batch' end # Retrieves line items in CSV format. YouTube & partners line items are not # supported. # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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. # @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 @@ -71,32 +66,29 @@ # @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) + def download_line_items(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::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. YouTube & partners line items are not # supported. # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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. # @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 @@ -105,31 +97,28 @@ # @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) + def upload_line_items(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::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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. # @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 @@ -138,32 +127,29 @@ # @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) + def create_query(query_object = nil, fields: nil, quota_user: 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 # Deletes a stored query as well as the associated stored reports. # @param [Fixnum] query_id # Query ID to delete. # @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. + # 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. # @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 @@ -172,29 +158,26 @@ # @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) + def deletequery(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? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a stored query. # @param [Fixnum] query_id # Query ID to retrieve. # @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. + # 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. # @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 @@ -203,29 +186,26 @@ # @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) + def get_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::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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. # @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 @@ -234,31 +214,28 @@ # @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) + def list_queries(fields: nil, quota_user: 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 # Runs a stored query to generate a report. # @param [Fixnum] query_id # 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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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. # @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 @@ -267,31 +244,28 @@ # @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) + def run_query(query_id, run_query_request_object = nil, fields: nil, quota_user: 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 # Retrieves stored reports. # @param [Fixnum] query_id # 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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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. # @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 @@ -300,30 +274,27 @@ # @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) + def list_reports(query_id, fields: nil, quota_user: 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 # Retrieves entities in SDF format. # @param [Google::Apis::DoubleclickbidmanagerV1::DownloadRequest] download_request_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. + # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::DownloadResponse] parsed result object @@ -332,27 +303,25 @@ # @return [Google::Apis::DoubleclickbidmanagerV1::DownloadResponse] # # @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_sdf(download_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + 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::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 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