Class: Google::Apis::AdexchangesellerV2_0::AdExchangeSellerService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::AdexchangesellerV2_0::AdExchangeSellerService
- Defined in:
- generated/google/apis/adexchangeseller_v2_0/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_account_report(account_id, 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::AdexchangesellerV2_0::Report
Generate an Ad Exchange report based on the report request sent in the query parameters.
-
#generate_account_saved_report(account_id, 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::AdexchangesellerV2_0::Report
Generate an Ad Exchange report based on the saved report ID sent in the query parameters.
-
#get_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::Account
Get information about the selected Ad Exchange account.
-
#get_account_custom_channel(account_id, ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::CustomChannel
Get the specified custom channel from the specified ad client.
-
#get_account_preferred_deal(account_id, deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::PreferredDeal
Get information about the selected Ad Exchange Preferred Deal.
-
#initialize ⇒ AdExchangeSellerService
constructor
A new instance of AdExchangeSellerService.
-
#list_account_ad_clients(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::AdClients
List all ad clients in this Ad Exchange account.
-
#list_account_alerts(account_id, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::Alerts
List the alerts for this Ad Exchange account.
-
#list_account_custom_channels(account_id, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::CustomChannels
List all custom channels in the specified ad client for this Ad Exchange account.
-
#list_account_metadata_dimensions(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::Metadata
List the metadata for the dimensions available to this AdExchange account.
-
#list_account_metadata_metrics(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::Metadata
List the metadata for the metrics available to this AdExchange account.
-
#list_account_preferred_deals(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::PreferredDeals
List the preferred deals for this Ad Exchange account.
-
#list_account_saved_reports(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::SavedReports
List all saved reports in this Ad Exchange account.
-
#list_account_url_channels(account_id, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::UrlChannels
List all URL channels in the specified ad client for this Ad Exchange account.
-
#list_accounts(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::Accounts
List all accounts available to 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_v2_0/service.rb', line 49 def initialize super('https://www.googleapis.com/', 'adexchangeseller/v2.0/') @batch_path = 'batch/adexchangeseller/v2.0' 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_v2_0/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_v2_0/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_v2_0/service.rb', line 47 def user_ip @user_ip end |
Instance Method Details
#generate_account_report(account_id, 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::AdexchangesellerV2_0::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.
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 470 def generate_account_report(account_id, 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, 'accounts/{accountId}/reports', ) else command = make_download_command(:get, 'accounts/{accountId}/reports', ) command.download_dest = download_dest end command.response_representation = Google::Apis::AdexchangesellerV2_0::Report::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Report command.params['accountId'] = account_id unless account_id.nil? 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_account_saved_report(account_id, 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::AdexchangesellerV2_0::Report
Generate an Ad Exchange report based on the saved report ID sent in the query parameters.
527 528 529 530 531 532 533 534 535 536 537 538 539 540 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 527 def generate_account_saved_report(account_id, 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, 'accounts/{accountId}/reports/{savedReportId}', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::Report::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Report command.params['accountId'] = account_id unless account_id.nil? 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_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::Account
Get information about the selected Ad Exchange account.
76 77 78 79 80 81 82 83 84 85 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 76 def get_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::Account::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Account command.params['accountId'] = account_id unless account_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_account_custom_channel(account_id, ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::CustomChannel
Get the specified custom channel from the specified ad client.
229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 229 def get_account_custom_channel(account_id, ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::CustomChannel::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::CustomChannel command.params['accountId'] = account_id unless account_id.nil? 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 |
#get_account_preferred_deal(account_id, deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::PreferredDeal
Get information about the selected Ad Exchange Preferred Deal.
378 379 380 381 382 383 384 385 386 387 388 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 378 def get_account_preferred_deal(account_id, deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/preferreddeals/{dealId}', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::PreferredDeal::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::PreferredDeal command.params['accountId'] = account_id unless account_id.nil? command.params['dealId'] = deal_id unless deal_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_account_ad_clients(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::AdClients
List all ad clients in this Ad Exchange account.
152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 152 def list_account_ad_clients(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/adclients', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::AdClients::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::AdClients command.params['accountId'] = account_id unless account_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_account_alerts(account_id, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::Alerts
List the alerts for this Ad Exchange account.
191 192 193 194 195 196 197 198 199 200 201 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 191 def list_account_alerts(account_id, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/alerts', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::Alerts::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Alerts command.params['accountId'] = account_id unless account_id.nil? command.query['locale'] = locale unless locale.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_account_custom_channels(account_id, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::CustomChannels
List all custom channels in the specified ad client for this Ad Exchange account.
274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 274 def list_account_custom_channels(account_id, 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, 'accounts/{accountId}/adclients/{adClientId}/customchannels', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::CustomChannels::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::CustomChannels command.params['accountId'] = account_id unless account_id.nil? 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_account_metadata_dimensions(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::Metadata
List the metadata for the dimensions available to this AdExchange account.
310 311 312 313 314 315 316 317 318 319 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 310 def (account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/metadata/dimensions', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::Metadata::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Metadata command.params['accountId'] = account_id unless account_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_account_metadata_metrics(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::Metadata
List the metadata for the metrics available to this AdExchange account.
343 344 345 346 347 348 349 350 351 352 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 343 def (account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/metadata/metrics', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::Metadata::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Metadata command.params['accountId'] = account_id unless account_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_account_preferred_deals(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::PreferredDeals
List the preferred deals for this Ad Exchange account.
412 413 414 415 416 417 418 419 420 421 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 412 def list_account_preferred_deals(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/preferreddeals', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::PreferredDeals::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::PreferredDeals command.params['accountId'] = account_id unless account_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_account_saved_reports(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::SavedReports
List all saved reports in this Ad Exchange account.
571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 571 def list_account_saved_reports(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/reports/saved', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::SavedReports::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::SavedReports command.params['accountId'] = account_id unless account_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_account_url_channels(account_id, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::UrlChannels
List all URL channels in the specified ad client for this Ad Exchange account.
614 615 616 617 618 619 620 621 622 623 624 625 626 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 614 def list_account_url_channels(account_id, 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, 'accounts/{accountId}/adclients/{adClientId}/urlchannels', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::UrlChannels::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::UrlChannels command.params['accountId'] = account_id unless account_id.nil? 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_accounts(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangesellerV2_0::Accounts
List all accounts available to this Ad Exchange account.
112 113 114 115 116 117 118 119 120 121 122 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 112 def list_accounts(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts', ) command.response_representation = Google::Apis::AdexchangesellerV2_0::Accounts::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Accounts 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 |