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.management.uploads.html b/docs/dyn/analytics_v3.management.uploads.html
index 2f814d0..a9aa13d 100644
--- a/docs/dyn/analytics_v3.management.uploads.html
+++ b/docs/dyn/analytics_v3.management.uploads.html
@@ -81,7 +81,7 @@
<code><a href="#get">get(accountId, webPropertyId, customDataSourceId, uploadId)</a></code></p>
<p class="firstline">List uploads to which the user has access.</p>
<p class="toc_element">
- <code><a href="#list">list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None)</a></code></p>
+ <code><a href="#list">list(accountId, webPropertyId, customDataSourceId, start_index=None, max_results=None)</a></code></p>
<p class="firstline">List uploads to which the user has access.</p>
<p class="toc_element">
<code><a href="#uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=None, media_mime_type=None)</a></code></p>
@@ -99,8 +99,8 @@
The object takes the form of:
{ # Request template for the delete upload data request.
- "customDataImportUids": [ # A list of upload UIDs.
- "A String",
+ "customDataImportUids": [ # A list of upload UIDs.
+ "A String",
],
}
@@ -121,52 +121,52 @@
An object of the form:
{ # Metadata returned for an upload operation.
- "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
- "uploadTime": "A String", # Time this file is uploaded.
- "errors": [ # Data import errors collection.
- "A String",
+ "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
+ "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
+ "accountId": "A String", # Account Id to which this upload belongs.
+ "id": "A String", # A unique ID for this upload.
+ "errors": [ # Data import errors collection.
+ "A String",
],
- "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
- "kind": "analytics#upload", # Resource type for Analytics upload.
- "id": "A String", # A unique ID for this upload.
- "accountId": "A String", # Account Id to which this upload belongs.
+ "uploadTime": "A String", # Time this file is uploaded.
+ "kind": "analytics#upload", # Resource type for Analytics upload.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None)</code>
+ <code class="details" id="list">list(accountId, webPropertyId, customDataSourceId, start_index=None, max_results=None)</code>
<pre>List uploads to which the user has access.
Args:
accountId: string, Account Id for the uploads to retrieve. (required)
webPropertyId: string, Web property Id for the uploads to retrieve. (required)
customDataSourceId: string, Custom data source Id for uploads to retrieve. (required)
- max_results: integer, The maximum number of uploads to include in this response.
start_index: integer, A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+ max_results: integer, The maximum number of uploads to include in this response.
Returns:
An object of the form:
{ # Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload.
- "kind": "analytics#uploads", # Collection type.
- "items": [ # A list of uploads.
+ "kind": "analytics#uploads", # Collection type.
+ "nextLink": "A String", # Link to next page for this upload collection.
+ "previousLink": "A String", # Link to previous page for this upload collection.
+ "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
+ "items": [ # A list of uploads.
{ # Metadata returned for an upload operation.
- "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
- "uploadTime": "A String", # Time this file is uploaded.
- "errors": [ # Data import errors collection.
- "A String",
+ "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
+ "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
+ "accountId": "A String", # Account Id to which this upload belongs.
+ "id": "A String", # A unique ID for this upload.
+ "errors": [ # Data import errors collection.
+ "A String",
],
- "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
- "kind": "analytics#upload", # Resource type for Analytics upload.
- "id": "A String", # A unique ID for this upload.
- "accountId": "A String", # Account Id to which this upload belongs.
+ "uploadTime": "A String", # Time this file is uploaded.
+ "kind": "analytics#upload", # Resource type for Analytics upload.
},
],
- "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "previousLink": "A String", # Link to previous page for this upload collection.
- "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
- "nextLink": "A String", # Link to next page for this upload collection.
- "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
+ "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
+ "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
}</pre>
</div>
@@ -185,15 +185,15 @@
An object of the form:
{ # Metadata returned for an upload operation.
- "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
- "uploadTime": "A String", # Time this file is uploaded.
- "errors": [ # Data import errors collection.
- "A String",
+ "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
+ "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
+ "accountId": "A String", # Account Id to which this upload belongs.
+ "id": "A String", # A unique ID for this upload.
+ "errors": [ # Data import errors collection.
+ "A String",
],
- "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
- "kind": "analytics#upload", # Resource type for Analytics upload.
- "id": "A String", # A unique ID for this upload.
- "accountId": "A String", # Account Id to which this upload belongs.
+ "uploadTime": "A String", # Time this file is uploaded.
+ "kind": "analytics#upload", # Resource type for Analytics upload.
}</pre>
</div>