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