RubyGems - adwords4r - Versions diffs - 15.0.1 → 15.1.0 - Mend

adwords4r 15.0.1 → 15.1.0

Files changed (1022) hide show

data/Readme.html ADDED

@@ -0,0 +1,6 @@
+<html>
+  <head>
+    <meta http-equiv="refresh" content="0;url=doc/index.html"/>
+  </head>
+  <body></body>
+</html>

data/Readme.txt CHANGED

@@ -1,5 +1,4 @@
-Google adwords4r Library
--------------------------
+= Google adwords4r Library
 Welcome to adwords4r: Bringing the delights of Ruby programming to the AdWords
 world!
@@ -7,77 +6,76 @@ world!
 Documentation and comments are a work in progress.
-Useful Web Resources
---------------------
+= Useful Web Resources
-- AdWords home:
-    https://adwords.google.com/
-- AdWords API discussion forum:
-    http://groups.google.com/group/adwords-api
-- AdWords API documentation:
-    http://code.google.com/apis/adwords/docs/developer/index.html
-- This project's Google Code page:
-    http://code.google.com/p/google-api-adwords-ruby/
+- {AdWords home}[https://adwords.google.com/]
+- {AdWords API discussion forum}[http://groups.google.com/group/adwords-api]
+- {AdWords API documentation}[http://code.google.com/apis/adwords/docs/developer/index.html]
+- {This project's Google Code page}[http://code.google.com/p/google-api-adwords-ruby/]
-Docs for Users
---------------
+= Docs for Users
-1 - Instalation:
+== 1 - Instalation:
 adwords4r is a ruby gem.  See http://docs.rubygems.org/read/book/1
 Install it using the gem install command.
-> gem install --local adwords4r
+   $ gem install --remote adwords4r
 The following gem libraries are required:
 - soap4r v1.5.8
 - httpclient v2.1.2 or greater
-2 - Using the client library:
+== 2 - Using the client library:
 It's pretty easy to use.
 See http://docs.rubygems.org/read/chapter/3#page70 for how to set the rubygem
 environment.
-export RUBYOPT=rubygems
-or ruby -rubygems my_program_that_uses_gems
+   $ export RUBYOPT=rubygems
+or
+   $ ruby -rubygems my_program_that_uses_gems
 If you do not use the rubygems option, you need to add
-require 'rubygems'
+   require 'rubygems'
 at the beginning of your programs.
 Then:
-require 'adwords4r'
+   require 'adwords4r'
-adwords = AdWords::API.new
+   adwords = AdWords::API.new
 creates a driver for the latest version of AdWords API using a credentials file
 in ENV['HOME']/adwords.properties
 There is an example credentials in the root adwords4r directory.
 You can also pass API a manually constructed AdWordsCredentials object like:
-adwords = AdWords::API.new(AdWords::AdWordsCredentials.new({
-  'developerToken' => 'DEVELOPER_TOKEN',
-  'applicationToken' => 'APPLICATION_TOKEN',
-  'useragent' => 'Ruby Sample',
-  'password' => 'PASSWORD',
-  'email' => 'user@domain.com'
-  'clientEmail' => 'user2@domain.com',
-}))
+   adwords = AdWords::API.new(AdWords::AdWordsCredentials.new({
+     'developerToken' => 'DEVELOPER_TOKEN',
+     'applicationToken' => 'APPLICATION_TOKEN',
+     'useragent' => 'Ruby Sample',
+     'password' => 'PASSWORD',
+     'email' => 'user@domain.com'
+     'clientEmail' => 'user2@domain.com',
+   }))
 Then, just specify which service you're looking to use, and which version:
-account_srv = adwords.get_service(13, 'Account')
+   account_srv = adwords.get_service(13, 'Account')
 and you should now be able to just use the API methods in the object you were
 returned:
-client_accounts = account_srv.getClientAccounts
+   client_accounts = account_srv.getClientAccounts
 See the code in the examples directory for working examples you can build from.
+*Note*: if your setup requires you to send connections through a proxy server,
+please set the HTTP_PROXY environment variable. For example, from your code:
+   $ ENV['HTTP_PROXY'] = 'http://myproxyserver:8080'
-2.1 - Using the Sandbox:
+=== 2.1 - Using the Sandbox:
 In order to use the v13 sandbox, you can add a credential named alternateUrl:
-alternateUrl=https://sandbox.google.com/api/adwords/v13/
+   alternateUrl=https://sandbox.google.com/api/adwords/v13/
 As for v200902, the alternateUrl parameter is currently ignored, since only the
 sandbox is available at the moment. For this API version, all requests will be
@@ -94,48 +92,54 @@ The multiple_versions.rb code sample shows you how to build an application using
 v13 and v200902 services simultaneously.
-2.2 - Logging:
+=== 2.2 - 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 ADWORDS4R_DEBUG environment variable to TRUE; e.g. in the bash shell:
-export ADWORDS4R_DEBUG=TRUE
+   $ export ADWORDS4R_DEBUG=TRUE
 or from your Ruby code:
-ENV['ADWORDS4R_DEBUG'] = 'TRUE'
+   ENV['ADWORDS4R_DEBUG'] = 'TRUE'
 This will output the SOAP XML to stderr, which will usually show up in your
 terminal window.
 There's also the option of logging requests and XML to files. In order to enable
 this, you should use the write_to_file method of the loggers inside your
-AdWords::API object:
-adwords = AdWords::API.new
-adwords.unit_logger.log_to_file
-adwords.xml_logger.log_to_file
+   AdWords::API object:
+   adwords = AdWords::API.new
+   adwords.unit_logger.log_to_file
+   adwords.xml_logger.log_to_file
 The first logs the units spent and the requests made, whereas the second logs
 the full SOAP XML being sent and received over the wire. These will be written
 to the current directory by default, but you can specify a path as an optional
 parameter to log_to_file:
-adwords.unit_logger.log_to_file('/var/log/my_app')
-adwords.xml_logger.log_to_file('/var/log/my_app')
+   adwords.unit_logger.log_to_file('/var/log/my_app')
+   adwords.xml_logger.log_to_file('/var/log/my_app')
 The files will be named request_info and soap_xml, respectively.
-Docs for Developers
--------------------
+= Docs for Developers
+ $ rake getwsdl
+to get the wsdl files
+ $ rake generate
+to regenerate the bindings if needed
+ $ rake rdoc
+to regenerate the project documentation if needed
+ $ rake package
+to package the gem and create a release
-rake getwsdl
-    to get the wsdl files
-rake generate
-    to regenerate the bindings if needed
-rake package
-    to package the gem and create a release
+ $ rake test
+to run unit tests on the library
-Copyright/License Info
-----------------------
+= Copyright/License Info
 Copyright 2009, Google Inc. All Rights Reserved.

data/doc/classes/AdWords.html ADDED

@@ -0,0 +1,168 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>AdWords</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
+    <link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
+    <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Module</span>
+            AdWords
+        </h1>
+        <ul class="files">
+            <li><a href="../files/lib/adwords4r/credentials_rb.html">lib/adwords4r/credentials.rb</a></li>
+            <li><a href="../files/lib/adwords4r_rb.html">lib/adwords4r.rb</a></li>
+            <li><a href="../files/lib/adwords4r/services_rb.html">lib/adwords4r/services.rb</a></li>
+            <li><a href="../files/lib/adwords4r/adwordslogger_rb.html">lib/adwords4r/adwordslogger.rb</a></li>
+            <li><a href="../files/lib/adwords4r/authtoken_rb.html">lib/adwords4r/authtoken.rb</a></li>
+            <li><a href="../files/lib/adwords4r/apiextensions_rb.html">lib/adwords4r/apiextensions.rb</a></li>
+            <li><a href="../files/lib/adwords4r/utils_rb.html">lib/adwords4r/utils.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/AccountServiceWrapper_rb.html">lib/adwords4r/v13/AccountServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/AdGroupServiceWrapper_rb.html">lib/adwords4r/v13/AdGroupServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/AdServiceWrapper_rb.html">lib/adwords4r/v13/AdServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/CampaignServiceWrapper_rb.html">lib/adwords4r/v13/CampaignServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/CriterionServiceWrapper_rb.html">lib/adwords4r/v13/CriterionServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/InfoServiceWrapper_rb.html">lib/adwords4r/v13/InfoServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/KeywordToolServiceWrapper_rb.html">lib/adwords4r/v13/KeywordToolServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/SiteSuggestionServiceWrapper_rb.html">lib/adwords4r/v13/SiteSuggestionServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/ReportServiceWrapper_rb.html">lib/adwords4r/v13/ReportServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/TrafficEstimatorServiceWrapper_rb.html">lib/adwords4r/v13/TrafficEstimatorServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/AdGroupAdServiceWrapper_rb.html">lib/adwords4r/v200902/AdGroupAdServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/AdGroupCriterionServiceWrapper_rb.html">lib/adwords4r/v200902/AdGroupCriterionServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/AdGroupServiceWrapper_rb.html">lib/adwords4r/v200902/AdGroupServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/CampaignServiceWrapper_rb.html">lib/adwords4r/v200902/CampaignServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/CampaignCriterionServiceWrapper_rb.html">lib/adwords4r/v200902/CampaignCriterionServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/CampaignTargetServiceWrapper_rb.html">lib/adwords4r/v200902/CampaignTargetServiceWrapper.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/AccountService_rb.html">lib/adwords4r/v13/AccountService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/AdGroupService_rb.html">lib/adwords4r/v13/AdGroupService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/AdService_rb.html">lib/adwords4r/v13/AdService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/CampaignService_rb.html">lib/adwords4r/v13/CampaignService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/CriterionService_rb.html">lib/adwords4r/v13/CriterionService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/InfoService_rb.html">lib/adwords4r/v13/InfoService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/KeywordToolService_rb.html">lib/adwords4r/v13/KeywordToolService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/ReportService_rb.html">lib/adwords4r/v13/ReportService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/SiteSuggestionService_rb.html">lib/adwords4r/v13/SiteSuggestionService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v13/TrafficEstimatorService_rb.html">lib/adwords4r/v13/TrafficEstimatorService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/AdGroupAdService_rb.html">lib/adwords4r/v200902/AdGroupAdService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/AdGroupCriterionService_rb.html">lib/adwords4r/v200902/AdGroupCriterionService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/AdGroupService_rb.html">lib/adwords4r/v200902/AdGroupService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/CampaignCriterionService_rb.html">lib/adwords4r/v200902/CampaignCriterionService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/CampaignService_rb.html">lib/adwords4r/v200902/CampaignService.rb</a></li>
+            <li><a href="../files/lib/adwords4r/v200902/CampaignTargetService_rb.html">lib/adwords4r/v200902/CampaignTargetService.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+        <p>
+Main namespace for all the client library&#8217;s modules and classes.
+</p>
+<hr size="1"></hr>
+    </div>
+    <div class="sectiontitle">Classes and Modules</div>
+    <ul>
+        <li><span class="type">MODULE</span> <a href="AdWords/AuthToken.html">AdWords::AuthToken</a></li>
+        <li><span class="type">MODULE</span> <a href="AdWords/Extensions.html">AdWords::Extensions</a></li>
+        <li><span class="type">MODULE</span> <a href="AdWords/Service.html">AdWords::Service</a></li>
+        <li><span class="type">MODULE</span> <a href="AdWords/Utils.html">AdWords::Utils</a></li>
+        <li><span class="type">MODULE</span> <a href="AdWords/V13.html">AdWords::V13</a></li>
+        <li><span class="type">MODULE</span> <a href="AdWords/V200902.html">AdWords::V200902</a></li>
+        <li><span class="type">CLASS</span> <a href="AdWords/API.html">AdWords::API</a></li>
+        <li><span class="type">CLASS</span> <a href="AdWords/AdWordsCredentials.html">AdWords::AdWordsCredentials</a></li>
+        <li><span class="type">CLASS</span> <a href="AdWords/AdWordsLogger.html">AdWords::AdWordsLogger</a></li>
+        <li><span class="type">CLASS</span> <a href="AdWords/Error.html">AdWords::Error</a></li>
+        <li><span class="type">CLASS</span> <a href="AdWords/Pre200902HeaderHandler.html">AdWords::Pre200902HeaderHandler</a></li>
+        <li><span class="type">CLASS</span> <a href="AdWords/ResponseHandler.html">AdWords::ResponseHandler</a></li>
+        <li><span class="type">CLASS</span> <a href="AdWords/Sandbox200902HeaderHandler.html">AdWords::Sandbox200902HeaderHandler</a></li>
+    </ul>
+</div>
+    </div>
+  </body>
+</html>

data/doc/classes/AdWords/API.html ADDED

@@ -0,0 +1,265 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>AdWords::API</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" />
+    <link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" />
+    <script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../../js/main.js" type="text/javascript" charset="utf-8"></script>
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            AdWords::API
+                <span class="parent">&lt;
+                    Object
+                </span>
+        </h1>
+        <ul class="files">
+            <li><a href="../../files/lib/adwords4r_rb.html">lib/adwords4r.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+        <p>
+Wrapper class that serves as the main point of access for all the <a
+href="API.html">API</a> usage.
+</p>
+<p>
+Holds all the services, as well as login credentials.
+</p>
+    </div>
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+        <dt>G</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000006">get_service</a></li>
+            </ul>
+        </dd>
+        <dt>N</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000005">new</a></li>
+            </ul>
+        </dd>
+    </dl>
+    <div class="sectiontitle">Attributes</div>
+    <table border='0' cellpadding='5'>
+        <tr valign='top'>
+            <td class='attr-rw'>
+                [R]
+            </td>
+            <td class='attr-name'>credentials</td>
+            <td class='attr-desc'><p>
+<a href="AdWordsCredentials.html">AdWordsCredentials</a> object used for
+authentication
+</p></td>
+        </tr>
+        <tr valign='top'>
+            <td class='attr-rw'>
+                [R]
+            </td>
+            <td class='attr-name'>xml_logger</td>
+            <td class='attr-desc'><p>
+<a href="AdWordsLogger.html">AdWordsLogger</a> object used for logging SOAP
+XML
+</p></td>
+        </tr>
+        <tr valign='top'>
+            <td class='attr-rw'>
+                [R]
+            </td>
+            <td class='attr-name'>unit_logger</td>
+            <td class='attr-desc'><p>
+<a href="AdWordsLogger.html">AdWordsLogger</a> object used for logging
+request info
+</p></td>
+        </tr>
+        <tr valign='top'>
+            <td class='attr-rw'>
+                [R]
+            </td>
+            <td class='attr-name'>mutex</td>
+            <td class='attr-desc'><p>
+Mutex object for controlling concurrent access to <a
+href="API.html">API</a> object data
+</p></td>
+        </tr>
+        <tr valign='top'>
+            <td class='attr-rw'>
+                [RW]
+            </td>
+            <td class='attr-name'>last_units</td>
+            <td class='attr-desc'><p>
+Number of units spent on the last operation via this <a
+href="API.html">API</a> object
+</p></td>
+        </tr>
+        <tr valign='top'>
+            <td class='attr-rw'>
+                [RW]
+            </td>
+            <td class='attr-name'>total_units</td>
+            <td class='attr-desc'><p>
+Number of units spent in total, via this <a href="API.html">API</a> object
+</p></td>
+        </tr>
+    </table>
+            <div class="sectiontitle">Class Public methods</div>
+            <div class="method">
+                <div class="title" id="M000005">
+                    <a name="M000005"></a><b>new</b>(credentials = AdWordsCredentials.new)
+                </div>
+                <div class="description">
+                  <p>
+Constructor for <a href="API.html">API</a>.
+</p>
+<p>
+Args:
+</p>
+<ul>
+<li>credentials: <a href="AdWordsCredentials.html">AdWordsCredentials</a>
+object containing the login information
+</li>
+</ul>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000005_source')" id="l_M000005_source">show</a>
+                    </p>
+                    <div id="M000005_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/adwords4r.rb, line 63</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">credentials</span> = <span class="ruby-constant">AdWordsCredentials</span>.<span class="ruby-identifier">new</span>)
+      <span class="ruby-ivar">@credentials</span> = <span class="ruby-identifier">credentials</span>
+      <span class="ruby-ivar">@drivers</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
+      <span class="ruby-ivar">@wrappers</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
+      <span class="ruby-ivar">@total_units</span> = <span class="ruby-value">0</span>
+      <span class="ruby-ivar">@last_units</span> = <span class="ruby-value">0</span>
+      <span class="ruby-identifier">log_to_console</span> = <span class="ruby-operator">!</span><span class="ruby-constant">ENV</span>[<span class="ruby-value str">'ADWORDS4R_DEBUG'</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span>
+          <span class="ruby-constant">ENV</span>[<span class="ruby-value str">'ADWORDS4R_DEBUG'</span>].<span class="ruby-identifier">upcase</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'TRUE'</span>
+      <span class="ruby-ivar">@xml_logger</span> = <span class="ruby-constant">AdWordsLogger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'soap_xml'</span>, <span class="ruby-identifier">log_to_console</span>)
+      <span class="ruby-ivar">@unit_logger</span> = <span class="ruby-constant">AdWordsLogger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'request_info'</span>)
+      <span class="ruby-ivar">@mutex</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
+      <span class="ruby-identifier">prepare_drivers</span>
+    <span class="ruby-keyword kw">end</span></pre>
+                    </div>
+                </div>
+            </div>
+            <div class="sectiontitle">Instance Public methods</div>
+            <div class="method">
+                <div class="title" id="M000006">
+                    <a name="M000006"></a><b>get_service</b>(version, name)
+                </div>
+                <div class="description">
+                  <p>
+Obtain an <a href="API.html">API</a> service, given a version and its name.
+</p>
+<p>
+Args:
+</p>
+<ul>
+<li>version: intended <a href="API.html">API</a> version. Must be an integer.
+</li>
+<li>name: name for the intended service
+</li>
+</ul>
+<p>
+Returns: The service wrapper for the intended service.
+</p>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000006_source')" id="l_M000006_source">show</a>
+                    </p>
+                    <div id="M000006_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/adwords4r.rb, line 86</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_service</span>(<span class="ruby-identifier">version</span>, <span class="ruby-identifier">name</span>)
+      <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@wrappers</span>[[<span class="ruby-identifier">version</span>, <span class="ruby-identifier">name</span>]]
+    <span class="ruby-keyword kw">end</span></pre>
+                    </div>
+                </div>
+            </div>
+</div>
+    </div>
+  </body>
+</html>