REST Resource: notes

Ressource: Hinweis

Eine einzelne Notiz.

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

string

Nur Ausgabe. Der Ressourcenname dieser Notiz. Siehe allgemeinen Hinweis zu Kennungen in KeepService.
createTime

string (Timestamp format)

Nur Ausgabe. Wann diese Notiz erstellt wurde.
updateTime

string (Timestamp format)

Nur Ausgabe. Wann diese Notiz zuletzt geändert wurde.
trashTime

string (Timestamp format)

Nur Ausgabe. Wann diese Notiz in den Papierkorb verschoben wurde. Wenn trashed, wird die Notiz gelöscht. Wenn die Notiz nicht in den Papierkorb verschoben wurde, ist dieses Feld nicht festgelegt und das Feld im Papierkorb lautet false.
trashed

boolean

Nur Ausgabe. true, wenn diese Notiz in den Papierkorb verschoben wurde. In den Papierkorb verschobene Elemente werden gelöscht.
attachments[]

object (Attachment)

Nur Ausgabe. Die an diese Notiz angehängten Anhänge.
permissions[]

object (Permission)

Nur Ausgabe. Die Liste der Berechtigungen, die für die Notiz festgelegt wurden. Enthält mindestens einen Eintrag für den Eigentümer der Notiz.
title

string

Der Titel der Notiz. Die Länge muss kürzer als 1.000 Zeichen sein.
body

object (Section)

Der Text der Notiz.

Anhang

Ein Anhang an eine Notiz.

JSON-Darstellung 
{
  "name": string,
  "mimeType": [
    string
  ]
}
Felder
name

string

Der Ressourcenname;
mimeType[]

string

Die MIME-Typen (IANA-Medientypen), in denen der Anhang verfügbar ist.

Berechtigung

Eine einzelne Berechtigung für die Notiz. Verknüpft ein member mit einem role.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname
role

enum (Role)

Die durch diese Berechtigung gewährte Rolle. Die Rolle bestimmt, ob die Entität Notizen lesen, schreiben und freigeben kann.
email

string

Die mit dem Mitglied verknüpfte E-Mail-Adresse. Wenn dieses Feld beim Erstellen erstellt wird, muss das Feld email in der Nachricht User oder Group entweder leer sein oder mit diesem Feld übereinstimmen. Ist beim Lesen möglicherweise nicht festgelegt, wenn dem Mitglied keine E-Mail-Adresse zugewiesen ist.
deleted

boolean

Nur Ausgabe. Gibt an, ob dieses Mitglied gelöscht wurde. Wenn das Mitglied wiederhergestellt wird, wird dieser Wert auf „false“ gesetzt und das wiederhergestellte Mitglied behält die Rolle für die Notiz.
Union-Feld member. Gibt die Identität an, die der Rolle zugewiesen wurde. Das Mitglied ist nicht festgelegt, wenn das Mitglied gelöscht wurde. Für member ist nur einer der folgenden Werte zulässig:
user

object (User)

Nur Ausgabe. Der Nutzer, für den diese Rolle gilt.
group

object (Group)

Nur Ausgabe. Die Gruppe, für die diese Rolle gilt.
family

object (Family)

Nur Ausgabe. Die Google-Familie, für die diese Rolle gilt.

Rolle

Definiert die verschiedenen Rollen, die eine Entität haben kann.

Enums
ROLE_UNSPECIFIED Eine nicht definierte Rolle.
OWNER Eine Rolle, die vollständigen Zugriff gewährt. Diese Rolle kann nicht hinzugefügt oder entfernt werden. Vom Ersteller der Notiz definiert.
WRITER Eine Rolle, die die Berechtigung zum Erstellen von Inhalten und zum Ändern von Notizenberechtigungen gewährt.

Nutzer

Beschreibt einen einzelnen Nutzer.

JSON-Darstellung 
{
  "email": string
}
Felder
email

string

Die E-Mail-Adresse des Nutzers.

Gruppe

Beschreibt eine einzelne Gruppe.

JSON-Darstellung 
{
  "email": string
}
Felder
email

string

Die E-Mail-Adresse der Gruppe.

Familie

Beschreibt eine einzelne Google-Familie.

Abschnitt

Der Inhalt der Notiz.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld Content. Der Inhalt des Abschnitts muss einem dieser Werttypen entsprechen. Für Content ist nur einer der folgenden Werte zulässig:
text

object (TextContent)

Wird verwendet, wenn der Inhalt dieses Abschnitts ein Textblock ist. Der Text muss kürzer als 20.000 Zeichen sein.
list

object (ListContent)

Wird verwendet, wenn der Inhalt dieses Abschnitts eine Liste ist.

Textinhalt

Der Textblock für einen einzelnen Textabschnitt oder ein Listenelement.

JSON-Darstellung 
{
  "text": string
}
Felder
text

string

Der Text der Notiz. Die Limits variieren je nach dem spezifischen Feld, das diesen Typ verwendet.

Listeninhalt

Die Liste der Elemente für eine einzelne Listennotiz.

JSON-Darstellung 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Felder
listItems[]

object (ListItem)

Die Elemente in der Liste. Die Anzahl der Elemente muss kleiner als 1.000 sein.

ListItem

Ein einzelner Listeneintrag in der Liste einer Notiz.

JSON-Darstellung 
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
Felder
childListItems[]

object (ListItem)

Wenn festgelegt, Liste der Listenelemente, die unter diesem Listenelement verschachtelt sind. Es ist nur eine Verschachtelungsebene zulässig.
text

object (TextContent)

Der Text dieses Elements. Die Länge muss kürzer als 1.000 Zeichen sein.
checked

boolean

Gibt an, ob dieser Artikel abgehakt wurde oder nicht.

Methoden

create

 Erstellt eine neue Notiz.

delete

 Löscht eine Notiz.

get

 Ruft eine Notiz ab.

list

 Listet Hinweise auf