Sandbox Account Viewer
======================

The Sandbox Account Viewer is a sample application that demonstrates how to
use the AdWords API client library to display contents of an AdWords sandbox
account. It can be used to visualize the effects of a request on your account
and to retrieve information such as IDs that are needed when running examples.
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.

The Sandbox Account Viewer does not attempt to replicate the official AdWords
web interface, but rather displays information exactly as it is returned by
the API. The objects in the account are displayed in a tree on the left, and
when selected their details are displayed in a table to the right.


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

1) Extract the source code to a working directory.

2) Download the latest version of the AdWords API Java client library and place
the jar file into lib folder.

3) Run the Ant task "compile" in the build file (build.xml) to build the
application.

4) Run the Ant task "run" to launch the application.

Alternativly, in an IDE you can launch the application by running the class:

  com.google.api.adwords.sandboxaccountviewer.Launcher

If you've generated a jar using the "jar" Ant task you can run the application
using the following command:

  java -jar sandbox-account-viewer-1.2.0.jar


Credentials
-----------

The Sandbox Account Viewer uses the AdWords API Java client library to connect
to sandbox environment and requires the same credentials. These credentials
can be entered manually in a dialog ("Account" -> "Enter credentials") or
loaded from a properties file ("Account" -> Load credentials from file").
The format of the properties file is the same as the client library:

  http://code.google.com/p/google-api-adwords-java/source/browse/trunk/adwords.properties

When the application starts it will attempt to automatically load credentials
from the adwords.properties file in your home directory, if one exists.


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

Access to production accounts is disabled by default, but can be enabled by
using the special command line parameter "--enable-production". Be aware
that the API unit costs of the requests made by the Sandbox Account Viewer
will be recorded against the developer token specified in the credentials and
may be significant.


How do I make a release?
------------------------

Update the ChangeLog with new changes. Update version number in:

  src/com/google/api/adwords/sandboxaccountviewer/build.properties

Use the Ant task "dist" to package the source distribution.


External dependencies:
----------------------

  - AdWords API Java client library


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-adwords-java/issues/list

Issues labled with "Apps-SandboxAccountViewer" pertain to this project and
not the client library in general.


Author:
    api.ekoleda@gmail.com (Eric Koleda)

Maintainer:
    api.ekoleda@gmail.com (Eric Koleda)