Method: notes.list

Wyświetla notatki.

Każde wywołanie listy zwraca stronę wyników, przy której górną granicę zwracanych elementów to pageSize. Jeśli pageSize ma wartość 0, serwer może wybrać górną granicę.

Maksymalna liczba wpisów w kolumnie ListNotesResponse to pageSize. Jeśli zostało jeszcze więcej pozycji do listy, funkcja wyświetla wartość nextPageToken. (Tokeny stron są wartościami nieprzezroczystymi).

Aby wyświetlić następną stronę wyników, skopiuj nextPageToken wyniku do pola pageToken następnego żądania. Powtarzaj te czynności, aż obiekt nextPageToken zwrócony ze stroną wyników będzie pusty.

notes.list zwraca spójne wyniki w przypadku równoczesnych zmian lub informuje, że w przypadku błędu ANORTED nie może wystąpić błąd.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Maksymalna liczba wyników do zwrócenia.

pageToken

string

Pole nextPageToken na poprzedniej stronie.

filter

string

Filtr w celu wyświetlenia listy wyników. Jeśli nie zostanie podany żaden filtr, domyślnie stosowany jest filtr trashed. Prawidłowe pola, według których można filtrować, to: createTime, updateTime, trashTime i trashed.

Składnia filtra jest zgodna ze specyfikacją filtrowania AIP Google.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania strony z notatkami.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "notes": [
    {
      object (Note)
    }
  ],
  "nextPageToken": string
}
Pola
notes[]

object (Note)

Strona z notatkami.

nextPageToken

string

Pole pageToken następnej strony.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.