REST Resource: notes

Recurso: Nota

Uma única nota.

Representação 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

Apenas saída. O nome do recurso dessa nota. Consulte a observação geral sobre identificadores no KeepService.
createTime

string (Timestamp format)

Apenas saída. Quando a nota foi criada.
updateTime

string (Timestamp format)

Apenas saída. Quando a nota foi modificada pela última vez.
trashTime

string (Timestamp format)

Apenas saída. Quando a nota foi movida para a lixeira. Se for trashed, a nota será excluída. Se a nota não estiver na lixeira, esse campo não será definido (e o campo da lixeira será false).
trashed

boolean

Apenas saída. true se a nota foi excluída. Se for excluída, a nota será excluída.
attachments[]

object (Attachment)

Apenas saída. Os anexos adicionados a esta nota.
permissions[]

object (Permission)

Apenas saída. A lista de permissões definidas na nota. Contém pelo menos uma entrada para o proprietário da nota.
title

string

O título da anotação. O comprimento precisa ser menor que 1.000 caracteres.
body

object (Section)

O corpo da nota.

Anexo

Um anexo a uma nota.

Representação JSON 
{
  "name": string,
  "mimeType": [
    string
  ]
}
Campos
name

string

O nome do recurso;
mimeType[]

string

Os tipos MIME (tipos de mídia IANA) em que o anexo está disponível.

Permissão

Uma única permissão na nota. Associa um member a um role.

Representação 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

Apenas saída. O nome do recurso.
role

enum (Role)

O papel concedido pela permissão. O papel determina a capacidade da entidade de ler, gravar e compartilhar anotações.
email

string

O e-mail associado ao participante. Se definido na criação, o campo email na mensagem User ou Group precisa estar vazio ou ser igual a este campo. Pode ser desativado se o participante não tiver um e-mail associado.
deleted

boolean

Apenas saída. Indica se o participante foi excluído. Se o membro for recuperado, esse valor será definido como "false", e o membro recuperado vai manter o papel na nota.
Campo de união member. Especifica a identidade que recebeu o papel. O participante é redefinido se tiver sido excluído. member pode ser apenas de um dos tipos a seguir:
user

object (User)

Apenas saída. O usuário a que essa função se aplica.
group

object (Group)

Apenas saída. O grupo a que essa função se aplica.
family

object (Family)

Apenas saída. A família do Google a que esse papel se aplica.

Papel

Define os vários papéis que uma entidade pode ter.

Enums
ROLE_UNSPECIFIED Uma função indefinida.
OWNER Uma função que concede acesso total. Não é possível adicionar ou remover essa função. Definido pelo criador da nota.
WRITER Um papel que permite contribuir com conteúdo e modificar as permissões de notas.

Usuário

Descreve um único usuário.

Representação JSON 
{
  "email": string
}
Campos
email

string

O e-mail do usuário.

Grupo

Descreve um único grupo.

Representação JSON 
{
  "email": string
}
Campos
email

string

O e-mail do grupo.

Família

Esse tipo não tem campos.

Descreve uma única família do Google.

Seção

O conteúdo da nota.

Representação 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ão Content. O conteúdo da seção precisa ser um desses tipos de valor. Content pode ser apenas de um dos tipos a seguir:
text

object (TextContent)

Usado se o conteúdo da seção for um bloco de texto. O conteúdo de texto precisa ter menos de 20.000 caracteres.
list

object (ListContent)

Usado se o conteúdo da seção for uma lista.

TextContent

O bloco de texto de uma única seção de texto ou item de lista.

Representação JSON 
{
  "text": string
}
Campos
text

string

O texto da anotação. Os limites variam de acordo com o campo específico que usa esse tipo.

ListContent

Lista de itens de uma única nota de lista.

Representação JSON 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Campos
listItems[]

object (ListItem)

Os itens na lista. O número de itens precisa ser menor que 1.000.

ListItem

Um único item de lista em uma lista de notas.

Representação JSON 
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
Campos
childListItems[]

object (ListItem)

Se definido, lista de itens da lista aninhados a este item. Apenas um nível de aninhamento é permitido.
text

object (TextContent)

O texto do item. O comprimento precisa ser menor que 1.000 caracteres.
checked

boolean

Indica se o item foi marcado ou não.

Métodos

create

 Cria uma nova nota.

delete

 Exclui uma nota.

get

 Recebe uma nota.

list

 Lista as anotações.