1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.apps.html">apps</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<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>
<p class="firstline">Lists a user's installed apps.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(appId)</code>
<pre>Gets a specific app.
Args:
appId: string, The ID of the app. (required)
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.
{
"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.
},
],
"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",
],
"supportsImport": True or False, # Whether this app supports importing Google Docs.
"supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
}</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.
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.
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.
{
"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.
},
],
"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",
],
"supportsImport": True or False, # Whether this app supports importing Google Docs.
"supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
},
],
"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",
],
}</pre>
</div>
</body></html>
|