545 lines
31 KiB
Ruby
545 lines
31 KiB
Ruby
# 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 AdexchangesellerV1
|
|
# Ad Exchange Seller API
|
|
#
|
|
# Accesses the inventory of Ad Exchange seller users and generates reports.
|
|
#
|
|
# @example
|
|
# require 'google/apis/adexchangeseller_v1'
|
|
#
|
|
# Adexchangeseller = Google::Apis::AdexchangesellerV1 # Alias the module
|
|
# service = Adexchangeseller::AdExchangeSellerService.new
|
|
#
|
|
# @see https://developers.google.com/ad-exchange/seller-rest/
|
|
class AdExchangeSellerService < 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]
|
|
# An opaque string that represents a user for quota purposes. Must 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/', 'adexchangeseller/v1/')
|
|
@batch_path = 'batch/adexchangeseller/v1'
|
|
end
|
|
|
|
# List all ad clients in this Ad Exchange account.
|
|
# @param [Fixnum] max_results
|
|
# The maximum number of ad clients to include in the response, used for paging.
|
|
# @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.
|
|
# @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::AdexchangesellerV1::AdClients] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::AdClients]
|
|
#
|
|
# @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_adclients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'adclients', options)
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::AdClients::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::AdClients
|
|
command.query['maxResults'] = max_results unless max_results.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?
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Gets the specified ad unit in the specified ad client.
|
|
# @param [String] ad_client_id
|
|
# Ad client for which to get the ad unit.
|
|
# @param [String] ad_unit_id
|
|
# Ad unit 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.
|
|
# @param [Google::Apis::RequestOptions] options
|
|
# Request-specific options
|
|
#
|
|
# @yield [result, err] Result & error if block supplied
|
|
# @yieldparam result [Google::Apis::AdexchangesellerV1::AdUnit] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::AdUnit]
|
|
#
|
|
# @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_adunit(ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}', options)
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::AdUnit::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::AdUnit
|
|
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
|
|
command.params['adUnitId'] = ad_unit_id unless ad_unit_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 all ad units in the specified ad client for this Ad Exchange account.
|
|
# @param [String] ad_client_id
|
|
# Ad client for which to list ad units.
|
|
# @param [Boolean] include_inactive
|
|
# Whether to include inactive ad units. Default: true.
|
|
# @param [Fixnum] max_results
|
|
# The maximum number of ad units to include in the response, used for paging.
|
|
# @param [String] page_token
|
|
# A continuation token, used to page through ad units. To retrieve the next page,
|
|
# set this parameter to the value of "nextPageToken" from the previous response.
|
|
# @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::AdexchangesellerV1::AdUnits] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::AdUnits]
|
|
#
|
|
# @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_adunits(ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'adclients/{adClientId}/adunits', options)
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::AdUnits::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::AdUnits
|
|
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
|
|
command.query['includeInactive'] = include_inactive unless include_inactive.nil?
|
|
command.query['maxResults'] = max_results unless max_results.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?
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# List all custom channels which the specified ad unit belongs to.
|
|
# @param [String] ad_client_id
|
|
# Ad client which contains the ad unit.
|
|
# @param [String] ad_unit_id
|
|
# Ad unit for which to list custom channels.
|
|
# @param [Fixnum] max_results
|
|
# The maximum number of custom channels to include in the response, used for
|
|
# paging.
|
|
# @param [String] page_token
|
|
# A continuation token, used to page through custom channels. To retrieve the
|
|
# next page, set this parameter to the value of "nextPageToken" from the
|
|
# previous response.
|
|
# @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::AdexchangesellerV1::CustomChannels] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::CustomChannels]
|
|
#
|
|
# @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_adunit_customchannels(ad_client_id, ad_unit_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}/customchannels', options)
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::CustomChannels::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::CustomChannels
|
|
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
|
|
command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
|
|
command.query['maxResults'] = max_results unless max_results.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?
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Get the specified custom channel from the specified ad client.
|
|
# @param [String] ad_client_id
|
|
# Ad client which contains the custom channel.
|
|
# @param [String] custom_channel_id
|
|
# Custom channel 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.
|
|
# @param [Google::Apis::RequestOptions] options
|
|
# Request-specific options
|
|
#
|
|
# @yield [result, err] Result & error if block supplied
|
|
# @yieldparam result [Google::Apis::AdexchangesellerV1::CustomChannel] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::CustomChannel]
|
|
#
|
|
# @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_customchannel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}', options)
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::CustomChannel::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::CustomChannel
|
|
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
|
|
command.params['customChannelId'] = custom_channel_id unless custom_channel_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 all custom channels in the specified ad client for this Ad Exchange
|
|
# account.
|
|
# @param [String] ad_client_id
|
|
# Ad client for which to list custom channels.
|
|
# @param [Fixnum] max_results
|
|
# The maximum number of custom channels to include in the response, used for
|
|
# paging.
|
|
# @param [String] page_token
|
|
# A continuation token, used to page through custom channels. To retrieve the
|
|
# next page, set this parameter to the value of "nextPageToken" from the
|
|
# previous response.
|
|
# @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::AdexchangesellerV1::CustomChannels] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::CustomChannels]
|
|
#
|
|
# @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_customchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'adclients/{adClientId}/customchannels', options)
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::CustomChannels::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::CustomChannels
|
|
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
|
|
command.query['maxResults'] = max_results unless max_results.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?
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# List all ad units in the specified custom channel.
|
|
# @param [String] ad_client_id
|
|
# Ad client which contains the custom channel.
|
|
# @param [String] custom_channel_id
|
|
# Custom channel for which to list ad units.
|
|
# @param [Boolean] include_inactive
|
|
# Whether to include inactive ad units. Default: true.
|
|
# @param [Fixnum] max_results
|
|
# The maximum number of ad units to include in the response, used for paging.
|
|
# @param [String] page_token
|
|
# A continuation token, used to page through ad units. To retrieve the next page,
|
|
# set this parameter to the value of "nextPageToken" from the previous response.
|
|
# @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::AdexchangesellerV1::AdUnits] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::AdUnits]
|
|
#
|
|
# @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_customchannel_adunits(ad_client_id, custom_channel_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}/adunits', options)
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::AdUnits::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::AdUnits
|
|
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
|
|
command.params['customChannelId'] = custom_channel_id unless custom_channel_id.nil?
|
|
command.query['includeInactive'] = include_inactive unless include_inactive.nil?
|
|
command.query['maxResults'] = max_results unless max_results.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?
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Generate an Ad Exchange report based on the report request sent in the query
|
|
# parameters. Returns the result as JSON; to retrieve output in CSV format
|
|
# specify "alt=csv" as a query parameter.
|
|
# @param [String] start_date
|
|
# Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
|
|
# @param [String] end_date
|
|
# End of the date range to report on in "YYYY-MM-DD" format, inclusive.
|
|
# @param [Array<String>, String] dimension
|
|
# Dimensions to base the report on.
|
|
# @param [Array<String>, String] filter
|
|
# Filters to be run on the report.
|
|
# @param [String] locale
|
|
# Optional locale to use for translating report output to a local language.
|
|
# Defaults to "en_US" if not specified.
|
|
# @param [Fixnum] max_results
|
|
# The maximum number of rows of report data to return.
|
|
# @param [Array<String>, String] metric
|
|
# Numeric columns to include in the report.
|
|
# @param [Array<String>, String] sort
|
|
# The name of a dimension or metric to sort the resulting report on, optionally
|
|
# prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is
|
|
# specified, the column is sorted ascending.
|
|
# @param [Fixnum] start_index
|
|
# Index of the first row of report data to return.
|
|
# @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 [IO, String] download_dest
|
|
# IO stream or filename to receive content download
|
|
# @param [Google::Apis::RequestOptions] options
|
|
# Request-specific options
|
|
#
|
|
# @yield [result, err] Result & error if block supplied
|
|
# @yieldparam result [Google::Apis::AdexchangesellerV1::Report] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::Report]
|
|
#
|
|
# @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 generate_report(start_date, end_date, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
|
|
if download_dest.nil?
|
|
command = make_simple_command(:get, 'reports', options)
|
|
else
|
|
command = make_download_command(:get, 'reports', options)
|
|
command.download_dest = download_dest
|
|
end
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::Report::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::Report
|
|
command.query['dimension'] = dimension unless dimension.nil?
|
|
command.query['endDate'] = end_date unless end_date.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['locale'] = locale unless locale.nil?
|
|
command.query['maxResults'] = max_results unless max_results.nil?
|
|
command.query['metric'] = metric unless metric.nil?
|
|
command.query['sort'] = sort unless sort.nil?
|
|
command.query['startDate'] = start_date unless start_date.nil?
|
|
command.query['startIndex'] = start_index unless start_index.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
|
|
|
|
# Generate an Ad Exchange report based on the saved report ID sent in the query
|
|
# parameters.
|
|
# @param [String] saved_report_id
|
|
# The saved report to retrieve.
|
|
# @param [String] locale
|
|
# Optional locale to use for translating report output to a local language.
|
|
# Defaults to "en_US" if not specified.
|
|
# @param [Fixnum] max_results
|
|
# The maximum number of rows of report data to return.
|
|
# @param [Fixnum] start_index
|
|
# Index of the first row of report data to return.
|
|
# @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::AdexchangesellerV1::Report] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::Report]
|
|
#
|
|
# @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 generate_report_saved(saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'reports/{savedReportId}', options)
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::Report::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::Report
|
|
command.params['savedReportId'] = saved_report_id unless saved_report_id.nil?
|
|
command.query['locale'] = locale unless locale.nil?
|
|
command.query['maxResults'] = max_results unless max_results.nil?
|
|
command.query['startIndex'] = start_index unless start_index.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 all saved reports in this Ad Exchange account.
|
|
# @param [Fixnum] max_results
|
|
# The maximum number of saved reports to include in the response, used for
|
|
# paging.
|
|
# @param [String] page_token
|
|
# A continuation token, used to page through saved reports. To retrieve the next
|
|
# page, set this parameter to the value of "nextPageToken" from the previous
|
|
# response.
|
|
# @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::AdexchangesellerV1::SavedReports] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::SavedReports]
|
|
#
|
|
# @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_report_saveds(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'reports/saved', options)
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::SavedReports::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::SavedReports
|
|
command.query['maxResults'] = max_results unless max_results.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?
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# List all URL channels in the specified ad client for this Ad Exchange account.
|
|
# @param [String] ad_client_id
|
|
# Ad client for which to list URL channels.
|
|
# @param [Fixnum] max_results
|
|
# The maximum number of URL channels to include in the response, used for paging.
|
|
# @param [String] page_token
|
|
# A continuation token, used to page through URL channels. To retrieve the next
|
|
# page, set this parameter to the value of "nextPageToken" from the previous
|
|
# response.
|
|
# @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::AdexchangesellerV1::UrlChannels] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::AdexchangesellerV1::UrlChannels]
|
|
#
|
|
# @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_urlchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'adclients/{adClientId}/urlchannels', options)
|
|
command.response_representation = Google::Apis::AdexchangesellerV1::UrlChannels::Representation
|
|
command.response_class = Google::Apis::AdexchangesellerV1::UrlChannels
|
|
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
|
|
command.query['maxResults'] = max_results unless max_results.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?
|
|
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
|