blob: 26dae05c34ea6a4c17be028a69e707b345340b27 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.apps.html">apps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -040081 <code><a href="#get">get(appId)</a></code></p>
82<p class="firstline">Gets a specific app.</p>
83<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070084 <code><a href="#list">list(appFilterExtensions=None, appFilterMimeTypes=None, languageCode=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<p class="firstline">Lists a user's installed apps.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
John Asmuth614db982014-04-24 15:46:26 -040093 <code class="details" id="get">get(appId)</code>
94 <pre>Gets a specific app.
95
96Args:
97 appId: string, The ID of the app. (required)
98
99Returns:
100 An object of the form:
101
Bu Sun Kim65020912020-05-20 12:08:20 -0700102 { # The apps resource provides a list of the apps that a user has installed, with information about each app&#x27;s supported MIME types, file extensions, and other details.
103 &quot;authorized&quot;: True or False, # Whether the app is authorized to access data on the user&#x27;s Drive.
104 &quot;createInFolderTemplate&quot;: &quot;A String&quot;, # 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.
105 &quot;createUrl&quot;: &quot;A String&quot;, # The url to create a new file with this app.
106 &quot;hasDriveWideScope&quot;: True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user&#x27;s drive.
107 &quot;icons&quot;: [ # The various icons for the app.
John Asmuth614db982014-04-24 15:46:26 -0400108 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700109 &quot;category&quot;: &quot;A String&quot;, # Category of the icon. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400110 # - application - icon for the application
111 # - document - icon for a file associated with the app
112 # - documentShared - icon for a shared file associated with the app
Bu Sun Kim65020912020-05-20 12:08:20 -0700113 &quot;iconUrl&quot;: &quot;A String&quot;, # URL for the icon.
114 &quot;size&quot;: 42, # Size of the icon. Represented as the maximum of the width and height.
John Asmuth614db982014-04-24 15:46:26 -0400115 },
116 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 &quot;id&quot;: &quot;A String&quot;, # The ID of the app.
118 &quot;installed&quot;: True or False, # Whether the app is installed.
119 &quot;kind&quot;: &quot;drive#app&quot;, # This is always drive#app.
120 &quot;longDescription&quot;: &quot;A String&quot;, # A long description of the app.
121 &quot;name&quot;: &quot;A String&quot;, # The name of the app.
122 &quot;objectType&quot;: &quot;A String&quot;, # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
123 &quot;openUrlTemplate&quot;: &quot;A String&quot;, # 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.
124 &quot;primaryFileExtensions&quot;: [ # The list of primary file extensions.
125 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400126 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700127 &quot;primaryMimeTypes&quot;: [ # The list of primary mime types.
128 &quot;A String&quot;,
129 ],
130 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product listing for this app.
131 &quot;productUrl&quot;: &quot;A String&quot;, # A link to the product listing for this app.
132 &quot;secondaryFileExtensions&quot;: [ # The list of secondary file extensions.
133 &quot;A String&quot;,
134 ],
135 &quot;secondaryMimeTypes&quot;: [ # The list of secondary mime types.
136 &quot;A String&quot;,
137 ],
138 &quot;shortDescription&quot;: &quot;A String&quot;, # A short description of the app.
139 &quot;supportsCreate&quot;: True or False, # Whether this app supports creating new objects.
140 &quot;supportsImport&quot;: True or False, # Whether this app supports importing Google Docs.
141 &quot;supportsMultiOpen&quot;: True or False, # Whether this app supports opening more than one file.
142 &quot;supportsOfflineCreate&quot;: True or False, # Whether this app supports creating new files when offline.
143 &quot;useByDefault&quot;: True or False, # Whether the app is selected as the default handler for the types it supports.
John Asmuth614db982014-04-24 15:46:26 -0400144 }</pre>
145</div>
146
147<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700148 <code class="details" id="list">list(appFilterExtensions=None, appFilterMimeTypes=None, languageCode=None)</code>
149 <pre>Lists a user&#x27;s installed apps.
John Asmuth614db982014-04-24 15:46:26 -0400150
151Args:
Craig Citro065b5302014-08-14 00:47:23 -0700152 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700153 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.
154 languageCode: string, A language or locale code, as defined by BCP 47, with some extensions from Unicode&#x27;s LDML format (http://www.unicode.org/reports/tr35/).
John Asmuth614db982014-04-24 15:46:26 -0400155
156Returns:
157 An object of the form:
158
159 { # A list of third-party applications which the user has installed or given access to Google Drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700160 &quot;defaultAppIds&quot;: [ # List of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest).
161 &quot;A String&quot;,
162 ],
163 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the list.
164 &quot;items&quot;: [ # The list of apps.
165 { # The apps resource provides a list of the apps that a user has installed, with information about each app&#x27;s supported MIME types, file extensions, and other details.
166 &quot;authorized&quot;: True or False, # Whether the app is authorized to access data on the user&#x27;s Drive.
167 &quot;createInFolderTemplate&quot;: &quot;A String&quot;, # 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.
168 &quot;createUrl&quot;: &quot;A String&quot;, # The url to create a new file with this app.
169 &quot;hasDriveWideScope&quot;: True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user&#x27;s drive.
170 &quot;icons&quot;: [ # The various icons for the app.
John Asmuth614db982014-04-24 15:46:26 -0400171 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700172 &quot;category&quot;: &quot;A String&quot;, # Category of the icon. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400173 # - application - icon for the application
174 # - document - icon for a file associated with the app
175 # - documentShared - icon for a shared file associated with the app
Bu Sun Kim65020912020-05-20 12:08:20 -0700176 &quot;iconUrl&quot;: &quot;A String&quot;, # URL for the icon.
177 &quot;size&quot;: 42, # Size of the icon. Represented as the maximum of the width and height.
John Asmuth614db982014-04-24 15:46:26 -0400178 },
179 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700180 &quot;id&quot;: &quot;A String&quot;, # The ID of the app.
181 &quot;installed&quot;: True or False, # Whether the app is installed.
182 &quot;kind&quot;: &quot;drive#app&quot;, # This is always drive#app.
183 &quot;longDescription&quot;: &quot;A String&quot;, # A long description of the app.
184 &quot;name&quot;: &quot;A String&quot;, # The name of the app.
185 &quot;objectType&quot;: &quot;A String&quot;, # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
186 &quot;openUrlTemplate&quot;: &quot;A String&quot;, # 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.
187 &quot;primaryFileExtensions&quot;: [ # The list of primary file extensions.
188 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400189 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700190 &quot;primaryMimeTypes&quot;: [ # The list of primary mime types.
191 &quot;A String&quot;,
192 ],
193 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product listing for this app.
194 &quot;productUrl&quot;: &quot;A String&quot;, # A link to the product listing for this app.
195 &quot;secondaryFileExtensions&quot;: [ # The list of secondary file extensions.
196 &quot;A String&quot;,
197 ],
198 &quot;secondaryMimeTypes&quot;: [ # The list of secondary mime types.
199 &quot;A String&quot;,
200 ],
201 &quot;shortDescription&quot;: &quot;A String&quot;, # A short description of the app.
202 &quot;supportsCreate&quot;: True or False, # Whether this app supports creating new objects.
203 &quot;supportsImport&quot;: True or False, # Whether this app supports importing Google Docs.
204 &quot;supportsMultiOpen&quot;: True or False, # Whether this app supports opening more than one file.
205 &quot;supportsOfflineCreate&quot;: True or False, # Whether this app supports creating new files when offline.
206 &quot;useByDefault&quot;: True or False, # Whether the app is selected as the default handler for the types it supports.
John Asmuth614db982014-04-24 15:46:26 -0400207 },
208 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700209 &quot;kind&quot;: &quot;drive#appList&quot;, # This is always drive#appList.
210 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this list.
John Asmuth614db982014-04-24 15:46:26 -0400211 }</pre>
212</div>
213
214</body></html>