REST Resource: notes

Risorsa: nota

Una singola nota.

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

string

Solo output. Il nome della risorsa di questa nota. Consulta la nota generale sugli identificatori in KeepService.

createTime

string (Timestamp format)

Solo output. La data di creazione della nota.

updateTime

string (Timestamp format)

Solo output. Data dell'ultima modifica di questa nota.

trashTime

string (Timestamp format)

Solo output. Quando questa nota è stata spostata nel cestino. Se trashed, la nota viene eliminata definitivamente. Se la nota non è nel cestino, questo campo non è impostato (e il campo del cestino è false).

trashed

boolean

Solo output. true se questa nota è stata spostata nel cestino. Se viene messa nel cestino, la nota viene eliminata definitivamente.

attachments[]

object (Attachment)

Solo output. Gli allegati a questa nota.

permissions[]

object (Permission)

Solo output. L'elenco delle autorizzazioni impostate sulla nota. Contiene almeno una voce per il proprietario della nota.

title

string

Il titolo della nota. La lunghezza deve essere inferiore a 1000 caratteri.

body

object (Section)

Il corpo della nota.

Allegato

Un allegato a una nota.

Rappresentazione JSON
{
  "name": string,
  "mimeType": [
    string
  ]
}
Campi
name

string

Il nome della risorsa.

mimeType[]

string

I tipi MIME (tipi di media IANA) in cui è disponibile l'allegato.

Autorizzazione

Una singola autorizzazione per la nota. Associa un member a un role.

Rappresentazione 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.
}
Campi
name

string

Solo output. Nome della risorsa.

role

enum (Role)

Il ruolo concesso da questa autorizzazione. Il ruolo determina la capacità dell'entità di leggere, scrivere e condividere note.

email

string

L'indirizzo email associato all'abbonato. Se impostato al momento della creazione, il campo email nel messaggio User o Group deve essere vuoto o corrispondere a questo campo. Al momento della lettura, potrebbe non essere impostato se al membro non è associato un indirizzo email.

deleted

boolean

Solo output. Indica se questo membro è stato eliminato. Se il membro viene recuperato, questo valore viene impostato su false e il membro recuperato mantiene il ruolo nella nota.

Campo unione member. Specifica l'identità a cui è stato concesso il ruolo. Il membro non è impostato se è stato eliminato. member può essere solo uno dei seguenti:
user

object (User)

Solo output. L'utente a cui si applica questo ruolo.

group

object (Group)

Solo output. Il gruppo a cui si applica questo ruolo.

family

object (Family)

Solo output. Il gruppo Famiglia Google a cui si applica questo ruolo.

Ruolo

Definisce i vari ruoli che un'entità può avere.

Enum
ROLE_UNSPECIFIED Un ruolo non definito.
OWNER Un ruolo che concede l'accesso completo. Questo ruolo non può essere aggiunto o rimosso. Definito dall'autore della nota.
WRITER Un ruolo che concede la possibilità di contribuire con contenuti e modificare le autorizzazioni delle note.

Utente

Descrive un singolo utente.

Rappresentazione JSON
{
  "email": string
}
Campi
email

string

L'email dell'utente.

Gruppo

Descrive un singolo gruppo.

Rappresentazione JSON
{
  "email": string
}
Campi
email

string

L'email del gruppo.

Famiglia

Questo tipo non contiene campi.

Descrive un singolo gruppo Famiglia Google.

Sezione

Il contenuto della nota.

Rappresentazione 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.
}
Campi
Campo unione Content. I contenuti della sezione devono essere uno di questi tipi di valori. Content può essere solo uno dei seguenti:
text

object (TextContent)

Da utilizzare se i contenuti di questa sezione sono un blocco di testo. La lunghezza del contenuto del testo deve essere inferiore a 20.000 caratteri.

list

object (ListContent)

Da utilizzare se i contenuti di questa sezione sono un elenco.

TextContent

Il blocco di testo per una singola sezione di testo o un elemento dell'elenco.

Rappresentazione JSON
{
  "text": string
}
Campi
text

string

Il testo della nota. I limiti variano in base al campo specifico che utilizza questo tipo.

ListContent

L'elenco di elementi per una singola nota elenco.

Rappresentazione JSON
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Campi
listItems[]

object (ListItem)

Gli elementi dell'elenco. Il numero di articoli deve essere inferiore a 1000.

ListItem

Un singolo elemento dell'elenco di una nota.

Rappresentazione JSON
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
Campi
childListItems[]

object (ListItem)

Se impostato, elenco di elementi dell'elenco nidificati sotto questo elemento dell'elenco. È consentito un solo livello di nidificazione.

text

object (TextContent)

Il testo di questo elemento. La lunghezza deve essere inferiore a 1000 caratteri.

checked

boolean

Indica se questo elemento è stato selezionato o meno.

Metodi

create

Crea una nuova nota.

delete

Elimina una nota.

get

Riceve una nota.

list

Elenca le note.