1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

AdWords API Starter Kit
=======================

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.


AdWords API Starter Kit is a framework built on top of the AdWords API. It is
written in the Java programming language and uses the AdWords API Java Client
Library to communicate with the AdWords platform. This framework allows
developers to focus on their business logic by providing a set of high-level
classes and functions that encapsulate the details of the AdWords API. The
framework's goal is to take down the wall developers generally face when trying
to learn another API. With less time spent on learning the numerous classes
and methods of the AdWords API, more time can be allocated towards designing
innovative and creative ways of managing AdWords accounts.

A standard AdWords API application usually follows the model of having external
data sources (e.g., XML, database, RSS, etc.) or events (e.g., weather, stock
prices, etc.), the business logic layer, and a layer of synchronizing local
data with AdWords accounts. The Starter Kit will accelerate the development of
the business logic layer and will, in most cases, handle the synchronization
part altogether.

In the business logic layer, the application will read data from external data
source, for example the number of items in stock, and will make some decisions
based on this data. An example of the decision could be "if the number of
item X in stock equal to 0, then pause the associated ad group". The application
is also capable of instantiating a snapshot of the new account in memory and
utility functions handle the tedious synchronization part.


How do I start?
---------------

Download the AdWords API Java Client Library from
http://code.google.com/p/google-api-adwords-java/ and place
"adwords-api-{version}.jar" file into "starterkit/lib" directory. Download
external dependencies from
http://adwords-api-starterkit.googlecode.com/files/lib_jars.tar.gz and place
the JARs into "starterkit/lib" directory.

Create a directory "starterkit/bin". From the "starterkit/" directory execute
the following command to create a list of all sources. The "sources.dat" file
will be placed into the "starterkit/bin" directory.

    $ find ./src/ -name "*.java" > bin/sources.dat

The next step is to compile the sources. From the "starterkit/" directory
execute the following command.

    $ javac -d bin -classpath ./lib/adwords-api-{version}.jar:./lib/commons-lang-2.4.jar:./lib/log4j-1.2.8.jar @./bin/sources.dat

Now, navigate to "starterkit/bin" directory and construct the JAR file for the
AdWords API Starter Kit as following.

    $ jar -cvf ../lib/adwords-api-starterkit-{version}.jar .

See the README file in the
"starterkit/src/com/google/api/adwords/starterkit/demo/" directory and make
appropriate modification to the "settings.xml" file.


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

Check out code from svn repository. Make appropriate changes to the code and
update the "ChangeLog" file with a summary of what was changed. Update code's
version in "com.google.api.adwords.starterkit.StarterKitSettings". Regenerate
new documentation using javadoc. Compile the code and construct an
"adwords-api-starterkit-{version}.jar" file. Place this file into
"starterkit/lib" directory. Create new directory with a name
"awapi_starterkit_v.v.v", where v.v.v is a version number (e.g., 1.0.0), and
copy new release into it. Pack new release into a tarball and then gzip it,

    $ tar --exclude=".svn" -cvf awapi_starterkit_v.v.v.tar awapi_starterkit_v.v.v/
    $ gzip awapi_starterkit_v.v.v.tar


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

Use issue tracker at http://code.google.com/p/adwords-api-starterkit/issues/list.


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

    - AdWords API Java Client Library
                        -- http://code.google.com/p/google-api-adwords-java/
    - Apache log4j      -- http://logging.apache.org/log4j/
    - Apache Commons Lang
                        -- http://commons.apache.org/lang/


Author:
    api.aubespin@gmail.com (David Aubespin)

Maintainers:
    rodrigo.f.vale@gmail.com (Rodrigo Vale)
    api.sgrinberg@gmail.com (Stan Grinberg)