REST Resource: notes

Zasób: uwaga

Pojedyncza 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. Zobacz ogólną uwagę na temat identyfikatorów w KeepService.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Data utworzenia tej notatki.
updateTime

string (Timestamp format)

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

string (Timestamp format)

Tylko dane wyjściowe. Kiedy ta notatka została przeniesiona do kosza. Jeśli trashed, notatka zostanie ostatecznie usunięta. Jeśli notatki nie ma w koszu, to pole nie jest ustawione (a pole kosza ma wartość false).
trashed

boolean

Tylko dane wyjściowe. true jeśli ta notatka została przeniesiona do kosza. Jeśli zostanie przeniesiona do kosza, zostanie ostatecznie 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 dla 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

nazwę zasobu;
mimeType[]

string

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

Uprawnienie

pojedyncze uprawnienia do notatki, Powiązanie 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 przyznana przez to uprawnienie. Rola określa, czy podmiot może odczytywać, zapisywać i udostępniać notatki.
email

string

Adres e-mail powiązany z użytkownikiem. Jeśli pole email zostało ustawione podczas tworzenia, pole User lub Group musi być puste lub musi odpowiadać temu polu. W przypadku przeczytania może być nieaktywny, jeśli użytkownik nie ma powiązanego adresu e-mail.
deleted

boolean

Tylko dane wyjściowe. Informacja o tym, czy ten użytkownik został usunięty. Jeśli użytkownik zostanie przywrócony, ta wartość zostanie ustawiona na „false” (fałsz) i użytkownik zachowa swoją rolę w notatce.
Pole unii member. Określa tożsamość, której przyznano rolę. Jeśli użytkownik został usunięty, jego pozycja w grupie jest pusta. member może być tylko jednym z tych elementów:
user

object (User)

Tylko dane wyjściowe. Użytkownik, do którego ta rola się odnosi.
group

object (Group)

Tylko dane wyjściowe. Grupa, do której ta rola się odnosi.
family

object (Family)

Tylko dane wyjściowe. Grupa rodzinna w Google, do której ta rola się odnosi.

Rola

Definiuje różne role, które może pełnić dany element.

Wartości w polu enum
ROLE_UNSPECIFIED Niezdefiniowana rola.
OWNER Rola przyznająca pełny dostęp. Tej roli nie można dodawać ani usuwać. Określa go twórca notatki.
WRITER Rola przyznająca uprawnienia do publikowania treści i modyfikowania uprawnień do notatek.

Użytkownik

Opis 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 ma pól.

Opisuje jedną grupę rodzinną 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 unii Content. Treść sekcji musi być jednym z tych typów wartości. Content może być tylko jednym z tych elementów:
text

object (TextContent)

Używane, gdy zawartość sekcji to blok tekstu. Treść tekstowa nie może mieć więcej niż 20 tys. znaków.
list

object (ListContent)

Używany, gdy zawartość tej sekcji jest listą.

TextContent

Blok tekstu w pojedynczej sekcji tekstowej lub elemencie listy.

Zapis JSON 
{
  "text": string
}
Pola
text

string

Tekst notatki. Limity te różnią się w zależności od konkretnego pola, które używa tego typu danych.

ListContent

Lista elementów pojedynczej notatki na liście.

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

object (ListItem)

Elementy na liście. Liczba produktów musi być mniejsza niż 1000.

ListItem

Pojedynczy element na liście w notatce.

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

object (ListItem)

Jeśli jest ustawiona, zawiera listę elementów listy zagnieżdżonych pod tym elementem listy. Dozwolony jest tylko 1 poziom umieszczania.
text

object (TextContent)

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

boolean

Określa, czy element jest zaznaczony.

Metody

create

 Tworzy nową notatkę.

delete

 Usuwa notatkę.

get

 Otrzymuje notatkę.

list

 Wyświetla listę notatek.