Method: spaces.setup

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

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

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

이름이 지정된 스페이스 또는 그룹 채팅의 경우 호출자가 일부 구성원을 차단하거나 일부 구성원에 의해 차단되거나 일부 구성원을 추가할 권한이 없는 경우 이러한 구성원은 생성된 스페이스에 추가되지 않습니다.

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

호출 사용자와 호출 앱 간에 DM을 만들려면 Space.singleUserBotDm을 true로 설정하고 멤버십을 지정하지 않습니다. 이 메서드는 호출 앱과의 DM을 설정하는 데만 사용할 수 있습니다. 호출 앱을 스페이스의 구성원 또는 두 상담사 사용자 간의 기존 DM으로 추가하려면 스페이스에 사용자 또는 앱 초대 또는 추가를 참고하세요.

두 사용자 간에 DM이 이미 있는 경우 요청이 이루어질 때 한 사용자가 다른 사용자를 차단하더라도 기존 DM이 반환됩니다.

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

다음 승인 범위 중 하나를 사용하여 사용자 인증이 필요합니다.

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

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를 설정하지 마세요.

상담사와 호출 Chat 앱 간에 1:1 대화를 만들려면 Space.spaceType을 DIRECT_MESSAGE로 설정하고 Space.singleUserBotDm을 true로 설정합니다. Space.displayName 또는 Space.spaceDetails를 설정하지 마세요.

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

string

선택사항입니다. 이 요청의 고유 ID입니다. 임의의 UUID를 사용하는 것이 좋습니다. 요청 ID를 지정하면 요청이 멱등해지므로 동일한 요청 ID가 있는 여러 동일한 요청으로 인해 스페이스가 하나만 생성됩니다. 요청된 세부정보가 현재 상태와 다르더라도 동일한 요청 ID가 있는 후속 요청은 기존 스페이스를 반환하고 스페이스를 업데이트하지 않습니다.

이 필드를 효과적으로 사용하려면 다음 안내를 따르세요.

  • 후속 요청이 동일하고 원래 요청과 동일한 인증 사용자 인증 정보를 사용하는지 확인합니다.
  • 제공된 요청 ID로 스페이스가 이미 생성된 경우 요청은 해당 스페이스를 반환합니다. 반환된 스페이스가 완전히 채워지지 않을 수 있습니다. API는 시스템 할당 리소스 이름이 채워진 요청의 스페이스를 에코합니다. 스페이스의 최신 메타데이터를 검색하려면 spaces.get을 호출합니다.
  • 인증된 사용자가 다른 기존 요청 ID를 재사용하면 오류가 발생합니다.
memberships[]

object (Membership)

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

현재 세트에서는 호출자 외에 최대 49개의 멤버십을 허용합니다.

상담사 멤버십의 경우 Membership.member 필드에 name이 채워진 user (형식: users/{user})와 type이 User.Type.HUMAN으로 설정된 user가 포함되어야 합니다. 스페이스를 설정할 때만 상담사 사용자를 추가할 수 있습니다 (Chat 앱 추가는 통화 앱과의 채팅 메시지 설정에만 지원됨). 사용자의 이메일을 {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로 설정할 때 정확히 하나의 멤버십과 함께 필수 항목입니다.

상담사와 호출 Chat 앱 간에 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

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