blob: 1638157c6589893e6cebf6339e17abee27830668 [file] [log] [blame]
Joe Gregorioafc45f22011-02-20 16:11:28 -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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Expands&nbsp;a&nbsp;short&nbsp;URL&nbsp;or&nbsp;gets&nbsp;creation&nbsp;time&nbsp;and&nbsp;analytics.<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050020&nbsp;&nbsp;shortUrl:&nbsp;string,&nbsp;The&nbsp;short&nbsp;URL,&nbsp;including&nbsp;the&nbsp;protocol.&nbsp;(required)<br>
21&nbsp;&nbsp;projection:&nbsp;string,&nbsp;Additional&nbsp;information&nbsp;to&nbsp;return.<br>
22&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
23&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ANALYTICS_CLICKS&nbsp;-&nbsp;Returns&nbsp;only&nbsp;click&nbsp;counts.<br>
24&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ANALYTICS_TOP_STRINGS&nbsp;-&nbsp;Returns&nbsp;only&nbsp;top&nbsp;string&nbsp;counts.<br>
25&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;FULL&nbsp;-&nbsp;Returns&nbsp;the&nbsp;creation&nbsp;timestamp&nbsp;and&nbsp;all&nbsp;available&nbsp;analytics.</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050026
27<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates&nbsp;a&nbsp;new&nbsp;short&nbsp;URL.<br>
28&nbsp;<br>
29Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050030&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050031
32<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;a&nbsp;list&nbsp;of&nbsp;URLs&nbsp;shortened&nbsp;by&nbsp;a&nbsp;user.<br>
33&nbsp;<br>
34Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050035&nbsp;&nbsp;start_token:&nbsp;string,&nbsp;Token&nbsp;for&nbsp;requesting&nbsp;successive&nbsp;pages&nbsp;of&nbsp;results.<br>
36&nbsp;&nbsp;projection:&nbsp;string,&nbsp;Additional&nbsp;information&nbsp;to&nbsp;return.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ANALYTICS_CLICKS&nbsp;-&nbsp;Returns&nbsp;short&nbsp;URL&nbsp;click&nbsp;counts.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;FULL&nbsp;-&nbsp;Returns&nbsp;short&nbsp;URL&nbsp;click&nbsp;counts.</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050040
41<hr>
42Data descriptors defined here:<br>
43<dl><dt><strong>__dict__</strong></dt>
44<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
45</dl>
46<dl><dt><strong>__weakref__</strong></dt>
47<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
48</dl>
49</td></tr></table>
50</body></html>