Method: notes.list

Répertorie les notes.

Chaque appel de liste renvoie une page de résultats avec pageSize comme limite supérieure des éléments renvoyés. Une pageSize de zéro permet au serveur de choisir la limite supérieure.

La réponse ListNotesResponse contient pageSize entrées au maximum. S'il reste d'autres éléments à répertorier, une valeur nextPageToken est fournie. (Les jetons de page sont des valeurs opaques.)

Pour obtenir la page de résultats suivante, copiez l'nextPageToken du résultat dans le pageToken de la requête suivante. Répétez l'opération jusqu'à ce que le nextPageToken renvoyé avec une page de résultats soit vide.

notes.list renvoie des résultats cohérents en présence de modifications simultanées ou indique qu'elle ne peut pas l'être avec une erreur ABORTED.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal de résultats à renvoyer.
pageToken

string

Le champ nextPageToken de la page précédente.
filter

string

Filtrer pour afficher les résultats sous forme de liste. Si aucun filtre n'est fourni, le filtre trashed est appliqué par défaut. Les champs valides pour le filtrage sont les suivants: createTime, updateTime, trashTime et trashed.

La syntaxe du filtre respecte les spécifications de filtrage de l'AIP de Google.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse lors de l'affichage d'une page de notes.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "notes": [
    {
      object (Note)
    }
  ],
  "nextPageToken": string
}
Champs
notes[]

object (Note)

Une page de notes.
nextPageToken

string

Champ pageToken de la page suivante.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le Guide relatif aux autorisations.