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. Allgemeiner Hinweis zu IDs 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. Bei trashed wird die Notiz irgendwann gelöscht. Wenn die Notiz nicht im Papierkorb ist, ist dieses Feld nicht festgelegt (und das Feld „Im Papierkorb“ ist false).
trashed

boolean

Nur Ausgabe. true, wenn diese Notiz im Papierkorb ist. Wenn die Notiz in den Papierkorb verschoben wird, wird sie nach einer gewissen Zeit gelöscht.
attachments[]

object (Attachment)

Nur Ausgabe. Die Anhänge, die an diese Notiz angehängt sind.
permissions[]

object (Permission)

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

string

Der Titel der Notiz. Die Länge darf maximal 1.000 Zeichen betragen.
body

object (Section)

Der Textkörper 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), in denen der Anhang verfügbar ist.

Berechtigung

Eine einzelne Berechtigung für den Hinweis. Ordnet eine member einer role zu.

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 Rolle, die durch diese Berechtigung gewährt wird. 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 beim Erstellen festgelegt, muss das Feld email in der User- oder Group-Nachricht entweder leer sein oder mit diesem Feld übereinstimmen. Wird beim Lesen möglicherweise zurückgesetzt, 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 in der Notiz.
Union-Feld member. Gibt die Identität an, der die Rolle zugewiesen wurde. „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, auf die diese Rolle angewendet wird.
family

object (Family)

Nur Ausgabe. Die Google-Familie, auf die diese Rolle angewendet wird.

Rolle

Hier werden die verschiedenen Rollen definiert, die eine Entität haben kann.

Enums
ROLE_UNSPECIFIED Eine nicht definierte Rolle.
OWNER Eine Rolle mit uneingeschränktem Zugriff. Diese Rolle kann nicht hinzugefügt oder entfernt werden. Wird vom Ersteller der Notiz festgelegt.
WRITER Eine Rolle, die die Möglichkeit bietet, Inhalte zu erstellen und Notizenberechtigungen zu ändern.

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

Dieser Typ hat keine Felder.

Beschreibt eine einzelne Google-Familie.

Bereich

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 einen dieser Werttypen haben. 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 darf maximal 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, für das dieser Typ verwendet wird.

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 Artikel muss unter 1.000 liegen.

ListItem

Ein einzelnes Listenelement 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 darf maximal 1.000 Zeichen betragen.
checked

boolean

Gibt an, ob dieser Artikel angeklickt wurde oder nicht.

Methoden

create

 Erstellt eine neue Notiz.

delete

 Löscht eine Notiz.

get

 Ruft eine Notiz ab.

list

 Listet Notizen auf.