REST Resource: notes

Recurso: Nota

Una sola nota.

Representación JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "trashTime": string,
  "trashed": boolean,
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "permissions": [
    {
      object (Permission)
    }
  ],
  "title": string,
  "body": {
    object (Section)
  }
}
Campos
name

string

Solo salida. Es el nombre del recurso de esta nota. Consulta la nota general sobre los identificadores en KeepService.
createTime

string (Timestamp format)

Solo salida. Cuándo se creó esta nota.
updateTime

string (Timestamp format)

Solo salida. La fecha de la última modificación de esta nota.
trashTime

string (Timestamp format)

Solo salida. La fecha en que se envió esta nota a la papelera. Si es trashed, la nota se borrará con el tiempo. Si la nota no se envía a la papelera, este campo no se establece (y el campo de papelera es false).
trashed

boolean

Solo salida. true si esta nota se envió a la papelera. Si se envía a la papelera, la nota se borrará con el tiempo.
attachments[]

object (Attachment)

Solo salida. Los archivos adjuntos de esta nota.
permissions[]

object (Permission)

Solo salida. Es la lista de permisos establecidos en la nota. Contiene al menos una entrada para el propietario de la nota.
title

string

Es el título de la nota. La longitud debe ser inferior a 1,000 caracteres.
body

object (Section)

Es el cuerpo de la nota.

Archivo adjunto

Un archivo adjunto a una nota.

Representación JSON 
{
  "name": string,
  "mimeType": [
    string
  ]
}
Campos
name

string

El nombre del recurso
mimeType[]

string

Los tipos MIME (tipos de medios IANA) en los que está disponible el archivo adjunto.

Permiso

Un solo permiso en la nota Asocia un member con un role.

Representación 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.
}
Campos
name

string

Solo salida. Nombre del recurso.
role

enum (Role)

El rol que otorga este permiso. El rol determina la capacidad de la entidad para leer, escribir y compartir notas.
email

string

Es el correo electrónico asociado con el miembro. Si se establece en la creación, el campo email en el mensaje User o Group debe estar vacío o coincidir con este campo. Cuando se lee, es posible que no se establezca si el miembro no tiene un correo electrónico asociado.
deleted

boolean

Solo salida. Indica si este miembro se borró. Si el miembro se recupera, este valor se establece como falso y el miembro recuperado conserva el rol en la nota.
Campo de unión member. Especifica la identidad a la que se le otorgó el rol. El miembro no se establece si se borró. Las direcciones (member) solo pueden ser una de las siguientes opciones:
user

object (User)

Solo salida. El usuario al que se aplica este rol.
group

object (Group)

Solo salida. Es el grupo al que se aplica este rol.
family

object (Family)

Solo salida. La Familia de Google a la que se aplica este rol.

Rol

Define los diversos roles que puede tener una entidad.

Enumeraciones
ROLE_UNSPECIFIED Un rol no definido.
OWNER Un rol que otorga acceso completo No se puede agregar ni quitar este rol. Es definido por el creador de la nota.
WRITER Es un rol que otorga la capacidad de contribuir con contenido y modificar los permisos de las notas.

Usuario

Describe un solo usuario.

Representación JSON 
{
  "email": string
}
Campos
email

string

Es el correo electrónico del usuario.

Grupo

Describe un solo grupo.

Representación JSON 
{
  "email": string
}
Campos
email

string

El correo electrónico del grupo

Familiar

Este tipo no tiene campos.

Describe una sola familia de Google.

Sección

Es el contenido de la nota.

Representación 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.
}
Campos
Campo de unión Content. El contenido de la sección debe ser uno de estos tipos de valor. Las direcciones (Content) solo pueden ser una de las siguientes opciones:
text

object (TextContent)

Se usa si el contenido de esta sección es un bloque de texto. La longitud del contenido de texto debe ser inferior a 20,000 caracteres.
list

object (ListContent)

Se usa si el contenido de esta sección es una lista.

TextContent

Es el bloque de texto de una sola sección de texto o elemento de lista.

Representación JSON 
{
  "text": string
}
Campos
text

string

Es el texto de la nota. Los límites varían según el campo específico que use este tipo.

ListContent

Es la lista de elementos de una sola nota de lista.

Representación JSON 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Campos
listItems[]

object (ListItem)

Los elementos de la lista. La cantidad de artículos debe ser inferior a 1,000.

ListItem

Es un solo elemento de una lista en la lista de una nota.

Representación JSON 
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
Campos
childListItems[]

object (ListItem)

Si se establece, es la lista de elementos de lista anidados en este elemento de lista. Solo se permite un nivel de anidamiento.
text

object (TextContent)

Es el texto de este elemento. La longitud debe ser inferior a 1,000 caracteres.
checked

boolean

Indica si este elemento se marcó o no.

Métodos

create

 Crea una nota nueva.

delete

 Borra una nota.

get

 Obtiene una nota.

list

 Enumera las notas.