Method: notes.list

Lista as anotações.

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

A ListNotesResponse contém no máximo pageSize entradas. Se houver mais itens para listar, ele vai 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 para o pageToken da próxima solicitação. Repita até que o nextPageToken retornado com uma página de resultados esteja vazio.

notes.list retorna resultados consistentes em caso de mudanças simultâneas ou indica que não pode 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

Filtre os resultados da lista. Se nenhum filtro for fornecido, o filtro 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 do 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 anotaçõ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 anotações.

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.