diff --git a/Gemfile.lock b/Gemfile.lock index 1e73293..40fbfe8 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - bing-ads-api (0.0.1) + bing-ads-api (0.1.0) rails savon (~> 2.3.0) @@ -41,7 +41,7 @@ GEM arel (3.0.3) builder (3.0.4) erubis (2.7.0) - gyoku (1.1.0) + gyoku (1.1.1) builder (>= 2.1.2) hike (1.2.3) httpi (2.1.0) @@ -57,8 +57,10 @@ GEM mime-types (~> 1.16) treetop (~> 1.4.8) mime-types (1.25.1) + mini_portile (0.5.2) multi_json (1.8.2) - nokogiri (1.5.10) + nokogiri (1.6.1) + mini_portile (~> 0.5.0) nori (2.3.0) polyglot (0.3.3) rack (1.4.5) @@ -87,14 +89,14 @@ GEM rdoc (3.12.2) json (~> 1.4) rubyntlm (0.3.4) - savon (2.3.0) + savon (2.3.3) akami (~> 1.2.0) builder (>= 2.1.2) gyoku (~> 1.1.0) httpi (~> 2.1.0) - nokogiri (>= 1.4.0, < 1.6) + nokogiri (>= 1.4.0) nori (~> 2.3.0) - wasabi (~> 3.2.0) + wasabi (~> 3.2.2) sprockets (2.2.2) hike (~> 1.2) multi_json (~> 1.0) @@ -107,9 +109,10 @@ GEM polyglot polyglot (>= 0.3.1) tzinfo (0.3.38) - wasabi (3.2.0) + wasabi (3.2.3) httpi (~> 2.0) - nokogiri (>= 1.4.0, < 1.6) + mime-types (< 2.0.0) + nokogiri (>= 1.4.0) PLATFORMS ruby diff --git a/README.rdoc b/README.rdoc index f0e0f0d..429c402 100644 --- a/README.rdoc +++ b/README.rdoc @@ -13,7 +13,7 @@ Add to your Gemfile gem 'bing-ads-api' == Examples -So far, I've just integrated some methods from +CampaignManagement+ and +Reporting+ services +So far, I've just integrated some methods from +CampaignManagement+, +CustomerManagement+ and +Reporting+ services === Authentication @@ -87,6 +87,35 @@ a object representation of the hash # => campaigns is an array of BingAdsApi::Campaign +=== Customer Management + +Example of service object initialization: + options = { + :environment => :sandbox, + :username => "desarrollo_neonline", + :password => "neonline2013", + :developer_token => "BBD37VB98", + :customer_id => "21021746", + :account_id => "5978083" + } + service = BingAdsApi::CustomerManagement.new(options) + +==== Get accounts info + accounts = service.get_accounts_info + # => accounts is an array of BingAdsApi::AccountsInfo + +For this method you can also specify a diferent customer id + accounts = service.get_accounts_info(12345) + # => accounts is an array of BingAdsApi::AccountsInfo +That would give you the customer's 12345 accounts + + === Reporting +==== Submit generate report + + +==== Poll generate report + + diff --git a/bing-ads-api-0.1.0.gem b/bing-ads-api-0.1.0.gem new file mode 100644 index 0000000..788e384 Binary files /dev/null and b/bing-ads-api-0.1.0.gem differ diff --git a/lib/bing-ads-api.yml b/lib/bing-ads-api.yml index cdaab93..264bf85 100644 --- a/lib/bing-ads-api.yml +++ b/lib/bing-ads-api.yml @@ -8,9 +8,11 @@ wsdl: sandbox: campaign_management: "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v9/CampaignManagementService.svc?singleWsdl" + customer_management: "https://clientcenter.api.sandbox.bingads.microsoft.com/Api/CustomerManagement/v9/CustomerManagementService.svc?singleWsdl" reporting: "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/Reporting/V9/ReportingService.svc?singleWsdl" production: campaign_management: "https://api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v9/CampaignManagementService.svc?singleWsdl" + customer_management: "i.bingads.microsoft.com/Api/CustomerManagement/v9/CustomerManagementService.svc?singleWsdl" reporting: "https://api.bingads.microsoft.com/Api/Advertiser/Reporting/V9/ReportingService.svc?singleWsdl" # All major constants are here @@ -177,6 +179,14 @@ constants: paused: 'Paused' deleted: 'Deleted' inactive: 'Inactive' + # Constants specific for customer management + customer_management: + account_life_cycle_statuses: + draft: "Draft" + active: "Active" + inactive: "Inactive" + pause: "Pause" + pending: "Pending" # Constants specific for reporting services reporting: format: diff --git a/lib/bing-ads-api/constants.rb b/lib/bing-ads-api/constants.rb index 293b9e8..3c3d17a 100644 --- a/lib/bing-ads-api/constants.rb +++ b/lib/bing-ads-api/constants.rb @@ -56,6 +56,23 @@ module AdLanguage end + + ## Dynamic classes for customer management constants + BingAdsApi::Config.instance.customer_management_constants.each do |const_key, const_value| + + const_module = Module.new do + # Dynamically create Constants classes for each value found + const_value.each do |key, value| + self.const_set(key.upcase, value) + end + + end + BingAdsApi.const_set(const_key.camelize, const_module) + + end + + + # Public : Module for Reporting formats # # Example diff --git a/lib/bing-ads-api/data/accounts_info.rb b/lib/bing-ads-api/data/accounts_info.rb new file mode 100644 index 0000000..e43c707 --- /dev/null +++ b/lib/bing-ads-api/data/accounts_info.rb @@ -0,0 +1,72 @@ +# -*- encoding : utf-8 -*- + +module BingAdsApi + + # Public : Define an account info + # + # Author:: jlopezn@neonline.cl + # + # Examples + # campaign = BingAdsApi::AccountInfo.new( + # :account_life_cycle_status => BingAdsApi::AccountsInfo::DRAFT + # :name => "Account Name", + # :number => 1234567, + # :pause_reason => "1") + # # => + class AccountInfo < BingAdsApi::DataObject + include BingAdsApi::AccountLifeCycleStatuses + + attr_accessor :id, :account_life_cycle_status, :name, :number, :pause_reason + + # Public:: Returns true if the account is in status active + # + # Author:: jlopezn@neonline.cl + # + # Returns:: boolean + def active? + return account_life_cycle_status == ACTIVE + end + + + # Public:: Returns true if the account is in status draft + # + # Author:: jlopezn@neonline.cl + # + # Returns:: boolean + def draft? + return account_life_cycle_status == DRAFT + end + + + # Public:: Returns true if the account is in status inactive + # + # Author:: jlopezn@neonline.cl + # + # Returns:: boolean + def inactive? + return account_life_cycle_status == INACTIVE + end + + + # Public:: Returns true if the account is in status pause + # + # Author:: jlopezn@neonline.cl + # + # Returns:: boolean + def pause? + return account_life_cycle_status == PAUSE + end + + + # Public:: Returns true if the account is in status pending + # + # Author:: jlopezn@neonline.cl + # + # Returns:: boolean + def pending? + return account_life_cycle_status == PENDING + end + + end + +end \ No newline at end of file diff --git a/lib/bing-ads-api/service.rb b/lib/bing-ads-api/service.rb index bb4f33d..ee1f0e2 100644 --- a/lib/bing-ads-api/service.rb +++ b/lib/bing-ads-api/service.rb @@ -13,6 +13,7 @@ class Service # Default logger for services LOGGER = Logger.new(STDOUT) + # Public : Constructor # # Author:: jlopezn@neonline.cl @@ -62,7 +63,8 @@ def initialize(options={}) self.client_proxy = BingAdsApi::ClientProxy.new(clientProxySettings) end - + + # Public : This is a utility wrapper for calling services into the # +ClientProxy+. This methods handle all the +Savon::Client+ Exceptions # and returns a Hash with the call response diff --git a/lib/bing-ads-api/service/customer_management.rb b/lib/bing-ads-api/service/customer_management.rb new file mode 100644 index 0000000..48875f7 --- /dev/null +++ b/lib/bing-ads-api/service/customer_management.rb @@ -0,0 +1,83 @@ +# -*- encoding : utf-8 -*- +module BingAdsApi + + + # Public : This class represents the Customer Management Services + # defined in the Bing Ads API, to manage customer accounts + # + # Author:: jlopezn@neonline.cl + # + # Examples + # options = { + # :environment => :sandbox, + # :username => "username", + # :password => "pass", + # :developer_token => "SOME_TOKEN", + # :customer_id => "1234567", + # :account_id => "9876543" } + # service = BingAdsApi::CustomerManagement.new(options) + class CustomerManagement < BingAdsApi::Service + + + # Public : Constructor + # + # Author:: jlopezn@neonline.cl + # + # options - Hash with the parameters for the client proxy and the environment + # + # Examples + # options = { + # :environment => :sandbox, + # :username => "username", + # :password => "password", + # :developer_token => "DEV_TOKEN", + # :customer_id => "123456", + # :account_id => "654321" + # } + # service = BingAdsApi::CustomerManagement.new(options) + def initialize(options={}) + super(options) + end + + + ######################### + ## Operations Wrappers ## + ######################### + + # Public : Gets a list of objects that contains account identification information, + # for example the name and identifier of the account, for the specified customer. + # + # Author:: jlopezn@neonline.cl + # + # === Parameters + # +customer_id+ - identifier for the customer who owns the accounts. If nil, then the authentication customer id is used + # +only_parent_accounts+ - boolean to determine whether to return only the accounts that belong to the customer or to also + # return the accounts that the customer manages for other customers. Default false + # + # === Examples + # customer_management_service.get_accounts_info + # # => Array[BingAdsApi::AccountsInfo] + # + # Returns:: Array of BingAdsApi::AccountsInfo + # + # Raises:: exception + def get_accounts_info(customer_id=nil, only_parent_accounts=false) + response = call(:get_accounts_info, + {customer_id: customer_id || self.client_proxy.customer_id, + only_parent_accounts: only_parent_accounts.to_s}) + response_hash = get_response_hash(response, __method__) + accounts = response_hash[:accounts_info][:account_info].map do |account_hash| + BingAdsApi::AccountInfo.new(account_hash) + end + return accounts + end + + + private + def get_service_name + "customer_management" + end + + end + +end \ No newline at end of file diff --git a/lib/bing-ads-api/soap_hasheable.rb b/lib/bing-ads-api/soap_hasheable.rb index fb813b2..dcadb0f 100644 --- a/lib/bing-ads-api/soap_hasheable.rb +++ b/lib/bing-ads-api/soap_hasheable.rb @@ -86,10 +86,27 @@ def object_to_hash(object, keys_case=:underscore) end + # Public:: Normalize the keys of a hash with the case specified + # + # Author:: jlopexn@neonline.cl + # + # === Parameters + # * +hash+ - Hash to be normalized + # * +keys_case+ - :underscore or :camelcase + # + # === Examples + # normalize_hash_keys({:some_key => value1}, :camelcase) + # # => {"SomeKey" => value1} + # + # normalize_hash_keys({:some_key => value1}, :underscore) + # # => {"some_key" => value1} + # + # Returns:: Hash def normalize_hash_keys(hash, keys_case) return hash.inject({}) { |h, (k, v)| h[get_attribute_key(k, keys_case)] = object_to_hash(v, keys_case); h } end + # Internal : Helper method to determinate the key name in the hash for the SOAP request # # Author:: jlopezn@neonline.cl diff --git a/lib/bing-ads-api/version.rb b/lib/bing-ads-api/version.rb index 7e9a342..1b0f660 100644 --- a/lib/bing-ads-api/version.rb +++ b/lib/bing-ads-api/version.rb @@ -2,5 +2,5 @@ module BingAdsApi # Gem Version - VERSION = "0.1.0" + VERSION = "0.2.0" end diff --git a/rdoc/BingAdsApi.html b/rdoc/BingAdsApi.html index c33b848..3935909 100644 --- a/rdoc/BingAdsApi.html +++ b/rdoc/BingAdsApi.html @@ -52,6 +52,7 @@

Defined In

  • lib/bing-ads-api/client_proxy.rb
  • lib/bing-ads-api/config.rb
  • lib/bing-ads-api/constants.rb +
  • lib/bing-ads-api/data/accounts_info.rb
  • lib/bing-ads-api/data/ad.rb
  • lib/bing-ads-api/data/ad_group.rb
  • lib/bing-ads-api/data/campaign.rb @@ -70,6 +71,7 @@

    Defined In

  • lib/bing-ads-api/fault/partial_errors.rb
  • lib/bing-ads-api/service.rb
  • lib/bing-ads-api/service/campaign_management.rb +
  • lib/bing-ads-api/service/customer_management.rb
  • lib/bing-ads-api/service/reporting.rb
  • lib/bing-ads-api/soap_hasheable.rb
  • lib/bing-ads-api/version.rb @@ -104,6 +106,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -134,6 +138,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/AccountInfo.html b/rdoc/BingAdsApi/AccountInfo.html new file mode 100644 index 0000000..adca2fb --- /dev/null +++ b/rdoc/BingAdsApi/AccountInfo.html @@ -0,0 +1,524 @@ + + + + + + +class BingAdsApi::AccountInfo - BingAdsApi + + + + + + + + + + + + + + + + +
    +

    class BingAdsApi::AccountInfo

    + +
    + +

    Public : Define an account info

    +
    Author +
    +

    jlopezn@neonline.cl

    +
    + +

    Examples

    + +
    campaign = BingAdsApi::AccountInfo.new(
    +  :account_life_cycle_status => BingAdsApi::AccountsInfo::DRAFT 
    +  :name => "Account Name",
    +  :number => 1234567,
    +  :pause_reason => "1")
    +# => <BingAdsApi::AccountInfo>
    +
    + +
    + + + + +
    + + + + + + + + +
    +

    Attributes

    + + +
    +
    + account_life_cycle_status[RW] +
    + +
    + + + +
    +
    + +
    +
    + id[RW] +
    + +
    + + + +
    +
    + +
    +
    + name[RW] +
    + +
    + + + +
    +
    + +
    +
    + number[RW] +
    + +
    + + + +
    +
    + +
    +
    + pause_reason[RW] +
    + +
    + + + +
    +
    + +
    + + + + +
    +

    Public Instance Methods

    + + +
    + +
    + active?() + click to toggle source +
    + + +
    + +
    Public +
    +

    Returns true if the account is in status active

    +
    Author +
    +

    jlopezn@neonline.cl

    +
    Returns +
    +

    boolean

    +
    + + + +
    +
    # File lib/bing-ads-api/data/accounts_info.rb, line 26
    +def active?
    +        return account_life_cycle_status == ACTIVE 
    +end
    +
    + +
    + + + + +
    + + +
    + +
    + draft?() + click to toggle source +
    + + +
    + +
    Public +
    +

    Returns true if the account is in status draft

    +
    Author +
    +

    jlopezn@neonline.cl

    +
    Returns +
    +

    boolean

    +
    + + + +
    +
    # File lib/bing-ads-api/data/accounts_info.rb, line 36
    +def draft?
    +        return account_life_cycle_status == DRAFT 
    +end
    +
    + +
    + + + + +
    + + +
    + +
    + inactive?() + click to toggle source +
    + + +
    + +
    Public +
    +

    Returns true if the account is in status inactive

    +
    Author +
    +

    jlopezn@neonline.cl

    +
    Returns +
    +

    boolean

    +
    + + + +
    +
    # File lib/bing-ads-api/data/accounts_info.rb, line 46
    +def inactive?
    +        return account_life_cycle_status == INACTIVE 
    +end
    +
    + +
    + + + + +
    + + +
    + +
    + pause?() + click to toggle source +
    + + +
    + +
    Public +
    +

    Returns true if the account is in status pause

    +
    Author +
    +

    jlopezn@neonline.cl

    +
    Returns +
    +

    boolean

    +
    + + + +
    +
    # File lib/bing-ads-api/data/accounts_info.rb, line 56
    +def pause?
    +        return account_life_cycle_status == PAUSE 
    +end
    +
    + +
    + + + + +
    + + +
    + +
    + pending?() + click to toggle source +
    + + +
    + +
    Public +
    +

    Returns true if the account is in status pending

    +
    Author +
    +

    jlopezn@neonline.cl

    +
    Returns +
    +

    boolean

    +
    + + + +
    +
    # File lib/bing-ads-api/data/accounts_info.rb, line 66
    +def pending?
    +        return account_life_cycle_status == PENDING 
    +end
    +
    + +
    + + + + +
    + + +
    + +
    + +
    + + + + diff --git a/rdoc/BingAdsApi/AccountPerformanceReportRequest.html b/rdoc/BingAdsApi/AccountPerformanceReportRequest.html index e2c06f8..4dcced1 100644 --- a/rdoc/BingAdsApi/AccountPerformanceReportRequest.html +++ b/rdoc/BingAdsApi/AccountPerformanceReportRequest.html @@ -97,6 +97,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -127,6 +129,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/Ad.html b/rdoc/BingAdsApi/Ad.html index 89d1016..6358a4d 100644 --- a/rdoc/BingAdsApi/Ad.html +++ b/rdoc/BingAdsApi/Ad.html @@ -105,6 +105,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -135,6 +137,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/AdApiError.html b/rdoc/BingAdsApi/AdApiError.html index e7f01b2..3ce0ea2 100644 --- a/rdoc/BingAdsApi/AdApiError.html +++ b/rdoc/BingAdsApi/AdApiError.html @@ -85,6 +85,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -115,6 +117,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/AdApiFaultDetail.html b/rdoc/BingAdsApi/AdApiFaultDetail.html index 64f759d..3f70708 100644 --- a/rdoc/BingAdsApi/AdApiFaultDetail.html +++ b/rdoc/BingAdsApi/AdApiFaultDetail.html @@ -97,6 +97,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -127,6 +129,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/AdGroup.html b/rdoc/BingAdsApi/AdGroup.html index 98df309..1d13c1a 100644 --- a/rdoc/BingAdsApi/AdGroup.html +++ b/rdoc/BingAdsApi/AdGroup.html @@ -129,6 +129,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -159,6 +161,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/AdLanguage.html b/rdoc/BingAdsApi/AdLanguage.html index 331edab..b639e9f 100644 --- a/rdoc/BingAdsApi/AdLanguage.html +++ b/rdoc/BingAdsApi/AdLanguage.html @@ -79,6 +79,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -109,6 +111,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ApiException.html b/rdoc/BingAdsApi/ApiException.html index 5b6e1ce..b2df99f 100644 --- a/rdoc/BingAdsApi/ApiException.html +++ b/rdoc/BingAdsApi/ApiException.html @@ -97,6 +97,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -127,6 +129,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ApiFaultDetail.html b/rdoc/BingAdsApi/ApiFaultDetail.html index d9e628c..5cdb32e 100644 --- a/rdoc/BingAdsApi/ApiFaultDetail.html +++ b/rdoc/BingAdsApi/ApiFaultDetail.html @@ -97,6 +97,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -127,6 +129,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ApplicationFault.html b/rdoc/BingAdsApi/ApplicationFault.html index 4f6e722..891d7f2 100644 --- a/rdoc/BingAdsApi/ApplicationFault.html +++ b/rdoc/BingAdsApi/ApplicationFault.html @@ -95,6 +95,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -125,6 +127,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/BatchError.html b/rdoc/BingAdsApi/BatchError.html index c96929a..be064d5 100644 --- a/rdoc/BingAdsApi/BatchError.html +++ b/rdoc/BingAdsApi/BatchError.html @@ -95,6 +95,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -125,6 +127,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/Campaign.html b/rdoc/BingAdsApi/Campaign.html index 3419b91..d241e98 100644 --- a/rdoc/BingAdsApi/Campaign.html +++ b/rdoc/BingAdsApi/Campaign.html @@ -109,6 +109,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -139,6 +141,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/CampaignManagement.html b/rdoc/BingAdsApi/CampaignManagement.html index cef8a73..584118a 100644 --- a/rdoc/BingAdsApi/CampaignManagement.html +++ b/rdoc/BingAdsApi/CampaignManagement.html @@ -117,6 +117,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -147,6 +149,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/CampaignPerformanceReportRequest.html b/rdoc/BingAdsApi/CampaignPerformanceReportRequest.html index 7a490d7..a6ba955 100644 --- a/rdoc/BingAdsApi/CampaignPerformanceReportRequest.html +++ b/rdoc/BingAdsApi/CampaignPerformanceReportRequest.html @@ -97,6 +97,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -127,6 +129,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ClientProxy.html b/rdoc/BingAdsApi/ClientProxy.html index 4799406..a0710c1 100644 --- a/rdoc/BingAdsApi/ClientProxy.html +++ b/rdoc/BingAdsApi/ClientProxy.html @@ -97,6 +97,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -127,6 +129,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/Config.html b/rdoc/BingAdsApi/Config.html index 8b459b7..603f433 100644 --- a/rdoc/BingAdsApi/Config.html +++ b/rdoc/BingAdsApi/Config.html @@ -111,6 +111,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -141,6 +143,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/CustomerManagement.html b/rdoc/BingAdsApi/CustomerManagement.html new file mode 100644 index 0000000..47fe718 --- /dev/null +++ b/rdoc/BingAdsApi/CustomerManagement.html @@ -0,0 +1,361 @@ + + + + + + +class BingAdsApi::CustomerManagement - BingAdsApi + + + + + + + + + + + + + + + + +
    +

    class BingAdsApi::CustomerManagement

    + +
    + +

    Public : This class represents the Customer Management Services defined in +the Bing Ads API, to manage customer accounts

    +
    Author +
    +

    jlopezn@neonline.cl

    +
    + +

    Examples

    + +
    options = {
    +  :environment => :sandbox,
    +  :username => "username",
    +  :password => "pass",
    +  :developer_token => "SOME_TOKEN",
    +  :customer_id => "1234567",
    +  :account_id => "9876543" }
    +service = BingAdsApi::CustomerManagement.new(options)
    +
    + +
    + + + + +
    + + + + + + + + + + +
    +

    Public Class Methods

    + + +
    + +
    + new(options={}) + click to toggle source +
    + + +
    + +

    Public : Constructor

    +
    Author +
    +

    jlopezn@neonline.cl

    +
    + +

    options - Hash with the parameters for the client proxy and the environment

    + +

    Examples

    + +
    options = {
    +  :environment => :sandbox,
    +  :username => "username",
    +  :password => "password",
    +  :developer_token => "DEV_TOKEN",
    +  :customer_id => "123456",
    +  :account_id => "654321"
    +}
    +service = BingAdsApi::CustomerManagement.new(options)
    +
    + + + +
    +
    # File lib/bing-ads-api/service/customer_management.rb, line 38
    +def initialize(options={})
    +        super(options)
    +end
    +
    + +
    + + + + +
    + + +
    + +
    +

    Public Instance Methods

    + + +
    + +
    + get_accounts_info(customer_id=nil, only_parent_accounts=false) + click to toggle source +
    + + +
    + +

    Public : Gets a list of objects that contains account identification +information, for example the name and identifier of the account, for the +specified customer.

    +
    Author +
    +

    jlopezn@neonline.cl

    +
    + +

    Parameters

    + +

    customer_id - identifier for the customer who owns the +accounts. If nil, then the authentication customer id is used +only_parent_accounts - boolean to determine whether to return +only the accounts that belong to the customer or to also return the +accounts that the customer manages for other customers. Default false

    + +

    Examples

    + +
    customer_management_service.get_accounts_info 
    +# => Array[BingAdsApi::AccountsInfo]
    +
    +
    Returns +
    +

    Array of BingAdsApi::AccountsInfo

    +
    Raises +
    +

    exception

    +
    + + + +
    +
    # File lib/bing-ads-api/service/customer_management.rb, line 64
    +def get_accounts_info(customer_id=nil, only_parent_accounts=false)
    +        response = call(:get_accounts_info, 
    +                {customer_id: customer_id || self.client_proxy.customer_id, 
    +                only_parent_accounts: only_parent_accounts.to_s})
    +        response_hash = get_response_hash(response, __method__)
    +        accounts = response_hash[:accounts_info][:account_info].map do |account_hash|
    +                BingAdsApi::AccountInfo.new(account_hash)
    +        end
    +        return accounts
    +end
    +
    + +
    + + + + +
    + + +
    + +
    + +
    + + + + diff --git a/rdoc/BingAdsApi/DataObject.html b/rdoc/BingAdsApi/DataObject.html index 99c6b67..4716685 100644 --- a/rdoc/BingAdsApi/DataObject.html +++ b/rdoc/BingAdsApi/DataObject.html @@ -109,6 +109,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -139,6 +141,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/EditorialError.html b/rdoc/BingAdsApi/EditorialError.html index 9887367..bd7c285 100644 --- a/rdoc/BingAdsApi/EditorialError.html +++ b/rdoc/BingAdsApi/EditorialError.html @@ -95,6 +95,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -125,6 +127,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/Helpers.html b/rdoc/BingAdsApi/Helpers.html index 101e475..cacafa3 100644 --- a/rdoc/BingAdsApi/Helpers.html +++ b/rdoc/BingAdsApi/Helpers.html @@ -82,6 +82,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -112,6 +114,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/Helpers/ColumnHelper.html b/rdoc/BingAdsApi/Helpers/ColumnHelper.html index 749f883..0b3a660 100644 --- a/rdoc/BingAdsApi/Helpers/ColumnHelper.html +++ b/rdoc/BingAdsApi/Helpers/ColumnHelper.html @@ -91,6 +91,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -121,6 +123,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/Helpers/FilterHelper.html b/rdoc/BingAdsApi/Helpers/FilterHelper.html index 7f67dde..15f853b 100644 --- a/rdoc/BingAdsApi/Helpers/FilterHelper.html +++ b/rdoc/BingAdsApi/Helpers/FilterHelper.html @@ -107,6 +107,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -137,6 +139,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/Helpers/ScopeHelper.html b/rdoc/BingAdsApi/Helpers/ScopeHelper.html index b75134a..6e48200 100644 --- a/rdoc/BingAdsApi/Helpers/ScopeHelper.html +++ b/rdoc/BingAdsApi/Helpers/ScopeHelper.html @@ -103,6 +103,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -133,6 +135,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/Helpers/TimeHelper.html b/rdoc/BingAdsApi/Helpers/TimeHelper.html index 74ac1b5..29c704b 100644 --- a/rdoc/BingAdsApi/Helpers/TimeHelper.html +++ b/rdoc/BingAdsApi/Helpers/TimeHelper.html @@ -91,6 +91,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -121,6 +123,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/MobileAd.html b/rdoc/BingAdsApi/MobileAd.html index f125dec..72ff635 100644 --- a/rdoc/BingAdsApi/MobileAd.html +++ b/rdoc/BingAdsApi/MobileAd.html @@ -95,6 +95,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -125,6 +127,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/OperationError.html b/rdoc/BingAdsApi/OperationError.html index a76c80d..27cbf01 100644 --- a/rdoc/BingAdsApi/OperationError.html +++ b/rdoc/BingAdsApi/OperationError.html @@ -95,6 +95,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -125,6 +127,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/PartialErrors.html b/rdoc/BingAdsApi/PartialErrors.html index 386d684..8c48ea3 100644 --- a/rdoc/BingAdsApi/PartialErrors.html +++ b/rdoc/BingAdsApi/PartialErrors.html @@ -97,6 +97,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -127,6 +129,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/PerformanceReportRequest.html b/rdoc/BingAdsApi/PerformanceReportRequest.html index 2e560fb..6795c6b 100644 --- a/rdoc/BingAdsApi/PerformanceReportRequest.html +++ b/rdoc/BingAdsApi/PerformanceReportRequest.html @@ -117,6 +117,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -147,6 +149,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ProductAd.html b/rdoc/BingAdsApi/ProductAd.html index 871ab89..ff40000 100644 --- a/rdoc/BingAdsApi/ProductAd.html +++ b/rdoc/BingAdsApi/ProductAd.html @@ -95,6 +95,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -125,6 +127,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ReportAggregation.html b/rdoc/BingAdsApi/ReportAggregation.html index b08fe04..714cc5f 100644 --- a/rdoc/BingAdsApi/ReportAggregation.html +++ b/rdoc/BingAdsApi/ReportAggregation.html @@ -79,6 +79,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -109,6 +111,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ReportFormat.html b/rdoc/BingAdsApi/ReportFormat.html index b8f764c..bc5dbf0 100644 --- a/rdoc/BingAdsApi/ReportFormat.html +++ b/rdoc/BingAdsApi/ReportFormat.html @@ -79,6 +79,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -109,6 +111,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ReportLanguage.html b/rdoc/BingAdsApi/ReportLanguage.html index bd121f8..5161000 100644 --- a/rdoc/BingAdsApi/ReportLanguage.html +++ b/rdoc/BingAdsApi/ReportLanguage.html @@ -79,6 +79,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -109,6 +111,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ReportRequest.html b/rdoc/BingAdsApi/ReportRequest.html index 89e3a84..26a789b 100644 --- a/rdoc/BingAdsApi/ReportRequest.html +++ b/rdoc/BingAdsApi/ReportRequest.html @@ -97,6 +97,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -127,6 +129,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ReportRequestStatus.html b/rdoc/BingAdsApi/ReportRequestStatus.html index 63e5b4e..b0d25c7 100644 --- a/rdoc/BingAdsApi/ReportRequestStatus.html +++ b/rdoc/BingAdsApi/ReportRequestStatus.html @@ -99,6 +99,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -129,6 +131,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/ReportTimePeriods.html b/rdoc/BingAdsApi/ReportTimePeriods.html index 41e3d29..6f88268 100644 --- a/rdoc/BingAdsApi/ReportTimePeriods.html +++ b/rdoc/BingAdsApi/ReportTimePeriods.html @@ -79,6 +79,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -109,6 +111,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/Reporting.html b/rdoc/BingAdsApi/Reporting.html index 4a20327..d678686 100644 --- a/rdoc/BingAdsApi/Reporting.html +++ b/rdoc/BingAdsApi/Reporting.html @@ -97,6 +97,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -127,6 +129,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/SOAPHasheable.html b/rdoc/BingAdsApi/SOAPHasheable.html index 4a34668..cf3fe47 100644 --- a/rdoc/BingAdsApi/SOAPHasheable.html +++ b/rdoc/BingAdsApi/SOAPHasheable.html @@ -97,6 +97,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -127,6 +129,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError @@ -249,7 +253,7 @@

    keys_case

    -
    # File lib/bing-ads-api/soap_hasheable.rb, line 133
    +            
    # File lib/bing-ads-api/soap_hasheable.rb, line 150
     def date_to_hash(date, keys_case)
             {
                     get_attribute_key("day", keys_case)   => date.day,
    @@ -315,7 +319,7 @@ 

    Examples

    -
    # File lib/bing-ads-api/soap_hasheable.rb, line 112
    +            
    # File lib/bing-ads-api/soap_hasheable.rb, line 129
     def get_attribute_key(attribute, keys_case = :underscore)
             if keys_case == :underscore
                     return attribute.to_s.delete("@").underscore
    @@ -344,12 +348,38 @@ 

    Examples

    - +
    Public +
    +

    Normalize the keys of a hash with the case specified

    +
    Author +
    +

    jlopexn@neonline.cl

    +
    + +

    Parameters

    +
    • +

      hash - Hash to be normalized

      +
    • +

      keys_case - :underscore or :camelcase

      +
    + +

    Examples

    + +
    normalize_hash_keys({:some_key => value1}, :camelcase) 
    +# => {"SomeKey" => value1} 
    +
    +normalize_hash_keys({:some_key => value1}, :underscore) 
    +# => {"some_key" => value1}
    +
    +
    Returns +
    +

    Hash

    +
    -
    # File lib/bing-ads-api/soap_hasheable.rb, line 89
    +            
    # File lib/bing-ads-api/soap_hasheable.rb, line 105
     def normalize_hash_keys(hash, keys_case)
             return hash.inject({}) { |h, (k, v)| h[get_attribute_key(k, keys_case)] = object_to_hash(v, keys_case); h }
     end
    diff --git a/rdoc/BingAdsApi/Service.html b/rdoc/BingAdsApi/Service.html index 4060c62..6edb411 100644 --- a/rdoc/BingAdsApi/Service.html +++ b/rdoc/BingAdsApi/Service.html @@ -99,6 +99,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -129,6 +131,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError @@ -315,7 +319,7 @@

    Examples

    -
    # File lib/bing-ads-api/service.rb, line 43
    +            
    # File lib/bing-ads-api/service.rb, line 44
     def initialize(options={})
             
             # Service Environment
    @@ -395,7 +399,7 @@ 

    Examples

    -
    # File lib/bing-ads-api/service.rb, line 82
    +            
    # File lib/bing-ads-api/service.rb, line 84
     def call(operation, message, &block)
             raise "You must provide an operation" if operation.nil?
             begin
    @@ -482,7 +486,7 @@ 

    Examples

    -
    # File lib/bing-ads-api/service.rb, line 136
    +            
    # File lib/bing-ads-api/service.rb, line 138
     def get_response_hash(response, method)
             return response[:envelope][:body]["#{method}_response".to_sym]
     end
    diff --git a/rdoc/BingAdsApi/TextAd.html b/rdoc/BingAdsApi/TextAd.html index 3432406..e7b7385 100644 --- a/rdoc/BingAdsApi/TextAd.html +++ b/rdoc/BingAdsApi/TextAd.html @@ -95,6 +95,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -125,6 +127,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/BingAdsApi/TimeZone.html b/rdoc/BingAdsApi/TimeZone.html index 9224ec6..a87dfc9 100644 --- a/rdoc/BingAdsApi/TimeZone.html +++ b/rdoc/BingAdsApi/TimeZone.html @@ -79,6 +79,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -109,6 +111,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/README_rdoc.html b/rdoc/README_rdoc.html index 749781c..24451af 100644 --- a/rdoc/README_rdoc.html +++ b/rdoc/README_rdoc.html @@ -61,6 +61,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -91,6 +93,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError @@ -163,7 +167,8 @@

    Installation

    Examples

    So far, I’ve just integrated some methods from -CampaignManagement and Reporting services

    +CampaignManagement, CustomerManagement and +Reporting services

    Authentication

    @@ -241,8 +246,41 @@

    Find Campaigns

    # => campaigns is an array of BingAdsApi::Campaign
  • +

    Customer Management

    + +

    Example of service object initialization:

    + +
    options = {
    +     :environment => :sandbox,
    +     :username => "desarrollo_neonline",
    +     :password => "neonline2013",
    +     :developer_token => "BBD37VB98",
    +     :customer_id => "21021746",
    +     :account_id => "5978083"
    +}
    +service = BingAdsApi::CustomerManagement.new(options)
    +
    + +

    Get accounts info

    + +
    accounts = service.get_accounts_info
    +# => accounts is an array of BingAdsApi::AccountsInfo
    +
    + +

    For this method you can also specify a diferent customer id

    + +
    accounts = service.get_accounts_info(12345)
    +# => accounts is an array of BingAdsApi::AccountsInfo
    +
    + +

    That would give you the customer’s 12345 accounts

    +

    Reporting

    +

    Submit generate report

    + +

    Poll generate report

    +
    diff --git a/rdoc/created.rid b/rdoc/created.rid index 79bac06..f98d076 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1,10 +1,11 @@ -Mon, 24 Feb 2014 17:13:50 -0300 -README.rdoc Mon, 24 Feb 2014 17:01:11 -0300 +Wed, 26 Feb 2014 18:01:04 -0300 +README.rdoc Wed, 26 Feb 2014 18:00:55 -0300 lib/bing-ads-api.rb Mon, 24 Feb 2014 14:58:35 -0300 lib/bing-ads-api/api_exception.rb Thu, 20 Feb 2014 11:06:54 -0300 lib/bing-ads-api/client_proxy.rb Thu, 20 Feb 2014 11:06:54 -0300 lib/bing-ads-api/config.rb Thu, 20 Feb 2014 11:06:54 -0300 -lib/bing-ads-api/constants.rb Thu, 20 Feb 2014 11:06:54 -0300 +lib/bing-ads-api/constants.rb Wed, 26 Feb 2014 16:45:07 -0300 +lib/bing-ads-api/data/accounts_info.rb Wed, 26 Feb 2014 16:52:57 -0300 lib/bing-ads-api/data/ad.rb Thu, 20 Feb 2014 11:06:54 -0300 lib/bing-ads-api/data/ad_group.rb Thu, 20 Feb 2014 11:06:54 -0300 lib/bing-ads-api/data/campaign.rb Thu, 20 Feb 2014 11:06:54 -0300 @@ -25,8 +26,9 @@ lib/bing-ads-api/fault/application_fault.rb Thu, 20 Feb 2014 11:06:55 -0300 lib/bing-ads-api/fault/batch_error.rb Thu, 20 Feb 2014 11:06:55 -0300 lib/bing-ads-api/fault/operation_error.rb Thu, 20 Feb 2014 11:06:55 -0300 lib/bing-ads-api/fault/partial_errors.rb Thu, 20 Feb 2014 11:06:55 -0300 -lib/bing-ads-api/service.rb Thu, 20 Feb 2014 11:06:55 -0300 +lib/bing-ads-api/service.rb Wed, 26 Feb 2014 17:55:47 -0300 lib/bing-ads-api/service/campaign_management.rb Thu, 20 Feb 2014 11:06:55 -0300 +lib/bing-ads-api/service/customer_management.rb Wed, 26 Feb 2014 17:53:05 -0300 lib/bing-ads-api/service/reporting.rb Mon, 24 Feb 2014 15:35:55 -0300 -lib/bing-ads-api/soap_hasheable.rb Thu, 20 Feb 2014 15:39:41 -0300 -lib/bing-ads-api/version.rb Fri, 14 Feb 2014 10:50:54 -0300 +lib/bing-ads-api/soap_hasheable.rb Wed, 26 Feb 2014 17:57:50 -0300 +lib/bing-ads-api/version.rb Mon, 24 Feb 2014 18:20:13 -0300 diff --git a/rdoc/index.html b/rdoc/index.html index 2edc9c2..1bcc9f6 100644 --- a/rdoc/index.html +++ b/rdoc/index.html @@ -61,6 +61,8 @@

    Class and Module Index

  • BingAdsApi +
  • BingAdsApi::AccountInfo +
  • BingAdsApi::AccountPerformanceReportRequest
  • BingAdsApi::Ad @@ -91,6 +93,8 @@

    Class and Module Index

  • BingAdsApi::Config +
  • BingAdsApi::CustomerManagement +
  • BingAdsApi::DataObject
  • BingAdsApi::EditorialError diff --git a/rdoc/js/search_index.js b/rdoc/js/search_index.js index cadbfd0..5f609c4 100644 --- a/rdoc/js/search_index.js +++ b/rdoc/js/search_index.js @@ -1 +1 @@ -var search_data = {"index":{"searchIndex":["bingadsapi","accountperformancereportrequest","ad","adapierror","adapifaultdetail","adgroup","adlanguage","apiexception","apifaultdetail","applicationfault","batcherror","campaign","campaignmanagement","campaignperformancereportrequest","clientproxy","config","dataobject","editorialerror","helpers","columnhelper","filterhelper","scopehelper","timehelper","mobilead","operationerror","partialerrors","performancereportrequest","productad","reportaggregation","reportformat","reportlanguage","reportrequest","reportrequeststatus","reporttimeperiods","reporting","soaphasheable","service","textad","timezone","add_ad_groups()","add_ads()","add_campaigns()","call()","call()","columns_to_hash()","date_to_hash()","error?()","filter_to_hash()","get_ad_groups_by_campaign_id()","get_ad_groups_by_ids()","get_ads_by_ad_group_id()","get_ads_by_ids()","get_attribute_key()","get_campaigns_by_account_id()","get_response_hash()","hash_instance()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","normalize_hash_keys()","object_to_hash()","pending?()","poll_generate_report()","scope_to_hash()","service_wsdl()","solve_filter_value()","submit_generate_report()","success?()","time_to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","update_ad_groups()","update_ads()","update_campaigns()","valid_columns()","valid_filter()","valid_filter_value()","valid_scope()","valid_time()","readme"],"longSearchIndex":["bingadsapi","bingadsapi::accountperformancereportrequest","bingadsapi::ad","bingadsapi::adapierror","bingadsapi::adapifaultdetail","bingadsapi::adgroup","bingadsapi::adlanguage","bingadsapi::apiexception","bingadsapi::apifaultdetail","bingadsapi::applicationfault","bingadsapi::batcherror","bingadsapi::campaign","bingadsapi::campaignmanagement","bingadsapi::campaignperformancereportrequest","bingadsapi::clientproxy","bingadsapi::config","bingadsapi::dataobject","bingadsapi::editorialerror","bingadsapi::helpers","bingadsapi::helpers::columnhelper","bingadsapi::helpers::filterhelper","bingadsapi::helpers::scopehelper","bingadsapi::helpers::timehelper","bingadsapi::mobilead","bingadsapi::operationerror","bingadsapi::partialerrors","bingadsapi::performancereportrequest","bingadsapi::productad","bingadsapi::reportaggregation","bingadsapi::reportformat","bingadsapi::reportlanguage","bingadsapi::reportrequest","bingadsapi::reportrequeststatus","bingadsapi::reporttimeperiods","bingadsapi::reporting","bingadsapi::soaphasheable","bingadsapi::service","bingadsapi::textad","bingadsapi::timezone","bingadsapi::campaignmanagement#add_ad_groups()","bingadsapi::campaignmanagement#add_ads()","bingadsapi::campaignmanagement#add_campaigns()","bingadsapi::clientproxy#call()","bingadsapi::service#call()","bingadsapi::helpers::columnhelper#columns_to_hash()","bingadsapi::soaphasheable#date_to_hash()","bingadsapi::reportrequeststatus#error?()","bingadsapi::helpers::filterhelper#filter_to_hash()","bingadsapi::campaignmanagement#get_ad_groups_by_campaign_id()","bingadsapi::campaignmanagement#get_ad_groups_by_ids()","bingadsapi::campaignmanagement#get_ads_by_ad_group_id()","bingadsapi::campaignmanagement#get_ads_by_ids()","bingadsapi::soaphasheable#get_attribute_key()","bingadsapi::campaignmanagement#get_campaigns_by_account_id()","bingadsapi::service#get_response_hash()","bingadsapi::config::hash_instance()","bingadsapi::accountperformancereportrequest::new()","bingadsapi::adapifaultdetail::new()","bingadsapi::adgroup::new()","bingadsapi::apiexception::new()","bingadsapi::apifaultdetail::new()","bingadsapi::campaignmanagement::new()","bingadsapi::campaignperformancereportrequest::new()","bingadsapi::clientproxy::new()","bingadsapi::config::new()","bingadsapi::dataobject::new()","bingadsapi::partialerrors::new()","bingadsapi::performancereportrequest::new()","bingadsapi::reportrequest::new()","bingadsapi::service::new()","bingadsapi::soaphasheable#normalize_hash_keys()","bingadsapi::soaphasheable#object_to_hash()","bingadsapi::reportrequeststatus#pending?()","bingadsapi::reporting#poll_generate_report()","bingadsapi::helpers::scopehelper#scope_to_hash()","bingadsapi::config#service_wsdl()","bingadsapi::helpers::filterhelper#solve_filter_value()","bingadsapi::reporting#submit_generate_report()","bingadsapi::reportrequeststatus#success?()","bingadsapi::helpers::timehelper#time_to_hash()","bingadsapi::accountperformancereportrequest#to_hash()","bingadsapi::adgroup#to_hash()","bingadsapi::campaignperformancereportrequest#to_hash()","bingadsapi::mobilead#to_hash()","bingadsapi::performancereportrequest#to_hash()","bingadsapi::productad#to_hash()","bingadsapi::reportrequest#to_hash()","bingadsapi::soaphasheable#to_hash()","bingadsapi::textad#to_hash()","bingadsapi::adapifaultdetail#to_s()","bingadsapi::apiexception#to_s()","bingadsapi::apifaultdetail#to_s()","bingadsapi::applicationfault#to_s()","bingadsapi::batcherror#to_s()","bingadsapi::dataobject#to_s()","bingadsapi::editorialerror#to_s()","bingadsapi::operationerror#to_s()","bingadsapi::partialerrors#to_s()","bingadsapi::campaignmanagement#update_ad_groups()","bingadsapi::campaignmanagement#update_ads()","bingadsapi::campaignmanagement#update_campaigns()","bingadsapi::helpers::columnhelper#valid_columns()","bingadsapi::helpers::filterhelper#valid_filter()","bingadsapi::helpers::filterhelper#valid_filter_value()","bingadsapi::helpers::scopehelper#valid_scope()","bingadsapi::helpers::timehelper#valid_time()",""],"info":[["BingAdsApi","","BingAdsApi.html","","

    Public : This is the main namespace for all classes and submodules in this\nBingAdsApi Gem\n

    Author — jlopezn@ …\n\n"],["BingAdsApi::AccountPerformanceReportRequest","","BingAdsApi/AccountPerformanceReportRequest.html","","

    Public : Defines the base object for all report requests. Do not\ninstantiate this object. Instead, you …\n"],["BingAdsApi::Ad","","BingAdsApi/Ad.html","","

    Public : Defines the base object of an ad. Do not instantiate this object.\nInstead you can instantiate …\n"],["BingAdsApi::AdApiError","","BingAdsApi/AdApiError.html","","

    Public : Defines an error object that contains the details that explain why\nthe service operation failed. …\n"],["BingAdsApi::AdApiFaultDetail","","BingAdsApi/AdApiFaultDetail.html","","

    Public : Defines a fault object that operations return when generic errors\noccur, such as an authentication …\n"],["BingAdsApi::AdGroup","","BingAdsApi/AdGroup.html","","

    Public : Defines an ad group.\n

    Author — jlopezn@neonline.cl\n\n

    Examples\n"],["BingAdsApi::AdLanguage","","BingAdsApi/AdLanguage.html","","

    Public : Utility class for AdLanguages values\n

    Example\n\n

    BingAdsApi::AdLanguages.SPANISH\n# => 'Spanish'\nBingAdsApi::AdLanguages.SPANISH_CODE ...\n
    \n"],["BingAdsApi::ApiException","","BingAdsApi/ApiException.html","","

    Public : Generic exception thrown by service classes in BingAdsApi.\n\n

    Exception of this kind wrap an AdApiFaultDetail ...
    \n"],["BingAdsApi::ApiFaultDetail","","BingAdsApi/ApiFaultDetail.html","","

    Public : Defines a fault object that operations return when web\nservice-specific errors occur, such …\n"],["BingAdsApi::ApplicationFault","","BingAdsApi/ApplicationFault.html","","

    Public : Defines the base object from which all fault detail objects\nderive.\n

    Reference:\nmsdn.microsoft.com/en-US/library/bing-ads-overview-applicationfault.aspx …\n"],["BingAdsApi::BatchError","","BingAdsApi/BatchError.html","","

    Public : Defines an error object that identifies the item within the batch\nof items in the request message …\n"],["BingAdsApi::Campaign","","BingAdsApi/Campaign.html","","

    Public : Define a campaign\n

    Author — jlopezn@neonline.cl\n\n

    Examples\n"],["BingAdsApi::CampaignManagement","","BingAdsApi/CampaignManagement.html","","

    Public : This class represents the Campaign Management Services defined in\nthe Bing Ads API, to manage …\n"],["BingAdsApi::CampaignPerformanceReportRequest","","BingAdsApi/CampaignPerformanceReportRequest.html","","

    Public : Defines the base object for all report requests. Do not\ninstantiate this object. Instead, you …\n"],["BingAdsApi::ClientProxy","","BingAdsApi/ClientProxy.html","","

    Public : ClientProxy es un objeto para encapsular la conexión y request\n\n

    de servicios a la API de Bing. ...
    \n"],["BingAdsApi::Config","","BingAdsApi/Config.html","","

    Public : Helper class for configuration issues like WSDL URLs and constants\n

    Author — author@neonline.cl …\n\n"],["BingAdsApi::DataObject","","BingAdsApi/DataObject.html","","

    Public : Base Class to define Bing API data objects Do not use this class\ndirectly, use any of the derived …\n"],["BingAdsApi::EditorialError","","BingAdsApi/EditorialError.html","","

    Public : Subclass of BatchError present in AdAdds operations Defines an\nerror object that identifies …\n"],["BingAdsApi::Helpers","","BingAdsApi/Helpers.html","",""],["BingAdsApi::Helpers::ColumnHelper","","BingAdsApi/Helpers/ColumnHelper.html","","

    Public : Utility module\n

    Author — jlopezn@neonline.cl\n\n"],["BingAdsApi::Helpers::FilterHelper","","BingAdsApi/Helpers/FilterHelper.html","","

    Public : Utility module for filter attribute in ReportRequest\nderived classes\n

    Author — jlopezn@neonline.cl …\n\n"],["BingAdsApi::Helpers::ScopeHelper","","BingAdsApi/Helpers/ScopeHelper.html","","

    Public : Utility module for scope attribute in ReportRequest\nderived classes\n

    Author — jlopezn@neonline.cl …\n\n"],["BingAdsApi::Helpers::TimeHelper","","BingAdsApi/Helpers/TimeHelper.html","","

    Public : Utility module\n

    Author — jlopezn@neonline.cl\n\n"],["BingAdsApi::MobileAd","","BingAdsApi/MobileAd.html","","

    Public : Defines a mobile ad. A mobile ad is displayed to a user when the\nad is viewed on a low-fi mobile …\n"],["BingAdsApi::OperationError","","BingAdsApi/OperationError.html","","

    Public : Defines an error object that contains the details that explain why\nthe service operation failed. …\n"],["BingAdsApi::PartialErrors","","BingAdsApi/PartialErrors.html","","

    Public : Defines an array of error that occur when adding ads\n

    Author — jlopezn@neonline.cl\n\n"],["BingAdsApi::PerformanceReportRequest","","BingAdsApi/PerformanceReportRequest.html","","

    Public : Defines the base class for ‘performance report requests’. Do not\ninstantiate this object. Instead …\n"],["BingAdsApi::ProductAd","","BingAdsApi/ProductAd.html","","

    Public : Defines a product ad.\n

    Reference:\nmsdn.microsoft.com/en-US/library/bing-ads-productad-campaign-management.aspx\n…\n"],["BingAdsApi::ReportAggregation","","BingAdsApi/ReportAggregation.html","","

    Public : Module for Reporting languages\n

    Example\n\n

    BingAdsApi::ReportAggregation.SUMMARY\n# => 'Summary'\nBingAdsApi::ReportAggregation.HOURLY ...\n
    \n"],["BingAdsApi::ReportFormat","","BingAdsApi/ReportFormat.html","","

    Public : Module for Reporting formats\n

    Example\n\n

    BingAdsApi::ReportFormat.CSV\n# => 'Csv'\n
    \n"],["BingAdsApi::ReportLanguage","","BingAdsApi/ReportLanguage.html","","

    Public : Module for Reporting languages\n

    Example\n\n

    BingAdsApi::ReportLanguage.ENGLISH\n# => 'English'\n
    \n"],["BingAdsApi::ReportRequest","","BingAdsApi/ReportRequest.html","","

    Public : Defines the base object for all report requests. Do not\ninstantiate this object. Instead, you …\n"],["BingAdsApi::ReportRequestStatus","","BingAdsApi/ReportRequestStatus.html","","

    Public : Defines the status of a report request.\n

    Reference:\nmsdn.microsoft.com/en-US/library/bing-ads-reporting-bing-ads-reportrequeststatus.aspx\n…\n"],["BingAdsApi::ReportTimePeriods","","BingAdsApi/ReportTimePeriods.html","","

    Public : Module for Reporting languages\n

    Example\n\n

    BingAdsApi::ReportTimePeriods.TODAY\n# => 'Today'\nBingAdsApi::ReportTimePeriods.LAST_WEEK ...\n
    \n"],["BingAdsApi::Reporting","","BingAdsApi/Reporting.html","","

    Public : This class represents the Reporting Services defined in the Bing\nAds API, to request and download …\n"],["BingAdsApi::SOAPHasheable","","BingAdsApi/SOAPHasheable.html","","

    Public — Module to define an object as Hasheable for the SOAP requests\n

    Author — jlopezn@neonline.cl\n\n"],["BingAdsApi::Service","","BingAdsApi/Service.html","","

    Public : Base class for service object\n

    Author — jlopezn@neonline.cl\n\n"],["BingAdsApi::TextAd","","BingAdsApi/TextAd.html","","

    Public : Defines a text ad.\n

    Reference:\nmsdn.microsoft.com/en-US/library/bing-ads-campaign-management-textad.aspx …\n"],["BingAdsApi::TimeZone","","BingAdsApi/TimeZone.html","","

    Public : Utility class for TimeZones values\n

    Example\n\n

    BingAdsApi::TimeZone.SANTIAGO\n# => 'Santiago'\n
    \n"],["add_ad_groups","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-add_ad_groups","(campaign_id, ad_groups)","

    Public : Adds 1 or more AdGroups to a Campaign\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["add_ads","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-add_ads","(ad_group_id, ads)","

    Public : Add ads into a specified ad group\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["add_campaigns","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-add_campaigns","(account_id, campaigns)","

    Public : Adds a campaign to the specified account\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["call","BingAdsApi::ClientProxy","BingAdsApi/ClientProxy.html#method-i-call","(service_name, message, options={})","

    Public : Delegate for Savon::Client.call method\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["call","BingAdsApi::Service","BingAdsApi/Service.html#method-i-call","(operation, message, &block)","

    Public : This is a utility wrapper for calling services into the \nClientProxy. This methods handle all …\n"],["columns_to_hash","BingAdsApi::Helpers::ColumnHelper","BingAdsApi/Helpers/ColumnHelper.html#method-i-columns_to_hash","(valid_columns, columns, keys_case=:underscore)","

    Public : Return the columns attribute of the ReportRequest as a valid Hash\nfor SOAP requests\n

    Author — "],["date_to_hash","BingAdsApi::SOAPHasheable","BingAdsApi/SOAPHasheable.html#method-i-date_to_hash","(date, keys_case)","

    Internal : Returns a DateTime as a hash for SOAP requests\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["error?","BingAdsApi::ReportRequestStatus","BingAdsApi/ReportRequestStatus.html#method-i-error-3F","()","

    Public — Returns true if the status is error\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["filter_to_hash","BingAdsApi::Helpers::FilterHelper","BingAdsApi/Helpers/FilterHelper.html#method-i-filter_to_hash","(valid_filters, keys_case=:undescore)","

    Public : Returns the filter attribute as a Hash to SOAP requests\n

    Author — jlopezn@neonline.cl\n\n

    filter - …\n"],["get_ad_groups_by_campaign_id","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-get_ad_groups_by_campaign_id","(campaign_id)","

    Public : Returns all the ad groups that belongs to the specified campaign\n

    Author — jlopezn@neonline.cl …\n\n"],["get_ad_groups_by_ids","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-get_ad_groups_by_ids","(campaign_id, ad_groups_ids)","

    Public : Returns the specified ad groups that belongs to the specified\ncampaign\n

    Author — jlopezn@neonline.cl …\n\n"],["get_ads_by_ad_group_id","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-get_ads_by_ad_group_id","(ad_group_id)","

    Public : Obtains all the ads associated to the specified ad group\n

    Author — jlopezn@neonline.cl\n\n

    Parameters …\n"],["get_ads_by_ids","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-get_ads_by_ids","(ad_group_id, ad_ids)","

    Public : Obtains the ads indicated in ad_ids associated to the specified ad\ngroup\n

    Author — jlopezn@neonline.cl …\n\n"],["get_attribute_key","BingAdsApi::SOAPHasheable","BingAdsApi/SOAPHasheable.html#method-i-get_attribute_key","(attribute, keys_case = :underscore)","

    Internal : Helper method to determinate the key name in the hash for the\nSOAP request\n

    Author — jlopezn@ …\n\n"],["get_campaigns_by_account_id","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-get_campaigns_by_account_id","(account_id)","

    Public : Returns all the campaigns found in the specified account\n

    Author — jlopezn@neonline.cl\n\n

    Parameters …\n"],["get_response_hash","BingAdsApi::Service","BingAdsApi/Service.html#method-i-get_response_hash","(response, method)","

    Public : Extracts the actual response from the entire response hash. For\nexample, if you specify ‘AddCampaigns’, …\n"],["hash_instance","BingAdsApi::Config","BingAdsApi/Config.html#method-c-hash_instance","()","

    Public : Returns the config file as an Hash instance\n

    Author — jlopezn@neonline.cl\n

    Returns — Hash\n"],["new","BingAdsApi::AccountPerformanceReportRequest","BingAdsApi/AccountPerformanceReportRequest.html#method-c-new","(attributes={})","

    Public : Constructor. Adds a validations for the columns, filter and scope\nattributes\n

    Author — jlopezn@ …\n\n"],["new","BingAdsApi::AdApiFaultDetail","BingAdsApi/AdApiFaultDetail.html#method-c-new","(attributes={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    attributes - Hash with the initial attributes\n"],["new","BingAdsApi::AdGroup","BingAdsApi/AdGroup.html#method-c-new","(attributes={})","

    Public : Constructor in a ActiveRecord style, with a hash of attributes as\ninput\n

    Author — jlopezn@neonline.cl …\n\n"],["new","BingAdsApi::ApiException","BingAdsApi/ApiException.html#method-c-new","(fault_object, msg=nil)","

    Public : Constructor. Based on the default Exception constructor, adds the\nfault_object instance, that …\n"],["new","BingAdsApi::ApiFaultDetail","BingAdsApi/ApiFaultDetail.html#method-c-new","(attributes={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    attributes - Hash with the initial attributes\n"],["new","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-c-new","(options={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    options - Hash with the parameters for the client proxy …\n"],["new","BingAdsApi::CampaignPerformanceReportRequest","BingAdsApi/CampaignPerformanceReportRequest.html#method-c-new","(attributes={})","

    Public : Constructor. Adds a validations for the columns, filter and scope\nattributes\n

    Author — jlopezn@ …\n\n"],["new","BingAdsApi::ClientProxy","BingAdsApi/ClientProxy.html#method-c-new","(options=nil)","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["new","BingAdsApi::Config","BingAdsApi/Config.html#method-c-new","()","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n"],["new","BingAdsApi::DataObject","BingAdsApi/DataObject.html#method-c-new","(attributes={})","

    Public : Constructor in a ActiveRecord style, with a hash of attributes as\ninput\n

    Author — jlopezn@neonline.cl …\n\n"],["new","BingAdsApi::PartialErrors","BingAdsApi/PartialErrors.html#method-c-new","(attributes={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    attributes - Hash with the initial attributes\n"],["new","BingAdsApi::PerformanceReportRequest","BingAdsApi/PerformanceReportRequest.html#method-c-new","(attributes={})","

    Public : Constructor. Adds validations to aggregations and time\n

    Author — jlopezn@neonline.cl\n\n

    Parameters …\n"],["new","BingAdsApi::ReportRequest","BingAdsApi/ReportRequest.html#method-c-new","(attributes={})","

    Public : Constructor. Adds validations to format and language attributes\n

    Author — jlopezn@neonline.cl …\n\n"],["new","BingAdsApi::Service","BingAdsApi/Service.html#method-c-new","(options={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["normalize_hash_keys","BingAdsApi::SOAPHasheable","BingAdsApi/SOAPHasheable.html#method-i-normalize_hash_keys","(hash, keys_case)",""],["object_to_hash","BingAdsApi::SOAPHasheable","BingAdsApi/SOAPHasheable.html#method-i-object_to_hash","(object, keys_case=:underscore)","

    Internal: Internal method to return an object as a SOAP Request alike hash\nIf the object is an array, …\n"],["pending?","BingAdsApi::ReportRequestStatus","BingAdsApi/ReportRequestStatus.html#method-i-pending-3F","()","

    Public — Returns true if the status is pending\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["poll_generate_report","BingAdsApi::Reporting","BingAdsApi/Reporting.html#method-i-poll_generate_report","(report_request_id)","

    Public : Get the status of a report request\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["scope_to_hash","BingAdsApi::Helpers::ScopeHelper","BingAdsApi/Helpers/ScopeHelper.html#method-i-scope_to_hash","(keys_case=:undescore)","

    Public : Returns the filter attribute as a Hash to SOAP requests\n

    Author — jlopezn@neonline.cl\n\n

    filter - …\n"],["service_wsdl","BingAdsApi::Config","BingAdsApi/Config.html#method-i-service_wsdl","(environment, service)","

    Public : Returns a String with WSDL url for the service indicated\n

    Author — jlopezn@neonline.cl\n\n

    Parameters …\n"],["solve_filter_value","BingAdsApi::Helpers::FilterHelper","BingAdsApi/Helpers/FilterHelper.html#method-i-solve_filter_value","(filter_criteria, filter_value)","

    Internal — Solves the Bing value for the given filter attribute\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["submit_generate_report","BingAdsApi::Reporting","BingAdsApi/Reporting.html#method-i-submit_generate_report","(report_request)","

    Public : Submits a report request\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["success?","BingAdsApi::ReportRequestStatus","BingAdsApi/ReportRequestStatus.html#method-i-success-3F","()","

    Public — Returns true if the status is success\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["time_to_hash","BingAdsApi::Helpers::TimeHelper","BingAdsApi/Helpers/TimeHelper.html#method-i-time_to_hash","(keys_case)","

    Public : Return the time attribute of the ReportRequest as a valid Hash for\nSOAP requests\n

    Author — jlopezn@ …\n\n"],["to_hash","BingAdsApi::AccountPerformanceReportRequest","BingAdsApi/AccountPerformanceReportRequest.html#method-i-to_hash","(keys = :underscore)","

    Public — Returns the object as a Hash valid for SOAP requests\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["to_hash","BingAdsApi::AdGroup","BingAdsApi/AdGroup.html#method-i-to_hash","(keys = :underscore)","

    Public : Returns this object as a hash to SOAP requests This methods is a\nspecialization for the +DataObject#to_hash …\n"],["to_hash","BingAdsApi::CampaignPerformanceReportRequest","BingAdsApi/CampaignPerformanceReportRequest.html#method-i-to_hash","(keys = :underscore)","

    Public — Returns the object as a Hash valid for SOAP requests\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["to_hash","BingAdsApi::MobileAd","BingAdsApi/MobileAd.html#method-i-to_hash","(keys = :underscore)","

    Public : Specification of DataObject#to_hash method that ads the type\nattribute based on this specific …\n"],["to_hash","BingAdsApi::PerformanceReportRequest","BingAdsApi/PerformanceReportRequest.html#method-i-to_hash","(keys_case = :underscore)","

    Public — Returns this object as a Hash for SOAP Requests\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["to_hash","BingAdsApi::ProductAd","BingAdsApi/ProductAd.html#method-i-to_hash","(keys = :underscore)","

    Public : Specification of DataObject#to_hash method that ads the type\nattribute based on this specific …\n"],["to_hash","BingAdsApi::ReportRequest","BingAdsApi/ReportRequest.html#method-i-to_hash","(keys_case = :underscore)","

    Public — Returns this object as a Hash for SOAP Requests\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["to_hash","BingAdsApi::SOAPHasheable","BingAdsApi/SOAPHasheable.html#method-i-to_hash","(keys_case=:underscore)","

    Internal: Metodo custom para transformar a hash un objeto. Se puede indicar\nsi se desean las keys en …\n"],["to_hash","BingAdsApi::TextAd","BingAdsApi/TextAd.html#method-i-to_hash","(keys = :underscore)","

    Public : Specification of DataObject#to_hash method that ads the type\nattribute based on this specific …\n"],["to_s","BingAdsApi::AdApiFaultDetail","BingAdsApi/AdApiFaultDetail.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::ApiException","BingAdsApi/ApiException.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::ApiFaultDetail","BingAdsApi/ApiFaultDetail.html#method-i-to_s","()","

    Public : Specific to string\n

    Author — jlopezn@neonline.cl\n

    Returns — the object ‘stringified’\n"],["to_s","BingAdsApi::ApplicationFault","BingAdsApi/ApplicationFault.html#method-i-to_s","()",""],["to_s","BingAdsApi::BatchError","BingAdsApi/BatchError.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::DataObject","BingAdsApi/DataObject.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::EditorialError","BingAdsApi/EditorialError.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::OperationError","BingAdsApi/OperationError.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::PartialErrors","BingAdsApi/PartialErrors.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["update_ad_groups","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-update_ad_groups","(campaign_id, ad_groups)","

    Public : Updates on or more ad groups in a specified campaign\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["update_ads","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-update_ads","(ad_group_id, ads)","

    Public : Updates ads for the specified ad group\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["update_campaigns","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-update_campaigns","(account_id, campaigns)","

    Public : Updates on or more campaigns for the specified account\n

    Author — jlopezn@neonline.cl\n\n

    Parameters …\n"],["valid_columns","BingAdsApi::Helpers::ColumnHelper","BingAdsApi/Helpers/ColumnHelper.html#method-i-valid_columns","(valid_columns, columns)","

    Internal : Validates the specified columns at the ReporRequest\ninitialization At the first invalid column …\n"],["valid_filter","BingAdsApi::Helpers::FilterHelper","BingAdsApi/Helpers/FilterHelper.html#method-i-valid_filter","(valid_filters, filter)","

    Internal : Validates the filter attribute at the ReporRequest\ninitialization At the first invalid filter …\n"],["valid_filter_value","BingAdsApi::Helpers::FilterHelper","BingAdsApi/Helpers/FilterHelper.html#method-i-valid_filter_value","(key, value)","

    Internal : Validates a specific filter criteria and his value\n

    Author — jlopezn@neonline.cl\n\n

    key - filter …\n"],["valid_scope","BingAdsApi::Helpers::ScopeHelper","BingAdsApi/Helpers/ScopeHelper.html#method-i-valid_scope","(valid_scopes, scope)","

    Internal : Validates the filter attribute at the ReporRequest\ninitialization At the first invalid filter …\n"],["valid_time","BingAdsApi::Helpers::TimeHelper","BingAdsApi/Helpers/TimeHelper.html#method-i-valid_time","(time)","

    Public : Validates the time attribute present in some report request\n

    Author — jlopezn@neonline.cl\n\n

    time …\n"],["README","","README_rdoc.html","","

    BingAdsApi\n

    This project rocks and uses MIT-LICENSE.\n

    Presentation\n"]]}} \ No newline at end of file +var search_data = {"index":{"searchIndex":["bingadsapi","accountinfo","accountperformancereportrequest","ad","adapierror","adapifaultdetail","adgroup","adlanguage","apiexception","apifaultdetail","applicationfault","batcherror","campaign","campaignmanagement","campaignperformancereportrequest","clientproxy","config","customermanagement","dataobject","editorialerror","helpers","columnhelper","filterhelper","scopehelper","timehelper","mobilead","operationerror","partialerrors","performancereportrequest","productad","reportaggregation","reportformat","reportlanguage","reportrequest","reportrequeststatus","reporttimeperiods","reporting","soaphasheable","service","textad","timezone","active?()","add_ad_groups()","add_ads()","add_campaigns()","call()","call()","columns_to_hash()","date_to_hash()","draft?()","error?()","filter_to_hash()","get_accounts_info()","get_ad_groups_by_campaign_id()","get_ad_groups_by_ids()","get_ads_by_ad_group_id()","get_ads_by_ids()","get_attribute_key()","get_campaigns_by_account_id()","get_response_hash()","hash_instance()","inactive?()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","normalize_hash_keys()","object_to_hash()","pause?()","pending?()","pending?()","poll_generate_report()","scope_to_hash()","service_wsdl()","solve_filter_value()","submit_generate_report()","success?()","time_to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_hash()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","update_ad_groups()","update_ads()","update_campaigns()","valid_columns()","valid_filter()","valid_filter_value()","valid_scope()","valid_time()","readme"],"longSearchIndex":["bingadsapi","bingadsapi::accountinfo","bingadsapi::accountperformancereportrequest","bingadsapi::ad","bingadsapi::adapierror","bingadsapi::adapifaultdetail","bingadsapi::adgroup","bingadsapi::adlanguage","bingadsapi::apiexception","bingadsapi::apifaultdetail","bingadsapi::applicationfault","bingadsapi::batcherror","bingadsapi::campaign","bingadsapi::campaignmanagement","bingadsapi::campaignperformancereportrequest","bingadsapi::clientproxy","bingadsapi::config","bingadsapi::customermanagement","bingadsapi::dataobject","bingadsapi::editorialerror","bingadsapi::helpers","bingadsapi::helpers::columnhelper","bingadsapi::helpers::filterhelper","bingadsapi::helpers::scopehelper","bingadsapi::helpers::timehelper","bingadsapi::mobilead","bingadsapi::operationerror","bingadsapi::partialerrors","bingadsapi::performancereportrequest","bingadsapi::productad","bingadsapi::reportaggregation","bingadsapi::reportformat","bingadsapi::reportlanguage","bingadsapi::reportrequest","bingadsapi::reportrequeststatus","bingadsapi::reporttimeperiods","bingadsapi::reporting","bingadsapi::soaphasheable","bingadsapi::service","bingadsapi::textad","bingadsapi::timezone","bingadsapi::accountinfo#active?()","bingadsapi::campaignmanagement#add_ad_groups()","bingadsapi::campaignmanagement#add_ads()","bingadsapi::campaignmanagement#add_campaigns()","bingadsapi::clientproxy#call()","bingadsapi::service#call()","bingadsapi::helpers::columnhelper#columns_to_hash()","bingadsapi::soaphasheable#date_to_hash()","bingadsapi::accountinfo#draft?()","bingadsapi::reportrequeststatus#error?()","bingadsapi::helpers::filterhelper#filter_to_hash()","bingadsapi::customermanagement#get_accounts_info()","bingadsapi::campaignmanagement#get_ad_groups_by_campaign_id()","bingadsapi::campaignmanagement#get_ad_groups_by_ids()","bingadsapi::campaignmanagement#get_ads_by_ad_group_id()","bingadsapi::campaignmanagement#get_ads_by_ids()","bingadsapi::soaphasheable#get_attribute_key()","bingadsapi::campaignmanagement#get_campaigns_by_account_id()","bingadsapi::service#get_response_hash()","bingadsapi::config::hash_instance()","bingadsapi::accountinfo#inactive?()","bingadsapi::accountperformancereportrequest::new()","bingadsapi::adapifaultdetail::new()","bingadsapi::adgroup::new()","bingadsapi::apiexception::new()","bingadsapi::apifaultdetail::new()","bingadsapi::campaignmanagement::new()","bingadsapi::campaignperformancereportrequest::new()","bingadsapi::clientproxy::new()","bingadsapi::config::new()","bingadsapi::customermanagement::new()","bingadsapi::dataobject::new()","bingadsapi::partialerrors::new()","bingadsapi::performancereportrequest::new()","bingadsapi::reportrequest::new()","bingadsapi::service::new()","bingadsapi::soaphasheable#normalize_hash_keys()","bingadsapi::soaphasheable#object_to_hash()","bingadsapi::accountinfo#pause?()","bingadsapi::accountinfo#pending?()","bingadsapi::reportrequeststatus#pending?()","bingadsapi::reporting#poll_generate_report()","bingadsapi::helpers::scopehelper#scope_to_hash()","bingadsapi::config#service_wsdl()","bingadsapi::helpers::filterhelper#solve_filter_value()","bingadsapi::reporting#submit_generate_report()","bingadsapi::reportrequeststatus#success?()","bingadsapi::helpers::timehelper#time_to_hash()","bingadsapi::accountperformancereportrequest#to_hash()","bingadsapi::adgroup#to_hash()","bingadsapi::campaignperformancereportrequest#to_hash()","bingadsapi::mobilead#to_hash()","bingadsapi::performancereportrequest#to_hash()","bingadsapi::productad#to_hash()","bingadsapi::reportrequest#to_hash()","bingadsapi::soaphasheable#to_hash()","bingadsapi::textad#to_hash()","bingadsapi::adapifaultdetail#to_s()","bingadsapi::apiexception#to_s()","bingadsapi::apifaultdetail#to_s()","bingadsapi::applicationfault#to_s()","bingadsapi::batcherror#to_s()","bingadsapi::dataobject#to_s()","bingadsapi::editorialerror#to_s()","bingadsapi::operationerror#to_s()","bingadsapi::partialerrors#to_s()","bingadsapi::campaignmanagement#update_ad_groups()","bingadsapi::campaignmanagement#update_ads()","bingadsapi::campaignmanagement#update_campaigns()","bingadsapi::helpers::columnhelper#valid_columns()","bingadsapi::helpers::filterhelper#valid_filter()","bingadsapi::helpers::filterhelper#valid_filter_value()","bingadsapi::helpers::scopehelper#valid_scope()","bingadsapi::helpers::timehelper#valid_time()",""],"info":[["BingAdsApi","","BingAdsApi.html","","

    Public : This is the main namespace for all classes and submodules in this\nBingAdsApi Gem\n

    Author — jlopezn@ …\n\n"],["BingAdsApi::AccountInfo","","BingAdsApi/AccountInfo.html","","

    Public : Define an account info\n

    Author — jlopezn@neonline.cl\n\n

    Examples\n"],["BingAdsApi::AccountPerformanceReportRequest","","BingAdsApi/AccountPerformanceReportRequest.html","","

    Public : Defines the base object for all report requests. Do not\ninstantiate this object. Instead, you …\n"],["BingAdsApi::Ad","","BingAdsApi/Ad.html","","

    Public : Defines the base object of an ad. Do not instantiate this object.\nInstead you can instantiate …\n"],["BingAdsApi::AdApiError","","BingAdsApi/AdApiError.html","","

    Public : Defines an error object that contains the details that explain why\nthe service operation failed. …\n"],["BingAdsApi::AdApiFaultDetail","","BingAdsApi/AdApiFaultDetail.html","","

    Public : Defines a fault object that operations return when generic errors\noccur, such as an authentication …\n"],["BingAdsApi::AdGroup","","BingAdsApi/AdGroup.html","","

    Public : Defines an ad group.\n

    Author — jlopezn@neonline.cl\n\n

    Examples\n"],["BingAdsApi::AdLanguage","","BingAdsApi/AdLanguage.html","","

    Public : Utility class for AdLanguages values\n

    Example\n\n

    BingAdsApi::AdLanguages.SPANISH\n# => 'Spanish'\nBingAdsApi::AdLanguages.SPANISH_CODE ...\n
    \n"],["BingAdsApi::ApiException","","BingAdsApi/ApiException.html","","

    Public : Generic exception thrown by service classes in BingAdsApi.\n\n

    Exception of this kind wrap an AdApiFaultDetail ...
    \n"],["BingAdsApi::ApiFaultDetail","","BingAdsApi/ApiFaultDetail.html","","

    Public : Defines a fault object that operations return when web\nservice-specific errors occur, such …\n"],["BingAdsApi::ApplicationFault","","BingAdsApi/ApplicationFault.html","","

    Public : Defines the base object from which all fault detail objects\nderive.\n

    Reference:\nmsdn.microsoft.com/en-US/library/bing-ads-overview-applicationfault.aspx …\n"],["BingAdsApi::BatchError","","BingAdsApi/BatchError.html","","

    Public : Defines an error object that identifies the item within the batch\nof items in the request message …\n"],["BingAdsApi::Campaign","","BingAdsApi/Campaign.html","","

    Public : Define a campaign\n

    Author — jlopezn@neonline.cl\n\n

    Examples\n"],["BingAdsApi::CampaignManagement","","BingAdsApi/CampaignManagement.html","","

    Public : This class represents the Campaign Management Services defined in\nthe Bing Ads API, to manage …\n"],["BingAdsApi::CampaignPerformanceReportRequest","","BingAdsApi/CampaignPerformanceReportRequest.html","","

    Public : Defines the base object for all report requests. Do not\ninstantiate this object. Instead, you …\n"],["BingAdsApi::ClientProxy","","BingAdsApi/ClientProxy.html","","

    Public : ClientProxy es un objeto para encapsular la conexión y request\n\n

    de servicios a la API de Bing. ...
    \n"],["BingAdsApi::Config","","BingAdsApi/Config.html","","

    Public : Helper class for configuration issues like WSDL URLs and constants\n

    Author — author@neonline.cl …\n\n"],["BingAdsApi::CustomerManagement","","BingAdsApi/CustomerManagement.html","","

    Public : This class represents the Customer Management Services defined in\nthe Bing Ads API, to manage …\n"],["BingAdsApi::DataObject","","BingAdsApi/DataObject.html","","

    Public : Base Class to define Bing API data objects Do not use this class\ndirectly, use any of the derived …\n"],["BingAdsApi::EditorialError","","BingAdsApi/EditorialError.html","","

    Public : Subclass of BatchError present in AdAdds operations Defines an\nerror object that identifies …\n"],["BingAdsApi::Helpers","","BingAdsApi/Helpers.html","",""],["BingAdsApi::Helpers::ColumnHelper","","BingAdsApi/Helpers/ColumnHelper.html","","

    Public : Utility module\n

    Author — jlopezn@neonline.cl\n\n"],["BingAdsApi::Helpers::FilterHelper","","BingAdsApi/Helpers/FilterHelper.html","","

    Public : Utility module for filter attribute in ReportRequest\nderived classes\n

    Author — jlopezn@neonline.cl …\n\n"],["BingAdsApi::Helpers::ScopeHelper","","BingAdsApi/Helpers/ScopeHelper.html","","

    Public : Utility module for scope attribute in ReportRequest\nderived classes\n

    Author — jlopezn@neonline.cl …\n\n"],["BingAdsApi::Helpers::TimeHelper","","BingAdsApi/Helpers/TimeHelper.html","","

    Public : Utility module\n

    Author — jlopezn@neonline.cl\n\n"],["BingAdsApi::MobileAd","","BingAdsApi/MobileAd.html","","

    Public : Defines a mobile ad. A mobile ad is displayed to a user when the\nad is viewed on a low-fi mobile …\n"],["BingAdsApi::OperationError","","BingAdsApi/OperationError.html","","

    Public : Defines an error object that contains the details that explain why\nthe service operation failed. …\n"],["BingAdsApi::PartialErrors","","BingAdsApi/PartialErrors.html","","

    Public : Defines an array of error that occur when adding ads\n

    Author — jlopezn@neonline.cl\n\n"],["BingAdsApi::PerformanceReportRequest","","BingAdsApi/PerformanceReportRequest.html","","

    Public : Defines the base class for ‘performance report requests’. Do not\ninstantiate this object. Instead …\n"],["BingAdsApi::ProductAd","","BingAdsApi/ProductAd.html","","

    Public : Defines a product ad.\n

    Reference:\nmsdn.microsoft.com/en-US/library/bing-ads-productad-campaign-management.aspx\n…\n"],["BingAdsApi::ReportAggregation","","BingAdsApi/ReportAggregation.html","","

    Public : Module for Reporting languages\n

    Example\n\n

    BingAdsApi::ReportAggregation.SUMMARY\n# => 'Summary'\nBingAdsApi::ReportAggregation.HOURLY ...\n
    \n"],["BingAdsApi::ReportFormat","","BingAdsApi/ReportFormat.html","","

    Public : Module for Reporting formats\n

    Example\n\n

    BingAdsApi::ReportFormat.CSV\n# => 'Csv'\n
    \n"],["BingAdsApi::ReportLanguage","","BingAdsApi/ReportLanguage.html","","

    Public : Module for Reporting languages\n

    Example\n\n

    BingAdsApi::ReportLanguage.ENGLISH\n# => 'English'\n
    \n"],["BingAdsApi::ReportRequest","","BingAdsApi/ReportRequest.html","","

    Public : Defines the base object for all report requests. Do not\ninstantiate this object. Instead, you …\n"],["BingAdsApi::ReportRequestStatus","","BingAdsApi/ReportRequestStatus.html","","

    Public : Defines the status of a report request.\n

    Reference:\nmsdn.microsoft.com/en-US/library/bing-ads-reporting-bing-ads-reportrequeststatus.aspx\n…\n"],["BingAdsApi::ReportTimePeriods","","BingAdsApi/ReportTimePeriods.html","","

    Public : Module for Reporting languages\n

    Example\n\n

    BingAdsApi::ReportTimePeriods.TODAY\n# => 'Today'\nBingAdsApi::ReportTimePeriods.LAST_WEEK ...\n
    \n"],["BingAdsApi::Reporting","","BingAdsApi/Reporting.html","","

    Public : This class represents the Reporting Services defined in the Bing\nAds API, to request and download …\n"],["BingAdsApi::SOAPHasheable","","BingAdsApi/SOAPHasheable.html","","

    Public — Module to define an object as Hasheable for the SOAP requests\n

    Author — jlopezn@neonline.cl\n\n"],["BingAdsApi::Service","","BingAdsApi/Service.html","","

    Public : Base class for service object\n

    Author — jlopezn@neonline.cl\n\n"],["BingAdsApi::TextAd","","BingAdsApi/TextAd.html","","

    Public : Defines a text ad.\n

    Reference:\nmsdn.microsoft.com/en-US/library/bing-ads-campaign-management-textad.aspx …\n"],["BingAdsApi::TimeZone","","BingAdsApi/TimeZone.html","","

    Public : Utility class for TimeZones values\n

    Example\n\n

    BingAdsApi::TimeZone.SANTIAGO\n# => 'Santiago'\n
    \n"],["active?","BingAdsApi::AccountInfo","BingAdsApi/AccountInfo.html#method-i-active-3F","()","

    Public — Returns true if the account is in status active\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["add_ad_groups","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-add_ad_groups","(campaign_id, ad_groups)","

    Public : Adds 1 or more AdGroups to a Campaign\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["add_ads","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-add_ads","(ad_group_id, ads)","

    Public : Add ads into a specified ad group\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["add_campaigns","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-add_campaigns","(account_id, campaigns)","

    Public : Adds a campaign to the specified account\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["call","BingAdsApi::ClientProxy","BingAdsApi/ClientProxy.html#method-i-call","(service_name, message, options={})","

    Public : Delegate for Savon::Client.call method\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["call","BingAdsApi::Service","BingAdsApi/Service.html#method-i-call","(operation, message, &block)","

    Public : This is a utility wrapper for calling services into the \nClientProxy. This methods handle all …\n"],["columns_to_hash","BingAdsApi::Helpers::ColumnHelper","BingAdsApi/Helpers/ColumnHelper.html#method-i-columns_to_hash","(valid_columns, columns, keys_case=:underscore)","

    Public : Return the columns attribute of the ReportRequest as a valid Hash\nfor SOAP requests\n

    Author — "],["date_to_hash","BingAdsApi::SOAPHasheable","BingAdsApi/SOAPHasheable.html#method-i-date_to_hash","(date, keys_case)","

    Internal : Returns a DateTime as a hash for SOAP requests\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["draft?","BingAdsApi::AccountInfo","BingAdsApi/AccountInfo.html#method-i-draft-3F","()","

    Public — Returns true if the account is in status draft\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["error?","BingAdsApi::ReportRequestStatus","BingAdsApi/ReportRequestStatus.html#method-i-error-3F","()","

    Public — Returns true if the status is error\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["filter_to_hash","BingAdsApi::Helpers::FilterHelper","BingAdsApi/Helpers/FilterHelper.html#method-i-filter_to_hash","(valid_filters, keys_case=:undescore)","

    Public : Returns the filter attribute as a Hash to SOAP requests\n

    Author — jlopezn@neonline.cl\n\n

    filter - …\n"],["get_accounts_info","BingAdsApi::CustomerManagement","BingAdsApi/CustomerManagement.html#method-i-get_accounts_info","(customer_id=nil, only_parent_accounts=false)","

    Public : Gets a list of objects that contains account identification\ninformation, for example the name …\n"],["get_ad_groups_by_campaign_id","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-get_ad_groups_by_campaign_id","(campaign_id)","

    Public : Returns all the ad groups that belongs to the specified campaign\n

    Author — jlopezn@neonline.cl …\n\n"],["get_ad_groups_by_ids","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-get_ad_groups_by_ids","(campaign_id, ad_groups_ids)","

    Public : Returns the specified ad groups that belongs to the specified\ncampaign\n

    Author — jlopezn@neonline.cl …\n\n"],["get_ads_by_ad_group_id","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-get_ads_by_ad_group_id","(ad_group_id)","

    Public : Obtains all the ads associated to the specified ad group\n

    Author — jlopezn@neonline.cl\n\n

    Parameters …\n"],["get_ads_by_ids","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-get_ads_by_ids","(ad_group_id, ad_ids)","

    Public : Obtains the ads indicated in ad_ids associated to the specified ad\ngroup\n

    Author — jlopezn@neonline.cl …\n\n"],["get_attribute_key","BingAdsApi::SOAPHasheable","BingAdsApi/SOAPHasheable.html#method-i-get_attribute_key","(attribute, keys_case = :underscore)","

    Internal : Helper method to determinate the key name in the hash for the\nSOAP request\n

    Author — jlopezn@ …\n\n"],["get_campaigns_by_account_id","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-get_campaigns_by_account_id","(account_id)","

    Public : Returns all the campaigns found in the specified account\n

    Author — jlopezn@neonline.cl\n\n

    Parameters …\n"],["get_response_hash","BingAdsApi::Service","BingAdsApi/Service.html#method-i-get_response_hash","(response, method)","

    Public : Extracts the actual response from the entire response hash. For\nexample, if you specify ‘AddCampaigns’, …\n"],["hash_instance","BingAdsApi::Config","BingAdsApi/Config.html#method-c-hash_instance","()","

    Public : Returns the config file as an Hash instance\n

    Author — jlopezn@neonline.cl\n

    Returns — Hash\n"],["inactive?","BingAdsApi::AccountInfo","BingAdsApi/AccountInfo.html#method-i-inactive-3F","()","

    Public — Returns true if the account is in status inactive\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["new","BingAdsApi::AccountPerformanceReportRequest","BingAdsApi/AccountPerformanceReportRequest.html#method-c-new","(attributes={})","

    Public : Constructor. Adds a validations for the columns, filter and scope\nattributes\n

    Author — jlopezn@ …\n\n"],["new","BingAdsApi::AdApiFaultDetail","BingAdsApi/AdApiFaultDetail.html#method-c-new","(attributes={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    attributes - Hash with the initial attributes\n"],["new","BingAdsApi::AdGroup","BingAdsApi/AdGroup.html#method-c-new","(attributes={})","

    Public : Constructor in a ActiveRecord style, with a hash of attributes as\ninput\n

    Author — jlopezn@neonline.cl …\n\n"],["new","BingAdsApi::ApiException","BingAdsApi/ApiException.html#method-c-new","(fault_object, msg=nil)","

    Public : Constructor. Based on the default Exception constructor, adds the\nfault_object instance, that …\n"],["new","BingAdsApi::ApiFaultDetail","BingAdsApi/ApiFaultDetail.html#method-c-new","(attributes={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    attributes - Hash with the initial attributes\n"],["new","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-c-new","(options={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    options - Hash with the parameters for the client proxy …\n"],["new","BingAdsApi::CampaignPerformanceReportRequest","BingAdsApi/CampaignPerformanceReportRequest.html#method-c-new","(attributes={})","

    Public : Constructor. Adds a validations for the columns, filter and scope\nattributes\n

    Author — jlopezn@ …\n\n"],["new","BingAdsApi::ClientProxy","BingAdsApi/ClientProxy.html#method-c-new","(options=nil)","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["new","BingAdsApi::Config","BingAdsApi/Config.html#method-c-new","()","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n"],["new","BingAdsApi::CustomerManagement","BingAdsApi/CustomerManagement.html#method-c-new","(options={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    options - Hash with the parameters for the client proxy …\n"],["new","BingAdsApi::DataObject","BingAdsApi/DataObject.html#method-c-new","(attributes={})","

    Public : Constructor in a ActiveRecord style, with a hash of attributes as\ninput\n

    Author — jlopezn@neonline.cl …\n\n"],["new","BingAdsApi::PartialErrors","BingAdsApi/PartialErrors.html#method-c-new","(attributes={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    attributes - Hash with the initial attributes\n"],["new","BingAdsApi::PerformanceReportRequest","BingAdsApi/PerformanceReportRequest.html#method-c-new","(attributes={})","

    Public : Constructor. Adds validations to aggregations and time\n

    Author — jlopezn@neonline.cl\n\n

    Parameters …\n"],["new","BingAdsApi::ReportRequest","BingAdsApi/ReportRequest.html#method-c-new","(attributes={})","

    Public : Constructor. Adds validations to format and language attributes\n

    Author — jlopezn@neonline.cl …\n\n"],["new","BingAdsApi::Service","BingAdsApi/Service.html#method-c-new","(options={})","

    Public : Constructor\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["normalize_hash_keys","BingAdsApi::SOAPHasheable","BingAdsApi/SOAPHasheable.html#method-i-normalize_hash_keys","(hash, keys_case)","

    Public — Normalize the keys of a hash with the case specified\n

    Author — jlopexn@neonline.cl\n\n

    Parameters\n"],["object_to_hash","BingAdsApi::SOAPHasheable","BingAdsApi/SOAPHasheable.html#method-i-object_to_hash","(object, keys_case=:underscore)","

    Internal: Internal method to return an object as a SOAP Request alike hash\nIf the object is an array, …\n"],["pause?","BingAdsApi::AccountInfo","BingAdsApi/AccountInfo.html#method-i-pause-3F","()","

    Public — Returns true if the account is in status pause\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["pending?","BingAdsApi::AccountInfo","BingAdsApi/AccountInfo.html#method-i-pending-3F","()","

    Public — Returns true if the account is in status pending\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["pending?","BingAdsApi::ReportRequestStatus","BingAdsApi/ReportRequestStatus.html#method-i-pending-3F","()","

    Public — Returns true if the status is pending\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["poll_generate_report","BingAdsApi::Reporting","BingAdsApi/Reporting.html#method-i-poll_generate_report","(report_request_id)","

    Public : Get the status of a report request\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["scope_to_hash","BingAdsApi::Helpers::ScopeHelper","BingAdsApi/Helpers/ScopeHelper.html#method-i-scope_to_hash","(keys_case=:undescore)","

    Public : Returns the filter attribute as a Hash to SOAP requests\n

    Author — jlopezn@neonline.cl\n\n

    filter - …\n"],["service_wsdl","BingAdsApi::Config","BingAdsApi/Config.html#method-i-service_wsdl","(environment, service)","

    Public : Returns a String with WSDL url for the service indicated\n

    Author — jlopezn@neonline.cl\n\n

    Parameters …\n"],["solve_filter_value","BingAdsApi::Helpers::FilterHelper","BingAdsApi/Helpers/FilterHelper.html#method-i-solve_filter_value","(filter_criteria, filter_value)","

    Internal — Solves the Bing value for the given filter attribute\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["submit_generate_report","BingAdsApi::Reporting","BingAdsApi/Reporting.html#method-i-submit_generate_report","(report_request)","

    Public : Submits a report request\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["success?","BingAdsApi::ReportRequestStatus","BingAdsApi/ReportRequestStatus.html#method-i-success-3F","()","

    Public — Returns true if the status is success\n

    Author — jlopezn@neonline.cl\n

    Returns — boolean\n"],["time_to_hash","BingAdsApi::Helpers::TimeHelper","BingAdsApi/Helpers/TimeHelper.html#method-i-time_to_hash","(keys_case)","

    Public : Return the time attribute of the ReportRequest as a valid Hash for\nSOAP requests\n

    Author — jlopezn@ …\n\n"],["to_hash","BingAdsApi::AccountPerformanceReportRequest","BingAdsApi/AccountPerformanceReportRequest.html#method-i-to_hash","(keys = :underscore)","

    Public — Returns the object as a Hash valid for SOAP requests\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["to_hash","BingAdsApi::AdGroup","BingAdsApi/AdGroup.html#method-i-to_hash","(keys = :underscore)","

    Public : Returns this object as a hash to SOAP requests This methods is a\nspecialization for the +DataObject#to_hash …\n"],["to_hash","BingAdsApi::CampaignPerformanceReportRequest","BingAdsApi/CampaignPerformanceReportRequest.html#method-i-to_hash","(keys = :underscore)","

    Public — Returns the object as a Hash valid for SOAP requests\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["to_hash","BingAdsApi::MobileAd","BingAdsApi/MobileAd.html#method-i-to_hash","(keys = :underscore)","

    Public : Specification of DataObject#to_hash method that ads the type\nattribute based on this specific …\n"],["to_hash","BingAdsApi::PerformanceReportRequest","BingAdsApi/PerformanceReportRequest.html#method-i-to_hash","(keys_case = :underscore)","

    Public — Returns this object as a Hash for SOAP Requests\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["to_hash","BingAdsApi::ProductAd","BingAdsApi/ProductAd.html#method-i-to_hash","(keys = :underscore)","

    Public : Specification of DataObject#to_hash method that ads the type\nattribute based on this specific …\n"],["to_hash","BingAdsApi::ReportRequest","BingAdsApi/ReportRequest.html#method-i-to_hash","(keys_case = :underscore)","

    Public — Returns this object as a Hash for SOAP Requests\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["to_hash","BingAdsApi::SOAPHasheable","BingAdsApi/SOAPHasheable.html#method-i-to_hash","(keys_case=:underscore)","

    Internal: Metodo custom para transformar a hash un objeto. Se puede indicar\nsi se desean las keys en …\n"],["to_hash","BingAdsApi::TextAd","BingAdsApi/TextAd.html#method-i-to_hash","(keys = :underscore)","

    Public : Specification of DataObject#to_hash method that ads the type\nattribute based on this specific …\n"],["to_s","BingAdsApi::AdApiFaultDetail","BingAdsApi/AdApiFaultDetail.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::ApiException","BingAdsApi/ApiException.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::ApiFaultDetail","BingAdsApi/ApiFaultDetail.html#method-i-to_s","()","

    Public : Specific to string\n

    Author — jlopezn@neonline.cl\n

    Returns — the object ‘stringified’\n"],["to_s","BingAdsApi::ApplicationFault","BingAdsApi/ApplicationFault.html#method-i-to_s","()",""],["to_s","BingAdsApi::BatchError","BingAdsApi/BatchError.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::DataObject","BingAdsApi/DataObject.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::EditorialError","BingAdsApi/EditorialError.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::OperationError","BingAdsApi/OperationError.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["to_s","BingAdsApi::PartialErrors","BingAdsApi/PartialErrors.html#method-i-to_s","()","

    Public : Specified to string method\n

    Author — jlopezn@neonline.cl\n\n"],["update_ad_groups","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-update_ad_groups","(campaign_id, ad_groups)","

    Public : Updates on or more ad groups in a specified campaign\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["update_ads","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-update_ads","(ad_group_id, ads)","

    Public : Updates ads for the specified ad group\n

    Author — jlopezn@neonline.cl\n\n

    Parameters\n"],["update_campaigns","BingAdsApi::CampaignManagement","BingAdsApi/CampaignManagement.html#method-i-update_campaigns","(account_id, campaigns)","

    Public : Updates on or more campaigns for the specified account\n

    Author — jlopezn@neonline.cl\n\n

    Parameters …\n"],["valid_columns","BingAdsApi::Helpers::ColumnHelper","BingAdsApi/Helpers/ColumnHelper.html#method-i-valid_columns","(valid_columns, columns)","

    Internal : Validates the specified columns at the ReporRequest\ninitialization At the first invalid column …\n"],["valid_filter","BingAdsApi::Helpers::FilterHelper","BingAdsApi/Helpers/FilterHelper.html#method-i-valid_filter","(valid_filters, filter)","

    Internal : Validates the filter attribute at the ReporRequest\ninitialization At the first invalid filter …\n"],["valid_filter_value","BingAdsApi::Helpers::FilterHelper","BingAdsApi/Helpers/FilterHelper.html#method-i-valid_filter_value","(key, value)","

    Internal : Validates a specific filter criteria and his value\n

    Author — jlopezn@neonline.cl\n\n

    key - filter …\n"],["valid_scope","BingAdsApi::Helpers::ScopeHelper","BingAdsApi/Helpers/ScopeHelper.html#method-i-valid_scope","(valid_scopes, scope)","

    Internal : Validates the filter attribute at the ReporRequest\ninitialization At the first invalid filter …\n"],["valid_time","BingAdsApi::Helpers::TimeHelper","BingAdsApi/Helpers/TimeHelper.html#method-i-valid_time","(time)","

    Public : Validates the time attribute present in some report request\n

    Author — jlopezn@neonline.cl\n\n

    time …\n"],["README","","README_rdoc.html","","

    BingAdsApi\n

    This project rocks and uses MIT-LICENSE.\n

    Presentation\n"]]}} \ No newline at end of file diff --git a/rdoc/table_of_contents.html b/rdoc/table_of_contents.html index 7a27b1f..d490f9e 100644 --- a/rdoc/table_of_contents.html +++ b/rdoc/table_of_contents.html @@ -38,7 +38,11 @@

    Pages

  • Campaign Management
  • Adding Campaigns
  • Find Campaigns +
  • Customer Management +
  • Get accounts info
  • Reporting +
  • Submit generate report +
  • Poll generate report
  • @@ -48,6 +52,9 @@

    Classes/Modules