Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5ae088dc027b89517b896a89a0aeb2ca80f492cf / . / docs / dyn / analytics_v3.data.ga.html
blob: 44a58f8e90639675789e231ee2d1201733b9e397 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.data.html">data</a> . <a href="analytics_v3.data.ga.html">ga</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]81 <code><a href="#get">get(ids, start_date, end_date, metrics, dimensions=None, sort=None, output=None, include_empty_rows=None, max_results=None, samplingLevel=None, start_index=None, segment=None, filters=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Returns Analytics data for a view (profile).</p>
83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]90 <code class="details" id="get">get(ids, start_date, end_date, metrics, dimensions=None, sort=None, output=None, include_empty_rows=None, max_results=None, samplingLevel=None, start_index=None, segment=None, filters=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91 <pre>Returns Analytics data for a view (profile).
92
93Args:
94 ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required)
95 start_date: string, Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. (required)
96 end_date: string, End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97 metrics: string, A comma-separated list of Analytics metrics. E.g., &#x27;ga:sessions,ga:pageviews&#x27;. At least one metric must be specified. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]98 dimensions: string, A comma-separated list of Analytics dimensions. E.g., &#x27;ga:browser,ga:city&#x27;.
99 sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 output: string, The selected format for the response. Default format is JSON.
101 Allowed values
102 dataTable - Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.
103 json - Returns the response in standard JSON format.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]104 include_empty_rows: boolean, The response will include empty rows if this parameter is set to true, the default is true
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]105 max_results: integer, The maximum number of entries to include in this feed.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]106 samplingLevel: string, The desired sampling level.
107 Allowed values
108 DEFAULT - Returns response with a sample size that balances speed and accuracy.
109 FASTER - Returns a fast response with a smaller sample size.
110 HIGHER_PRECISION - Returns a more accurate response using a large sample size, but this may result in the response being slower.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]111 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112 segment: string, An Analytics segment to be applied to data.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]113 filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114
115Returns:
116 An object of the form:
117
118 { # Analytics data for a given view (profile).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]119 &quot;sampleSize&quot;: &quot;A String&quot;, # The number of samples used to calculate the result.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]120 &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this Analytics data query.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]121 &quot;itemsPerPage&quot;: 42, # The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]122 &quot;totalResults&quot;: 42, # The total number of rows for the query, regardless of the number of rows in the response.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]123 &quot;dataTable&quot;: {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]124 &quot;cols&quot;: [
125 {
126 &quot;type&quot;: &quot;A String&quot;,
127 &quot;label&quot;: &quot;A String&quot;,
128 &quot;id&quot;: &quot;A String&quot;,
129 },
130 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]131 &quot;rows&quot;: [
132 {
133 &quot;c&quot;: [
134 {
135 &quot;v&quot;: &quot;A String&quot;,
136 },
137 ],
138 },
139 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]140 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]141 &quot;containsSampledData&quot;: True or False, # Determines if Analytics data contains samples.
142 &quot;kind&quot;: &quot;analytics#gaData&quot;, # Resource type.
143 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this page.
144 &quot;dataLastRefreshed&quot;: &quot;A String&quot;, # The last refreshed time in seconds for Analytics data.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 &quot;columnHeaders&quot;: [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
146 {
147 &quot;name&quot;: &quot;A String&quot;, # Column name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]148 &quot;columnType&quot;: &quot;A String&quot;, # Column Type. Either DIMENSION or METRIC.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]149 &quot;dataType&quot;: &quot;A String&quot;, # Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]150 },
151 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]152 &quot;profileInfo&quot;: { # Information for the view (profile), for which the Analytics data was requested.
153 &quot;profileName&quot;: &quot;A String&quot;, # View (Profile) name.
154 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web Property ID to which this view (profile) belongs.
155 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
156 &quot;profileId&quot;: &quot;A String&quot;, # View (Profile) ID.
157 &quot;tableId&quot;: &quot;A String&quot;, # Table ID for view (profile).
158 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]160 &quot;rows&quot;: [ # Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
161 [
162 &quot;A String&quot;,
163 ],
164 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]165 &quot;id&quot;: &quot;A String&quot;, # Unique ID for this data response.
166 &quot;sampleSpace&quot;: &quot;A String&quot;, # Total size of the sample space from which the samples were selected.
167 &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this Analytics data query.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]168 &quot;totalsForAllResults&quot;: { # Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
169 &quot;a_key&quot;: &quot;A String&quot;, # Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.
170 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]171 &quot;query&quot;: { # Analytics data request query parameters.
172 &quot;sort&quot;: [ # List of dimensions or metrics based on which Analytics data is sorted.
173 &quot;A String&quot;,
174 ],
175 &quot;metrics&quot;: [ # List of analytics metrics.
176 &quot;A String&quot;,
177 ],
178 &quot;start-index&quot;: 42, # Start index.
179 &quot;max-results&quot;: 42, # Maximum results per page.
180 &quot;segment&quot;: &quot;A String&quot;, # Analytics advanced segment.
181 &quot;start-date&quot;: &quot;A String&quot;, # Start date.
182 &quot;filters&quot;: &quot;A String&quot;, # Comma-separated list of dimension or metric filters.
183 &quot;end-date&quot;: &quot;A String&quot;, # End date.
184 &quot;dimensions&quot;: &quot;A String&quot;, # List of analytics dimensions.
185 &quot;samplingLevel&quot;: &quot;A String&quot;, # Desired sampling level
186 &quot;ids&quot;: &quot;A String&quot;, # Unique table ID.
187 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]188 }</pre>
189</div>
190
191</body></html>