Class: Google::Apis::AdsensehostV4_1::AdSenseHostService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::AdsensehostV4_1::AdSenseHostService
- Defined in:
- lib/google/apis/adsensehost_v4_1/service.rb
Overview
AdSense Host API
Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.
Constant Summary collapse
- DEFAULT_ENDPOINT_TEMPLATE =
"https://www.$UNIVERSE_DOMAIN$/"
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.
Instance Method Summary collapse
-
#delete_account_ad_unit(account_id, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdUnit
Delete the specified ad unit from the specified publisher AdSense account.
-
#delete_custom_channel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannel
Delete a specific custom channel from the host AdSense account.
-
#delete_url_channel(ad_client_id, url_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::UrlChannel
Delete a URL channel from the host AdSense account.
-
#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, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::Report
Generate an AdSense report based on the report request sent in the query parameters.
-
#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, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::Report
Generate an AdSense report based on the report request sent in the query parameters.
-
#get_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::Account
Get information about the selected associated AdSense account.
-
#get_account_ad_client(account_id, ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdClient
Get information about one of the ad clients in the specified publisher's AdSense account.
-
#get_account_ad_unit(account_id, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdUnit
Get the specified host ad unit in this AdSense account.
-
#get_account_ad_unit_ad_code(account_id, ad_client_id, ad_unit_id, host_custom_channel_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdCode
Get ad code for the specified ad unit, attaching the specified host custom channels.
-
#get_ad_client(ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdClient
Get information about one of the ad clients in the Host AdSense account.
-
#get_custom_channel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannel
Get a specific custom channel from the host AdSense account.
-
#initialize ⇒ AdSenseHostService
constructor
A new instance of AdSenseHostService.
-
#insert_account_ad_unit(account_id, ad_client_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdUnit
Insert the supplied ad unit into the specified publisher AdSense account.
-
#insert_custom_channel(ad_client_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannel
Add a new custom channel to the host AdSense account.
-
#insert_url_channel(ad_client_id, url_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::UrlChannel
Add a new URL channel to the host AdSense account.
-
#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::AdsensehostV4_1::AdClients
List all hosted ad clients in the specified hosted account.
-
#list_account_ad_units(account_id, 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::AdsensehostV4_1::AdUnits
List all ad units in the specified publisher's AdSense account.
-
#list_accounts(filter_ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::Accounts
List hosted accounts associated with this AdSense account by ad client id.
-
#list_ad_clients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdClients
List all host ad clients in this AdSense account.
-
#list_custom_channels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannels
List all host custom channels in this AdSense account.
-
#list_url_channels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::UrlChannels
List all host URL channels in the host AdSense account.
-
#patch_account_ad_unit(account_id, ad_client_id, ad_unit_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdUnit
Update the supplied ad unit in the specified publisher AdSense account.
-
#patch_custom_channel(ad_client_id, custom_channel_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannel
Update a custom channel in the host AdSense account.
-
#start_association_session(product_code, website_url, callback_url: nil, user_locale: nil, website_locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AssociationSession
Create an association session for initiating an association with an AdSense user.
-
#update_account_ad_unit(account_id, ad_client_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdUnit
Update the supplied ad unit in the specified publisher AdSense account.
-
#update_custom_channel(ad_client_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannel
Update a custom channel in the host AdSense account.
-
#verify_association_session(token, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AssociationSession
Verify an association session after the association callback returns from AdSense signup.
Constructor Details
#initialize ⇒ AdSenseHostService
Returns a new instance of AdSenseHostService.
52 53 54 55 56 57 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 52 def initialize super(DEFAULT_ENDPOINT_TEMPLATE, 'adsensehost/v4.1/', client_name: 'google-apis-adsensehost_v4_1', client_version: Google::Apis::AdsensehostV4_1::GEM_VERSION) @batch_path = 'batch/adsensehost/v4.1' 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.
41 42 43 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 41 def key @key end |
#quota_user ⇒ String
Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
46 47 48 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 46 def quota_user @quota_user end |
#user_ip ⇒ String
Returns Deprecated. Please use quotaUser instead.
50 51 52 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 50 def user_ip @user_ip end |
Instance Method Details
#delete_account_ad_unit(account_id, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdUnit
Delete the specified ad unit from the specified publisher AdSense account.
229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 229 def delete_account_ad_unit(account_id, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}', ) command.response_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation command.response_class = Google::Apis::AdsensehostV4_1::AdUnit command.params['accountId'] = account_id unless account_id.nil? 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 |
#delete_custom_channel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannel
Delete a specific custom channel from the host AdSense account.
732 733 734 735 736 737 738 739 740 741 742 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 732 def delete_custom_channel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'adclients/{adClientId}/customchannels/{customChannelId}', ) command.response_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation command.response_class = Google::Apis::AdsensehostV4_1::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 |
#delete_url_channel(ad_client_id, url_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::UrlChannel
Delete a URL channel from the host AdSense account.
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 1020 def delete_url_channel(ad_client_id, url_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'adclients/{adClientId}/urlchannels/{urlChannelId}', ) command.response_representation = Google::Apis::AdsensehostV4_1::UrlChannel::Representation command.response_class = Google::Apis::AdsensehostV4_1::UrlChannel command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.params['urlChannelId'] = url_channel_id unless url_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 |
#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, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::Report
Generate an AdSense 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.
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 536 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, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/reports', ) command.response_representation = Google::Apis::AdsensehostV4_1::Report::Representation command.response_class = Google::Apis::AdsensehostV4_1::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_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, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::Report
Generate an AdSense 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.
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 977 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, options: nil, &block) command = make_simple_command(:get, 'reports', ) command.response_representation = Google::Apis::AdsensehostV4_1::Report::Representation command.response_class = Google::Apis::AdsensehostV4_1::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 |
#get_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::Account
Get information about the selected associated AdSense account.
81 82 83 84 85 86 87 88 89 90 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 81 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::AdsensehostV4_1::Account::Representation command.response_class = Google::Apis::AdsensehostV4_1::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_ad_client(account_id, ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdClient
Get information about one of the ad clients in the specified publisher's AdSense account.
150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 150 def get_account_ad_client(account_id, ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}', ) command.response_representation = Google::Apis::AdsensehostV4_1::AdClient::Representation command.response_class = Google::Apis::AdsensehostV4_1::AdClient command.params['accountId'] = account_id unless account_id.nil? command.params['adClientId'] = ad_client_id unless ad_client_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_ad_unit(account_id, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdUnit
Get the specified host ad unit in this AdSense account.
268 269 270 271 272 273 274 275 276 277 278 279 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 268 def get_account_ad_unit(account_id, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}', ) command.response_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation command.response_class = Google::Apis::AdsensehostV4_1::AdUnit command.params['accountId'] = account_id unless account_id.nil? 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_account_ad_unit_ad_code(account_id, ad_client_id, ad_unit_id, host_custom_channel_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdCode
Get ad code for the specified ad unit, attaching the specified host custom channels.
310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 310 def get_account_ad_unit_ad_code(account_id, ad_client_id, ad_unit_id, host_custom_channel_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode', ) command.response_representation = Google::Apis::AdsensehostV4_1::AdCode::Representation command.response_class = Google::Apis::AdsensehostV4_1::AdCode command.params['accountId'] = account_id unless account_id.nil? command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil? command.query['hostCustomChannelId'] = host_custom_channel_id unless host_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_ad_client(ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdClient
Get information about one of the ad clients in the Host AdSense account.
578 579 580 581 582 583 584 585 586 587 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 578 def get_ad_client(ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'adclients/{adClientId}', ) command.response_representation = Google::Apis::AdsensehostV4_1::AdClient::Representation command.response_class = Google::Apis::AdsensehostV4_1::AdClient command.params['adClientId'] = ad_client_id unless ad_client_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_custom_channel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannel
Get a specific custom channel from the host AdSense account.
768 769 770 771 772 773 774 775 776 777 778 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 768 def get_custom_channel(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::AdsensehostV4_1::CustomChannel::Representation command.response_class = Google::Apis::AdsensehostV4_1::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 |
#insert_account_ad_unit(account_id, ad_client_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdUnit
Insert the supplied ad unit into the specified publisher AdSense account.
349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 349 def insert_account_ad_unit(account_id, ad_client_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/adclients/{adClientId}/adunits', ) command.request_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation command.request_object = ad_unit_object command.response_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation command.response_class = Google::Apis::AdsensehostV4_1::AdUnit command.params['accountId'] = account_id unless account_id.nil? command.params['adClientId'] = ad_client_id unless ad_client_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 |
#insert_custom_channel(ad_client_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannel
Add a new custom channel to the host AdSense account.
803 804 805 806 807 808 809 810 811 812 813 814 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 803 def insert_custom_channel(ad_client_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'adclients/{adClientId}/customchannels', ) command.request_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation command.request_object = custom_channel_object command.response_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation command.response_class = Google::Apis::AdsensehostV4_1::CustomChannel command.params['adClientId'] = ad_client_id unless ad_client_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 |
#insert_url_channel(ad_client_id, url_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::UrlChannel
Add a new URL channel to the host AdSense account.
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 1055 def insert_url_channel(ad_client_id, url_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'adclients/{adClientId}/urlchannels', ) command.request_representation = Google::Apis::AdsensehostV4_1::UrlChannel::Representation command.request_object = url_channel_object command.response_representation = Google::Apis::AdsensehostV4_1::UrlChannel::Representation command.response_class = Google::Apis::AdsensehostV4_1::UrlChannel command.params['adClientId'] = ad_client_id unless ad_client_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::AdsensehostV4_1::AdClients
List all hosted ad clients in the specified hosted account.
190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 190 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::AdsensehostV4_1::AdClients::Representation command.response_class = Google::Apis::AdsensehostV4_1::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_ad_units(account_id, 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::AdsensehostV4_1::AdUnits
List all ad units in the specified publisher's AdSense account.
394 395 396 397 398 399 400 401 402 403 404 405 406 407 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 394 def list_account_ad_units(account_id, 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, 'accounts/{accountId}/adclients/{adClientId}/adunits', ) command.response_representation = Google::Apis::AdsensehostV4_1::AdUnits::Representation command.response_class = Google::Apis::AdsensehostV4_1::AdUnits command.params['accountId'] = account_id unless account_id.nil? 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_accounts(filter_ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::Accounts
List hosted accounts associated with this AdSense account by ad client id.
114 115 116 117 118 119 120 121 122 123 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 114 def list_accounts(filter_ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts', ) command.response_representation = Google::Apis::AdsensehostV4_1::Accounts::Representation command.response_class = Google::Apis::AdsensehostV4_1::Accounts command.query['filterAdClientId'] = filter_ad_client_id unless filter_ad_client_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_ad_clients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdClients
List all host ad clients in this AdSense account.
615 616 617 618 619 620 621 622 623 624 625 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 615 def list_ad_clients(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::AdsensehostV4_1::AdClients::Representation command.response_class = Google::Apis::AdsensehostV4_1::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_custom_channels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannels
List all host custom channels in this AdSense account.
845 846 847 848 849 850 851 852 853 854 855 856 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 845 def list_custom_channels(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::AdsensehostV4_1::CustomChannels::Representation command.response_class = Google::Apis::AdsensehostV4_1::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_url_channels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::UrlChannels
List all host URL channels in the host AdSense account.
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 1096 def list_url_channels(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::AdsensehostV4_1::UrlChannels::Representation command.response_class = Google::Apis::AdsensehostV4_1::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 |
#patch_account_ad_unit(account_id, ad_client_id, ad_unit_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdUnit
Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.
437 438 439 440 441 442 443 444 445 446 447 448 449 450 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 437 def patch_account_ad_unit(account_id, ad_client_id, ad_unit_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'accounts/{accountId}/adclients/{adClientId}/adunits', ) command.request_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation command.request_object = ad_unit_object command.response_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation command.response_class = Google::Apis::AdsensehostV4_1::AdUnit command.params['accountId'] = account_id unless account_id.nil? command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.query['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 |
#patch_custom_channel(ad_client_id, custom_channel_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannel
Update a custom channel in the host AdSense account. This method supports patch semantics.
884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 884 def patch_custom_channel(ad_client_id, custom_channel_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'adclients/{adClientId}/customchannels', ) command.request_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation command.request_object = custom_channel_object command.response_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation command.response_class = Google::Apis::AdsensehostV4_1::CustomChannel command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.query['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 |
#start_association_session(product_code, website_url, callback_url: nil, user_locale: nil, website_locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AssociationSession
Create an association session for initiating an association with an AdSense user.
659 660 661 662 663 664 665 666 667 668 669 670 671 672 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 659 def start_association_session(product_code, website_url, callback_url: nil, user_locale: nil, website_locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'associationsessions/start', ) command.response_representation = Google::Apis::AdsensehostV4_1::AssociationSession::Representation command.response_class = Google::Apis::AdsensehostV4_1::AssociationSession command.query['callbackUrl'] = callback_url unless callback_url.nil? command.query['productCode'] = product_code unless product_code.nil? command.query['userLocale'] = user_locale unless user_locale.nil? command.query['websiteLocale'] = website_locale unless website_locale.nil? command.query['websiteUrl'] = website_url unless website_url.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 |
#update_account_ad_unit(account_id, ad_client_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AdUnit
Update the supplied ad unit in the specified publisher AdSense account.
477 478 479 480 481 482 483 484 485 486 487 488 489 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 477 def update_account_ad_unit(account_id, ad_client_id, ad_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/adclients/{adClientId}/adunits', ) command.request_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation command.request_object = ad_unit_object command.response_representation = Google::Apis::AdsensehostV4_1::AdUnit::Representation command.response_class = Google::Apis::AdsensehostV4_1::AdUnit command.params['accountId'] = account_id unless account_id.nil? command.params['adClientId'] = ad_client_id unless ad_client_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 |
#update_custom_channel(ad_client_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::CustomChannel
Update a custom channel in the host AdSense account.
921 922 923 924 925 926 927 928 929 930 931 932 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 921 def update_custom_channel(ad_client_id, custom_channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'adclients/{adClientId}/customchannels', ) command.request_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation command.request_object = custom_channel_object command.response_representation = Google::Apis::AdsensehostV4_1::CustomChannel::Representation command.response_class = Google::Apis::AdsensehostV4_1::CustomChannel command.params['adClientId'] = ad_client_id unless ad_client_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 |
#verify_association_session(token, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsensehostV4_1::AssociationSession
Verify an association session after the association callback returns from AdSense signup.
697 698 699 700 701 702 703 704 705 706 |
# File 'lib/google/apis/adsensehost_v4_1/service.rb', line 697 def verify_association_session(token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'associationsessions/verify', ) command.response_representation = Google::Apis::AdsensehostV4_1::AssociationSession::Representation command.response_class = Google::Apis::AdsensehostV4_1::AssociationSession command.query['token'] = token unless 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 |