chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/analytics_v3.data.ga.html b/docs/dyn/analytics_v3.data.ga.html
index 38da759..249a8ab 100644
--- a/docs/dyn/analytics_v3.data.ga.html
+++ b/docs/dyn/analytics_v3.data.ga.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, start_index=None, samplingLevel=None, max_results=None, output=None, segment=None, filters=None, dimensions=None, include_empty_rows=None, sort=None)</a></code></p>
+ <code><a href="#get">get(ids, start_date, end_date, metrics, include_empty_rows=None, max_results=None, start_index=None, dimensions=None, sort=None, filters=None, output=None, samplingLevel=None, segment=None)</a></code></p>
<p class="firstline">Returns Analytics 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, start_index=None, samplingLevel=None, max_results=None, output=None, segment=None, filters=None, dimensions=None, include_empty_rows=None, sort=None)</code>
+ <code class="details" id="get">get(ids, start_date, end_date, metrics, include_empty_rows=None, max_results=None, start_index=None, dimensions=None, sort=None, filters=None, output=None, samplingLevel=None, segment=None)</code>
<pre>Returns Analytics data for a view (profile).
Args:
@@ -95,43 +95,75 @@
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. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday. (required)
metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified. (required)
+ include_empty_rows: boolean, The response will include empty rows if this parameter is set to true, the default is true
+ 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.
+ dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
+ sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
+ filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.
+ output: string, The selected format for the response. Default format is JSON.
+ Allowed values
+ dataTable - Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.
+ json - Returns the response in standard JSON format.
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.
- output: string, The selected format for the response. Default format is JSON.
- Allowed values
- dataTable - Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.
- json - Returns the response in standard JSON format.
segment: string, An Analytics segment to be applied to data.
- filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.
- dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
- include_empty_rows: boolean, The response will include empty rows if this parameter is set to true, the default is true
- sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
Returns:
An object of the form:
{ # Analytics 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.
- "nextLink": "A String", # Link to next page for this Analytics data query.
- "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 column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.
- "name": "A String", # Column name.
- },
- ],
+ "kind": "analytics#gaData", # Resource type.
"id": "A String", # Unique ID for this data response.
+ "dataLastRefreshed": "A String", # The last refreshed time in seconds for Analytics 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.
+ },
+ "selfLink": "A String", # Link to this page.
+ "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.
+ "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 String",
+ ],
+ ],
+ "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.
+ "profileName": "A String", # View (Profile) name.
+ "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).
+ "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
+ },
+ "previousLink": "A String", # Link to previous page for this Analytics data query.
+ "sampleSpace": "A String", # Total size of the sample space from which the samples were selected.
+ "query": { # Analytics data request query parameters.
+ "filters": "A String", # Comma-separated list of dimension or metric filters.
+ "max-results": 42, # Maximum results per page.
+ "ids": "A String", # Unique table ID.
+ "metrics": [ # List of analytics metrics.
+ "A String",
+ ],
+ "start-index": 42, # Start index.
+ "sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
+ "A String",
+ ],
+ "segment": "A String", # Analytics advanced segment.
+ "start-date": "A String", # Start date.
+ "samplingLevel": "A String", # Desired sampling level
+ "end-date": "A String", # End date.
+ "dimensions": "A String", # List of analytics dimensions.
+ },
+ "containsSampledData": True or False, # Determines if Analytics data contains samples.
+ "nextLink": "A String", # Link to next page for this Analytics data query.
"dataTable": {
"cols": [
{
"id": "A String",
- "label": "A String",
"type": "A String",
+ "label": "A String",
},
],
"rows": [
@@ -144,47 +176,15 @@
},
],
},
- "containsSampledData": True or False, # Determines if Analytics data contains samples.
- "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.
- },
- "selfLink": "A String", # Link to this page.
- "kind": "analytics#gaData", # Resource type.
- "sampleSpace": "A String", # Total size of the sample space from which the samples were selected.
- "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 String",
- ],
- ],
- "query": { # Analytics data request query parameters.
- "max-results": 42, # Maximum results per page.
- "end-date": "A String", # End date.
- "samplingLevel": "A String", # Desired sampling level
- "start-date": "A String", # Start date.
- "ids": "A String", # Unique table ID.
- "segment": "A String", # Analytics advanced segment.
- "sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
- "A String",
- ],
- "filters": "A String", # Comma-separated list of dimension or metric filters.
- "start-index": 42, # Start index.
- "metrics": [ # List of analytics metrics.
- "A String",
- ],
- "dimensions": "A String", # List of analytics dimensions.
- },
- "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.
- "dataLastRefreshed": "A String", # The last refreshed time in seconds for Analytics data.
- "profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
- "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.
- "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.
- },
- "previousLink": "A String", # Link to previous page for this Analytics data query.
"sampleSize": "A String", # The number of samples used to calculate the result.
+ "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
+ "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 column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.
+ "name": "A String", # Column name.
+ "columnType": "A String", # Column Type. Either DIMENSION or METRIC.
+ },
+ ],
}</pre>
</div>