docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/analytics_v3.data.mcf.html b/docs/dyn/analytics_v3.data.mcf.html
index cc02bd2..4473f88 100644
--- a/docs/dyn/analytics_v3.data.mcf.html
+++ b/docs/dyn/analytics_v3.data.mcf.html
@@ -75,11 +75,19 @@
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
- <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>
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#get">get(ids, start_date, end_date, metrics, max_results=None, filters=None, dimensions=None, samplingLevel=None, sort=None, start_index=None)</a></code></p>
<p class="firstline">Returns Analytics Multi-Channel Funnels data for a view (profile).</p>
<h3>Method Details</h3>
<div class="method">
- <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>
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(ids, start_date, end_date, metrics, max_results=None, filters=None, dimensions=None, samplingLevel=None, sort=None, start_index=None)</code>
<pre>Returns Analytics Multi-Channel Funnels data for a view (profile).
Args:
@@ -87,79 +95,79 @@
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)
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)
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)
- sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
+ max_results: integer, The maximum number of entries to include in this feed.
+ filters: string, A comma-separated list of dimension or metric filters to be applied to the Analytics data.
+ dimensions: string, A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
samplingLevel: string, The desired sampling level.
Allowed values
DEFAULT - Returns response with a sample size that balances speed and accuracy.
FASTER - Returns a fast response with a smaller sample size.
HIGHER_PRECISION - Returns a more accurate response using a large sample size, but this may result in the response being slower.
- max_results: integer, The maximum number of entries to include in this feed.
- dimensions: string, A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
- filters: string, A comma-separated list of dimension or metric filters to be applied to the Analytics data.
+ sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # Multi-Channel Funnels data for a given view (profile).
- "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
- "containsSampledData": True or False, # Determines if the Analytics data contains sampled data.
- "nextLink": "A String", # Link to next page for this Analytics data query.
"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.
- "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.
- "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.
- },
- "profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
- "profileName": "A String", # View (Profile) name.
- "tableId": "A String", # Table ID for view (profile).
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- "webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
- "profileId": "A String", # View (Profile) ID.
- },
- "sampleSpace": "A String", # Total size of the sample space from which the samples were selected.
- "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.
- {
- "columnType": "A String", # Column Type. Either DIMENSION or METRIC.
- "dataType": "A String", # Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.
- "name": "A String", # Column name.
- },
- ],
+ "containsSampledData": True or False, # Determines if the Analytics data contains sampled data.
+ "kind": "analytics#mcfData", # Resource type.
"sampleSize": "A String", # The number of samples used to calculate the result.
"id": "A String", # Unique ID for this data response.
+ "nextLink": "A String", # Link to next page for this Analytics data query.
+ "selfLink": "A String", # Link to this page.
+ "query": { # Analytics data request query parameters.
+ "dimensions": "A String", # List of analytics dimensions.
+ "start-index": 42, # Start index.
+ "max-results": 42, # Maximum results per page.
+ "samplingLevel": "A String", # Desired sampling level
+ "metrics": [ # List of analytics metrics.
+ "A String",
+ ],
+ "filters": "A String", # Comma-separated list of dimension or metric filters.
+ "end-date": "A String", # End date.
+ "segment": "A String", # Analytics advanced segment.
+ "sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
+ "A String",
+ ],
+ "start-date": "A String", # Start date.
+ "ids": "A String", # Unique table ID.
+ },
"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.
[
{ # A union object representing a dimension or metric value. Only one of "primitiveValue" or "conversionPathValue" attribute will be populated.
- "primitiveValue": "A String", # A primitive dimension value. A primitive metric value.
"conversionPathValue": [ # A conversion path dimension value, containing a list of interactions with their attributes.
{
"nodeValue": "A String", # Node value of an interaction on conversion path. Such as source, medium etc.
"interactionType": "A String", # Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.
},
],
+ "primitiveValue": "A String", # A primitive dimension value. A primitive metric value.
},
],
],
- "previousLink": "A String", # Link to previous page for this Analytics data query.
- "query": { # Analytics data request query parameters.
- "dimensions": "A String", # List of analytics dimensions.
- "sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
- "A String",
- ],
- "start-index": 42, # Start index.
- "segment": "A String", # Analytics advanced segment.
- "filters": "A String", # Comma-separated list of dimension or metric filters.
- "end-date": "A String", # End date.
- "samplingLevel": "A String", # Desired sampling level
- "metrics": [ # List of analytics metrics.
- "A String",
- ],
- "ids": "A String", # Unique table ID.
- "start-date": "A String", # Start date.
- "max-results": 42, # Maximum results per page.
+ "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.
+ "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.
},
- "kind": "analytics#mcfData", # Resource type.
- "selfLink": "A String", # Link to this page.
+ "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
+ "previousLink": "A String", # Link to previous page for this Analytics data query.
+ "profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
+ "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
+ "tableId": "A String", # Table ID for view (profile).
+ "accountId": "A String", # Account ID to which this view (profile) belongs.
+ "profileId": "A String", # View (Profile) ID.
+ "webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
+ "profileName": "A String", # View (Profile) name.
+ },
+ "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.
+ {
+ "dataType": "A String", # Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.
+ "name": "A String", # Column name.
+ "columnType": "A String", # Column Type. Either DIMENSION or METRIC.
+ },
+ ],
+ "sampleSpace": "A String", # Total size of the sample space from which the samples were selected.
}</pre>
</div>