REST Resource: notes

Zasób: Uwagi

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ą notatkę dotyczącą identyfikatorów w usłudze 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 usunięta do kosza. Jeśli trashed, uwaga zostanie usunięta. Jeśli uwaga nie jest w koszu, to pole nie jest ustawione (a to pole false).

trashed

boolean

Tylko dane wyjściowe. true, jeśli ta notatka została przeniesiona do kosza. Jeśli przeniesiesz je do kosza, zostanie ona 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. Długość nie może przekraczać 1000 znaków.

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 MIME (typy multimediów IANA), w których jest dostępny załącznik.

Uprawnienia

Jedno uprawnienie do notatki. Powiązanie elementu member z elementem 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 możliwość odczytywania, zapisywania i udostępniania notatek przez element.

email

string

Adres e-mail powiązany z członkiem. Jeśli jest ustawiona podczas tworzenia, pole email w komunikacie User lub Group musi być puste lub zgodne z tym polem. W przypadku odczytu może być nieskonfigurowana, jeśli członek nie ma powiązanego adresu e-mail.

deleted

boolean

Tylko dane wyjściowe. Czy użytkownik został usunięty. Jeśli dana osoba zostanie przywrócona, ta wartość zostanie ustawiona na Fałsz, a odzyskany członek zachowa rolę w notatce.

Pole sumy: member. Określa tożsamość przypisaną do roli. Jeśli użytkownik został usunięty, nie jest ustawiona. 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 należy ta rola.

family

object (Family)

Tylko dane wyjściowe. Rodzina Google, której dotyczy ta rola.

Rola

Określa różne role jednostki.

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

Użytkownik

Opisuje pojedynczego użytkownika.

Zapis JSON
{
  "email": string
}
Pola
email

string

Adres e-mail użytkownika.

Grupa

Opisuje pojedynczą grupę.

Zapis JSON
{
  "email": string
}
Pola
email

string

Adres e-mail grupy.

Rodzinna

Opisuje pojedynczą rodzinę 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 być jednym z tych typów wartości. Content może mieć tylko jedną z tych wartości:
text

object (TextContent)

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

list

object (ListContent)

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

Treść

Blok tekstu w pojedynczej sekcji tekstu lub elemencie listy.

Zapis JSON
{
  "text": string
}
Pola
text

string

Tekst notatki. Limity różnią się w zależności od konkretnego pola wykorzystującego ten typ.

Wyświetlanie treści

Lista elementów jednej notatki.

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

object (ListItem)

Elementy 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 skonfigurowana, pojawi się lista elementów listy zagnieżdżonych w tym elemencie listy. Dozwolony jest tylko jeden poziom zagnieżdżania.

text

object (TextContent)

Tekst tego elementu. Długość nie może przekraczać 1000 znaków.

checked

boolean

Określa, czy ten element został odznaczony.

Metody

create

Tworzy nową notatkę.

delete

Usuwa notatkę.

get

Pobiera notatkę.

list

Wyświetla listę notatek.