Class: Google::Apis::AdexchangesellerV2_0::AdExchangeSellerService

Inherits:
Core::BaseService
  • Object
show all
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.

Examples:

require 'google/apis/adexchangeseller_v2_0'

Adexchangeseller = Google::Apis::AdexchangesellerV2_0 # Alias the module
service = Adexchangeseller::AdExchangeSellerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ AdExchangeSellerService

Returns a new instance of AdExchangeSellerService



51
52
53
54
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'adexchangeseller/v2.0/')
  @batch_path = 'batch'
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.

Returns:

  • (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.



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.

Returns:

  • (String) —

    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.

Returns:

  • (String) —

    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.

Parameters:

  • account_id (String) —

    Account which owns the generated report.

  • start_date (String) —

    Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

  • end_date (String) —

    End of the date range to report on in "YYYY-MM-DD" format, inclusive.

  • dimension (Array<String>, String) —

    Dimensions to base the report on.

  • filter (Array<String>, String) —

    Filters to be run on the report.

  • locale (String) —

    Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

  • max_results (Fixnum) —

    The maximum number of rows of report data to return.

  • metric (Array<String>, String) —

    Numeric columns to include in the report.

  • sort (Array<String>, String) —

    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.

  • start_index (Fixnum) —

    Index of the first row of report data to return.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • download_dest (IO, String) —

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 494

def (, 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', options)
  else
    command = make_download_command(:get, 'accounts/{accountId}/reports', options)
    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'] =  unless .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.

Parameters:

  • account_id (String) —

    Account owning the saved report.

  • saved_report_id (String) —

    The saved report to retrieve.

  • locale (String) —

    Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

  • max_results (Fixnum) —

    The maximum number of rows of report data to return.

  • start_index (Fixnum) —

    Index of the first row of report data to return.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 553

def (, 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}', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::Report::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::Report
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account to get information about. Tip: 'myaccount' is a valid ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



80
81
82
83
84
85
86
87
88
89
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 80

def (, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::Account::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::Account
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • ad_client_id (String) —

    Ad client which contains the custom channel.

  • custom_channel_id (String) —

    Custom channel to retrieve.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 241

def (, 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}', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::CustomChannel::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::CustomChannel
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account owning the deal.

  • deal_id (String) —

    Preferred deal to get information about.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



398
399
400
401
402
403
404
405
406
407
408
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 398

def (, deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/preferreddeals/{dealId}', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::PreferredDeal::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::PreferredDeal
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • max_results (Fixnum) —

    The maximum number of ad clients to include in the response, used for paging.

  • page_token (String) —

    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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 160

def (, 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', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::AdClients::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::AdClients
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account owning the alerts.

  • locale (String) —

    The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



201
202
203
204
205
206
207
208
209
210
211
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 201

def (, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/alerts', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::Alerts::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::Alerts
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • ad_client_id (String) —

    Ad client for which to list custom channels.

  • max_results (Fixnum) —

    The maximum number of custom channels to include in the response, used for paging.

  • page_token (String) —

    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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 288

def (, 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', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::CustomChannels::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::CustomChannels
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account with visibility to the dimensions.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



326
327
328
329
330
331
332
333
334
335
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 326

def (, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/metadata/dimensions', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::Metadata::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::Metadata
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account with visibility to the metrics.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



361
362
363
364
365
366
367
368
369
370
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 361

def (, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/metadata/metrics', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::Metadata::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::Metadata
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account owning the deals.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



434
435
436
437
438
439
440
441
442
443
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 434

def (, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/preferreddeals', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::PreferredDeals::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::PreferredDeals
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account owning the saved reports.

  • max_results (Fixnum) —

    The maximum number of saved reports to include in the response, used for paging.

  • page_token (String) —

    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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 599

def (, 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', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::SavedReports::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::SavedReports
  command.params['accountId'] =  unless .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.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • ad_client_id (String) —

    Ad client for which to list URL channels.

  • max_results (Fixnum) —

    The maximum number of URL channels to include in the response, used for paging.

  • page_token (String) —

    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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 644

def (, 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', options)
  command.response_representation = Google::Apis::AdexchangesellerV2_0::UrlChannels::Representation
  command.response_class = Google::Apis::AdexchangesellerV2_0::UrlChannels
  command.params['accountId'] =  unless .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.

Parameters:

  • max_results (Fixnum) —

    The maximum number of accounts to include in the response, used for paging.

  • page_token (String) —

    A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



118
119
120
121
122
123
124
125
126
127
128
 
# File 'generated/google/apis/adexchangeseller_v2_0/service.rb', line 118

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', options)
  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