Class: Google::Apis::AdexchangesellerV1::AdExchangeSellerService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::AdexchangesellerV1::AdExchangeSellerService
- Defined in:
- generated/google/apis/adexchangeseller_v1/service.rb
Overview
Ad Exchange Seller API
Accesses the inventory of Ad Exchange seller users and generates reports.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
An opaque string that represents a user for quota purposes.
-
#user_ip ⇒ String
Deprecated.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#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) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::Report
Generate an Ad Exchange report based on the report request sent in the query parameters.
-
#generate_report_saved(saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::Report
Generate an Ad Exchange report based on the saved report ID sent in the query parameters.
-
#get_adunit(ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::AdUnit
Gets the specified ad unit in the specified ad client.
-
#get_customchannel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::CustomChannel
Get the specified custom channel from the specified ad client.
-
#initialize ⇒ AdExchangeSellerService
constructor
A new instance of AdExchangeSellerService.
-
#list_adclients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::AdClients
List all ad clients in this Ad Exchange account.
-
#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) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::CustomChannels
List all custom channels which the specified ad unit belongs to.
-
#list_adunits(ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::AdUnits
List all ad units in the specified ad client for this Ad Exchange account.
-
#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) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::AdUnits
List all ad units in the specified custom channel.
-
#list_customchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::CustomChannels
List all custom channels in the specified ad client for this Ad Exchange account.
-
#list_report_saveds(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::SavedReports
List all saved reports in this Ad Exchange account.
-
#list_urlchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::UrlChannels
List all URL channels in the specified ad client for this Ad Exchange account.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ AdExchangeSellerService
Returns a new instance of AdExchangeSellerService
49 50 51 52 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 49 def initialize super('https://www.googleapis.com/', 'adexchangeseller/v1/') @batch_path = 'batch/adexchangeseller/v1' 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.
38 39 40 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
43 44 45 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 43 def quota_user @quota_user end |
#user_ip ⇒ String
Returns Deprecated. Please use quotaUser instead.
47 48 49 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 47 def user_ip @user_ip end |
Instance Method Details
#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) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::Report
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.
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 386 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', ) else command = make_download_command(:get, 'reports', ) 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_report_saved(saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::Report
Generate an Ad Exchange report based on the saved report ID sent in the query parameters.
440 441 442 443 444 445 446 447 448 449 450 451 452 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 440 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}', ) 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 |
#get_adunit(ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::AdUnit
Gets the specified ad unit in the specified ad client.
116 117 118 119 120 121 122 123 124 125 126 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 116 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}', ) 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 |
#get_customchannel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::CustomChannel
Get the specified custom channel from the specified ad client.
240 241 242 243 244 245 246 247 248 249 250 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 240 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}', ) 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_adclients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::AdClients
List all ad clients in this Ad Exchange account.
80 81 82 83 84 85 86 87 88 89 90 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 80 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', ) 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 |
#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) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::CustomChannels
List all custom channels which the specified ad unit belongs to.
202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 202 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', ) 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 |
#list_adunits(ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::AdUnits
List all ad units in the specified ad client for this Ad Exchange account.
157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 157 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', ) 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_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) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::AdUnits
List all ad units in the specified custom channel.
326 327 328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 326 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', ) 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 |
#list_customchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::CustomChannels
List all custom channels in the specified ad client for this Ad Exchange account.
282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 282 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', ) 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_report_saveds(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::SavedReports
List all saved reports in this Ad Exchange account.
481 482 483 484 485 486 487 488 489 490 491 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 481 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', ) 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_urlchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV1::UrlChannels
List all URL channels in the specified ad client for this Ad Exchange account.
521 522 523 524 525 526 527 528 529 530 531 532 |
# File 'generated/google/apis/adexchangeseller_v1/service.rb', line 521 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', ) 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 |