REST Resource: spaces

리소스: 스페이스

Google Chat의 스페이스 스페이스는 두 명 이상의 사용자 간의 대화 또는 사용자와 Chat 앱 간의 일대일 메시지입니다.

JSON 표현 
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,
  "customer": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
필드
name

string

식별자. 공간의 리소스 이름입니다.

형식: spaces/{space}

여기서 {space}는 스페이스의 시스템 할당 ID를 나타냅니다. spaces.list() 메서드를 호출하거나 스페이스 URL에서 스페이스 ID를 가져올 수 있습니다. 예를 들어 스페이스 URL이 https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA이면 스페이스 ID는 AAAAAAAAA입니다.
type
(deprecated)

enum (Type)

출력 전용입니다. 지원 중단됨: 대신 spaceType를 사용하세요. 스페이스 유형입니다.
spaceType

enum (SpaceType)

선택사항입니다. 스페이스 유형입니다. 스페이스를 만들거나 스페이스의 스페이스 유형을 업데이트할 때 필요합니다. 다른 용도에 대해서만 출력합니다.
singleUserBotDm

boolean

선택사항입니다. 스페이스가 Chat 앱과 한 명의 사용자 간의 DM인지 여부입니다.
threaded
(deprecated)

boolean

출력 전용입니다. 지원 중단됨: 대신 spaceThreadingState를 사용하세요. 이 스페이스에서 메시지가 대화목록 형식으로 표시되는지 여부입니다.
displayName

string

선택사항입니다. 스페이스의 표시 이름입니다. spaceType이 SPACE인 스페이스를 만들 때 필요합니다. 스페이스를 만들거나 displayName를 업데이트할 때 ALREADY_EXISTS 오류 메시지가 표시되면 다른 displayName를 사용해 보세요. Google Workspace 조직 내의 기존 스페이스에서 이미 이 표시 이름을 사용하고 있을 수 있습니다.

채팅 메시지의 경우 이 필드가 비어 있을 수 있습니다.

최대 128자(영문 기준)를 지원합니다.
externalUserAllowed

boolean

선택사항입니다. 변경할 수 없습니다. 이 스페이스에서 Google Chat 사용자를 회원으로 허용하는지 여부입니다. Google Workspace 조직에서 스페이스를 만들 때 입력합니다. 다음과 같은 조건에서 스페이스를 만들 때 이 필드를 생략합니다.

  • 인증된 사용자가 일반 계정 (비관리 사용자 계정)을 사용합니다. 기본적으로 일반 사용자 계정으로 만든 스페이스는 모든 Google Chat 사용자를 허용합니다.

기존 스페이스의 경우 이 필드는 출력 전용입니다.
spaceThreadingState

enum (SpaceThreadingState)

출력 전용입니다. Chat 스페이스의 대화목록 상태입니다.
spaceDetails

object (SpaceDetails)

선택사항입니다. 설명 및 규칙을 포함한 스페이스에 관한 세부정보입니다.
spaceHistoryState

enum (HistoryState)

선택사항입니다. 이 스페이스의 메시지 및 대화목록에 대한 메시지 기록 상태입니다.
importMode

boolean

선택사항입니다. 이 스페이스가 Google Workspace로의 데이터 이전의 일환으로 Import Mode에서 생성되었는지 여부입니다. 스페이스를 가져오는 동안 가져오기가 완료될 때까지 사용자에게 표시되지 않습니다.

Import Mode에서 스페이스를 만들려면 사용자 인증이 필요합니다.
createTime

string (Timestamp format)

선택사항입니다. 변경할 수 없습니다. Chat에서 만든 스페이스의 경우 스페이스가 생성된 시간입니다. 이 필드는 가져오기 모드 스페이스에서 사용되는 경우를 제외하고 출력 전용입니다.

가져오기 모드 스페이스의 경우 원래 생성 시간을 보존하려면 이 필드를 소스에서 스페이스가 생성된 이전 타임스탬프로 설정하세요.

spaceType가 GROUP_CHAT 또는 SPACE인 경우에만 출력에 채워집니다.
lastActiveTime

string (Timestamp format)

출력 전용입니다. 스페이스의 마지막 메시지의 타임스탬프입니다.
adminInstalled

boolean

출력 전용입니다. Chat 앱이 있는 채팅 메시지 (DM) 스페이스의 경우 Google Workspace 관리자가 스페이스를 만들었는지 여부입니다. 관리자는 조직의 사용자를 대신하여 Chat 앱을 설치하고 채팅 메시지를 설정할 수 있습니다.

관리자 설치를 지원하려면 Chat 앱에 채팅 메시지 기능이 있어야 합니다.
membershipCount

object (MembershipCount)

출력 전용입니다. 회원 유형별로 그룹화된 가입 멤버십 수입니다. spaceType가 SPACE, DIRECT_MESSAGE 또는 GROUP_CHAT인 경우 채워집니다.
accessSettings

object (AccessSettings)

선택사항입니다. 스페이스의 액세스 설정을 지정합니다. spaceType가 SPACE일 때만 채워집니다.
spaceUri

string

출력 전용입니다. 사용자가 스페이스에 액세스할 수 있는 URI입니다.
customer

string

선택사항입니다. 변경할 수 없습니다. 스페이스 도메인의 고객 ID입니다. 앱 인증으로 스페이스를 만들고 SpaceType이 SPACE인 경우에만 필요하며, 그 외의 경우에는 설정하면 안 됩니다.

customers/{customer} 형식이며 여기서 customer는 [관리 SDK 고객 리소스]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers)의 id입니다. 비공개 앱은 customers/my_customer 별칭을 사용하여 앱과 동일한 Google Workspace 조직에 스페이스를 만들 수도 있습니다.

DM의 경우 이 필드가 채워지지 않습니다.

통합 필드 space_permission_settings. 스페이스의 권한 설정을 나타냅니다. space_type가 SPACE일 때만 채워집니다.

사용자 인증이 필요합니다. space_permission_settings은 다음 중 하나여야 합니다.
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

선택사항입니다. 입력 전용입니다. 사전 정의된 스페이스 권한 설정으로, 스페이스를 만들 때만 입력합니다. 이 필드가 설정되지 않으면 공동작업 공간이 생성됩니다. 스페이스를 만든 후 설정이 PermissionSettings 필드에 채워집니다.
permissionSettings

object (PermissionSettings)

선택사항입니다. 기존 스페이스의 스페이스 권한 설정 기존 권한 설정이 대체되는 정확한 스페이스 권한 설정을 업데이트하기 위한 입력입니다. 출력에 현재 권한 설정이 나열됩니다.

유형

지원 중단됨: 대신 SpaceType를 사용하세요.

열거형
TYPE_UNSPECIFIED 예약됨
ROOM 두 명 이상의 인간 간의 대화
DM 모든 메시지가 평면인 사람과 Chat 앱 간의 1:1 채팅 메시지입니다. 사람 간의 채팅 메시지는 여기에 포함되지 않습니다.

SpaceType

스페이스 유형입니다. 스페이스를 만들거나 업데이트할 때 필요합니다. 다른 용도에 대해서만 출력합니다.

열거형
SPACE_TYPE_UNSPECIFIED 예약됨
SPACE 사용자가 메시지를 보내고, 파일을 공유하고, 공동작업을 할 수 있는 공간입니다. SPACE에는 Chat 앱이 포함될 수 있습니다.
GROUP_CHAT 3명 이상의 사용자 간의 그룹 대화 GROUP_CHAT에는 Chat 앱이 포함될 수 있습니다.
DIRECT_MESSAGE 두 사람 또는 사람과 Chat 앱 간의 1:1 메시지

SpaceThreadingState

Chat 스페이스의 대화목록 상태 유형을 지정합니다.

열거형
SPACE_THREADING_STATE_UNSPECIFIED 예약됨
THREADED_MESSAGES 메시지 대화를 지원하는 이름이 지정된 스페이스 사용자가 메시지에 응답할 때 대화목록에서 답장하면 원본 메시지의 맥락에서 응답을 유지할 수 있습니다.
GROUPED_MESSAGES 대화가 주제별로 정리된 스페이스의 이름입니다. 주제와 답글이 그룹화됩니다.
UNTHREADED_MESSAGES 두 사람 간의 채팅 메시지 (DM) 및 3명 이상의 사용자 간의 그룹 대화

SpaceDetails

설명 및 규칙을 포함한 스페이스에 관한 세부정보입니다.

JSON 표현 
{
  "description": string,
  "guidelines": string
}
필드
description

string

선택사항입니다. 스페이스에 대한 설명입니다. 예를 들어 스페이스의 토론 주제, 기능적 목적 또는 참여자를 설명합니다.

최대 150자(영문 기준)를 지원합니다.
guidelines

string

선택사항입니다. 스페이스의 규칙, 기대사항, 에티켓

최대 5,000자(영문 기준)까지 지원합니다.

HistoryState

메시지 및 스페이스의 기록 상태입니다. 메시지 및 대화목록이 생성된 후 보관되는 기간을 지정합니다.

열거형
HISTORY_STATE_UNSPECIFIED 기본값 사용하지 마세요.
HISTORY_OFF 기록이 사용 중지되어 있습니다. 메시지 및 대화목록은 24시간 동안 보관됩니다.
HISTORY_ON 대화 기록이 사용 설정됨 조직의 Vault 보관 규칙에 따라 메일 및 대화목록이 보관되는 기간이 지정됩니다.

MembershipCount

스페이스의 멤버십 수를 카테고리별로 그룹화하여 나타냅니다.

JSON 표현 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
필드
joinedDirectHumanUserCount

integer

출력 전용입니다. 스페이스에 직접 참여한 사람 수입니다. 참여 그룹의 멤버십을 통해 참여한 사용자는 포함되지 않습니다.
joinedGroupCount

integer

출력 전용입니다. 스페이스에 직접 참여한 모든 그룹의 수입니다.

AccessSettings

공간의 액세스 설정을 나타냅니다.

JSON 표현 
{
  "accessState": enum (AccessState),
  "audience": string
}
필드
accessState

enum (AccessState)

출력 전용입니다. 스페이스의 액세스 상태를 나타냅니다.
audience

string

선택사항입니다. 스페이스를 검색하고, 스페이스에 참여하며, 스페이스의 메시지를 미리 볼 수 있는 공유 대상 그룹의 리소스 이름입니다. 이 옵션을 사용 중지하면 스페이스에 개별적으로 초대되거나 추가된 사용자 또는 Google 그룹만 스페이스에 액세스할 수 있습니다. 자세한 내용은 공유 스페이스를 공유 대상 그룹에 표시하기를 참고하세요.

형식: audiences/{audience}

Google Workspace 조직의 기본 공유 대상 그룹을 사용하려면 audiences/default로 설정합니다.

공유 대상 그룹을 읽으면 다음 작업을 할 수 있습니다.

앱 인증과 함께 chat.bot 범위를 사용하는 경우 이 필드에는 값이 채워지지 않습니다.

공유 대상 그룹을 설정하려면 사용자 인증이 필요합니다.

AccessState

스페이스의 액세스 상태를 나타냅니다.

열거형
ACCESS_STATE_UNSPECIFIED 액세스 상태를 알 수 없거나 이 API에서 지원되지 않습니다.
PRIVATE 다른 사용자 또는 Google Workspace 관리자가 개별적으로 추가하거나 초대한 사용자 또는 Google 그룹스만 스페이스를 검색하고 액세스할 수 있습니다.
DISCOVERABLE

스페이스 관리자가 공유 대상 그룹에 스페이스 액세스 권한을 부여했습니다. 스페이스에 개별적으로 추가되거나 초대된 사용자 또는 Google 그룹도 스페이스를 검색하고 액세스할 수 있습니다. 자세한 내용은 특정 사용자에게 스페이스를 검색 가능하도록 설정하기를 참고하세요.

검색 가능한 스페이스를 만들려면 사용자 인증이 필요합니다.

PredefinedPermissionSettings

이름이 지정된 스페이스를 만들 때만 지정할 수 있는 사전 정의된 권한 설정입니다. 향후 더 많은 설정이 추가될 수 있습니다. 이름이 지정된 스페이스의 권한 설정에 관한 자세한 내용은 스페이스 알아보기를 참고하세요.

열거형
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED 지정되지 않았습니다. 사용하지 마세요.
COLLABORATION_SPACE 스페이스를 모든 구성원이 메시지를 게시할 수 있는 공동작업 스페이스로 설정하는 기능입니다.
ANNOUNCEMENT_SPACE 스페이스를 스페이스 관리자만 메시지를 게시할 수 있는 공지사항 스페이스로 설정합니다.

PermissionSettings

기존의 이름이 지정된 스페이스를 업데이트할 때 지정할 수 있는 권한 설정입니다.

스페이스를 만들 때 권한 설정을 지정하려면 요청에 PredefinedPermissionSettings 필드를 지정합니다.

JSON 표현 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
필드
manageMembersAndGroups

object (PermissionSetting)

선택사항입니다. 스페이스에서 구성원 및 그룹을 관리하기 위한 설정입니다.
modifySpaceDetails

object (PermissionSetting)

선택사항입니다. 스페이스 이름, 아바타, 설명, 가이드라인을 업데이트하기 위한 설정입니다.
toggleHistory

object (PermissionSetting)

선택사항입니다. 스페이스 기록을 사용 설정 또는 사용 중지하는 설정입니다.
useAtMentionAll

object (PermissionSetting)

선택사항입니다. 스페이스에서 @all을 사용할 수 있는 설정입니다.
manageApps

object (PermissionSetting)

선택사항입니다. 스페이스에서 앱을 관리하기 위한 설정입니다.
manageWebhooks

object (PermissionSetting)

선택사항입니다. 스페이스에서 웹훅을 관리하기 위한 설정입니다.
postMessages

object (PermissionSetting)

출력 전용입니다. 스페이스에 메시지를 게시하기 위한 설정입니다.
replyMessages

object (PermissionSetting)

선택사항입니다. 스페이스에서 메시지에 답장하기 위한 설정입니다.

PermissionSetting

스페이스 권한 설정을 나타냅니다.

JSON 표현 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
필드
managersAllowed

boolean

선택사항입니다. 스페이스 관리자에게 이 권한이 있는지 여부입니다.
membersAllowed

boolean

선택사항입니다. 관리자가 아닌 구성원에게 이 권한이 있는지 여부입니다.

메서드

completeImport

 지정된 스페이스의 가져오기 프로세스를 완료하고 사용자에게 표시합니다.

create

 회원이 없는 스페이스를 만듭니다.

delete

 이름이 지정된 스페이스를 삭제합니다.

findDirectMessage

 지정된 사용자와의 기존 채팅 메시지를 반환합니다.

get

 스페이스에 대한 세부정보를 반환합니다.

list

 호출자가 속한 스페이스를 나열합니다.

patch

 스페이스를 업데이트합니다.
관리자의 검색어를 기반으로 Google Workspace 조직의 스페이스 목록을 반환합니다.

setup

 스페이스를 만들고 지정된 사용자를 추가합니다.