| Joe Gregorio | 0250385 | 2011-08-31 09:07:55 -0400 | [diff] [blame] | 1 | |
| 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> <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> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </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>Lists all accounts to which the user has access.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 20 | max_results: integer, The maximum number of entries to include in this response.<br> |
| 21 | start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br> |
| 22 | <br> |
| 23 | Returns:<br> |
| 24 | An object of the form<br> |
| 25 | <br> |
| 26 | {<br> |
| 27 | "username": "A String", # Email ID of the authenticated user<br> |
| 28 | "kind": "analytics#accounts", # Collection type.<br> |
| 29 | "items": [ # A list of accounts.<br> |
| 30 | {<br> |
| 31 | "kind": "analytics#account", # Resource type for Analytics account.<br> |
| 32 | "name": "A String", # Account name.<br> |
| 33 | "created": "A String", # Time the account was created.<br> |
| 34 | "updated": "A String", # Time the account was last modified.<br> |
| 35 | "childLink": { # Child link for an account entry. Points to the list of web properties for this account.<br> |
| 36 | "href": "A String", # Link to the list of web properties for this account.<br> |
| 37 | "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".<br> |
| 38 | },<br> |
| 39 | "id": "A String", # Account ID.<br> |
| 40 | "selfLink": "A String", # Link for this account.<br> |
| 41 | },<br> |
| 42 | ],<br> |
| 43 | "itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.<br> |
| 44 | "previousLink": "A String", # Previous link for this account collection.<br> |
| 45 | "startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.<br> |
| 46 | "nextLink": "A String", # Next link for this account collection.<br> |
| 47 | "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.<br> |
| 48 | }</tt></dd></dl> |
| Joe Gregorio | 0250385 | 2011-08-31 09:07:55 -0400 | [diff] [blame] | 49 | |
| 50 | <hr> |
| 51 | Data descriptors defined here:<br> |
| 52 | <dl><dt><strong>__dict__</strong></dt> |
| 53 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 54 | </dl> |
| 55 | <dl><dt><strong>__weakref__</strong></dt> |
| 56 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 57 | </dl> |
| 58 | </td></tr></table> |
| 59 | </body></html> |