Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ebd0b8402b34d30c7c0ee4fa2198f48f1bcfd62b / . / docs / dyn / adsense.v1.1.adunits.html
blob: a4b5ee5168bd6f409cd0cf267b07dca109b28cd4 [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-customchannels"><strong><a href="adsense.v1.1.adunits.customchannels.html">customchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
18
19<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets&nbsp;the&nbsp;specified&nbsp;ad&nbsp;unit&nbsp;in&nbsp;the&nbsp;specified&nbsp;ad&nbsp;client.<br>
20&nbsp;<br>
21Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]22&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
23&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]24&nbsp;&nbsp;adClientId:&nbsp;string,&nbsp;Ad&nbsp;client&nbsp;for&nbsp;which&nbsp;to&nbsp;get&nbsp;the&nbsp;ad&nbsp;unit.&nbsp;(required)<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;&nbsp;adUnitId:&nbsp;string,&nbsp;Ad&nbsp;unit&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
28&nbsp;<br>
29Returns:<br>
30&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
31&nbsp;<br>
32&nbsp;&nbsp;&nbsp;&nbsp;{<br>
33&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;this&nbsp;ad&nbsp;unit.&nbsp;Possible&nbsp;values&nbsp;are:<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;NEW:&nbsp;Indicates&nbsp;that&nbsp;the&nbsp;ad&nbsp;unit&nbsp;was&nbsp;created&nbsp;within&nbsp;the&nbsp;last&nbsp;seven&nbsp;days&nbsp;and&nbsp;does&nbsp;not&nbsp;yet&nbsp;have&nbsp;any&nbsp;activity&nbsp;associated&nbsp;with&nbsp;it.<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;ACTIVE:&nbsp;Indicates&nbsp;that&nbsp;there&nbsp;has&nbsp;been&nbsp;activity&nbsp;on&nbsp;this&nbsp;ad&nbsp;unit&nbsp;in&nbsp;the&nbsp;last&nbsp;seven&nbsp;days.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;INACTIVE:&nbsp;Indicates&nbsp;that&nbsp;there&nbsp;has&nbsp;been&nbsp;no&nbsp;activity&nbsp;on&nbsp;this&nbsp;ad&nbsp;unit&nbsp;in&nbsp;the&nbsp;last&nbsp;seven&nbsp;days.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#adUnit",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#adUnit.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;"code":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identity&nbsp;code&nbsp;of&nbsp;this&nbsp;ad&nbsp;unit,&nbsp;not&nbsp;necessarily&nbsp;unique&nbsp;across&nbsp;ad&nbsp;clients.<br>
41&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;this&nbsp;ad&nbsp;unit.&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>
42&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;this&nbsp;ad&nbsp;unit.<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;ad&nbsp;units&nbsp;in&nbsp;the&nbsp;specified&nbsp;ad&nbsp;client&nbsp;for&nbsp;this&nbsp;AdSense&nbsp;account.<br>
46&nbsp;<br>
47Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]48&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 -0500[diff] [blame]50&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token,&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;ad&nbsp;units.&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;includeInactive:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;include&nbsp;inactive&nbsp;ad&nbsp;units.&nbsp;Default:&nbsp;true.<br>
52&nbsp;&nbsp;adClientId:&nbsp;string,&nbsp;Ad&nbsp;client&nbsp;for&nbsp;which&nbsp;to&nbsp;list&nbsp;ad&nbsp;units.&nbsp;(required)<br>
53&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;ad&nbsp;units&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]54&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
55&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]56&nbsp;<br>
57Returns:<br>
58&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
59&nbsp;<br>
60&nbsp;&nbsp;&nbsp;&nbsp;{<br>
61&nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Continuation&nbsp;token&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;ad&nbsp;units.&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>
62&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;ad&nbsp;units&nbsp;returned&nbsp;in&nbsp;this&nbsp;list&nbsp;response.<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;this&nbsp;ad&nbsp;unit.&nbsp;Possible&nbsp;values&nbsp;are:<br>
65&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;NEW:&nbsp;Indicates&nbsp;that&nbsp;the&nbsp;ad&nbsp;unit&nbsp;was&nbsp;created&nbsp;within&nbsp;the&nbsp;last&nbsp;seven&nbsp;days&nbsp;and&nbsp;does&nbsp;not&nbsp;yet&nbsp;have&nbsp;any&nbsp;activity&nbsp;associated&nbsp;with&nbsp;it.<br>
66&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#<br>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;ACTIVE:&nbsp;Indicates&nbsp;that&nbsp;there&nbsp;has&nbsp;been&nbsp;activity&nbsp;on&nbsp;this&nbsp;ad&nbsp;unit&nbsp;in&nbsp;the&nbsp;last&nbsp;seven&nbsp;days.<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#<br>
69&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;INACTIVE:&nbsp;Indicates&nbsp;that&nbsp;there&nbsp;has&nbsp;been&nbsp;no&nbsp;activity&nbsp;on&nbsp;this&nbsp;ad&nbsp;unit&nbsp;in&nbsp;the&nbsp;last&nbsp;seven&nbsp;days.<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#adUnit",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#adUnit.<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"code":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identity&nbsp;code&nbsp;of&nbsp;this&nbsp;ad&nbsp;unit,&nbsp;not&nbsp;necessarily&nbsp;unique&nbsp;across&nbsp;ad&nbsp;clients.<br>
72&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;this&nbsp;ad&nbsp;unit.&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>
73&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;this&nbsp;ad&nbsp;unit.<br>
74&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
75&nbsp;&nbsp;&nbsp;&nbsp;],<br>
76&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#adUnits",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;list&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#adUnits.<br>
77&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>
78&nbsp;&nbsp;}</tt></dd></dl>
79
80<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>
81&nbsp;<br>
82Args:<br>
83&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
84&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
85&nbsp;<br>
86Returns:<br>
87&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>
88&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>
89
90<hr>
91Data descriptors defined here:<br>
92<dl><dt><strong>__dict__</strong></dt>
93<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
94</dl>
95<dl><dt><strong>__weakref__</strong></dt>
96<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
97</dl>
98</td></tr></table>
99</body></html>