Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a07cb9ce4a45949705af26f385fb60b636a4788c / . / docs / dyn / adsense.v1.reports.html
blob: cb7aa5fe81b83ce6282f915da53d237b8659f271 [file] [log] [blame]
Joe Gregorio761c4562011-10-28 14:36:24 -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>&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-generate"><strong>generate</strong></a> = method(self, **kwargs)</dt><dd><tt>Generate&nbsp;an&nbsp;AdSense&nbsp;report&nbsp;based&nbsp;on&nbsp;the&nbsp;report&nbsp;request&nbsp;sent&nbsp;in&nbsp;the&nbsp;query&nbsp;parameters.&nbsp;Returns&nbsp;the&nbsp;result&nbsp;as&nbsp;JSON;&nbsp;to&nbsp;retrieve&nbsp;output&nbsp;in&nbsp;CSV&nbsp;format&nbsp;specify&nbsp;"alt=csv"&nbsp;as&nbsp;a&nbsp;query&nbsp;parameter.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;sort:&nbsp;string,&nbsp;The&nbsp;name&nbsp;of&nbsp;a&nbsp;dimension&nbsp;or&nbsp;metric&nbsp;to&nbsp;sort&nbsp;the&nbsp;resulting&nbsp;report&nbsp;on,&nbsp;optionally&nbsp;prefixed&nbsp;with&nbsp;"+"&nbsp;to&nbsp;sort&nbsp;ascending&nbsp;or&nbsp;"-"&nbsp;to&nbsp;sort&nbsp;descending.&nbsp;If&nbsp;no&nbsp;prefix&nbsp;is&nbsp;specified,&nbsp;the&nbsp;column&nbsp;is&nbsp;sorted&nbsp;ascending.&nbsp;(repeated)<br>
21&nbsp;&nbsp;startDate:&nbsp;string,&nbsp;Start&nbsp;of&nbsp;the&nbsp;date&nbsp;range&nbsp;to&nbsp;report&nbsp;on&nbsp;in&nbsp;"YYYY-MM-DD"&nbsp;format,&nbsp;inclusive.&nbsp;(required)<br>
22&nbsp;&nbsp;endDate:&nbsp;string,&nbsp;End&nbsp;of&nbsp;the&nbsp;date&nbsp;range&nbsp;to&nbsp;report&nbsp;on&nbsp;in&nbsp;"YYYY-MM-DD"&nbsp;format,&nbsp;inclusive.&nbsp;(required)<br>
23&nbsp;&nbsp;currency:&nbsp;string,&nbsp;Optional&nbsp;currency&nbsp;to&nbsp;use&nbsp;when&nbsp;reporting&nbsp;on&nbsp;monetary&nbsp;metrics.&nbsp;Defaults&nbsp;to&nbsp;the&nbsp;account's&nbsp;currency&nbsp;if&nbsp;not&nbsp;set.<br>
24&nbsp;&nbsp;locale:&nbsp;string,&nbsp;Optional&nbsp;locale&nbsp;to&nbsp;use&nbsp;for&nbsp;translating&nbsp;report&nbsp;output&nbsp;to&nbsp;a&nbsp;local&nbsp;language.&nbsp;Defaults&nbsp;to&nbsp;"en_US"&nbsp;if&nbsp;not&nbsp;specified.<br>
25&nbsp;&nbsp;metric:&nbsp;string,&nbsp;Numeric&nbsp;columns&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;report.&nbsp;(repeated)<br>
26&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;rows&nbsp;of&nbsp;report&nbsp;data&nbsp;to&nbsp;return.<br>
27&nbsp;&nbsp;filter:&nbsp;string,&nbsp;Filters&nbsp;to&nbsp;be&nbsp;run&nbsp;on&nbsp;the&nbsp;report.&nbsp;(repeated)<br>
28&nbsp;&nbsp;startIndex:&nbsp;integer,&nbsp;Index&nbsp;of&nbsp;the&nbsp;first&nbsp;row&nbsp;of&nbsp;report&nbsp;data&nbsp;to&nbsp;return.<br>
29&nbsp;&nbsp;dimension:&nbsp;string,&nbsp;Dimensions&nbsp;to&nbsp;base&nbsp;the&nbsp;report&nbsp;on.&nbsp;(repeated)</tt></dd></dl>
30
31<hr>
32Data descriptors defined here:<br>
33<dl><dt><strong>__dict__</strong></dt>
34<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
35</dl>
36<dl><dt><strong>__weakref__</strong></dt>
37<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
38</dl>
39</td></tr></table>
40</body></html>