docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/analytics_v3.data.mcf.html b/docs/dyn/analytics_v3.data.mcf.html
index cbb1d6a..b3a9a46 100644
--- a/docs/dyn/analytics_v3.data.mcf.html
+++ b/docs/dyn/analytics_v3.data.mcf.html
@@ -78,7 +78,7 @@
<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, dimensions=None, sort=None, samplingLevel=None, max_results=None, filters=None, start_index=None)</a></code></p>
+ <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>
<p class="firstline">Returns Analytics Multi-Channel Funnels data for a view (profile).</p>
<h3>Method Details</h3>
<div class="method">
@@ -87,7 +87,7 @@
</div>
<div class="method">
- <code class="details" id="get">get(ids, start_date, end_date, metrics, dimensions=None, sort=None, samplingLevel=None, max_results=None, filters=None, start_index=None)</code>
+ <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>
<pre>Returns Analytics Multi-Channel Funnels data for a view (profile).
Args:
@@ -95,46 +95,42 @@
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)
- 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.
+ start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+ max_results: integer, The maximum number of entries to include in this feed.
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'.
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.
- filters: string, A comma-separated list of dimension or metric filters to be applied to 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).
- "sampleSize": "A String", # The number of samples used to calculate the result.
"id": "A String", # Unique ID for this data response.
- "selfLink": "A String", # Link to this page.
- "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.
- "profileId": "A String", # View (Profile) ID.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- "tableId": "A String", # Table ID for view (profile).
- "profileName": "A String", # View (Profile) name.
- },
- "containsSampledData": True or False, # Determines if the Analytics data contains sampled data.
- "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.
- {
- "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.
- },
- ],
"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.
- "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
+ "query": { # Analytics data request query parameters.
+ "segment": "A String", # Analytics advanced segment.
+ "end-date": "A String", # End date.
+ "dimensions": "A String", # List of analytics dimensions.
+ "ids": "A String", # Unique table ID.
+ "sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
+ "A String",
+ ],
+ "metrics": [ # List of analytics metrics.
+ "A String",
+ ],
+ "samplingLevel": "A String", # Desired sampling level
+ "start-date": "A String", # Start date.
+ "start-index": 42, # Start index.
+ "filters": "A String", # Comma-separated list of dimension or metric filters.
+ "max-results": 42, # Maximum results per page.
+ },
"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.
@@ -148,26 +144,30 @@
},
],
],
- "kind": "analytics#mcfData", # Resource type.
- "query": { # Analytics data request query parameters.
- "end-date": "A String", # End date.
- "start-index": 42, # Start index.
- "max-results": 42, # Maximum results per page.
- "ids": "A String", # Unique table ID.
- "filters": "A String", # Comma-separated list of dimension or metric filters.
- "sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
- "A String",
- ],
- "samplingLevel": "A String", # Desired sampling level
- "segment": "A String", # Analytics advanced segment.
- "start-date": "A String", # Start date.
- "metrics": [ # List of analytics metrics.
- "A String",
- ],
- "dimensions": "A String", # List of analytics dimensions.
- },
- "nextLink": "A String", # Link to next page for this Analytics data query.
"previousLink": "A String", # Link to previous page for this Analytics data query.
+ "selfLink": "A String", # Link to this page.
+ "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.
+ {
+ "name": "A String", # Column name.
+ "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.
+ },
+ ],
+ "sampleSize": "A String", # The number of samples used to calculate the result.
+ "containsSampledData": True or False, # Determines if the Analytics data contains sampled data.
+ "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.
+ "nextLink": "A String", # Link to next page for this Analytics data query.
+ "kind": "analytics#mcfData", # Resource type.
+ "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
+ "profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
+ "profileId": "A String", # View (Profile) ID.
+ "tableId": "A String", # Table ID for view (profile).
+ "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.
+ "profileName": "A String", # View (Profile) name.
+ "accountId": "A String", # Account ID to which this view (profile) belongs.
+ },
+ "sampleSpace": "A String", # Total size of the sample space from which the samples were selected.
}</pre>
</div>