Method: spaces.setup

스페이스를 만들고 지정된 사용자를 추가합니다. 호출하는 사용자는 스페이스에 자동으로 추가되며, 요청에서 멤버십으로 지정되면 안 됩니다. 예시는 초기 참여자로 스페이스 설정을 참고하세요.

추가할 실제 구성원을 지정하려면 적절한 membership.member.name를 사용하여 멤버십을 추가합니다. 실제 사용자를 추가하려면 users/{user}를 사용합니다. 여기서 {user}은 사용자의 이메일 주소일 수 있습니다. 동일한 Workspace 조직에 있는 사용자의 경우 {user}은 People API에서 사용자를 위한 id이거나 Directory API에서 사용자의 id가 될 수도 있습니다. 예를 들어 user@example.com의 People API Person 프로필 ID가 123456789이면 membership.member.name를 users/user@example.com 또는 users/123456789로 설정하여 스페이스에 사용자를 추가할 수 있습니다.

추가할 Google 그룹을 지정하려면 적절한 membership.group_member.name를 사용하여 멤버십을 추가합니다. Google 그룹을 추가하거나 초대하려면 groups/{group}을 사용합니다. 여기서 {group}는 Cloud ID Groups API에서 그룹에 대한 id입니다. 예를 들어 Cloud ID 그룹스 lookup API를 사용하여 그룹 이메일 group@example.com의 ID 123456789을 검색한 다음 membership.group_member.name를 groups/123456789로 설정하여 스페이스에 그룹을 추가할 수 있습니다. 그룹 이메일은 지원되지 않으며 Google 그룹은 이름이 지정된 스페이스의 멤버로만 추가할 수 있습니다.

이름이 지정된 스페이스 또는 그룹 채팅의 경우 발신자가 차단 또는 차단되거나, 일부 멤버를 추가할 권한이 없는 경우 해당 멤버는 생성된 스페이스에 추가되지 않습니다.

전화를 거는 사용자와 다른 실제 사용자 간에 채팅 메시지 (DM)를 만들려면 실제 사용자를 나타내는 멤버십을 하나만 지정하세요. 한 사용자가 다른 사용자를 차단하면 요청이 실패하고 DM이 생성되지 않습니다.

통화 사용자와 통화 앱 간에 DM을 만들려면 Space.singleUserBotDm를 true로 설정하고 멤버십을 지정하지 않습니다. 이 메서드는 통화 앱에서 채팅 메시지를 설정하는 데만 사용할 수 있습니다. 통화 앱을 스페이스의 멤버로 추가하거나 두 사용자 간의 기존 채팅 메시지로 추가하려면 스페이스에 사용자 또는 앱 초대 또는 추가하기를 참고하세요.

두 사용자 사이에 이미 채팅 메시지가 있는 경우, 요청 시 한 사용자가 다른 사용자를 차단하더라도 기존 채팅 메시지가 반환됩니다.

대화목록 답장이 있는 스페이스는 지원되지 않습니다. 스페이스를 설정할 때 ALREADY_EXISTS 오류 메시지가 표시되면 다른 displayName을 사용해 보세요. Google Workspace 조직 내의 기존 스페이스에서 이미 이 표시 이름을 사용 중일 수 있습니다.

사용자 인증이 필요합니다.

HTTP 요청

POST https://chat.googleapis.com/v1/spaces:setup

URL은 gRPC 트랜스코딩 구문을 사용합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
입력란
space

object (Space)

필수 항목입니다. Space.spaceType 필드는 필수 입력란입니다.

스페이스를 만들려면 Space.spaceType를 SPACE로 설정하고 Space.displayName를 설정합니다. 스페이스를 설정할 때 ALREADY_EXISTS 오류 메시지가 표시되면 다른 displayName을 사용해 보세요. Google Workspace 조직 내의 기존 스페이스에서 이미 이 표시 이름을 사용 중일 수 있습니다.

그룹 채팅을 만들려면 Space.spaceType를 GROUP_CHAT로 설정하세요. Space.displayName를 설정하면 안 됩니다.

사람 간에 1:1 대화를 만들려면 Space.spaceType를 DIRECT_MESSAGE로, Space.singleUserBotDm를 false로 설정하세요. Space.displayName 또는 Space.spaceDetails를 설정하지 마세요.

사람과 통화하는 채팅 앱 간에 1:1 대화를 만들려면 Space.spaceType을 DIRECT_MESSAGE로, Space.singleUserBotDm를 true로 설정합니다. Space.displayName 또는 Space.spaceDetails를 설정하지 마세요.

DIRECT_MESSAGE 스페이스가 이미 있는 경우 새 스페이스를 만드는 대신 해당 공백이 반환됩니다.
requestId

string

선택사항입니다. 이 요청의 고유 식별자입니다. 임의의 UUID를 사용하는 것이 좋습니다. 기존 요청 ID를 지정하면 새 스페이스를 만드는 대신 해당 ID로 생성된 스페이스가 반환됩니다. 동일한 채팅 앱에서 인증된 다른 사용자가 있는 기존 요청 ID를 지정하면 오류가 반환됩니다.
memberships[]

object (Membership)

선택사항입니다. 스페이스에 참여하도록 초대할 Google Chat 사용자 또는 그룹입니다. 호출하는 사용자는 자동으로 추가되므로 생략합니다.

현재는 발신자 외에 최대 20개의 멤버십을 허용합니다.

수동 멤버십의 경우 Membership.member 필드에 name가 채워지고 (형식: users/{user}) type가 User.Type.HUMAN로 설정된 user가 포함되어야 합니다. 스페이스를 설정할 때만 실제 사용자를 추가할 수 있습니다. 채팅 앱 추가는 통화 앱과의 채팅 메시지 설정에서만 지원됩니다. 사용자의 이메일을 {user}의 별칭으로 사용하여 구성원을 추가할 수도 있습니다. 예를 들어 user.name는 users/example@gmail.com일 수 있습니다. Gmail 사용자 또는 외부 Google Workspace 도메인의 사용자를 초대하려면 {user}에 사용자의 이메일을 사용해야 합니다.

Google 그룹 멤버십의 경우 Membership.group_member 필드에 name가 채워진 group (groups/{group} 형식)이 포함되어야 합니다. Space.spaceType를 SPACE로 설정할 때만 Google 그룹을 추가할 수 있습니다.

Space.spaceType를 SPACE로 설정하는 경우 선택사항입니다.

2개 이상의 멤버십과 함께 Space.spaceType를 GROUP_CHAT로 설정할 때 필요합니다.

정확히 하나의 멤버십과 함께 실제 사용자로 Space.spaceType를 DIRECT_MESSAGE로 설정할 때 필요합니다.

사람과 통화 채팅 앱 간에 1:1 대화를 만드는 경우 (Space.spaceType를 DIRECT_MESSAGE로, Space.singleUserBotDm를 true로 설정하는 경우) 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문에 Space의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

자세한 내용은 승인 가이드를 참조하세요.