docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/analytics_v3.data.mcf.html b/docs/dyn/analytics_v3.data.mcf.html
index c87ad7f..39453ba 100644
--- a/docs/dyn/analytics_v3.data.mcf.html
+++ b/docs/dyn/analytics_v3.data.mcf.html
@@ -75,91 +75,91 @@
<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, dimensions=None, filters=None, max_results=None, samplingLevel=None, start_index=None)</a></code></p>
+ <code><a href="#get">get(ids, start_date, end_date, metrics, filters=None, sort=None, max_results=None, start_index=None, samplingLevel=None, dimensions=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, dimensions=None, filters=None, max_results=None, samplingLevel=None, start_index=None)</code>
+ <code class="details" id="get">get(ids, start_date, end_date, metrics, filters=None, sort=None, max_results=None, start_index=None, samplingLevel=None, dimensions=None)</code>
<pre>Returns Analytics Multi-Channel Funnels data for a view (profile).
Args:
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)
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.
- dimensions: string, A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
+ 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)
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.
max_results: integer, The maximum number of entries to include in this feed.
+ start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
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.
- start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+ dimensions: string, A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
Returns:
An object of the form:
{ # Multi-Channel Funnels data for a given view (profile).
- "kind": "analytics#mcfData", # Resource type.
- "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.
+ "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
+ "sampleSpace": "A String", # Total size of the sample space from which the samples were selected.
+ "selfLink": "A String", # Link to this 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.
+ },
+ "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).
+ "profileName": "A String", # View (Profile) name.
+ "webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
+ "accountId": "A String", # Account ID to which this view (profile) belongs.
+ "profileId": "A String", # View (Profile) 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.
+ { # A union object representing a dimension or metric value. Only one of "primitiveValue" or "conversionPathValue" attribute will be populated.
+ "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.
+ "interactionType": "A String", # Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.
+ "nodeValue": "A String", # Node value of an interaction on conversion path. Such as source, medium etc.
},
],
+ "primitiveValue": "A String", # A primitive dimension value. A primitive metric value.
},
],
],
- "containsSampledData": True or False, # Determines if the Analytics data contains sampled data.
- "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.
- },
- "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.
- "profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
- "webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "tableId": "A String", # Table ID for view (profile).
- "profileId": "A String", # View (Profile) ID.
- "profileName": "A String", # View (Profile) name.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- },
- "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.
+ "kind": "analytics#mcfData", # Resource type.
+ "sampleSize": "A String", # The number of samples used to calculate the result.
+ "containsSampledData": True or False, # Determines if the Analytics data contains sampled data.
+ "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.
- "columnType": "A String", # Column Type. Either DIMENSION or METRIC.
- "name": "A String", # Column name.
+ "dataType": "A String", # Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.
+ "columnType": "A String", # Column Type. Either DIMENSION or METRIC.
+ "name": "A String", # Column name.
},
],
- "sampleSize": "A String", # The number of samples used to calculate the result.
- "query": { # Analytics data request query parameters.
- "sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
- "A String",
+ "id": "A String", # Unique ID for this data response.
+ "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.
+ "query": { # Analytics data request query parameters.
+ "sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
+ "A String",
],
- "max-results": 42, # Maximum results per page.
- "dimensions": "A String", # List of analytics dimensions.
- "start-date": "A String", # Start date.
- "start-index": 42, # Start index.
- "end-date": "A String", # End date.
- "ids": "A String", # Unique table ID.
- "metrics": [ # List of analytics metrics.
- "A String",
+ "max-results": 42, # Maximum results per page.
+ "metrics": [ # List of analytics metrics.
+ "A String",
],
- "samplingLevel": "A String", # Desired sampling level
- "filters": "A String", # Comma-separated list of dimension or metric filters.
- "segment": "A String", # Analytics advanced segment.
+ "segment": "A String", # Analytics advanced segment.
+ "start-date": "A String", # Start date.
+ "start-index": 42, # Start index.
+ "ids": "A String", # Unique table ID.
+ "samplingLevel": "A String", # Desired sampling level
+ "dimensions": "A String", # List of analytics dimensions.
+ "end-date": "A String", # End date.
+ "filters": "A String", # Comma-separated list of dimension or metric filters.
},
- "previousLink": "A String", # Link to previous page for this Analytics data query.
- "nextLink": "A String", # Link to next page for this Analytics data query.
- "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
- "id": "A String", # Unique ID for this data response.
- "selfLink": "A String", # Link to this page.
- "sampleSpace": "A String", # Total size of the sample space from which the samples were selected.
+ "nextLink": "A String", # Link to next page for this Analytics data query.
+ "previousLink": "A String", # Link to previous page for this Analytics data query.
}</pre>
</div>