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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<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">Google Drive API</a> . <a href="drive_v2.properties.html">properties</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, propertyKey, visibility=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a property.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, propertyKey, visibility=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a property by its key.</p>
<p class="toc_element">
<code><a href="#insert">insert(fileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a property to a file, or updates it if it already exists.</p>
<p class="toc_element">
<code><a href="#list">list(fileId, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a file's properties.</p>
<p class="toc_element">
<code><a href="#patch">patch(fileId, propertyKey, body=None, visibility=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a property.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, propertyKey, body=None, visibility=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a property.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(fileId, propertyKey, visibility=None, x__xgafv=None)</code>
<pre>Deletes a property.
Args:
fileId: string, The ID of the file. (required)
propertyKey: string, The key of the property. (required)
visibility: string, The visibility of the property.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, propertyKey, visibility=None, x__xgafv=None)</code>
<pre>Gets a property by its key.
Args:
fileId: string, The ID of the file. (required)
propertyKey: string, The key of the property. (required)
visibility: string, The visibility of the property.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. 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.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(fileId, body=None, x__xgafv=None)</code>
<pre>Adds a property to a file, or updates it if it already exists.
Args:
fileId: string, The ID of the file. (required)
body: object, The request body.
The object takes the form of:
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. 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.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. 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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(fileId, x__xgafv=None)</code>
<pre>Lists a file's properties.
Args:
fileId: string, The ID of the file. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A collection of properties, key-value pairs that are either public or private to an application.
"etag": "A String", # The ETag of the list.
"items": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. 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.
},
],
"kind": "drive#propertyList", # This is always `drive#propertyList`.
"selfLink": "A String", # The link back to this list.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(fileId, propertyKey, body=None, visibility=None, x__xgafv=None)</code>
<pre>Updates a property.
Args:
fileId: string, The ID of the file. (required)
propertyKey: string, The key of the property. (required)
body: object, The request body.
The object takes the form of:
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. 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.
}
visibility: string, The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. 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.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(fileId, propertyKey, body=None, visibility=None, x__xgafv=None)</code>
<pre>Updates a property.
Args:
fileId: string, The ID of the file. (required)
propertyKey: string, The key of the property. (required)
body: object, The request body.
The object takes the form of:
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. 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.
}
visibility: string, The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. 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.
}</pre>
</div>
</body></html>
|
