blob: e8e3cf71b9ee3cd53d3bbc1f4704b322693c7322 [file] [log] [blame]
Joe Gregorio2401bd62011-12-15 09:18:49 -05001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;all&nbsp;ad&nbsp;clients&nbsp;in&nbsp;the&nbsp;specified&nbsp;account.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token,&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;ad&nbsp;clients.&nbsp;To&nbsp;retrieve&nbsp;the&nbsp;next&nbsp;page,&nbsp;set&nbsp;this&nbsp;parameter&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;"nextPageToken"&nbsp;from&nbsp;the&nbsp;previous&nbsp;response.<br>
21&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;ad&nbsp;clients&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;response,&nbsp;used&nbsp;for&nbsp;paging.<br>
22&nbsp;&nbsp;accountId:&nbsp;string,&nbsp;Account&nbsp;for&nbsp;which&nbsp;to&nbsp;list&nbsp;ad&nbsp;clients.&nbsp;(required)<br>
23&nbsp;<br>
24Returns:<br>
25&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
26&nbsp;<br>
27&nbsp;&nbsp;&nbsp;&nbsp;{<br>
28&nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Continuation&nbsp;token&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;ad&nbsp;clients.&nbsp;To&nbsp;retrieve&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results,&nbsp;set&nbsp;the&nbsp;next&nbsp;request's&nbsp;"pageToken"&nbsp;value&nbsp;to&nbsp;this.<br>
29&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;ad&nbsp;clients&nbsp;returned&nbsp;in&nbsp;this&nbsp;list&nbsp;response.<br>
30&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
31&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"productCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;This&nbsp;ad&nbsp;client's&nbsp;product&nbsp;code,&nbsp;which&nbsp;corresponds&nbsp;to&nbsp;the&nbsp;PRODUCT_CODE&nbsp;report&nbsp;dimension.<br>
32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#adClient",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#adClient.<br>
33&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;this&nbsp;ad&nbsp;client.<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"supportsReporting":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Whether&nbsp;this&nbsp;ad&nbsp;client&nbsp;supports&nbsp;being&nbsp;reported&nbsp;on.<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
36&nbsp;&nbsp;&nbsp;&nbsp;],<br>
37&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#adClients",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;list&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#adClients.<br>
38&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;this&nbsp;response&nbsp;for&nbsp;caching&nbsp;purposes.<br>
39&nbsp;&nbsp;}</tt></dd></dl>
40
41<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
42&nbsp;<br>
43Args:<br>
44&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
45&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
46&nbsp;<br>
47Returns:<br>
48&nbsp;&nbsp;A&nbsp;request&nbsp;object&nbsp;that&nbsp;you&nbsp;can&nbsp;call&nbsp;'execute()'&nbsp;on&nbsp;to&nbsp;request&nbsp;the&nbsp;next<br>
49&nbsp;&nbsp;page.&nbsp;Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</tt></dd></dl>
50
51<hr>
52Data descriptors defined here:<br>
53<dl><dt><strong>__dict__</strong></dt>
54<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
55</dl>
56<dl><dt><strong>__weakref__</strong></dt>
57<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
58</dl>
59</td></tr></table>
60</body></html>