REST Resource: notes

리소스: 메모

단일 메모

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

string

출력 전용입니다. 이 메모의 리소스 이름입니다. KeepService의 식별자에 관한 일반 메모를 참고하세요.
createTime

string (Timestamp format)

출력 전용입니다. 이 메모가 생성된 시간입니다.
updateTime

string (Timestamp format)

출력 전용입니다. 이 메모가 마지막으로 수정된 시점입니다.
trashTime

string (Timestamp format)

출력 전용입니다. 이 메모가 휴지통에 삭제된 시간입니다. trashed인 경우 메모가 삭제됩니다. 메모가 휴지통에 넣어지지 않으면 이 필드는 설정되지 않으며 휴지통 필드는 false입니다.
trashed

boolean

출력 전용입니다. true: 이 메모가 휴지통에 있는 경우 휴지통에 넣으면 메모가 삭제됩니다.
attachments[]

object (Attachment)

출력 전용입니다. 이 메모에 첨부된 첨부파일입니다.
permissions[]

object (Permission)

출력 전용입니다. 메모에 설정된 권한 목록입니다. 메모 소유자에 대한 항목이 하나 이상 포함되어 있습니다.
title

string

메모의 제목입니다. 길이는 1,000자(영문 기준) 미만이어야 합니다.
body

object (Section)

메모의 본문입니다.

첨부파일

메모의 첨부파일입니다.

JSON 표현 
{
  "name": string,
  "mimeType": [
    string
  ]
}
필드
name

string

리소스 이름
mimeType[]

string

첨부파일을 사용할 수 있는 MIME 유형 (IANA 미디어 유형)입니다.

권한

메모에 대한 단일 권한 member를 role과 연결합니다.

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.
}
필드
name

string

출력 전용입니다. 리소스 이름입니다.
role

enum (Role)

이 권한이 부여하는 역할입니다. 역할에 따라 항목이 메모를 읽고, 쓰고, 공유할 수 있는 기능이 결정됩니다.
email

string

회원과 연결된 이메일입니다. 생성 시 설정된 경우 User 또는 Group 메시지의 email 필드가 비어 있거나 이 필드와 일치해야 합니다. 읽을 때 회원에게 연결된 이메일이 없는 경우 설정 해제될 수 있습니다.
deleted

boolean

출력 전용입니다. 이 회원이 삭제되었는지 여부입니다. 구성원이 복구되면 이 값은 false로 설정되고 복구된 구성원은 메모에서 역할을 유지합니다.
통합 필드 member. 역할이 부여된 ID를 지정합니다. 구성원이 삭제된 경우 구성원이 설정되지 않습니다. member은 다음 중 하나여야 합니다.
user

object (User)

출력 전용입니다. 이 역할이 적용되는 사용자입니다.
group

object (Group)

출력 전용입니다. 이 역할이 적용되는 그룹입니다.
family

object (Family)

출력 전용입니다. 이 역할이 적용되는 Google 가족입니다.

역할

항목에 있을 수 있는 다양한 역할을 정의합니다.

열거형
ROLE_UNSPECIFIED 정의되지 않은 역할
OWNER 전체 액세스 권한을 부여하는 역할입니다. 이 역할은 추가하거나 삭제할 수 없습니다. 메모 작성자가 정의합니다.
WRITER 콘텐츠를 제공하고 메모 권한을 수정할 수 있는 권한을 부여하는 역할입니다.

사용자

단일 사용자를 설명합니다.

JSON 표현 
{
  "email": string
}
필드
email

string

사용자의 이메일입니다.

그룹

단일 그룹을 설명합니다.

JSON 표현 
{
  "email": string
}
필드
email

string

그룹 이메일입니다.

가족

이 유형에는 필드가 없습니다.

단일 Google 가족을 설명합니다.

섹션

메모의 콘텐츠입니다.

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.
}
필드
통합 필드 Content. 섹션의 콘텐츠는 이러한 값 유형 중 하나여야 합니다. Content은 다음 중 하나여야 합니다.
text

object (TextContent)

이 섹션의 콘텐츠가 텍스트 블록인 경우 사용됩니다. 텍스트 콘텐츠의 길이는 20,000자(영문 기준) 미만이어야 합니다.
list

object (ListContent)

이 섹션의 콘텐츠가 목록인 경우 사용됩니다.

TextContent

단일 텍스트 섹션 또는 목록 항목의 텍스트 블록입니다.

JSON 표현 
{
  "text": string
}
필드
text

string

메모의 텍스트입니다. 이 제한은 이 유형을 사용하는 특정 필드에 따라 다릅니다.

ListContent

단일 목록 메모의 항목 목록입니다.

JSON 표현 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
필드
listItems[]

object (ListItem)

목록의 항목입니다. 항목 수는 1,000개 미만이어야 합니다.

ListItem

메모 목록의 단일 목록 항목입니다.

JSON 표현 
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
필드
childListItems[]

object (ListItem)

설정된 경우 이 목록 항목 아래에 중첩된 목록 항목 목록입니다. 중첩 수준은 하나만 허용됩니다.
text

object (TextContent)

이 항목의 텍스트입니다. 길이는 1,000자(영문 기준) 미만이어야 합니다.
checked

boolean

이 항목이 선택되었는지 여부입니다.

메서드

create

 새 메모를 만듭니다.

delete

 메모를 삭제합니다.

get

 메모를 가져옵니다.

list

 메모를 나열합니다.