Blame - docs/dyn/analytics_v3.data.mcf.html - platform/external/python/google-api-python-client

<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

Dmitry Frenkel

3e17f89

2020-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

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

81

<code><a href="#get">get(ids, start_date, end_date, metrics, filters=None, start_index=None, max_results=None, sort=None, dimensions=None, samplingLevel=None)</a></code></p>

John Asmuth

614db98

2014-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

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

85

<code class="details" id="close">close()</code>

86

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

90

<code class="details" id="get">get(ids, start_date, end_date, metrics, filters=None, start_index=None, max_results=None, sort=None, dimensions=None, samplingLevel=None)</code>

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

91

<pre>Returns Analytics Multi-Channel Funnels data for a view (profile).

92

93

Args:

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 Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

97

metrics: string, A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. (required)

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

98

filters: string, A comma-separated list of dimension or metric filters to be applied to the Analytics data.

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.

100

max_results: integer, The maximum number of entries to include in this feed.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

101

sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

102

dimensions: string, A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

103

samplingLevel: string, The desired sampling level.

104

Allowed values

105

DEFAULT - Returns response with a sample size that balances speed and accuracy.

106

FASTER - Returns a fast response with a smaller sample size.

107

HIGHER_PRECISION - Returns a more accurate response using a large sample size, but this may result in the response being slower.

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

108

109

Returns:

110

An object of the form:

111

112

{ # Multi-Channel Funnels data for a given view (profile).

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

113

"id": "A String", # Unique ID for this data response.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

114

"totalsForAllResults": { # 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.

115

"a_key": "A String", # 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.

116

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

117

"query": { # Analytics data request query parameters.

118

"segment": "A String", # Analytics advanced segment.

119

"end-date": "A String", # End date.

120

"dimensions": "A String", # List of analytics dimensions.

121

"ids": "A String", # Unique table ID.

122

"sort": [ # List of dimensions or metrics based on which Analytics data is sorted.

123

"A String",

124

],

125

"metrics": [ # List of analytics metrics.

126

"A String",

127

],

128

"samplingLevel": "A String", # Desired sampling level

129

"start-date": "A String", # Start date.

130

"start-index": 42, # Start index.

131

"filters": "A String", # Comma-separated list of dimension or metric filters.

132

"max-results": 42, # Maximum results per page.

133

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

134

"rows": [ # 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.

135

[

136

{ # A union object representing a dimension or metric value. Only one of "primitiveValue" or "conversionPathValue" attribute will be populated.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

137

"primitiveValue": "A String", # A primitive dimension value. A primitive metric value.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

138

"conversionPathValue": [ # A conversion path dimension value, containing a list of interactions with their attributes.

139

{

140

"nodeValue": "A String", # Node value of an interaction on conversion path. Such as source, medium etc.

141

"interactionType": "A String", # Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.

142

},

143

],

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

144

},

145

],

146

],

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

147

"previousLink": "A String", # Link to previous page for this Analytics data query.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

148

"selfLink": "A String", # Link to this page.

149

"columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

150

{

151

"name": "A String", # Column name.

152

"columnType": "A String", # Column Type. Either DIMENSION or METRIC.

153

"dataType": "A String", # Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.

154

},

155

],

156

"sampleSize": "A String", # The number of samples used to calculate the result.

157

"containsSampledData": True or False, # Determines if the Analytics data contains sampled data.

158

"itemsPerPage": 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.

159

"nextLink": "A String", # Link to next page for this Analytics data query.

160

"kind": "analytics#mcfData", # Resource type.

161

"totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.

162

"profileInfo": { # Information for the view (profile), for which the Analytics data was requested.

163

"profileId": "A String", # View (Profile) ID.

164

"tableId": "A String", # Table ID for view (profile).