blob: 6943550cdcc7ba8a27fb41a02b7e791fe518a24e [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.properties.html">properties</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="#delete">delete(fileId, propertyKey, visibility=None)</a></code></p>
82<p class="firstline">Deletes a property.</p>
83<p class="toc_element">
84 <code><a href="#get">get(fileId, propertyKey, visibility=None)</a></code></p>
85<p class="firstline">Gets a property by its key.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#insert">insert(fileId, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070088<p class="firstline">Adds a property to a file, or updates it if it already exists.</p>
John Asmuth614db982014-04-24 15:46:26 -040089<p class="toc_element">
90 <code><a href="#list">list(fileId)</a></code></p>
91<p class="firstline">Lists a file's properties.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#patch">patch(fileId, propertyKey, body=None, visibility=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Updates a property.</p>
John Asmuth614db982014-04-24 15:46:26 -040095<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#update">update(fileId, propertyKey, body=None, visibility=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Updates a property.</p>
John Asmuth614db982014-04-24 15:46:26 -040098<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400105 <code class="details" id="delete">delete(fileId, propertyKey, visibility=None)</code>
106 <pre>Deletes a property.
107
108Args:
109 fileId: string, The ID of the file. (required)
110 propertyKey: string, The key of the property. (required)
111 visibility: string, The visibility of the property.
112</pre>
113</div>
114
115<div class="method">
116 <code class="details" id="get">get(fileId, propertyKey, visibility=None)</code>
117 <pre>Gets a property by its key.
118
119Args:
120 fileId: string, The ID of the file. (required)
121 propertyKey: string, The key of the property. (required)
122 visibility: string, The visibility of the property.
123
124Returns:
125 An object of the form:
126
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000127 { # A key-value pair attached to a file that is either public or private to an application.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800128 # The following limits apply to file properties:
129 # - Maximum of 100 properties total per file
130 # - Maximum of 30 private properties per app
131 # - Maximum of 30 public properties
132 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
133 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
134 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
135 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
136 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
137 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800138 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800139}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400140</div>
141
142<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700143 <code class="details" id="insert">insert(fileId, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700144 <pre>Adds a property to a file, or updates it if it already exists.
John Asmuth614db982014-04-24 15:46:26 -0400145
146Args:
147 fileId: string, The ID of the file. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700148 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400149 The object takes the form of:
150
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000151{ # A key-value pair attached to a file that is either public or private to an application.
152 # The following limits apply to file properties:
153 # - Maximum of 100 properties total per file
154 # - Maximum of 30 private properties per app
155 # - Maximum of 30 public properties
156 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700157 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
158 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
159 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
160 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
161 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800162 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
John Asmuth614db982014-04-24 15:46:26 -0400163}
164
165
166Returns:
167 An object of the form:
168
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000169 { # A key-value pair attached to a file that is either public or private to an application.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800170 # The following limits apply to file properties:
171 # - Maximum of 100 properties total per file
172 # - Maximum of 30 private properties per app
173 # - Maximum of 30 public properties
174 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
175 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
176 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
177 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
178 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
179 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800180 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800181}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400182</div>
183
184<div class="method">
185 <code class="details" id="list">list(fileId)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700186 <pre>Lists a file&#x27;s properties.
John Asmuth614db982014-04-24 15:46:26 -0400187
188Args:
189 fileId: string, The ID of the file. (required)
190
191Returns:
192 An object of the form:
193
194 { # A collection of properties, key-value pairs that are either public or private to an application.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800195 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the list.
196 &quot;items&quot;: [ # The list of properties.
197 { # A key-value pair attached to a file that is either public or private to an application.
198 # The following limits apply to file properties:
199 # - Maximum of 100 properties total per file
200 # - Maximum of 30 private properties per app
201 # - Maximum of 30 public properties
202 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
203 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
204 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
205 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
206 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
207 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800208 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800209 },
210 ],
211 &quot;kind&quot;: &quot;drive#propertyList&quot;, # This is always drive#propertyList.
212 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this list.
213}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400214</div>
215
216<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700217 <code class="details" id="patch">patch(fileId, propertyKey, body=None, visibility=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700218 <pre>Updates a property.
John Asmuth614db982014-04-24 15:46:26 -0400219
220Args:
221 fileId: string, The ID of the file. (required)
222 propertyKey: string, The key of the property. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700223 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400224 The object takes the form of:
225
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000226{ # A key-value pair attached to a file that is either public or private to an application.
227 # The following limits apply to file properties:
228 # - Maximum of 100 properties total per file
229 # - Maximum of 30 private properties per app
230 # - Maximum of 30 public properties
231 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700232 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
233 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
234 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
235 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
236 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800237 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
John Asmuth614db982014-04-24 15:46:26 -0400238}
239
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700240 visibility: string, The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400241
242Returns:
243 An object of the form:
244
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000245 { # A key-value pair attached to a file that is either public or private to an application.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800246 # The following limits apply to file properties:
247 # - Maximum of 100 properties total per file
248 # - Maximum of 30 private properties per app
249 # - Maximum of 30 public properties
250 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
251 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
252 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
253 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
254 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
255 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800256 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800257}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400258</div>
259
260<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700261 <code class="details" id="update">update(fileId, propertyKey, body=None, visibility=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700262 <pre>Updates a property.
John Asmuth614db982014-04-24 15:46:26 -0400263
264Args:
265 fileId: string, The ID of the file. (required)
266 propertyKey: string, The key of the property. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700267 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400268 The object takes the form of:
269
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000270{ # A key-value pair attached to a file that is either public or private to an application.
271 # The following limits apply to file properties:
272 # - Maximum of 100 properties total per file
273 # - Maximum of 30 private properties per app
274 # - Maximum of 30 public properties
275 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700276 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
277 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
278 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
279 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
280 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800281 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
John Asmuth614db982014-04-24 15:46:26 -0400282}
283
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700284 visibility: string, The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400285
286Returns:
287 An object of the form:
288
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000289 { # A key-value pair attached to a file that is either public or private to an application.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800290 # The following limits apply to file properties:
291 # - Maximum of 100 properties total per file
292 # - Maximum of 30 private properties per app
293 # - Maximum of 30 public properties
294 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
295 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
296 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
297 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
298 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
299 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800300 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800301}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400302</div>
303
304</body></html>