doc/classes/AdWords/Extensions.html in adwords4r-16.0.0 vs doc/classes/AdWords/Extensions.html in adwords4r-17.0.0

- old
+ new

@@ -41,42 +41,42 @@ <dt>D</dt> <dd> <ul> - <li><a href="#M000043">downloadCsvReport</a>,</li> + <li><a href="#M000054">downloadCsvReport</a>,</li> - <li><a href="#M000041">downloadXmlReport</a></li> + <li><a href="#M000050">downloadXmlReport</a></li> </ul> </dd> <dt>E</dt> <dd> <ul> - <li><a href="#M000037">extensions</a></li> + <li><a href="#M000046">extensions</a></li> </ul> </dd> <dt>G</dt> <dd> <ul> - <li><a href="#M000046">getClientUnitsUsage</a>,</li> + <li><a href="#M000056">getClientUnitsUsage</a>,</li> - <li><a href="#M000044">getMethodUsage</a></li> + <li><a href="#M000055">getMethodUsage</a></li> </ul> </dd> <dt>M</dt> <dd> <ul> - <li><a href="#M000040">methods</a></li> + <li><a href="#M000049">methods</a></li> </ul> </dd> </dl> @@ -94,13 +94,13 @@ <div class="sectiontitle">Class Public methods</div> <div class="method"> - <div class="title" id="M000043"> + <div class="title" id="M000054"> - <a name="M000043"></a><b>downloadCsvReport</b>(wrapper, job_id, report_xml=nil) + <a name="M000054"></a><b>downloadCsvReport</b>(wrapper, job_id, report_xml=nil) </div> <div class="description"> <p> @@ -134,15 +134,15 @@ <div class="sourcecode"> <p class="source-link"> - Source: <a href="javascript:toggleSource('M000043_source')" id="l_M000043_source">show</a> + Source: <a href="javascript:toggleSource('M000054_source')" id="l_M000054_source">show</a> </p> - <div id="M000043_source" class="dyn-source"> - <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 118</span> + <div id="M000054_source" class="dyn-source"> + <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 121</span> <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">downloadCsvReport</span>(<span class="ruby-identifier">wrapper</span>, <span class="ruby-identifier">job_id</span>, <span class="ruby-identifier">report_xml</span>=<span class="ruby-keyword kw">nil</span>) <span class="ruby-comment cmt"># Get XML report data.</span> <span class="ruby-identifier">report_xml</span> = <span class="ruby-identifier">downloadXmlReport</span>(<span class="ruby-identifier">wrapper</span>, <span class="ruby-identifier">job_id</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">report_xml</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">begin</span> @@ -184,13 +184,13 @@ </div> </div> <div class="method"> - <div class="title" id="M000041"> + <div class="title" id="M000050"> - <a name="M000041"></a><b>downloadXmlReport</b>(wrapper, job_id) + <a name="M000050"></a><b>downloadXmlReport</b>(wrapper, job_id) </div> <div class="description"> <p> @@ -221,15 +221,15 @@ <div class="sourcecode"> <p class="source-link"> - Source: <a href="javascript:toggleSource('M000041_source')" id="l_M000041_source">show</a> + Source: <a href="javascript:toggleSource('M000050_source')" id="l_M000050_source">show</a> </p> - <div id="M000041_source" class="dyn-source"> - <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 71</span> + <div id="M000050_source" class="dyn-source"> + <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 74</span> <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">downloadXmlReport</span>(<span class="ruby-identifier">wrapper</span>, <span class="ruby-identifier">job_id</span>) <span class="ruby-identifier">sleep_interval</span> = <span class="ruby-value">30</span> <span class="ruby-comment cmt"># Repeatedly check the report status until it is finished.</span> <span class="ruby-comment cmt"># 'Pending' and 'InProgress' statuses indicate the job is still being run.</span> @@ -265,13 +265,13 @@ </div> </div> <div class="method"> - <div class="title" id="M000037"> + <div class="title" id="M000046"> - <a name="M000037"></a><b>extensions</b>() + <a name="M000046"></a><b>extensions</b>() </div> <div class="description"> <p> @@ -283,27 +283,27 @@ <div class="sourcecode"> <p class="source-link"> - Source: <a href="javascript:toggleSource('M000037_source')" id="l_M000037_source">show</a> + Source: <a href="javascript:toggleSource('M000046_source')" id="l_M000046_source">show</a> </p> - <div id="M000037_source" class="dyn-source"> - <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 43</span> + <div id="M000046_source" class="dyn-source"> + <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 46</span> <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">extensions</span> <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@@extensions</span> <span class="ruby-keyword kw">end</span></pre> </div> </div> </div> <div class="method"> - <div class="title" id="M000046"> + <div class="title" id="M000056"> - <a name="M000046"></a><b>getClientUnitsUsage</b>(wrapper, start_date, end_date) + <a name="M000056"></a><b>getClientUnitsUsage</b>(wrapper, start_date, end_date) </div> <div class="description"> <p> @@ -354,15 +354,15 @@ <div class="sourcecode"> <p class="source-link"> - Source: <a href="javascript:toggleSource('M000046_source')" id="l_M000046_source">show</a> + Source: <a href="javascript:toggleSource('M000056_source')" id="l_M000056_source">show</a> </p> - <div id="M000046_source" class="dyn-source"> - <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 209</span> + <div id="M000056_source" class="dyn-source"> + <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 214</span> <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">getClientUnitsUsage</span>(<span class="ruby-identifier">wrapper</span>, <span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>) <span class="ruby-comment cmt"># Create a new AdWords::API object to ensure thread-safety (we'll need to</span> <span class="ruby-comment cmt"># change the clientEmail)</span> <span class="ruby-identifier">adwords</span> = <span class="ruby-constant">AdWords</span><span class="ruby-operator">::</span><span class="ruby-constant">API</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">wrapper</span>.<span class="ruby-identifier">api</span>.<span class="ruby-identifier">credentials</span>.<span class="ruby-identifier">dup</span>) <span class="ruby-identifier">adwords</span>.<span class="ruby-identifier">credentials</span>.<span class="ruby-identifier">set_header</span>(<span class="ruby-value str">'clientEmail'</span>, <span class="ruby-value str">''</span>) @@ -379,13 +379,13 @@ </div> </div> <div class="method"> - <div class="title" id="M000044"> + <div class="title" id="M000055"> - <a name="M000044"></a><b>getMethodUsage</b>(wrapper, start_date, end_date) + <a name="M000055"></a><b>getMethodUsage</b>(wrapper, start_date, end_date) </div> <div class="description"> <p> @@ -428,36 +428,38 @@ <div class="sourcecode"> <p class="source-link"> - Source: <a href="javascript:toggleSource('M000044_source')" id="l_M000044_source">show</a> + Source: <a href="javascript:toggleSource('M000055_source')" id="l_M000055_source">show</a> </p> - <div id="M000044_source" class="dyn-source"> - <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 176</span> + <div id="M000055_source" class="dyn-source"> + <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 179</span> <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">getMethodUsage</span>(<span class="ruby-identifier">wrapper</span>, <span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>) <span class="ruby-identifier">op_rates</span> = <span class="ruby-constant">AdWords</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">get_operation_rates</span> <span class="ruby-identifier">usage</span> = {} <span class="ruby-identifier">op_rates</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">op</span><span class="ruby-operator">|</span> - <span class="ruby-identifier">service</span>, <span class="ruby-identifier">method</span> = <span class="ruby-identifier">op</span> - <span class="ruby-identifier">usage</span>[<span class="ruby-identifier">service</span> <span class="ruby-operator">+</span> <span class="ruby-value str">'.'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">method</span>] = <span class="ruby-identifier">wrapper</span>.<span class="ruby-identifier">getUnitCountForMethod</span>(<span class="ruby-identifier">service</span>, - <span class="ruby-identifier">method</span>, <span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>).<span class="ruby-identifier">getUnitCountForMethodReturn</span> + <span class="ruby-identifier">version</span>, <span class="ruby-identifier">service</span>, <span class="ruby-identifier">method</span> = <span class="ruby-identifier">op</span> + <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">version</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'v13'</span> + <span class="ruby-identifier">usage</span>[<span class="ruby-identifier">service</span> <span class="ruby-operator">+</span> <span class="ruby-value str">'.'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">method</span>] = <span class="ruby-identifier">wrapper</span>.<span class="ruby-identifier">getUnitCountForMethod</span>(<span class="ruby-identifier">service</span>, + <span class="ruby-identifier">method</span>, <span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>).<span class="ruby-identifier">getUnitCountForMethodReturn</span> + <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">usage</span> <span class="ruby-keyword kw">end</span></pre> </div> </div> </div> <div class="method"> - <div class="title" id="M000040"> + <div class="title" id="M000049"> - <a name="M000040"></a><b>methods</b>() + <a name="M000049"></a><b>methods</b>() </div> <div class="description"> <p> @@ -469,14 +471,14 @@ <div class="sourcecode"> <p class="source-link"> - Source: <a href="javascript:toggleSource('M000040_source')" id="l_M000040_source">show</a> + Source: <a href="javascript:toggleSource('M000049_source')" id="l_M000049_source">show</a> </p> - <div id="M000040_source" class="dyn-source"> - <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 48</span> + <div id="M000049_source" class="dyn-source"> + <pre><span class="ruby-comment cmt"># File lib/adwords4r/apiextensions.rb, line 51</span> <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">methods</span> <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@@methods</span> <span class="ruby-keyword kw">end</span></pre> </div> </div> \ No newline at end of file