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/drive_v2.apps.html b/docs/dyn/drive_v2.apps.html
index eb655a6..2a24cba 100644
--- a/docs/dyn/drive_v2.apps.html
+++ b/docs/dyn/drive_v2.apps.html
@@ -78,7 +78,7 @@
<code><a href="#get">get(appId)</a></code></p>
<p class="firstline">Gets a specific app.</p>
<p class="toc_element">
- <code><a href="#list">list(languageCode=None, appFilterMimeTypes=None, appFilterExtensions=None)</a></code></p>
+ <code><a href="#list">list(appFilterExtensions=None, appFilterMimeTypes=None, languageCode=None)</a></code></p>
<p class="firstline">Lists a user's installed apps.</p>
<h3>Method Details</h3>
<div class="method">
@@ -91,115 +91,115 @@
Returns:
An object of the form:
- { # The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
- "secondaryMimeTypes": [ # The list of secondary mime types.
- "A String",
- ],
- "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
- "installed": True or False, # Whether the app is installed.
- "productUrl": "A String", # A link to the product listing for this app.
- "shortDescription": "A String", # A short description of the app.
- "id": "A String", # The ID of the app.
- "hasDriveWideScope": True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive.
- "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
- "primaryFileExtensions": [ # The list of primary file extensions.
- "A String",
- ],
- "primaryMimeTypes": [ # The list of primary mime types.
- "A String",
- ],
- "icons": [ # The various icons for the app.
+ { # The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
+ "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
+ "createInFolderTemplate": "A String", # The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.
+ "createUrl": "A String", # The url to create a new file with this app.
+ "hasDriveWideScope": True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive.
+ "icons": [ # The various icons for the app.
{
- "category": "A String", # Category of the icon. Allowed values are:
+ "category": "A String", # Category of the icon. Allowed values are:
# - application - icon for the application
# - document - icon for a file associated with the app
# - documentShared - icon for a shared file associated with the app
- "iconUrl": "A String", # URL for the icon.
- "size": 42, # Size of the icon. Represented as the maximum of the width and height.
+ "iconUrl": "A String", # URL for the icon.
+ "size": 42, # Size of the icon. Represented as the maximum of the width and height.
},
],
- "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
- "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation.
- "productId": "A String", # The ID of the product listing for this app.
- "longDescription": "A String", # A long description of the app.
- "supportsCreate": True or False, # Whether this app supports creating new objects.
- "supportsOfflineCreate": True or False, # Whether this app supports creating new files when offline.
- "kind": "drive#app", # This is always drive#app.
- "name": "A String", # The name of the app.
- "createUrl": "A String", # The url to create a new file with this app.
- "createInFolderTemplate": "A String", # The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.
- "secondaryFileExtensions": [ # The list of secondary file extensions.
- "A String",
+ "id": "A String", # The ID of the app.
+ "installed": True or False, # Whether the app is installed.
+ "kind": "drive#app", # This is always drive#app.
+ "longDescription": "A String", # A long description of the app.
+ "name": "A String", # The name of the app.
+ "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
+ "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation.
+ "primaryFileExtensions": [ # The list of primary file extensions.
+ "A String",
],
- "supportsImport": True or False, # Whether this app supports importing Google Docs.
- "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
+ "primaryMimeTypes": [ # The list of primary mime types.
+ "A String",
+ ],
+ "productId": "A String", # The ID of the product listing for this app.
+ "productUrl": "A String", # A link to the product listing for this app.
+ "secondaryFileExtensions": [ # The list of secondary file extensions.
+ "A String",
+ ],
+ "secondaryMimeTypes": [ # The list of secondary mime types.
+ "A String",
+ ],
+ "shortDescription": "A String", # A short description of the app.
+ "supportsCreate": True or False, # Whether this app supports creating new objects.
+ "supportsImport": True or False, # Whether this app supports importing Google Docs.
+ "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
+ "supportsOfflineCreate": True or False, # Whether this app supports creating new files when offline.
+ "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(languageCode=None, appFilterMimeTypes=None, appFilterExtensions=None)</code>
- <pre>Lists a user's installed apps.
+ <code class="details" id="list">list(appFilterExtensions=None, appFilterMimeTypes=None, languageCode=None)</code>
+ <pre>Lists a user's installed apps.
Args:
- languageCode: string, A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
- appFilterMimeTypes: string, A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists.
appFilterExtensions: string, A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists.
+ appFilterMimeTypes: string, A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists.
+ languageCode: string, A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
Returns:
An object of the form:
{ # A list of third-party applications which the user has installed or given access to Google Drive.
- "items": [ # The list of apps.
- { # The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
- "secondaryMimeTypes": [ # The list of secondary mime types.
- "A String",
- ],
- "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
- "installed": True or False, # Whether the app is installed.
- "productUrl": "A String", # A link to the product listing for this app.
- "shortDescription": "A String", # A short description of the app.
- "id": "A String", # The ID of the app.
- "hasDriveWideScope": True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive.
- "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
- "primaryFileExtensions": [ # The list of primary file extensions.
- "A String",
- ],
- "primaryMimeTypes": [ # The list of primary mime types.
- "A String",
- ],
- "icons": [ # The various icons for the app.
+ "defaultAppIds": [ # List of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest).
+ "A String",
+ ],
+ "etag": "A String", # The ETag of the list.
+ "items": [ # The list of apps.
+ { # The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
+ "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
+ "createInFolderTemplate": "A String", # The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.
+ "createUrl": "A String", # The url to create a new file with this app.
+ "hasDriveWideScope": True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive.
+ "icons": [ # The various icons for the app.
{
- "category": "A String", # Category of the icon. Allowed values are:
+ "category": "A String", # Category of the icon. Allowed values are:
# - application - icon for the application
# - document - icon for a file associated with the app
# - documentShared - icon for a shared file associated with the app
- "iconUrl": "A String", # URL for the icon.
- "size": 42, # Size of the icon. Represented as the maximum of the width and height.
+ "iconUrl": "A String", # URL for the icon.
+ "size": 42, # Size of the icon. Represented as the maximum of the width and height.
},
],
- "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
- "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation.
- "productId": "A String", # The ID of the product listing for this app.
- "longDescription": "A String", # A long description of the app.
- "supportsCreate": True or False, # Whether this app supports creating new objects.
- "supportsOfflineCreate": True or False, # Whether this app supports creating new files when offline.
- "kind": "drive#app", # This is always drive#app.
- "name": "A String", # The name of the app.
- "createUrl": "A String", # The url to create a new file with this app.
- "createInFolderTemplate": "A String", # The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.
- "secondaryFileExtensions": [ # The list of secondary file extensions.
- "A String",
+ "id": "A String", # The ID of the app.
+ "installed": True or False, # Whether the app is installed.
+ "kind": "drive#app", # This is always drive#app.
+ "longDescription": "A String", # A long description of the app.
+ "name": "A String", # The name of the app.
+ "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
+ "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation.
+ "primaryFileExtensions": [ # The list of primary file extensions.
+ "A String",
],
- "supportsImport": True or False, # Whether this app supports importing Google Docs.
- "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
+ "primaryMimeTypes": [ # The list of primary mime types.
+ "A String",
+ ],
+ "productId": "A String", # The ID of the product listing for this app.
+ "productUrl": "A String", # A link to the product listing for this app.
+ "secondaryFileExtensions": [ # The list of secondary file extensions.
+ "A String",
+ ],
+ "secondaryMimeTypes": [ # The list of secondary mime types.
+ "A String",
+ ],
+ "shortDescription": "A String", # A short description of the app.
+ "supportsCreate": True or False, # Whether this app supports creating new objects.
+ "supportsImport": True or False, # Whether this app supports importing Google Docs.
+ "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
+ "supportsOfflineCreate": True or False, # Whether this app supports creating new files when offline.
+ "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
},
],
- "kind": "drive#appList", # This is always drive#appList.
- "etag": "A String", # The ETag of the list.
- "selfLink": "A String", # A link back to this list.
- "defaultAppIds": [ # List of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest).
- "A String",
- ],
+ "kind": "drive#appList", # This is always drive#appList.
+ "selfLink": "A String", # A link back to this list.
}</pre>
</div>