blob: 2e1b602ee0ab5a152ee76da1f950619db7a90f44 [file] [log] [blame]
yoshi-code-botcb945f32021-06-08 00:36:03 -07001<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="keep_v1.html">Google Keep API</a> . <a href="keep_v1.notes.html">notes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="keep_v1.notes.permissions.html">permissions()</a></code>
79</p>
80<p class="firstline">Returns the permissions Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Creates a new note.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Deletes a note. Caller must have the `OWNER` role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.</p>
91<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Gets a note.</p>
94<p class="toc_element">
95 <code><a href="#list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
96<p class="firstline">Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result's `next_page_token` into the next request's `page_token`. Repeat until the `next_page_token` returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.</p>
97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<h3>Method Details</h3>
101<div class="method">
102 <code class="details" id="close">close()</code>
103 <pre>Close httplib2 connections.</pre>
104</div>
105
106<div class="method">
107 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
108 <pre>Creates a new note.
109
110Args:
111 body: object, The request body.
112 The object takes the form of:
113
114{ # A single note.
115 &quot;attachments&quot;: [ # Output only. The attachments attached to this note.
116 { # An attachment to a note.
117 &quot;mimeType&quot;: [ # The MIME types (IANA media types) in which the attachment is available.
118 &quot;A String&quot;,
119 ],
120 &quot;name&quot;: &quot;A String&quot;, # The resource name;
121 },
122 ],
123 &quot;body&quot;: { # The content of the note. # The body of the note.
124 &quot;list&quot;: { # The list of items for a single list note. # Used if this section&#x27;s content is a list.
125 &quot;listItems&quot;: [ # The items in the list. The number of items must be less than 1,000.
126 { # A single list item in a note&#x27;s list.
127 &quot;checked&quot;: True or False, # Whether this item has been checked off or not.
128 &quot;childListItems&quot;: [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.
129 # Object with schema name: ListItem
130 ],
131 &quot;text&quot;: { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.
132 &quot;text&quot;: &quot;A String&quot;, # The text of the note. The limits on this vary with the specific field using this type.
133 },
134 },
135 ],
136 },
137 &quot;text&quot;: { # The block of text for a single text section or list item. # Used if this section&#x27;s content is a block of text. The length of the text content must be less than 20,000 characters.
138 &quot;text&quot;: &quot;A String&quot;, # The text of the note. The limits on this vary with the specific field using this type.
139 },
140 },
141 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When this note was created.
142 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this note. See general note on identifiers in KeepService.
143 &quot;permissions&quot;: [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.
144 { # A single permission on the note. Associates a `member` with a `role`.
145 &quot;deleted&quot;: True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
146 &quot;email&quot;: &quot;A String&quot;, # The email associated with the member. If set on create, the email field in the User or Group message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
147 &quot;family&quot;: { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
148 },
149 &quot;group&quot;: { # Describes a single Group. # Output only. The group to which this role applies.
150 &quot;email&quot;: &quot;A String&quot;, # The group email.
151 },
152 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name.
153 &quot;role&quot;: &quot;A String&quot;, # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
154 &quot;user&quot;: { # Describes a single user. # Output only. The user to whom this role applies.
155 &quot;email&quot;: &quot;A String&quot;, # The user&#x27;s email.
156 },
157 },
158 ],
159 &quot;title&quot;: &quot;A String&quot;, # The title of the note. Length must be less than 1,000 characters.
160 &quot;trashTime&quot;: &quot;A String&quot;, # Output only. If this note has been trashed, when that happened. If trashed, the note will eventually be deleted. If the note is not trashed, this is not set (and the trashed field is false).
161 &quot;trashed&quot;: True or False, # Output only. True if this note has been trashed. If trashed, the note will eventually be deleted.
162 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When this note was last modified.
163}
164
165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170Returns:
171 An object of the form:
172
173 { # A single note.
174 &quot;attachments&quot;: [ # Output only. The attachments attached to this note.
175 { # An attachment to a note.
176 &quot;mimeType&quot;: [ # The MIME types (IANA media types) in which the attachment is available.
177 &quot;A String&quot;,
178 ],
179 &quot;name&quot;: &quot;A String&quot;, # The resource name;
180 },
181 ],
182 &quot;body&quot;: { # The content of the note. # The body of the note.
183 &quot;list&quot;: { # The list of items for a single list note. # Used if this section&#x27;s content is a list.
184 &quot;listItems&quot;: [ # The items in the list. The number of items must be less than 1,000.
185 { # A single list item in a note&#x27;s list.
186 &quot;checked&quot;: True or False, # Whether this item has been checked off or not.
187 &quot;childListItems&quot;: [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.
188 # Object with schema name: ListItem
189 ],
190 &quot;text&quot;: { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.
191 &quot;text&quot;: &quot;A String&quot;, # The text of the note. The limits on this vary with the specific field using this type.
192 },
193 },
194 ],
195 },
196 &quot;text&quot;: { # The block of text for a single text section or list item. # Used if this section&#x27;s content is a block of text. The length of the text content must be less than 20,000 characters.
197 &quot;text&quot;: &quot;A String&quot;, # The text of the note. The limits on this vary with the specific field using this type.
198 },
199 },
200 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When this note was created.
201 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this note. See general note on identifiers in KeepService.
202 &quot;permissions&quot;: [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.
203 { # A single permission on the note. Associates a `member` with a `role`.
204 &quot;deleted&quot;: True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
205 &quot;email&quot;: &quot;A String&quot;, # The email associated with the member. If set on create, the email field in the User or Group message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
206 &quot;family&quot;: { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
207 },
208 &quot;group&quot;: { # Describes a single Group. # Output only. The group to which this role applies.
209 &quot;email&quot;: &quot;A String&quot;, # The group email.
210 },
211 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name.
212 &quot;role&quot;: &quot;A String&quot;, # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
213 &quot;user&quot;: { # Describes a single user. # Output only. The user to whom this role applies.
214 &quot;email&quot;: &quot;A String&quot;, # The user&#x27;s email.
215 },
216 },
217 ],
218 &quot;title&quot;: &quot;A String&quot;, # The title of the note. Length must be less than 1,000 characters.
219 &quot;trashTime&quot;: &quot;A String&quot;, # Output only. If this note has been trashed, when that happened. If trashed, the note will eventually be deleted. If the note is not trashed, this is not set (and the trashed field is false).
220 &quot;trashed&quot;: True or False, # Output only. True if this note has been trashed. If trashed, the note will eventually be deleted.
221 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When this note was last modified.
222}</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
227 <pre>Deletes a note. Caller must have the `OWNER` role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.
228
229Args:
230 name: string, Required. Name of the note to delete. (required)
231 x__xgafv: string, V1 error format.
232 Allowed values
233 1 - v1 error format
234 2 - v2 error format
235
236Returns:
237 An object of the form:
238
239 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
240}</pre>
241</div>
242
243<div class="method">
244 <code class="details" id="get">get(name, x__xgafv=None)</code>
245 <pre>Gets a note.
246
247Args:
248 name: string, Required. Name of the resource. (required)
249 x__xgafv: string, V1 error format.
250 Allowed values
251 1 - v1 error format
252 2 - v2 error format
253
254Returns:
255 An object of the form:
256
257 { # A single note.
258 &quot;attachments&quot;: [ # Output only. The attachments attached to this note.
259 { # An attachment to a note.
260 &quot;mimeType&quot;: [ # The MIME types (IANA media types) in which the attachment is available.
261 &quot;A String&quot;,
262 ],
263 &quot;name&quot;: &quot;A String&quot;, # The resource name;
264 },
265 ],
266 &quot;body&quot;: { # The content of the note. # The body of the note.
267 &quot;list&quot;: { # The list of items for a single list note. # Used if this section&#x27;s content is a list.
268 &quot;listItems&quot;: [ # The items in the list. The number of items must be less than 1,000.
269 { # A single list item in a note&#x27;s list.
270 &quot;checked&quot;: True or False, # Whether this item has been checked off or not.
271 &quot;childListItems&quot;: [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.
272 # Object with schema name: ListItem
273 ],
274 &quot;text&quot;: { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.
275 &quot;text&quot;: &quot;A String&quot;, # The text of the note. The limits on this vary with the specific field using this type.
276 },
277 },
278 ],
279 },
280 &quot;text&quot;: { # The block of text for a single text section or list item. # Used if this section&#x27;s content is a block of text. The length of the text content must be less than 20,000 characters.
281 &quot;text&quot;: &quot;A String&quot;, # The text of the note. The limits on this vary with the specific field using this type.
282 },
283 },
284 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When this note was created.
285 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this note. See general note on identifiers in KeepService.
286 &quot;permissions&quot;: [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.
287 { # A single permission on the note. Associates a `member` with a `role`.
288 &quot;deleted&quot;: True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
289 &quot;email&quot;: &quot;A String&quot;, # The email associated with the member. If set on create, the email field in the User or Group message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
290 &quot;family&quot;: { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
291 },
292 &quot;group&quot;: { # Describes a single Group. # Output only. The group to which this role applies.
293 &quot;email&quot;: &quot;A String&quot;, # The group email.
294 },
295 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name.
296 &quot;role&quot;: &quot;A String&quot;, # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
297 &quot;user&quot;: { # Describes a single user. # Output only. The user to whom this role applies.
298 &quot;email&quot;: &quot;A String&quot;, # The user&#x27;s email.
299 },
300 },
301 ],
302 &quot;title&quot;: &quot;A String&quot;, # The title of the note. Length must be less than 1,000 characters.
303 &quot;trashTime&quot;: &quot;A String&quot;, # Output only. If this note has been trashed, when that happened. If trashed, the note will eventually be deleted. If the note is not trashed, this is not set (and the trashed field is false).
304 &quot;trashed&quot;: True or False, # Output only. True if this note has been trashed. If trashed, the note will eventually be deleted.
305 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When this note was last modified.
306}</pre>
307</div>
308
309<div class="method">
310 <code class="details" id="list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
311 <pre>Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result&#x27;s `next_page_token` into the next request&#x27;s `page_token`. Repeat until the `next_page_token` returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.
312
313Args:
314 filter: string, Filter for list results. If no filter is supplied, the &quot;-trashed&quot; filter is applied by default. Valid fields to filter by are: - `create_time` - `update_time` - `trash_time` - `trashed` Filter syntax follows the Google AIP filtering spec: https://aip.dev/160
315 pageSize: integer, The maximum number of results to return.
316 pageToken: string, The previous page&#x27;s `next_page_token` field.
317 x__xgafv: string, V1 error format.
318 Allowed values
319 1 - v1 error format
320 2 - v2 error format
321
322Returns:
323 An object of the form:
324
325 { # The response when listing a page of notes (see KeepService documentation).
326 &quot;nextPageToken&quot;: &quot;A String&quot;, # Next page&#x27;s `page_token` field.
327 &quot;notes&quot;: [ # A page of notes.
328 { # A single note.
329 &quot;attachments&quot;: [ # Output only. The attachments attached to this note.
330 { # An attachment to a note.
331 &quot;mimeType&quot;: [ # The MIME types (IANA media types) in which the attachment is available.
332 &quot;A String&quot;,
333 ],
334 &quot;name&quot;: &quot;A String&quot;, # The resource name;
335 },
336 ],
337 &quot;body&quot;: { # The content of the note. # The body of the note.
338 &quot;list&quot;: { # The list of items for a single list note. # Used if this section&#x27;s content is a list.
339 &quot;listItems&quot;: [ # The items in the list. The number of items must be less than 1,000.
340 { # A single list item in a note&#x27;s list.
341 &quot;checked&quot;: True or False, # Whether this item has been checked off or not.
342 &quot;childListItems&quot;: [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.
343 # Object with schema name: ListItem
344 ],
345 &quot;text&quot;: { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.
346 &quot;text&quot;: &quot;A String&quot;, # The text of the note. The limits on this vary with the specific field using this type.
347 },
348 },
349 ],
350 },
351 &quot;text&quot;: { # The block of text for a single text section or list item. # Used if this section&#x27;s content is a block of text. The length of the text content must be less than 20,000 characters.
352 &quot;text&quot;: &quot;A String&quot;, # The text of the note. The limits on this vary with the specific field using this type.
353 },
354 },
355 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When this note was created.
356 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this note. See general note on identifiers in KeepService.
357 &quot;permissions&quot;: [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.
358 { # A single permission on the note. Associates a `member` with a `role`.
359 &quot;deleted&quot;: True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
360 &quot;email&quot;: &quot;A String&quot;, # The email associated with the member. If set on create, the email field in the User or Group message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
361 &quot;family&quot;: { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
362 },
363 &quot;group&quot;: { # Describes a single Group. # Output only. The group to which this role applies.
364 &quot;email&quot;: &quot;A String&quot;, # The group email.
365 },
366 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name.
367 &quot;role&quot;: &quot;A String&quot;, # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
368 &quot;user&quot;: { # Describes a single user. # Output only. The user to whom this role applies.
369 &quot;email&quot;: &quot;A String&quot;, # The user&#x27;s email.
370 },
371 },
372 ],
373 &quot;title&quot;: &quot;A String&quot;, # The title of the note. Length must be less than 1,000 characters.
374 &quot;trashTime&quot;: &quot;A String&quot;, # Output only. If this note has been trashed, when that happened. If trashed, the note will eventually be deleted. If the note is not trashed, this is not set (and the trashed field is false).
375 &quot;trashed&quot;: True or False, # Output only. True if this note has been trashed. If trashed, the note will eventually be deleted.
376 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When this note was last modified.
377 },
378 ],
379}</pre>
380</div>
381
382<div class="method">
383 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
384 <pre>Retrieves the next page of results.
385
386Args:
387 previous_request: The request for the previous page. (required)
388 previous_response: The response from the request for the previous page. (required)
389
390Returns:
391 A request object that you can call &#x27;execute()&#x27; on to request the next
392 page. Returns None if there are no more items in the collection.
393 </pre>
394</div>
395
396</body></html>