Joe Gregorio | 2401bd6 | 2011-12-15 09:18:49 -0500 | [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>List all custom channels which the specified ad unit belongs to.<br> |
| 18 | <br> |
| 19 | Args:<br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 20 | pp: string, A parameter<br> |
| 21 | trace: string, A parameter<br> |
Joe Gregorio | 2401bd6 | 2011-12-15 09:18:49 -0500 | [diff] [blame] | 22 | pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br> |
| 23 | adClientId: string, Ad client which contains the ad unit. (required)<br> |
| 24 | maxResults: integer, The maximum number of custom channels to include in the response, used for paging.<br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 25 | strict: string, A parameter<br> |
| 26 | userip: string, A parameter<br> |
Joe Gregorio | 2401bd6 | 2011-12-15 09:18:49 -0500 | [diff] [blame] | 27 | adUnitId: string, Ad unit for which to list custom channels. (required)<br> |
| 28 | <br> |
| 29 | Returns:<br> |
| 30 | An object of the form<br> |
| 31 | <br> |
| 32 | {<br> |
| 33 | "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.<br> |
| 34 | "items": [ # The custom channels returned in this list response.<br> |
| 35 | {<br> |
| 36 | "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.<br> |
| 37 | "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.<br> |
| 38 | "targetingInfo": { # The targeting information of this custom channel, if activated.<br> |
| 39 | "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.<br> |
| 40 | "adsAppearOn": "A String", # The name used to describe this channel externally.<br> |
| 41 | "siteLanguage": "A String", # The language of the sites ads will be displayed on.<br> |
| 42 | "description": "A String", # The external description of the channel.<br> |
| 43 | },<br> |
| 44 | "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.<br> |
| 45 | "name": "A String", # Name of this custom channel.<br> |
| 46 | },<br> |
| 47 | ],<br> |
| 48 | "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.<br> |
| 49 | "etag": "A String", # ETag of this response for caching purposes.<br> |
| 50 | }</tt></dd></dl> |
| 51 | |
| 52 | <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br> |
| 53 | <br> |
| 54 | Args:<br> |
| 55 | previous_request: The request for the previous page.<br> |
| 56 | previous_response: The response from the request for the previous page.<br> |
| 57 | <br> |
| 58 | Returns:<br> |
| 59 | A request object that you can call 'execute()' on to request the next<br> |
| 60 | page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| 61 | |
| 62 | <hr> |
| 63 | Data descriptors defined here:<br> |
| 64 | <dl><dt><strong>__dict__</strong></dt> |
| 65 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 66 | </dl> |
| 67 | <dl><dt><strong>__weakref__</strong></dt> |
| 68 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 69 | </dl> |
| 70 | </td></tr></table> |
| 71 | </body></html> |