Skip to main content

notes

Overview

Namenotes
TypeResource
Idgoogleworkspace.keep.notes

Fields

NameDatatypeDescription
namestringOutput only. The resource name of this note. See general note on identifiers in KeepService.
permissionsarrayOutput only. The list of permissions set on the note. Contains at least one entry for the note owner.
trashedbooleanOutput only. true if this note has been trashed. If trashed, the note is eventually deleted.
attachmentsarrayOutput only. The attachments attached to this note.
bodyobjectThe content of the note.
createTimestringOutput only. When this note was created.
titlestringThe title of the note. Length must be less than 1,000 characters.
updateTimestringOutput only. When this note was last modified.
trashTimestringOutput only. When this note was trashed. If trashed, the note is eventually deleted. If the note is not trashed, this field is not set (and the trashed field is false).

Methods

NameAccessible byRequired ParamsDescription
getSELECTnotesIdGets a note.
listSELECTLists 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.
createINSERTCreates a new note.
deleteDELETEnotesIdDeletes 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.