REST Resource: notes

Referensi: Catatan

Satu catatan.

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

string

Hanya output. Nama resource catatan ini. Lihat catatan umum tentang ID di KeepService.
createTime

string (Timestamp format)

Hanya output. Saat catatan ini dibuat.
updateTime

string (Timestamp format)

Hanya output. Waktu catatan ini terakhir diubah.
trashTime

string (Timestamp format)

Hanya output. Saat catatan ini dibuang. Jika trashed, catatan pada akhirnya akan dihapus. Jika catatan tidak dibuang, kolom ini tidak disetel (dan kolom yang dibuang adalah false).
trashed

boolean

Hanya output. true jika catatan ini telah dibuang. Jika dihapus, catatan pada akhirnya akan dihapus.
attachments[]

object (Attachment)

Hanya output. Lampiran yang dilampirkan ke catatan ini.
permissions[]

object (Permission)

Hanya output. Daftar izin yang ditetapkan di catatan. Berisi setidaknya satu entri untuk pemilik catatan.
title

string

Judul catatan. Panjang harus kurang dari 1.000 karakter.
body

object (Section)

Isi catatan.

Lampiran

Lampiran ke catatan.

Representasi JSON 
{
  "name": string,
  "mimeType": [
    string
  ]
}
Kolom
name

string

Nama resource;
mimeType[]

string

Jenis MIME (jenis media IANA) yang menyediakan lampiran.

Izin

Satu izin pada catatan. Mengaitkan member dengan role.

Representasi 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.
}
Kolom
name

string

Hanya output. Nama resource.
role

enum (Role)

Peran yang diberikan oleh izin ini. Peran tersebut menentukan kemampuan entitas untuk membaca, menulis, dan membagikan catatan.
email

string

Email yang terkait dengan anggota. Jika ditetapkan saat membuat, kolom email di pesan User atau Group harus kosong atau cocok dengan kolom ini. Aktif, dapat tidak disetel jika anggota tidak memiliki email terkait.
deleted

boolean

Hanya output. Apakah anggota ini sudah dihapus. Jika anggota dipulihkan, nilai ini akan ditetapkan ke salah (false) dan anggota yang dipulihkan akan mempertahankan peran di catatan.
Kolom union member. Menentukan identitas yang diberikan peran. Anggota tidak ditetapkan jika anggota telah dihapus. member hanya dapat berupa salah satu dari berikut:
user

object (User)

Hanya output. Pengguna yang dikenai peran ini.
group

object (Group)

Hanya output. Grup tempat peran ini berlaku.
family

object (Family)

Hanya output. Keluarga Google tempat peran ini berlaku.

Peran

Menentukan berbagai peran yang dapat dimiliki oleh suatu entity.

Enum
ROLE_UNSPECIFIED Peran yang tidak ditentukan.
OWNER Peran yang memberikan akses penuh. Peran ini tidak dapat ditambahkan atau dihapus. Ditentukan oleh pembuat catatan.
WRITER Peran yang memberikan kemampuan untuk berkontribusi pada konten dan mengubah izin catatan.

Pengguna

Menggambarkan satu pengguna.

Representasi JSON 
{
  "email": string
}
Kolom
email

string

Email pengguna.

Grup

Mendeskripsikan satu Grup.

Representasi JSON 
{
  "email": string
}
Kolom
email

string

Email grup.

Keluarga

Jenis ini tidak memiliki kolom.

Mendeskripsikan satu Grup Keluarga Google.

Bagian

Konten catatan.

Representasi 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.
}
Kolom
Kolom union Content. Konten bagian harus berupa salah satu jenis nilai berikut. Content hanya dapat berupa salah satu dari berikut:
text

object (TextContent)

Digunakan jika konten bagian ini adalah blok teks. Panjang konten teks harus kurang dari 20.000 karakter.
list

object (ListContent)

Digunakan jika konten bagian ini berupa daftar.

TextContent

Blok teks untuk satu bagian teks atau item daftar.

Representasi JSON 
{
  "text": string
}
Kolom
text

string

Teks catatan. Batas ini bervariasi menurut kolom spesifik yang menggunakan jenis ini.

ListContent

Daftar item untuk catatan daftar tunggal.

Representasi JSON 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Kolom
listItems[]

object (ListItem)

Item dalam daftar. Jumlah item harus kurang dari 1.000.

ListItem

Satu item daftar dalam daftar catatan.

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

object (ListItem)

Jika ditetapkan, daftar item daftar bertingkat dalam item daftar ini. Hanya satu tingkat pengumpulan yang diizinkan.
text

object (TextContent)

Teks item ini. Panjang harus kurang dari 1.000 karakter.
checked

boolean

Apakah item ini telah dicentang atau belum.

Metode

create

 Membuat catatan baru.

delete

 Menghapus catatan.

get

 Mendapatkan catatan.

list

 Mencantumkan catatan.