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. El nombre de recurso de esta nota. Consulte 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. Cuándo se envió esta nota a la papelera Si es trashed, la nota se borra con el tiempo. Si la nota no está en la papelera, este campo no se establece (y el campo está en la papelera false).

trashed

boolean

Solo salida. true si esta nota se envió a la papelera. Si la envías 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. La lista de permisos establecidos en la nota. Contiene al menos una entrada para el propietario de la nota.

title

string

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

body

object (Section)

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 de MIME (tipos de medios de IANA) en los que el adjunto está disponible.

Permiso

Un único 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. Es el nombre del recurso.

role

enum (Role)

La función que otorga este permiso. La función determina la capacidad de la entidad para leer, escribir y compartir notas.

email

string

El correo electrónico asociado con el miembro. Si se configura al crear, el campo email en el mensaje User o Group debe estar vacío o coincidir con este campo. Es posible que la operación de lectura se anule si el miembro no tiene un correo electrónico asociado.

deleted

boolean

Solo salida. Indica si se borró este miembro. Si se recupera el miembro, este valor se establece como falso y el miembro recuperado conserva la función en la nota.

Campo de unión member. Especifica la identidad otorgada con la función. El miembro no se configura si se lo borró. Las direcciones (member) solo pueden ser una de las siguientes opciones:
user

object (User)

Solo salida. El usuario al que se aplica esta función.

group

object (Group)

Solo salida. El grupo al que se aplica esta función.

family

object (Family)

Solo salida. La familia de Google a la que se aplica esta función.

Rol

Define las diversas funciones que puede tener una entidad.

Enumeradores
ROLE_UNSPECIFIED Función indefinida.
OWNER Una función que otorga acceso completo. No se puede agregar ni quitar esta función. Definida por el creador de la nota.
WRITER Una función que otorga la capacidad de contribuir contenido y modificar los permisos de las notas.

Usuario

Describe a un solo usuario.

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

string

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

Describe a una sola familia de Google.

Sección

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 utiliza si el contenido de esta sección es un bloque de texto. El contenido de texto debe tener menos de 20,000 caracteres.

list

object (ListContent)

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

Contenido del texto

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

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

string

El texto de la nota. Los límites varían en función del campo específico que use este tipo.

Contenido de lista

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 elementos debe ser inferior a 1,000.

ListItem

Un único elemento en la lista de una nota.

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

object (ListItem)

Si se configura, lista de elementos anidados en este elemento. Solo se permite un nivel de anidación.

text

object (TextContent)

El texto de este elemento. La longitud debe ser inferior a 1,000 caracteres.

checked

boolean

Indica si este elemento está marcado o no.

Métodos

create

Crea una nota nueva.

delete

Borra una nota.

get

Obtiene una nota.

list

Enumera notas.