REST Resource: notes

Zasób: notatka

Jedna notatka.

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

string

Tylko dane wyjściowe. Nazwa zasobu tej notatki. Przeczytaj ogólne uwagi na temat identyfikatorów w KeepService.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Data utworzenia notatki.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Data ostatniej modyfikacji notatki.
trashTime

string (Timestamp format)

Tylko dane wyjściowe. Kiedy ta notatka została usunięta do kosza. Jeśli trashed, notatka zostanie w końcu usunięta. Jeśli notatka nie została przeniesiona do kosza, to pole nie jest ustawione (a pole usunięte do kosza to false).
trashed

boolean

Tylko dane wyjściowe. true, jeśli ta notatka została usunięta do kosza. Jeśli notatka zostanie przeniesiona do kosza, zostanie w końcu usunięta.
attachments[]

object (Attachment)

Tylko dane wyjściowe. Załączniki dołączone do tej notatki.
permissions[]

object (Permission)

Tylko dane wyjściowe. Lista uprawnień ustawionych w notatce. Zawiera co najmniej 1 wpis właściciela notatki.
title

string

Tytuł notatki. Liczba znaków musi być mniejsza niż 1000.
body

object (Section)

Treść notatki.

Załącznik

Załącznik do notatki.

Zapis JSON 
{
  "name": string,
  "mimeType": [
    string
  ]
}
Pola
name

string

nazwa zasobu;
mimeType[]

string

Typy multimediów (IANA), w których dostępny jest załącznik.

Uprawnienie

Jedno uprawnienie do danej notatki. Wiąże member z role.

Zapis 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.
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu.
role

enum (Role)

Rola przypisana przez to uprawnienie. Rola określa zdolność jednostki do odczytywania, pisania i udostępniania notatek.
email

string

Adres e-mail powiązany z użytkownikiem. Jeśli ta zasada jest ustawiona podczas tworzenia, pole email w wiadomości User lub Group musi być puste lub pasować do tego pola. W trakcie czytania może to nie nastąpić, jeśli użytkownik nie ma powiązanego adresu e-mail.
deleted

boolean

Tylko dane wyjściowe. Wskazuje, czy użytkownik został usunięty. Jeśli użytkownik odzyska dostęp do konta, ta wartość zostanie ustawiona na „false”, a przywrócony użytkownik zachowa rolę przypisaną do notatki.
Pole sumy member. Określa tożsamość, do której przypisano rolę. Członek jest nieskonfigurowany, jeśli został usunięty. member może mieć tylko jedną z tych wartości:
user

object (User)

Tylko dane wyjściowe. Użytkownik, którego dotyczy ta rola.
group

object (Group)

Tylko dane wyjściowe. Grupa, do której ma zastosowanie ta rola.
family

object (Family)

Tylko dane wyjściowe. Grupa rodzinna w Google, której dotyczy ta rola.

Rola

Określa różne role, jakie może mieć encja.

Wartości w polu enum
ROLE_UNSPECIFIED Niezdefiniowana rola.
OWNER Rola przyznająca pełny dostęp. Tej roli nie można dodać ani usunąć. Zdefiniowany przez twórcę notatki.
WRITER Rola umożliwiająca dodawanie treści i modyfikowanie uprawnień do notatek.

Użytkownik

Opisuje pojedynczego użytkownika.

Zapis JSON 
{
  "email": string
}
Pola
email

string

Adres e-mail użytkownika.

Grupa

Opisuje jedną grupę.

Zapis JSON 
{
  "email": string
}
Pola
email

string

Adres e-mail grupy.

Rodzinny

Ten typ nie zawiera pól.

Opis pojedynczej grupy rodzinnej w Google.

Sekcja

Treść notatki.

Zapis 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.
}
Pola
Pole sumy Content. Zawartość sekcji musi mieć jeden z tych typów wartości. Content może mieć tylko jedną z tych wartości:
text

object (TextContent)

Używana, jeśli zawartość tej sekcji jest blokiem tekstu. Długość tekstu musi być mniejsza niż 20 000 znaków.
list

object (ListContent)

Używana, jeśli zawartość tej sekcji jest listą.

TextContent

Blok tekstu dla pojedynczej sekcji tekstu lub elementu listy.

Zapis JSON 
{
  "text": string
}
Pola
text

string

Tekst notatki. Limity różnią się w zależności od pola korzystającego z tego typu danych.

ListContent

Lista elementów jednej notatki z listą.

Zapis JSON 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Pola
listItems[]

object (ListItem)

Pozycje na liście. Liczba elementów musi być mniejsza niż 1000.

ListItem

Pojedynczy element listy na liście notatki.

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

object (ListItem)

Jeśli jest ustawiona, lista elementów listy zagnieżdżonych w danym elemencie listy. Dozwolony jest tylko 1 poziom zagnieżdżenia.
text

object (TextContent)

Tekst tego elementu. Liczba znaków musi być mniejsza niż 1000.
checked

boolean

Wskazuje, czy produkt został odznaczony.

Metody

create

 Tworzy nową notatkę.

delete

 Usuwa notatkę.

get

 Pobiera notatkę.

list

 Wyświetla notatki.