google-adwords-api 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a4d1f1115e11224900bd4c5c2984f25f7356804b65c1aed1205961e52a99f55
-  data.tar.gz: f134a2e8fcabe7cfabfe3a3f0dd926b44ef27ad6cba4ecf0e7753fd77a0657e3
+  metadata.gz: 91ec6f3a83f5affe00c79f9bd1c5f0cd831d8b6f249ed1dda38cdc507353f0d0
+  data.tar.gz: 998210bfdf2745291dd5cbceebf2c15c484f580aa64964686792399ad2080c02
 SHA512:
-  metadata.gz: 18be5196b193e3148843e432671b194fa8ae961bd77dffda0574249d13824f0f3faed5798d420da4d2f0555a015e9c4f9fe48812f2c2b483b5fb8c659af08fb3
-  data.tar.gz: 446ecf63502be235a0485def5f615c631bd0b1fdc9321677596994487e35dc6735d3c423a16e32dec0c9eb2f1667acfdf62acf4a7f505f50ba3510187914f6a1
+  metadata.gz: 92ad02273f9f74ef83529c8ac1ebecd372560a56a813a7b8397212933a16b60adb672ab85c5b0cf13619419d378fe27e6ec21e112f67481a5cb59744e196c050
+  data.tar.gz: cd2ca42ad522be03bc83f9b638f0edb4bde4064646a46e0d0f6ec78093f9dfcad8d353e995b3a362a42e55d6e9c43d66e8ecb7a1e62f859470dc8e15f6383ae3

data/ChangeLog

@@ -1,3 +1,7 @@
+1.6.0:
+  - Adwords API has been sunset. This library is no longer maintained.
+  - Please upgrade to the Google Ads API: https://developers.google.com/google-ads/api/docs/client-libs/ruby
+
 1.5.0:
   - Remove deprecated API version v201806.
   - Fixed a release script issue that prevented older versions from being

data/README.md

@@ -1,239 +1,12 @@
 # Google AdWords Client Library
 
-Welcome to the next generation Google-developed Ruby client library for the
-AdWords API!
+The AdWords API is no longer available. This library is no longer maintained.
 
-It contains full support for all API services with full stubs, and a simplified
-programming interface that lets you handle everything in native Ruby
-collections.
-
-
-# Docs for Users
-
-## 1 - Installation
-
-`google-adwords-api` is a ruby gem. See
-[http://guides.rubygems.org/rubygems-basics/]().
-
-Install it using the gem install command:
-
-    $ gem install --remote google-adwords-api
-
-The following gem libraries are required:
-
- - google-ads-savon
- - google-ads-common
-
-Note: If you're using a version of Ruby lower than 2.2.2, you will need to
-manually install a previous version of Rack, a dependency of our HTTP library.
-You can do this with:
-
-    $ gem install rack -v 1.6.4
-
-## 2 - Using the client library
-
-Before starting to use the client library, you need to set up OAuth2. You can
-find our guide on how to obtain OAuth2 credentials
-[on the wiki](https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2).
-
-By default, the API uses a config file in `ENV['HOME']/adwords_api.yml`. When
-generating your OAuth2 refresh token, you will be given the option for the
-sample to automatically store the refresh token in this file.
-
-You can also pass the API a manually constructed config hash like:
-
-    adwords = AdwordsApi::Api.new({
-      :authentication => {
-          :method => 'OAuth2',
-          :oauth2_client_id => 'INSERT_OAUTH2_CLIENT_ID_HERE',
-          :oauth2_client_secret => 'INSERT_OAUTH2_CLIENT_SECRET_HERE',
-          :developer_token => 'DEVELOPER_TOKEN',
-          :client_customer_id => '012-345-6789',
-          :user_agent => 'Ruby Sample'
-      },
-      :service => {
-        :environment => 'PRODUCTION'
-      }
-    })
-
-Once you have all the requisite setup complete, you're ready to make an API
-call. The easiest way to do this is to look at one of our
-[examples](https://github.com/googleads/google-api-ads-ruby/tree/master/adwords_api/examples).
-The `adwords_on_rails` example will show how to use the web flow, and the other
-examples will use the installed application OAuth2 flow.
-
-The basics of making a request are:
-
- 1. Include the library with `require`:
-
-        require 'adwords_api'
-
- 2. Create an API instance:
-
-        adwords = AdwordsApi::Api.new
-
- 3. Specify which service you're looking to use, and which version:
-
-        campaign_srv = adwords.service(:CampaignService, :v201809)
-
- 4. You should now be able to just use the API methods in the returned object:
-
-        # Get 'Id', 'Name' and 'Status' fields of all campaigns.
-        campaigns = campaign_srv.get({:fields => ['Id', 'Name', 'Status']})
-
-See the code in the examples directory for more thorough working examples you
-can build from.
-
-*Note*: If your setup requires you to send connections through a proxy server,
-please set the appropriate options in the config file or config hash.
-For example:
-
-    config[:connection] = {
-      :proxy => 'http://user:password@proxy_hostname:8080'
-    }
-
-### 2.1 - Ruby names for a Ruby library
-
-In order to make things more Ruby-like for our Ruby developers, we've renamed
-API objects and methods to more closely match Ruby conventions. This means using
-snake_case for methods and parameters, and UpperCamelCase for class names.
-
-For example, the `startDate` field of the Campaign object is named `start_date`
-in the client library. The `get` method, returns a CampaignPage object which has
-`entries` and `total_num_entries` fields. So, to access the return
-values, you would do this:
-
-    response = campaign_srv.get(selector)
-    num_entries = response[:total_num_entries]
-
-Essentially, all you have to do is follow Ruby conventions, and the library will
-do the rest. All of the examples are written following this standard.
-
-
-### 2.2 - Using the Test Account
-
-For testing purposes, obtain a Test Account in the production environment. Any
-request against a Test Account inccurs no API units charge. See
-[this guide](https://developers.google.com/adwords/api/docs/test-accounts) for
-more details.
-
-To use the library against a Test Account, set the `client_customer_id` property in
-the configuration file to its client customer ID.
-
-
-### 2.3 - Logging
-
-It is often useful to see a trace of the raw SOAP XML being sent and received.
-The quickest way of achieving this when debugging your application is by setting
-the `library.log_level` configuration variable to DEBUG.
-
-    config[:library] = {
-      :log_level => 'DEBUG'
-    }
-
-This can alternatively be done via a configuration file.
-
-This will output the SOAP XML to `stderr`, which will usually show up in your
-terminal window.
-
-There's also an option of logging requests and XML to a file. In order to enable
-this, you should create a standard Logger object and pass it to the library:
-
-    require 'logger'
-    logger = Logger.new('path/to/log_filename')
-    logger.level = Logger::DEBUG
-    adwords = AdwordsApi::Api.new
-    adwords.logger = logger
-
-Request details and units spend are logged at the INFO log level, while raw HTTP
-headers and XML dumps are logged at the DEBUG log level. For more details on
-using Logger refer to the Ruby Logger documentation.
-
-
-### 2.4 - Calculating operations usage
-
-Each AdWords API operation performed consumes a certain number of operations as
-described in the
-[rate sheet](https://developers.google.com/adwords/api/docs/ratesheet).
-
-The amount of operations consumed is returned in the header part of the SOAP
-response. This information can be obtained by passing a user block during the
-method call:
-
-    response = campaign_srv.get(selector) do |header|
-      puts "Operations consumed: %d" % header[:operations]
-    end
-
-You can also retrieve the response body as the second block parameter:
-
-    campaign_srv.get(selector) {|header, body| ... }
-
-
-### 2.5 - GZip compression
-
-The library offers a transparent compression option which can be enabled in the
-configuration file or by the following setting:
-
-    config[:connection] = {
-      :enable_gzip => true
-    }
-
-Enabling this option will set the headers required to request the server to
-respond in gzipped format. All requests are sent uncompressed regardless.
-
-
-### 2.6 - Utilities
-
-The library offers utilities to make fetching reports and using the
-BatchJobService easier. Take a look at our wiki page on
-[AdWords Utilities](https://github.com/googleads/google-api-ads-ruby/wiki/AdWords-Utilities)
-for more information.
-
-
-# Docs for Developers
-
-## Rake targets
-
-To regenerate all the stubs for all versions if needed:
-
-    $ rake generate
-
-To target a specific version:
-
-    $ rake generate[version]
-
-For example:
-
-    $ rake generate[v201809]
-
-To target a specific service in a specific version:
-
-    $ rake generate[version,service]
-
-For example:
-
-    $ rake generate[v201809,CampaignService]
-
-To build the gems:
-
-    $ gem build google-adwords-api.gemspec
-
-To run unit tests on the library:
-
-    $ rake test
-
-
-## Where do I submit bug reports and feature requests?
-
-Bug reports and feature requests can be posted
-[on the library page](https://github.com/googleads/google-api-ads-ruby/issues).
-
-Questions can be asked [on the forum](http://groups.google.com/group/adwords-api).
-
-Make sure to subscribe to our
-[Google Plus page](https://plus.google.com/+GoogleAdsDevelopers) for API change
-announcements and other news.
+Please upgrade to the
+[Google Ads API](https://developers.google.com/google-ads/api/docs/start).
 
+To access the Google Ads API use the
+[google-ads-googleads](https://rubygems.org/gems/google-ads-googleads) library.
 
 # Copyright/License Info
 
@@ -257,10 +30,10 @@ limitations under the License.
 
 Authors:
 
- - Sérgio Gomes
- - Danial Klimkin
- - Michael Cloonan
+- Sérgio Gomes
+- Danial Klimkin
+- Michael Cloonan
 
 Maintainer:
 
- - Michael Cloonan
+- Michael Cloonan

data/lib/adwords_api.rb

@@ -1,237 +1,5 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2010, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# Contains the main classes for the client library.
-
-require 'ads_common/api'
-require 'ads_common/savon_headers/oauth_header_handler'
-require 'adwords_api/api_config'
-require 'adwords_api/credential_handler'
-require 'adwords_api/errors'
-require 'adwords_api/report_utils'
-require 'adwords_api/batch_job_utils'
-require 'adwords_api/utils_reporter'
-require 'adwords_api/query_utils/report_query_builder'
-require 'adwords_api/query_utils/service_query_builder'
-
 # Main namespace for all the client library's modules and classes.
 module AdwordsApi
-
-  # Wrapper class that serves as the main point of access for all the API usage.
-  #
-  # Holds all the services, as well as login credentials.
-  #
-  class Api < AdsCommon::Api
-
-    attr_reader :utils_reporter
-
-    # Constructor for API.
-    def initialize(provided_config = nil)
-      super(provided_config)
-      @credential_handler = AdwordsApi::CredentialHandler.new(@config)
-      @utils_reporter = AdwordsApi::UtilsReporter.new(@credential_handler)
-    end
-
-    # Getter for the API service configurations
-    def api_config()
-      AdwordsApi::ApiConfig
-    end
-
-    # Retrieve correct soap_header_handler.
-    #
-    # Args:
-    # - auth_handler: instance of an AdsCommon::Auth::BaseHandler subclass to
-    #   handle authentication
-    # - version: intended API version
-    # - header_ns: header namespace
-    # - default_ns: default namespace
-    #
-    # Returns:
-    # - SOAP header handler
-    #
-    def soap_header_handler(auth_handler, version, header_ns, default_ns)
-      auth_method = @config.read('authentication.method', :OAUTH2)
-      handler_class = case auth_method
-        when :OAUTH2, :OAUTH2_SERVICE_ACCOUNT
-          AdsCommon::SavonHeaders::OAuthHeaderHandler
-        else
-          raise AdsCommon::Errors::AuthError,
-              "Unknown auth method: %s" % auth_method
-        end
-      return handler_class.new(@credential_handler, auth_handler, header_ns,
-                                  default_ns, version)
-    end
-
-    # Helper method to provide a simple way of doing a validate-only operation
-    # without the need to change credentials. Executes a block of code as an
-    # validate-only operation and/or returns the current status of the property.
-    #
-    # Args:
-    # - accepts a block, which it will execute as a validate-only operation
-    #
-    # Returns:
-    # - block execution result, if block given
-    # - boolean indicating whether validate-only operations are currently
-    #   enabled or disabled, if no block provided
-    #
-    def validate_only(&block)
-      return (block_given?) ?
-        run_with_temporary_flag(:@validate_only, true, block) :
-        @credential_handler.validate_only
-    end
-
-    # Helper method to provide a simple way of performing validate-only
-    # operations. Sets the value of the property
-    # that controls whether validate-only operations are enabled or disabled.
-    #
-    # Args:
-    # - value: the new value for the property (boolean)
-    #
-    def validate_only=(value)
-      @credential_handler.validate_only = value
-    end
-
-    # Helper method to skip the report header when downloading reports.
-    #
-    # Args:
-    # - value: whether to skip the report header (boolean)
-    #
-    def skip_report_header=(value)
-      @config.set('library.skip_report_header', value)
-    end
-
-    # Helper method to skip the report summary when downloading reports.
-    #
-    # Args:
-    # - value: whether to skip the report summary (boolean)
-    #
-    def skip_report_summary=(value)
-      @config.set('library.skip_report_summary', value)
-    end
-
-    # Helper method to skip the column header when downloading reports.
-    #
-    # Args:
-    # - value: whether to skip the column header (boolean)
-    #
-    def skip_column_header=(value)
-      @config.set('library.skip_column_header', value)
-    end
-
-    # Helper method to include zero impressions when downloading reports.
-    #
-    # Args:
-    # - value: whether to include zero impressions (boolean)
-    #
-    def include_zero_impressions=(value)
-      @config.set('library.include_zero_impressions', value)
-    end
-
-    # Helper method to use raw enum values when downloading reports.
-    #
-    # Args:
-    # - value: whether to use raw enum values (boolean)
-    #
-    def use_raw_enum_values=(value)
-      @config.set('library.use_raw_enum_values', value)
-    end
-
-    # Helper method to provide a simple way of performing requests with support
-    # for partial failures. Executes a block of code with partial failures
-    # enabled and/or returns the current status of the property.
-    #
-    # Args:
-    # - accepts a block, which it will execute as a partial failure operation
-    #
-    # Returns:
-    # - block execution result, if block given
-    # - boolean indicating whether partial failure operations are currently
-    # enabled or disabled, if no block provided
-    #
-    def partial_failure(&block)
-      return (block_given?) ?
-        run_with_temporary_flag(:@partial_failure, true, block) :
-        @credential_handler.partial_failure
-    end
-
-    # Helper method to provide a simple way of performing requests with support
-    # for partial failures.
-    #
-    # Args:
-    # - value: the new value for the property (boolean)
-    #
-    def partial_failure=(value)
-      @credential_handler.partial_failure = value
-    end
-
-    # Returns an instance of ReportUtils object with all utilities relevant to
-    # the reporting.
-    #
-    # Args:
-    # - version: version of the API to use (optional).
-    #
-    def report_utils(version = nil)
-      version = api_config.default_version if version.nil?
-      # Check if version exists.
-      if !api_config.versions.include?(version)
-        raise AdsCommon::Errors::Error, "Unknown version '%s'" % version
-      end
-      return AdwordsApi::ReportUtils.new(self, version)
-    end
-
-    # Returns an instance of BatchJobUtils object with all utilities relevant
-    # to running batch jobs.
-    #
-    # Args:
-    # - version: version of the API to use (optional).
-    #
-    def batch_job_utils(version = nil)
-      version = api_config.default_version if version.nil?
-      # Check if version exists.
-      if !api_config.versions.include?(version)
-        raise AdsCommon::Errors::Error, "Unknown version '%s'" % version
-      end
-      return AdwordsApi::BatchJobUtils.new(self, version)
-    end
-
-    # Returns an instance of ReportQueryBuilder to aid in generating AWQL for
-    # reports.
-    def report_query_builder(&block)
-      return AdwordsApi::ReportQueryBuilder.new(self, &block)
-    end
-
-    # Returns an instance of ServiceQueryBuilder to aid in generating AWQL for
-    # service queries.
-    def service_query_builder(&block)
-      return AdwordsApi::ServiceQueryBuilder.new(self, &block)
-    end
-
-    private
-
-    # Executes block with a temporary flag set to a given value. Returns block
-    # result.
-    def run_with_temporary_flag(flag_name, flag_value, block)
-      previous = @credential_handler.instance_variable_get(flag_name)
-      @credential_handler.instance_variable_set(flag_name, flag_value)
-      begin
-        return block.call
-      ensure
-        @credential_handler.instance_variable_set(flag_name, previous)
-      end
-    end
-  end
+  puts "The AdWords API is no longer available.\nUse the Google Ads API instead:
+  https://developers.google.com/google-ads/api/docs/client-libs/ruby"
 end