Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1adde1a2b51f7de770d5100c99aa3e3b21a7f2d8 / . / docs / dyn / analytics.v3.report.html
blob: fb4d8cf04142c6fd2a74c41d60b4fdb860cc4d22 [file] [log] [blame]
Joe Gregorioc4fc0952011-11-09 12:21:11 -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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;Analytics&nbsp;report&nbsp;data&nbsp;for&nbsp;a&nbsp;profile.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;sort:&nbsp;string,&nbsp;A&nbsp;comma-separated&nbsp;list&nbsp;of&nbsp;dimensions&nbsp;or&nbsp;metrics&nbsp;that&nbsp;determine&nbsp;the&nbsp;sort&nbsp;order&nbsp;for&nbsp;the&nbsp;report&nbsp;data.<br>
21&nbsp;&nbsp;end_date:&nbsp;string,&nbsp;End&nbsp;date&nbsp;for&nbsp;fetching&nbsp;report&nbsp;data.&nbsp;All&nbsp;requests&nbsp;should&nbsp;specify&nbsp;an&nbsp;end&nbsp;date&nbsp;formatted&nbsp;as&nbsp;YYYY-MM-DD.&nbsp;(required)<br>
22&nbsp;&nbsp;dimensions:&nbsp;string,&nbsp;A&nbsp;comma-separated&nbsp;list&nbsp;of&nbsp;Analytics&nbsp;dimensions.&nbsp;E.g.,&nbsp;'ga:browser,ga:city'.<br>
23&nbsp;&nbsp;ids:&nbsp;string,&nbsp;Unique&nbsp;table&nbsp;ID&nbsp;for&nbsp;retrieving&nbsp;report&nbsp;data.&nbsp;Table&nbsp;ID&nbsp;is&nbsp;of&nbsp;the&nbsp;form&nbsp;ga:XXXX,&nbsp;where&nbsp;XXXX&nbsp;is&nbsp;the&nbsp;Analytics&nbsp;profile&nbsp;ID.&nbsp;(required)<br>
24&nbsp;&nbsp;metrics:&nbsp;string,&nbsp;A&nbsp;comma-separated&nbsp;list&nbsp;of&nbsp;Analytics&nbsp;metrics.&nbsp;E.g.,&nbsp;'ga:visits,ga:pageviews'.&nbsp;At&nbsp;least&nbsp;one&nbsp;metric&nbsp;must&nbsp;be&nbsp;specified&nbsp;to&nbsp;retrieve&nbsp;a&nbsp;valid&nbsp;Analytics&nbsp;report.&nbsp;(required)<br>
25&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;entries&nbsp;to&nbsp;include&nbsp;in&nbsp;this&nbsp;feed.<br>
26&nbsp;&nbsp;filters:&nbsp;string,&nbsp;A&nbsp;comma-separated&nbsp;list&nbsp;of&nbsp;dimension&nbsp;or&nbsp;metric&nbsp;filters&nbsp;to&nbsp;be&nbsp;applied&nbsp;to&nbsp;the&nbsp;report&nbsp;data.<br>
27&nbsp;&nbsp;segment:&nbsp;string,&nbsp;An&nbsp;Analytics&nbsp;advanced&nbsp;segment&nbsp;to&nbsp;be&nbsp;applied&nbsp;to&nbsp;the&nbsp;report&nbsp;data.<br>
28&nbsp;&nbsp;start_date:&nbsp;string,&nbsp;Start&nbsp;date&nbsp;for&nbsp;fetching&nbsp;report&nbsp;data.&nbsp;All&nbsp;requests&nbsp;should&nbsp;specify&nbsp;a&nbsp;start&nbsp;date&nbsp;formatted&nbsp;as&nbsp;YYYY-MM-DD.&nbsp;(required)<br>
29&nbsp;&nbsp;start_index:&nbsp;integer,&nbsp;An&nbsp;index&nbsp;of&nbsp;the&nbsp;first&nbsp;entity&nbsp;to&nbsp;retrieve.&nbsp;Use&nbsp;this&nbsp;parameter&nbsp;as&nbsp;a&nbsp;pagination&nbsp;mechanism&nbsp;along&nbsp;with&nbsp;the&nbsp;max-results&nbsp;parameter.</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>