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 dieses Hinweises. Siehe allgemeinen Hinweis zu IDs in KeepService.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem diese Notiz erstellt wurde.
updateTime

string (Timestamp format)

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

string (Timestamp format)

Nur Ausgabe. Wann die Notiz in den Papierkorb verschoben wurde. Wenn trashed, wird die Notiz schließlich gelöscht. Wenn die Notiz nicht in den Papierkorb verschoben wurde, ist dieses Feld nicht festgelegt (und das in den Papierkorb verschobene Feld ist false).
trashed

boolean

Nur Ausgabe. true, wenn die Notiz in den Papierkorb verschoben wurde. Wenn sie in den Papierkorb verschoben wird, wird sie schließlich 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 Hinweisinhaber.
title

string

Der Titel der Notiz. Die Länge muss weniger als 1.000 Zeichen betragen.
body

object (Section)

Der Text der Notiz.

Anhang

Ein Anhang zu einer Notiz.

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

string

Der Ressourcenname
mimeType[]

string

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

Berechtigung

Eine einzelne Berechtigung für die Notiz. Verbindet 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. Über die Rolle wird festgelegt, ob die Entität Notizen lesen, schreiben und teilen kann.
email

string

Die mit dem Mitglied verknüpfte E-Mail-Adresse. Wenn das Feld beim Erstellen festgelegt wird, muss das Feld email in der User- oder Group-Nachricht entweder leer sein oder mit diesem Feld übereinstimmen. Kann beim Lesen deaktiviert werden, wenn dem Mitglied keine E-Mail-Adresse zugeordnet 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 bei.
Union-Feld member. Gibt die Identität an, der die Rolle gewährt wurde. Die Festlegung des Mitglieds wird aufgehoben, 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 weder hinzugefügt noch entfernt werden. Wird vom Ersteller der Notiz festgelegt.
WRITER Eine Rolle mit der Berechtigung, Inhalte beizusteuern und die Berechtigungen für Notizen zu ändern.

Nutzer

Beschreibt eine einzelne nutzende Person.

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

Dieser Typ hat keine Felder.

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 Bereichs 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 Textinhalt muss weniger als 20.000 Zeichen lang sein.
list

object (ListContent)

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

TextContent

Der Textblock für einen einzelnen Textabschnitt oder Listeneintrag.

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

string

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

ListContent

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 einzelnes Listenelement in der Liste einer Notiz.

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

object (ListItem)

Falls festgelegt, Liste der unter diesem Listenelement verschachtelten Listenelemente. Es ist nur eine Verschachtelungsebene zulässig.
text

object (TextContent)

Der Text dieses Elements. Die Länge muss weniger als 1.000 Zeichen betragen.
checked

boolean

Gibt an, ob dieser Artikel abgehakt wurde.

Methoden

create

 Erstellt eine neue Notiz.

delete

 Löscht eine Notiz.

get

 Ruft eine Notiz ab.

list

 Listet Notizen auf.