Skip to content

Commit ad8013f

Browse files
jcgregoriojcgregorio
committed
refresh docs
1 parent c128bbd commit ad8013f

File tree

157 files changed

+3836
-1829
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

157 files changed

+3836
-1829
lines changed

‎docs/dyn/analytics_v3.data.ga.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h3>Method Details</h3>
9797
Returns:
9898
An object of the form:
9999

100-
{
100+
{ # Analytics data for a given profile.
101101
"kind": "analytics#gaData", # Resource type.
102102
"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.
103103
[

‎docs/dyn/analytics_v3.data.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,4 +79,9 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the ga Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="analytics_v3.data.mcf.html">mcf()</a></code>
84+
</p>
85+
<p class="firstline">Returns the mcf Resource.</p>
86+
8287
</body></html>

‎docs/dyn/analytics_v3.data.mcf.html‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
<html><body>
2+
<style>
3+
4+
body, 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+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, 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">
78+
<code><a href="#get">get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)</a></code></p>
79+
<p class="firstline">Returns Analytics Multi-Channel Funnels data for a profile.</p>
80+
<h3>Method Details</h3>
81+
<div class="method">
82+
<code class="details" id="get">get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)</code>
83+
<pre>Returns Analytics Multi-Channel Funnels data for a profile.
84+
85+
Args:
86+
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID. (required)
87+
start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
88+
end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)
89+
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)
90+
sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
91+
dimensions: string, A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
92+
filters: string, A comma-separated list of dimension or metric filters to be applied to the Analytics data.
93+
max_results: integer, The maximum number of entries to include in this feed.
94+
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
95+
96+
Returns:
97+
An object of the form:
98+
99+
{ # Multi-Channel Funnels data for a given profile.
100+
"kind": "analytics#mcfData", # Resource type.
101+
"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.
102+
[
103+
{ # A union object representing a dimension or metric value. Only one of "primitiveValue" or "conversionPathValue" attribute will be populated.
104+
"primitiveValue": "A String", # A primitive metric value. A primitive dimension value.
105+
"conversionPathValue": [ # A conversion path dimension value, containing a list of interactions with their attributes.
106+
{
107+
"nodeValue": "A String", # Node value of an interaction on conversion path. Such as source, medium etc.
108+
"interactionType": "A String", # Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.
109+
},
110+
],
111+
},
112+
],
113+
],
114+
"containsSampledData": True or False, # Determines if the Analytics data contains sampled data.
115+
"totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
116+
"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.
117+
"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.
118+
"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.
119+
},
120+
"nextLink": "A String", # Link to next page for this Analytics data query.
121+
"id": "A String", # Unique ID for this data response.
122+
"query": { # Analytics data request query parameters.
123+
"max-results": 42, # Maximum results per page.
124+
"sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
125+
"A String",
126+
],
127+
"dimensions": "A String", # List of analytics dimensions.
128+
"start-date": "A String", # Start date.
129+
"start-index": 42, # Start index.
130+
"segment": "A String", # Analytics advanced segment.
131+
"ids": "A String", # Unique table ID.
132+
"metrics": [ # List of analytics metrics.
133+
"A String",
134+
],
135+
"filters": "A String", # Comma-separated list of dimension or metric filters.
136+
"end-date": "A String", # End date.
137+
},
138+
"previousLink": "A String", # Link to previous page for this Analytics data query.
139+
"profileInfo": { # Information for the profile, for which the Analytics data was requested.
140+
"webPropertyId": "A String", # Web Property ID to which this profile belongs.
141+
"internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.
142+
"tableId": "A String", # Table ID for profile.
143+
"profileId": "A String", # Profile ID.
144+
"profileName": "A String", # Profile name.
145+
"accountId": "A String", # Account ID to which this profile belongs.
146+
},
147+
"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.
148+
{
149+
"dataType": "A String", # Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.
150+
"columnType": "A String", # Column Type. Either DIMENSION or METRIC.
151+
"name": "A String", # Column name.
152+
},
153+
],
154+
"selfLink": "A String", # Link to this page.
155+
}</pre>
156+
</div>
157+
158+
</body></html>

‎docs/dyn/analytics_v3.management.accounts.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,11 @@ <h3>Method Details</h3>
8989
Returns:
9090
An object of the form:
9191

92-
{
92+
{ # An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account.
9393
"username": "A String", # Email ID of the authenticated user
9494
"kind": "analytics#accounts", # Collection type.
9595
"items": [ # A list of accounts.
96-
{
96+
{ # JSON template for Analytics account entry.
9797
"kind": "analytics#account", # Resource type for Analytics account.
9898
"name": "A String", # Account name.
9999
"created": "A String", # Time the account was created.

‎docs/dyn/analytics_v3.management.goals.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ <h3>Method Details</h3>
9292
Returns:
9393
An object of the form:
9494

95-
{
95+
{ # A goal collection lists Analytics goals to which the user has access. Each profile can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.
9696
"username": "A String", # Email ID of the authenticated user
9797
"kind": "analytics#goals", # Collection type.
9898
"items": [ # A list of goals.
99-
{
99+
{ # JSON template for Analytics goal resource.
100100
"kind": "analytics#goal", # Resource type for an Analytics goal.
101101
"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
102102
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

‎docs/dyn/analytics_v3.management.profiles.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,11 @@ <h3>Method Details</h3>
9191
Returns:
9292
An object of the form:
9393

94-
{
94+
{ # A profile collection lists Analytics profiles to which the user has access. Each resource in the collection corresponds to a single Analytics profile.
9595
"username": "A String", # Email ID of the authenticated user
9696
"kind": "analytics#profiles", # Collection type.
9797
"items": [ # A list of profiles.
98-
{
98+
{ # JSON template for an Analytics profile.
9999
"defaultPage": "A String", # Default page for this profile.
100100
"kind": "analytics#profile", # Resource type for Analytics profile.
101101
"excludeQueryParameters": "A String", # The query parameters that are excluded from this profile.

‎docs/dyn/analytics_v3.management.segments.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,11 @@ <h3>Method Details</h3>
8989
Returns:
9090
An object of the form:
9191

92-
{
92+
{ # An advanced segment collection lists Analytics advanced segments that the user has access to. Each resource in the collection corresponds to a single Analytics advanced segment.
9393
"username": "A String", # Email ID of the authenticated user
9494
"kind": "analytics#segments", # Collection type for advanced segments.
9595
"items": [ # A list of advanced segments.
96-
{
96+
{ # JSON template for an Analytics advanced segment.
9797
"definition": "A String", # Advanced segment definition.
9898
"kind": "analytics#segment", # Resource type for Analytics advanced segment.
9999
"segmentId": "A String", # Segment ID. Can be used with the 'segment' parameter in Data Feed.

‎docs/dyn/analytics_v3.management.webproperties.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,11 @@ <h3>Method Details</h3>
9090
Returns:
9191
An object of the form:
9292

93-
{
93+
{ # A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.
9494
"username": "A String", # Email ID of the authenticated user
9595
"kind": "analytics#webproperties", # Collection type.
9696
"items": [ # A list of web properties.
97-
{
97+
{ # JSON template for an Analytics web property.
9898
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
9999
"name": "A String", # Name of this web property.
100100
"created": "A String", # Time this web property was created.

0 commit comments

Comments
 (0)