REST Resource: notes

Ressource : Note

Une seule 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 cette note.
updateTime

string (Timestamp format)

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

string (Timestamp format)

Uniquement en sortie. Date à laquelle cette note a été placée dans la corbeille. Si la valeur est trashed, la note finit par être supprimée. Si la note n'est pas dans la corbeille, ce champ n'est pas défini (et le champ placé dans la corbeille est false).
trashed

boolean

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

object (Attachment)

Uniquement en sortie. 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) pour lesquels la pièce jointe est disponible.

Autorisation

Autorisation unique sur la note. Associe un 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. "Lors de la 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 est récupéré, cette valeur est définie sur "false" et le membre récupéré conserve son rôle sur la note.
Champ d'union member. Spécifie l'identité à laquelle le rôle a été attribué. Le membre n'est pas défini s'il a été supprimé. 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 ce rôle s'applique.
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éfinie par le créateur de la note.
WRITER Rôle permettant d'ajouter du contenu et de modifier les autorisations relatives 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

Ce type ne comporte aucun champ.

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)

Utilisé si le contenu de cette section est un bloc de texte. Le contenu du texte doit comporter moins de 20 000 caractères.
list

object (ListContent)

Utilisé si le contenu de cette section est une liste.

TextContent

Bloc de texte d'une section de texte unique ou d'un élément de liste.

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

string

Texte de la note. Les limites relatives à ce type varient en fonction du champ spécifique utilisé.

ListContent

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

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 unique dans la liste d'une note.

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

object (ListItem)

Si défini, liste d'é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 cet article a été coché ou non.

Méthodes

create

 Crée une note.

delete

 Supprime une note.

get

 Permet d'obtenir une note.

list

 Répertorie les notes.