docs/dyn/adsense.v1.1.reports.html - platform/external/python/google-api-python-client - Gitiles


 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><title>Python: class Resource</title>
 </head><body bgcolor="#f0f0f8">
 <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ffc8d8">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <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>

 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 <td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
 <tr><td>&nbsp;</td>
 <td width="100%">Methods defined here:<br>
 <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>

 <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>
 &nbsp;<br>
 Args:<br>
 &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>
 &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>
 &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>
 &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>
 &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>
 &nbsp;&nbsp;metric:&nbsp;string,&nbsp;Numeric&nbsp;columns&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;report.&nbsp;(repeated)<br>
 &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>
 &nbsp;&nbsp;filter:&nbsp;string,&nbsp;Filters&nbsp;to&nbsp;be&nbsp;run&nbsp;on&nbsp;the&nbsp;report.&nbsp;(repeated)<br>
 &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>
 &nbsp;&nbsp;dimension:&nbsp;string,&nbsp;Dimensions&nbsp;to&nbsp;base&nbsp;the&nbsp;report&nbsp;on.&nbsp;(repeated)<br>
 &nbsp;&nbsp;accountId:&nbsp;string,&nbsp;Accounts&nbsp;upon&nbsp;which&nbsp;to&nbsp;report.&nbsp;(repeated)<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
 &nbsp;<br>
 &nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#report",&nbsp;#&nbsp;Kind&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#report.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"rows":&nbsp;[&nbsp;#&nbsp;The&nbsp;output&nbsp;rows&nbsp;of&nbsp;the&nbsp;report.&nbsp;Each&nbsp;row&nbsp;is&nbsp;a&nbsp;list&nbsp;of&nbsp;cells;&nbsp;one&nbsp;for&nbsp;each&nbsp;dimension&nbsp;in&nbsp;the&nbsp;request,&nbsp;followed&nbsp;by&nbsp;one&nbsp;for&nbsp;each&nbsp;metric&nbsp;in&nbsp;the&nbsp;request.&nbsp;The&nbsp;dimension&nbsp;cells&nbsp;contain&nbsp;strings,&nbsp;and&nbsp;the&nbsp;metric&nbsp;cells&nbsp;contain&nbsp;numbers.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"warnings":&nbsp;[&nbsp;#&nbsp;Any&nbsp;warnings&nbsp;associated&nbsp;with&nbsp;generation&nbsp;of&nbsp;the&nbsp;report.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"totals":&nbsp;[&nbsp;#&nbsp;The&nbsp;totals&nbsp;of&nbsp;the&nbsp;report.&nbsp;This&nbsp;is&nbsp;the&nbsp;same&nbsp;length&nbsp;as&nbsp;any&nbsp;other&nbsp;row&nbsp;in&nbsp;the&nbsp;report;&nbsp;cells&nbsp;corresponding&nbsp;to&nbsp;dimension&nbsp;columns&nbsp;are&nbsp;empty.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"headers":&nbsp;[&nbsp;#&nbsp;The&nbsp;header&nbsp;information&nbsp;of&nbsp;the&nbsp;columns&nbsp;requested&nbsp;in&nbsp;the&nbsp;report.&nbsp;This&nbsp;is&nbsp;a&nbsp;list&nbsp;of&nbsp;headers;&nbsp;one&nbsp;for&nbsp;each&nbsp;dimension&nbsp;in&nbsp;the&nbsp;request,&nbsp;followed&nbsp;by&nbsp;one&nbsp;for&nbsp;each&nbsp;metric&nbsp;in&nbsp;the&nbsp;request.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currency":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;currency&nbsp;of&nbsp;this&nbsp;column.&nbsp;Only&nbsp;present&nbsp;if&nbsp;the&nbsp;header&nbsp;type&nbsp;is&nbsp;METRIC_CURRENCY.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;type&nbsp;of&nbsp;the&nbsp;header;&nbsp;one&nbsp;of&nbsp;DIMENSION,&nbsp;METRIC_TALLY,&nbsp;METRIC_RATIO,&nbsp;or&nbsp;METRIC_CURRENCY.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;header.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"totalMatchedRows":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;total&nbsp;number&nbsp;of&nbsp;rows&nbsp;matched&nbsp;by&nbsp;the&nbsp;report&nbsp;request.&nbsp;Fewer&nbsp;rows&nbsp;may&nbsp;be&nbsp;returned&nbsp;in&nbsp;the&nbsp;response&nbsp;due&nbsp;to&nbsp;being&nbsp;limited&nbsp;by&nbsp;the&nbsp;row&nbsp;count&nbsp;requested&nbsp;or&nbsp;the&nbsp;report&nbsp;row&nbsp;limit.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"averages":&nbsp;[&nbsp;#&nbsp;The&nbsp;averages&nbsp;of&nbsp;the&nbsp;report.&nbsp;This&nbsp;is&nbsp;the&nbsp;same&nbsp;length&nbsp;as&nbsp;any&nbsp;other&nbsp;row&nbsp;in&nbsp;the&nbsp;report;&nbsp;cells&nbsp;corresponding&nbsp;to&nbsp;dimension&nbsp;columns&nbsp;are&nbsp;empty.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;}</tt></dd></dl>

 <hr>
 Data descriptors defined here:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 </td></tr></table>
 </body></html>

	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html><head><title>Python: class Resource</title>
	</head><body bgcolor="#f0f0f8">
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ffc8d8">
	<td colspan=3 valign=bottom> <br>
	<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>

	<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>
	<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
	<tr><td> </td>
	<td width="100%">Methods defined here:<br>
	<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>

	<dl><dt><a name="Resource-generate"><strong>generate</strong></a> = method(self, **kwargs)</dt><dd><tt>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.<br>
	<br>
	Args:<br>
	sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)<br>
	startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
	endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
	currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.<br>
	locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.<br>
	metric: string, Numeric columns to include in the report. (repeated)<br>
	maxResults: integer, The maximum number of rows of report data to return.<br>
	filter: string, Filters to be run on the report. (repeated)<br>
	startIndex: integer, Index of the first row of report data to return.<br>
	dimension: string, Dimensions to base the report on. (repeated)<br>
	accountId: string, Accounts upon which to report. (repeated)<br>
	<br>
	Returns:<br>
	An object of the form<br>
	<br>
	{<br>
	"kind": "adsense#report", # Kind this is, in this case adsense#report.<br>
	"rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.<br>
	[<br>
	"A String",<br>
	],<br>
	],<br>
	"warnings": [ # Any warnings associated with generation of the report.<br>
	"A String",<br>
	],<br>
	"totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.<br>
	"A String",<br>
	],<br>
	"headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.<br>
	{<br>
	"currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.<br>
	"type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.<br>
	"name": "A String", # The name of the header.<br>
	},<br>
	],<br>
	"totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.<br>
	"averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.<br>
	"A String",<br>
	],<br>
	}</tt></dd></dl>

	<hr>
	Data descriptors defined here:<br>
	<dl><dt><strong>__dict__</strong></dt>
	<dd><tt>dictionary for instance variables (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>__weakref__</strong></dt>
	<dd><tt>list of weak references to the object (if defined)</tt></dd>
	</dl>
	</td></tr></table>
	</body></html>