AdWords on Rails
================

Google's AdWords API service lets developers design computer programs that
interact directly with the AdWords platform. With these applications,
advertisers and third parties can more efficiently -- and creatively -- manage
their large or complex AdWords accounts and campaigns.

The AdWords on Rails sample application demonstrates how to access the AdWords
API from within a Ruby on Rails environment. It is based on the Google Ruby
AdWords API client library:

  http://code.google.com/p/google-api-ads-ruby/

If you are new to Rails you can find more information on the official site:

  http://rubyonrails.org/

The application demonstrates the following:

 - Authorization against AdWords with OAuth schema and credentials re-use.
 - Simple service request (CampaignService.get) and displaying the results.
 - Basic AdHoc reporting functionality with downloads support.

We are sharing this code as open source to provide a starting point for new
developers and to demonstrate some of the core functionality in the API.


How do I get started?
---------------------

1. Make sure you have Ruby 1.9.2 or later installed:

  $ ruby -v
  ruby 1.9.2p0 (2010-08-18 revision 29036) [x86_64-linux]

2. Download the application from the code site:

  http://code.google.com/p/google-api-ads-ruby/downloads/list

3. Unpack the contents and change to the application root:

  $ tar xvzf adwords_on_rails-<version>.tar.gz && cd adwords_on_rails

4. Install the Ruby bundle:

  $ gem install bundle

5. Install all required dependencies:

  $ bundle install

6. Initialize default local SQLite schema:

  $ rake db:migrate

7. Configure AdWords API settings:

  $ vi config/adwords_api.yml

8. Start the server:

  $ script/rails server

You should be able to access the application now by pointing your browser to:

  http://localhost:3000


Using the application
---------------------

In order to access AdWords data the application needs to be granted access by a
logged in user. You will be automatically redirected to a page with login prompt
when not yet authorized.

To grant access, click the 'Proceed' link. Make sure you are on the Google login
page, log in with your AdWords account credentials and select 'Grant access'.

Note: Granting access to the application will only allow access to the AdWords
data for the account. Other services will not be accessible.

Once logged in you can retrieve the accounts list, select an account and browse
the campaigns list or download a report with the corresponding menu items.


Configuring the Ruby AdWords API library
----------------------------------------

To be able to use the AdWords API there are a few parameters that need to be
specified. The configuration file is located under the 'config' directory and
named adwords_api.yml.

For details regarding configuration directive please refer to the library
README:

  http://code.google.com/p/google-api-ads-ruby/wiki/AdWordsReadme


Production accounts
-------------------

This demo is capable of accessing production accounts. Be aware that the API
unit costs of the requests made by the AdWords on Rails application will be
recorded against the developer token specified in the credentials and may be
significant.


Where do I submit bug reports and feature requests?
---------------------------------------------------

Bug reports and feature requests can be submitted at:

  http://code.google.com/p/google-api-ads-ruby/issues/list

Also please feel free to ask questions and discuss the application on forums:

  https://groups.google.com/forum/#!forum/adwords-api


Contacts:
---------

Authors:
    Danial Klimkin (api.dklimkin@gmail.com)