REST Resource: notes

Ressource : Note

Une note.

Représentation JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "trashTime": string,
  "trashed": boolean,
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "permissions": [
    {
      object (Permission)
    }
  ],
  "title": string,
  "body": {
    object (Section)
  }
}
Champs
name

string

Uniquement en sortie. Nom de ressource de cette note. Consultez la remarque générale sur les identifiants dans KeepService.
createTime

string (Timestamp format)

Uniquement en sortie. Date de création de la note.
updateTime

string (Timestamp format)

Uniquement en sortie. Date de la dernière modification de cette note.
trashTime

string (Timestamp format)

Uniquement en sortie. Lorsque cette note a été placée dans la corbeille. Si la valeur est trashed, la note est supprimée. Si la note n'est pas placée dans la corbeille, ce champ n'est pas défini (et le champ "Corbeille" indique false).
trashed

boolean

Uniquement en sortie. true si la note a été placée dans la corbeille. Si elle est placée dans la corbeille, la note est supprimée.
attachments[]

object (Attachment)

Uniquement en sortie. Les pièces jointes à cette note.
permissions[]

object (Permission)

Uniquement en sortie. Liste des autorisations définies sur la note. Contient au moins une entrée pour le propriétaire de la note.
title

string

Titre de la note. La longueur doit être inférieure à 1 000 caractères.
body

object (Section)

Corps de la note.

Pièce jointe

Pièce jointe à une note.

Représentation JSON 
{
  "name": string,
  "mimeType": [
    string
  ]
}
Champs
name

string

Nom de la ressource.
mimeType[]

string

Types MIME (types de médias IANA) dans lesquels la pièce jointe est disponible.

Permission

Une seule autorisation sur la note. Associe une member à un role.

Représentation JSON 
{
  "name": string,
  "role": enum (Role),
  "email": string,
  "deleted": boolean,

  // Union field member can be only one of the following:
  "user": {
    object (User)
  },
  "group": {
    object (Group)
  },
  "family": {
    object (Family)
  }
  // End of list of possible types for union field member.
}
Champs
name

string

Uniquement en sortie. Nom de la ressource
role

enum (Role)

Rôle accordé par cette autorisation. Le rôle détermine la capacité de l'entité à lire, écrire et partager des notes.
email

string

Adresse e-mail associée au membre. S'il est défini lors de la création, le champ email du message User ou Group doit être vide ou correspondre à ce champ. En lecture, peut être désactivé si le membre n'a pas d'adresse e-mail associée.
deleted

boolean

Uniquement en sortie. Indique si ce membre a été supprimé. Si le membre récupéré est défini sur "false", le membre récupéré conserve son rôle sur la note.
Champ d'union member. Spécifie l'identité du rôle. Si le membre a été supprimé, il n'est pas défini. member ne peut être qu'un des éléments suivants :
user

object (User)

Uniquement en sortie. Utilisateur auquel ce rôle s'applique.
group

object (Group)

Uniquement en sortie. Groupe auquel s'applique ce rôle.
family

object (Family)

Uniquement en sortie. Famille Google à laquelle ce rôle s'applique.

Rôle

Définit les différents rôles qu'une entité peut avoir.

Enums
ROLE_UNSPECIFIED Rôle non défini.
OWNER Rôle accordant un accès complet. Impossible d'ajouter ou de supprimer ce rôle. Défini par le créateur de la note.
WRITER Rôle permettant d'ajouter du contenu et de modifier les autorisations liées aux notes.

Utilisateur

Décrit un seul utilisateur.

Représentation JSON 
{
  "email": string
}
Champs
email

string

Adresse e-mail de l'utilisateur.

Groupe

Décrit un seul groupe.

Représentation JSON 
{
  "email": string
}
Champs
email

string

Adresse e-mail du groupe.

Famille

Décrit une seule famille Google.

Section

Contenu de la note.

Représentation JSON 
{

  // Union field Content can be only one of the following:
  "text": {
    object (TextContent)
  },
  "list": {
    object (ListContent)
  }
  // End of list of possible types for union field Content.
}
Champs
Champ d'union Content. Le contenu de la section doit correspondre à l'un de ces types de valeurs. Content ne peut être qu'un des éléments suivants :
text

object (TextContent)

À utiliser si le contenu de cette section est un bloc de texte. La longueur du contenu textuel doit être inférieure à 20 000 caractères.
list

object (ListContent)

À utiliser si le contenu de cette section est une liste.

Contenu textuel

Bloc de texte pour une seule section de texte ou un seul élément de liste.

Représentation JSON 
{
  "text": string
}
Champs
text

string

Texte de la note. Les limites en la matière dépendent du champ spécifique qui utilise ce type.

ListeContenu

Liste d'éléments pour une seule note.

Représentation JSON 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Champs
listItems[]

object (ListItem)

Éléments de la liste. Le nombre d'éléments doit être inférieur à 1 000.

ListItem

Élément de liste unique dans une liste de notes.

Représentation JSON 
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
Champs
childListItems[]

object (ListItem)

Si ce champ est défini, liste des éléments de liste imbriqués sous cet élément de liste. Un seul niveau d'imbrication est autorisé.
text

object (TextContent)

Texte de cet élément. La longueur doit être inférieure à 1 000 caractères.
checked

boolean

Indique si l'article a été coché ou non.

Méthodes

create

 Crée une note.

delete

 Supprime une note.

get

 Récupère une note.

list

 Répertorie les notes.