REST Resource: notes

Recurso: Nota

Uma única observação.

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 desta nota. Consulte a observação geral sobre identificadores no KeepService.

createTime

string (Timestamp format)

Apenas saída. Quando esta nota foi criada.

updateTime

string (Timestamp format)

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

trashTime

string (Timestamp format)

Apenas saída. Quando esta nota foi enviada para a lixeira. Se trashed, a nota será excluída. Se a nota não estiver na lixeira, este campo não será definido e o campo será false.

trashed

boolean

Apenas saída. true se esta nota tiver sido enviada para a lixeira. Se for movida para a lixeira, a nota será excluída.

attachments[]

object (Attachment)

Apenas saída. Os anexos anexados a esta observação.

permissions[]

object (Permission)

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

title

string

Título da nota. O comprimento deve ser inferior a 1.000 caracteres.

body

object (Section)

O corpo da nota.

Anexo

Um anexo de 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 para a 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 notas.

email

string

O e-mail associado ao membro. Se definido na criação, o campo email na mensagem User ou Group precisará estar vazio ou corresponder a esse campo. Na leitura, é possível que o membro não tenha um e-mail associado.

deleted

boolean

Apenas saída. Indica se o membro foi excluído. Se o membro for recuperado, esse valor será definido como falso e o membro recuperado manterá o papel na nota.

Campo de união member. Especifica a identidade que recebeu o papel. O membro não será definido 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 quem esse papel se aplica.

group

object (Group)

Apenas saída. O grupo ao qual essa função se aplica.

family

object (Family)

Apenas saída. A família do Google a que essa função se aplica.

Papel

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

Enums
ROLE_UNSPECIFIED Papel indefinido.
OWNER Um papel que concede acesso total. Não é possível adicionar ou remover este papel. Definido pelo criador da nota.
WRITER Uma função que concede a capacidade de colaborar com conteúdo e modificar 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

Descreve uma única família do Google.

Seção

Conteúdo da anotação.

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 desta seção for um bloco de texto. O conteúdo do texto precisa ter menos de 20.000 caracteres.

list

object (ListContent)

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

Conteúdo do texto

O bloco de texto para uma única seção de texto ou item da 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.

Conteúdo da lista

A lista de itens de uma única nota da 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 na lista de uma nota.

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

object (ListItem)

Se definido, lista os itens de lista aninhados nesse item da lista. Só é permitido um nível de aninhamento.

text

object (TextContent)

O texto desse item. O comprimento deve ser inferior a 1.000 caracteres.

checked

boolean

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 observações.