Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 81d92cc73fb5e35c1e6a539dc1eb5f60b02dd316 / . / docs / dyn / adsense.v1.1.urlchannels.html
blob: bb6d4a5688bc39df86789fdc0f30581425a215b4 [file] [log] [blame]
Joe Gregorio2401bd62011-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>&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;URL&nbsp;channels&nbsp;in&nbsp;the&nbsp;specified&nbsp;ad&nbsp;client&nbsp;for&nbsp;this&nbsp;AdSense&nbsp;account.<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]20&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]22&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token,&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;URL&nbsp;channels.&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>
23&nbsp;&nbsp;adClientId:&nbsp;string,&nbsp;Ad&nbsp;client&nbsp;for&nbsp;which&nbsp;to&nbsp;list&nbsp;URL&nbsp;channels.&nbsp;(required)<br>
24&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;URL&nbsp;channels&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;response,&nbsp;used&nbsp;for&nbsp;paging.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]25&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
26&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]27&nbsp;<br>
28Returns:<br>
29&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
30&nbsp;<br>
31&nbsp;&nbsp;&nbsp;&nbsp;{<br>
32&nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Continuation&nbsp;token&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;URL&nbsp;channels.&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>
33&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;URL&nbsp;channels&nbsp;returned&nbsp;in&nbsp;this&nbsp;list&nbsp;response.<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#urlChannel",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#urlChannel.<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;this&nbsp;URL&nbsp;channel.&nbsp;This&nbsp;should&nbsp;be&nbsp;considered&nbsp;an&nbsp;opaque&nbsp;identifier;&nbsp;it&nbsp;is&nbsp;not&nbsp;safe&nbsp;to&nbsp;rely&nbsp;on&nbsp;it&nbsp;being&nbsp;in&nbsp;any&nbsp;particular&nbsp;format.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"urlPattern":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;Pattern&nbsp;of&nbsp;this&nbsp;URL&nbsp;channel.&nbsp;Does&nbsp;not&nbsp;include&nbsp;"http://"&nbsp;or&nbsp;"https://".&nbsp;Example:&nbsp;www.example.com/home<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
39&nbsp;&nbsp;&nbsp;&nbsp;],<br>
40&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#urlChannels",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;list&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#urlChannels.<br>
41&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>
42&nbsp;&nbsp;}</tt></dd></dl>
43
44<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>
45&nbsp;<br>
46Args:<br>
47&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
48&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
49&nbsp;<br>
50Returns:<br>
51&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>
52&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>
53
54<hr>
55Data descriptors defined here:<br>
56<dl><dt><strong>__dict__</strong></dt>
57<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
58</dl>
59<dl><dt><strong>__weakref__</strong></dt>
60<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
61</dl>
62</td></tr></table>
63</body></html>