blob: 8add277952bb62532a8272183ae6d1c912eb9bd0 [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-adclients"><strong><a href="adsense.v1.1.accounts.adclients.html">adclients</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
18
19<dl><dt><a name="Resource-adunits"><strong><a href="adsense.v1.1.accounts.adunits.html">adunits</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
20
21<dl><dt><a name="Resource-customchannels"><strong><a href="adsense.v1.1.accounts.customchannels.html">customchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
22
23<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;information&nbsp;about&nbsp;the&nbsp;selected&nbsp;AdSense&nbsp;account.<br>
24&nbsp;<br>
25Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -040026&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
27&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -050028&nbsp;&nbsp;tree:&nbsp;boolean,&nbsp;Whether&nbsp;the&nbsp;tree&nbsp;of&nbsp;sub&nbsp;accounts&nbsp;should&nbsp;be&nbsp;returned.<br>
Joe Gregorio66212032012-06-14 09:10:14 -040029&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
30&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -050031&nbsp;&nbsp;accountId:&nbsp;string,&nbsp;Account&nbsp;to&nbsp;get&nbsp;information&nbsp;about.&nbsp;(required)<br>
32&nbsp;<br>
33Returns:<br>
34&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
35&nbsp;<br>
36&nbsp;&nbsp;&nbsp;&nbsp;{<br>
37&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#account",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#account.<br>
38&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;this&nbsp;account.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;"subAccounts":&nbsp;[&nbsp;#&nbsp;Sub&nbsp;accounts&nbsp;of&nbsp;the&nbsp;this&nbsp;account.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;Object&nbsp;with&nbsp;schema&nbsp;name:&nbsp;Account<br>
41&nbsp;&nbsp;&nbsp;&nbsp;],<br>
42&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;this&nbsp;account.<br>
43&nbsp;&nbsp;}</tt></dd></dl>
44
45<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;all&nbsp;accounts&nbsp;available&nbsp;to&nbsp;this&nbsp;AdSense&nbsp;account.<br>
46&nbsp;<br>
47Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -040048&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
49&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -050050&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token,&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;accounts.&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>
51&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;accounts&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;response,&nbsp;used&nbsp;for&nbsp;paging.<br>
Joe Gregorio66212032012-06-14 09:10:14 -040052&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
53&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -050054&nbsp;<br>
55Returns:<br>
56&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
57&nbsp;<br>
58&nbsp;&nbsp;&nbsp;&nbsp;{<br>
59&nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Continuation&nbsp;token&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;accounts.&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>
60&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;accounts&nbsp;returned&nbsp;in&nbsp;this&nbsp;list&nbsp;response.<br>
61&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#account",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#account.<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;this&nbsp;account.<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"subAccounts":&nbsp;[&nbsp;#&nbsp;Sub&nbsp;accounts&nbsp;of&nbsp;the&nbsp;this&nbsp;account.<br>
65&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;Object&nbsp;with&nbsp;schema&nbsp;name:&nbsp;Account<br>
66&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;this&nbsp;account.<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
69&nbsp;&nbsp;&nbsp;&nbsp;],<br>
70&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#accounts",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;list&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#accounts.<br>
71&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>
72&nbsp;&nbsp;}</tt></dd></dl>
73
74<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>
75&nbsp;<br>
76Args:<br>
77&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
78&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
79&nbsp;<br>
80Returns:<br>
81&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>
82&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>
83
84<dl><dt><a name="Resource-reports"><strong><a href="adsense.v1.1.accounts.reports.html">reports</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
85
86<dl><dt><a name="Resource-urlchannels"><strong><a href="adsense.v1.1.accounts.urlchannels.html">urlchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
87
88<hr>
89Data descriptors defined here:<br>
90<dl><dt><strong>__dict__</strong></dt>
91<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
92</dl>
93<dl><dt><strong>__weakref__</strong></dt>
94<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
95</dl>
96</td></tr></table>
97</body></html>