Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 32d1c597b364e2641eca33ccf6df802bb218eea1 / . / docs / dyn / analytics_v3.data.mcf.html
blob: 04204dc26b19b041282f430ae8a3ad756f38651c [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.mcf.html">mcf</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">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]81 <code><a href="#get">get(ids, start_date, end_date, metrics, sort=None, filters=None, start_index=None, max_results=None, samplingLevel=None, dimensions=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Returns Analytics Multi-Channel Funnels 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">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]90 <code class="details" id="get">get(ids, start_date, end_date, metrics, sort=None, filters=None, start_index=None, max_results=None, samplingLevel=None, dimensions=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91 <pre>Returns Analytics Multi-Channel Funnels 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. 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)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97 metrics: string, A comma-separated list of Multi-Channel Funnels metrics. E.g., &#x27;mcf:totalConversions,mcf:totalConversionValue&#x27;. At least one metric must be specified. (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]98 sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]99 filters: string, A comma-separated list of dimension or metric filters to be applied to the Analytics data.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]100 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]101 max_results: integer, The maximum number of entries to include in this feed.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102 samplingLevel: string, The desired sampling level.
103 Allowed values
104 DEFAULT - Returns response with a sample size that balances speed and accuracy.
105 FASTER - Returns a fast response with a smaller sample size.
106 HIGHER_PRECISION - Returns a more accurate response using a large sample size, but this may result in the response being slower.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]107 dimensions: string, A comma-separated list of Multi-Channel Funnels dimensions. E.g., &#x27;mcf:source,mcf:medium&#x27;.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108
109Returns:
110 An object of the form:
111
112 { # Multi-Channel Funnels data for a given view (profile).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]113 &quot;sampleSize&quot;: &quot;A String&quot;, # The number of samples used to calculate the result.
114 &quot;totalResults&quot;: 42, # The total number of rows for the query, regardless of the number of rows in the response.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]115 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]116 &quot;query&quot;: { # Analytics data request query parameters.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]117 &quot;ids&quot;: &quot;A String&quot;, # Unique table ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]118 &quot;metrics&quot;: [ # List of analytics metrics.
119 &quot;A String&quot;,
120 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]121 &quot;sort&quot;: [ # List of dimensions or metrics based on which Analytics data is sorted.
122 &quot;A String&quot;,
123 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]124 &quot;end-date&quot;: &quot;A String&quot;, # End date.
125 &quot;dimensions&quot;: &quot;A String&quot;, # List of analytics dimensions.
126 &quot;filters&quot;: &quot;A String&quot;, # Comma-separated list of dimension or metric filters.
127 &quot;segment&quot;: &quot;A String&quot;, # Analytics advanced segment.
128 &quot;samplingLevel&quot;: &quot;A String&quot;, # Desired sampling level
129 &quot;start-date&quot;: &quot;A String&quot;, # Start date.
130 &quot;max-results&quot;: 42, # Maximum results per page.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]131 &quot;start-index&quot;: 42, # Start index.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]132 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]133 &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.
134 &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.
135 },
136 &quot;containsSampledData&quot;: True or False, # Determines if the Analytics data contains sampled data.
137 &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this Analytics data query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]138 &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.
139 [
140 { # A union object representing a dimension or metric value. Only one of &quot;primitiveValue&quot; or &quot;conversionPathValue&quot; attribute will be populated.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]141 &quot;primitiveValue&quot;: &quot;A String&quot;, # A primitive dimension value. A primitive metric value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]142 &quot;conversionPathValue&quot;: [ # A conversion path dimension value, containing a list of interactions with their attributes.
143 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]144 &quot;nodeValue&quot;: &quot;A String&quot;, # Node value of an interaction on conversion path. Such as source, medium etc.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]145 &quot;interactionType&quot;: &quot;A String&quot;, # Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]146 },
147 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]148 },
149 ],
150 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]151 &quot;id&quot;: &quot;A String&quot;, # Unique ID for this data response.
152 &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.
153 {
154 &quot;name&quot;: &quot;A String&quot;, # Column name.
155 &quot;dataType&quot;: &quot;A String&quot;, # Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.
156 &quot;columnType&quot;: &quot;A String&quot;, # Column Type. Either DIMENSION or METRIC.
157 },
158 ],
159 &quot;profileInfo&quot;: { # Information for the view (profile), for which the Analytics data was requested.
160 &quot;profileName&quot;: &quot;A String&quot;, # View (Profile) name.
161 &quot;profileId&quot;: &quot;A String&quot;, # View (Profile) ID.
162 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this view (profile) belongs.
163 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web Property ID to which this view (profile) belongs.
164 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this view (profile) belongs.
165 &quot;tableId&quot;: &quot;A String&quot;, # Table ID for view (profile).
166 },
167 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this page.
168 &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this Analytics data query.
169 &quot;sampleSpace&quot;: &quot;A String&quot;, # Total size of the sample space from which the samples were selected.
170 &quot;kind&quot;: &quot;analytics#mcfData&quot;, # Resource type.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]171 }</pre>
172</div>
173
174</body></html>