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
Available to use for quota purposes for server-side applications.
-
#user_ip ⇒ String
IP address of the site where the request originates.
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
Constructor Details
#initialize ⇒ AdExchangeSellerService
Returns a new instance of AdExchangeSellerService.
51 52 53 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 51 def initialize super('https://www.googleapis.com/', '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 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.
44 45 46 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 44 def quota_user @quota_user end |
#user_ip ⇒ String
Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.
49 50 51 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 49 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.
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 493 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.
552 553 554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 552 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.
79 80 81 82 83 84 85 86 87 88 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 79 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.
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 240 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.
397 398 399 400 401 402 403 404 405 406 407 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 397 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.
159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 159 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.
200 201 202 203 204 205 206 207 208 209 210 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 200 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.
287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 287 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.
325 326 327 328 329 330 331 332 333 334 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 325 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.
360 361 362 363 364 365 366 367 368 369 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 360 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.
433 434 435 436 437 438 439 440 441 442 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 433 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.
598 599 600 601 602 603 604 605 606 607 608 609 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 598 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.
643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 643 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.
117 118 119 120 121 122 123 124 125 126 127 |
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 117 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 |