Method: notes.list

Lista as notas.

Cada chamada de lista retorna uma página de resultados com pageSize como limite superior de itens retornados. Um pageSize de zero permite que o servidor escolha o limite superior.

O ListNotesResponse contém no máximo pageSize entradas. Se houver mais itens para listar, ele fornecerá um valor nextPageToken. (Os tokens de página são valores opacos.)

Para acessar a próxima página de resultados, copie o nextPageToken do resultado no pageToken da próxima solicitação. Repita até que o campo nextPageToken retornado com uma página de resultados esteja vazio.

O Notes.list retorna resultados consistentes diante de alterações simultâneas ou indica que não é possível fazer isso com um erro ABORTED.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de resultados a serem retornados.
pageToken

string

O campo nextPageToken da página anterior.
filter

string

Filtrar por resultados de lista. Se nenhum filtro for fornecido, o trashed será aplicado por padrão. Os campos válidos para filtrar são: createTime, updateTime, trashTime e trashed.

A sintaxe do filtro segue a especificação de filtragem AIP do Google.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta ao listar uma página de observações.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "notes": [
    {
      object (Note)
    }
  ],
  "nextPageToken": string
}
Campos
notes[]

object (Note)

Uma página de notas.
nextPageToken

string

Campo pageToken da próxima página.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o Guia de autorização.