Method: notes.list

Muestra una lista de notas.

Cada llamada a list muestra una página de resultados con pageSize como el límite superior de los elementos que se muestran. Un pageSize de cero permite que el servidor elija el límite superior.

ListNotesResponse contiene como máximo pageSize entradas. Si quedan más elementos por enumerar, proporciona un valor nextPageToken. (Los tokens de página son valores opacos).

Para obtener la siguiente página de resultados, copia el nextPageToken del resultado en el pageToken de la siguiente solicitud. Repite hasta que la nextPageToken que se muestra con una página de resultados esté vacía.

Notes.list muestra resultados coherentes frente a cambios simultáneos o indicadores que no se pueden con un error ABORTED.

Solicitud HTTP

GET https://keep.googleapis.com/v1/notes

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
pageSize

integer

La cantidad máxima de resultados que se mostrarán.

pageToken

string

El campo nextPageToken de la página anterior

filter

string

Filtra los resultados de la lista. Si no se proporciona ningún filtro, el filtro trashed se aplica de forma predeterminada. Los campos válidos para filtrar son: createTime, updateTime, trashTime y trashed.

La sintaxis del filtro sigue las especificaciones de filtrado de la AIP de Google.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

La respuesta que se obtiene cuando se enumera una página de notas.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "notes": [
    {
      object (Note)
    }
  ],
  "nextPageToken": string
}
Campos
notes[]

object (Note)

Una página de notas.

nextPageToken

string

Campo pageToken de la página siguiente

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/keep
  • https://www.googleapis.com/auth/keep.readonly

Para obtener más información, consulta la Guía de autorización.