Google Chat 이벤트 구독하기

이 페이지에서는 Google Workspace Events API를 사용하여 Google Chat 앱이 구독할 수 있는 Google Chat 이벤트를 설명합니다. 필요한 이벤트 유형을 결정한 후 구독을 만들어 Google Chat에서 이벤트를 수신합니다.

이벤트를 구독하는 것 외에도 Chat API를 호출하여 이벤트를 쿼리할 수 있습니다. Chat API를 호출하면 주기적으로 이벤트를 가져오거나 서비스 중단으로 인해 구독에서 누락되었을 수 있는 이벤트를 따라잡을 수 있습니다. Chat 이벤트를 수신하고 이에 응답하는 방법을 알아보려면 Chat 문서의 Google Chat의 이벤트 사용을 참고하세요.

지원되는 Chat 이벤트

Google Workspace 구독을 사용하면 Chat에서 다음과 같은 유형의 변경사항에 관한 이벤트를 수신할 수 있습니다.

  • 스페이스의 신규, 업데이트 또는 삭제된 메시지입니다.
  • 메시지에 대한 반응이 새로 추가되거나 삭제되었습니다.
  • 스페이스의 신규, 업데이트된 또는 삭제된 구성원입니다.
  • 업데이트된 스페이스 이름 또는 설명과 같이 내가 구독한 스페이스의 변경사항

이벤트를 모니터링할 수 있는 리소스

이벤트를 수신하려면 모니터링할 Chat 리소스를 지정해야 합니다. 이를 구독의 타겟 리소스라고 합니다.

Google Workspace Events API는 Chat에 대해 다음 타겟 리소스를 지원합니다.

타겟 리소스 방식 제한사항
공백

//chat.googleapis.com/spaces/SPACE

여기서 SPACE은 Chat API space 리소스의 리소스 이름에 있는 ID입니다. 스페이스의 URL에서 또는 spaces.list() 메서드를 사용하여 ID를 가져올 수 있습니다.

 구독을 승인하는 Chat 사용자 또는 Chat 앱은 Google Workspace 또는 Google 계정을 통해 스페이스의 구성원이어야 합니다. 지원:
사용자의 모든 스페이스

//chat.googleapis.com/spaces/-

 구독은 사용자가 Google Workspace 또는 Google 계정을 통해 회원인 스페이스의 이벤트만 수신합니다. 사용자 인증만 지원합니다.
사용자

//cloudidentity.googleapis.com/users/USER

여기서 USER은 Chat API user 리소스의 리소스 이름에 있는 ID입니다. 자세한 내용은 Google Chat 사용자 식별 및 지정하기를 참고하세요.

구독은 구독을 승인한 사용자에 관한 이벤트만 수신합니다. 사용자는 다른 사용자를 대신하여 구독을 승인할 수 없습니다. 사용자 인증만 지원합니다.

구독 생성 이벤트 유형

정기 결제를 만들 때 eventTypes[] 필드를 사용하여 수신할 이벤트 유형을 지정합니다. 이벤트 유형은 CloudEvents 사양(예: google.workspace.APPLICATION.RESOURCE.VERSION.ACTION)에 따라 형식이 지정됩니다.

예를 들어 사용자가 Chat 스페이스에 참여하는 것에 관한 이벤트를 수신하려면 스페이스를 타겟 리소스로 지정하고 이벤트 유형을 google.workspace.chat.membership.v1.created로 지정합니다. 특정 사용자가 스페이스에 참여하는 것에 관한 이벤트를 수신하려면 사용자를 타겟 리소스로 지정하고 이벤트 유형을 google.workspace.chat.membership.v1.created로 지정합니다. 이벤트 작동 방식에 대해 자세히 알아보려면 Google Workspace 이벤트 구조를 참고하세요.

다음 표에는 스페이스 구독 및 사용자 구독에 지원되는 이벤트 유형이 표시되어 있습니다. 이벤트를 트리거하는 항목에 관한 예외에 대해 알아보려면 제한사항을 참고하세요.

이벤트 유형 방식 리소스 데이터
스페이스 구독  
메시지가 게시됩니다.

google.workspace.chat.message.v1.created

space.message
메일이 업데이트됩니다.

google.workspace.chat.message.v1.updated

space.message
메시지가 삭제됩니다.

google.workspace.chat.message.v1.deleted

space.message
리액션이 생성됩니다.

google.workspace.chat.reaction.v1.created

space.message.reaction
반응이 삭제됩니다.

google.workspace.chat.reaction.v1.deleted

space.message.reaction
멤버가 스페이스에 추가됩니다.

google.workspace.chat.membership.v1.created

space.membership
스페이스에서 회원이 업데이트됩니다.

google.workspace.chat.membership.v1.updated

space.membership
구성원이 스페이스에서 삭제됩니다.

google.workspace.chat.membership.v1.deleted

space.membership
스페이스가 업데이트됩니다.

google.workspace.chat.space.v1.updated

space
스페이스가 삭제됩니다.

google.workspace.chat.space.v1.deleted

space
사용자 구독  
사용자가 스페이스의 구성원이 됩니다.

모든 신규 회원이 이벤트를 트리거하는 것은 아닙니다. 자세한 내용은 제한사항을 참고하세요.

google.workspace.chat.membership.v1.created

space.membership
스페이스에 대한 사용자의 멤버십이 업데이트됩니다.

google.workspace.chat.membership.v1.updated

space.membership
사용자가 스페이스의 직접 구성원으로 삭제됩니다.

google.workspace.chat.membership.v1.deleted

space.membership

일괄 이벤트 유형 (출력 전용)

구독한 이벤트 유형 외에도 Chat 앱에서 일괄 이벤트를 수신할 수도 있습니다. 일괄 이벤트는 짧은 기간에 발생하는 동일한 유형의 여러 이벤트를 나타내는 이벤트입니다. 일괄 이벤트의 페이로드에는 변경된 모든 리소스의 목록이 포함됩니다.

예를 들어 사용자가 스페이스에 20명의 사용자를 동시에 추가하면 채팅 앱이 일괄 이벤트(google.workspace.chat.membership.v1.batchCreated)를 수신할 수 있습니다. 이벤트 페이로드에는 사용자가 스페이스에 구성원을 추가할 때 생성된 모든 새 Membership 리소스 목록이 포함됩니다.

구독하는 모든 이벤트 유형에 대해 일괄 이벤트가 수신되므로 구독을 만들 때 일괄 이벤트를 지정할 필요가 없습니다. 예를 들어 새 반응(google.workspace.chat.reaction.v1.created)을 구독하면 Chat 앱이 일괄 반응 이벤트 (google.workspace.chat.reaction.v1.batchCreated)를 수신하도록 자동으로 구성됩니다.

다음 표에는 정기 결제의 가능한 일괄 이벤트가 표시되어 있습니다.

일괄 이벤트 유형 방식
여러 메시지가 게시됩니다.

google.workspace.chat.message.v1.batchCreated
여러 메시지가 업데이트됩니다.

google.workspace.chat.message.v1.batchUpdated
여러 메시지가 삭제됩니다.

google.workspace.chat.message.v1.batchDeleted
여러 리액션이 생성됩니다.

google.workspace.chat.reaction.v1.batchCreated
여러 반응이 삭제됩니다.

google.workspace.chat.reaction.v1.batchDeleted
구독한 스페이스에 여러 구성원이 추가되거나 구독한 사용자가 여러 스페이스에 추가되었습니다.

google.workspace.chat.membership.v1.batchCreated
구독한 스페이스 또는 구독한 사용자의 멤버십이 여러 개 업데이트됩니다.

google.workspace.chat.membership.v1.batchUpdated
정기 결제 스페이스에서 여러 회원이 삭제되거나 정기 결제 사용자가 여러 스페이스에서 삭제되었습니다.

google.workspace.chat.membership.v1.batchDeleted
스페이스에 업데이트가 여러 개 있습니다.

google.workspace.chat.space.v1.batchUpdated

이벤트 데이터

이 섹션에서는 Chat의 이벤트에 관한 이벤트 데이터와 페이로드 예를 설명합니다.

Google Workspace 구독이 Chat에서 이벤트를 수신하면 data 필드에 이벤트 페이로드가 포함됩니다. 이 페이로드에는 변경된 Google Workspace 리소스에 관한 정보가 있습니다. 예를 들어 스페이스에서 회원 이벤트에 가입한 경우 이러한 이벤트의 페이로드에는 변경된 spaces.membership 리소스에 관한 정보가 포함됩니다.

이벤트 페이로드의 리소스 데이터

구독을 만들 때 페이로드에 리소스에 관한 세부정보를 포함할지 아니면 리소스 이름만 포함할지 지정할 수 있습니다. 예를 들어 Chat 스페이스의 회원에 관한 이벤트를 수신하려면 이벤트 페이로드에서 수신할 멤버십 리소스의 필드를 지정하면 됩니다.

다음 표는 Chat 스페이스 spaces/AAAABBBBBB 구독의 JSON 페이로드 예를 보여줍니다. 구독이 수신하는 각 이벤트의 경우 페이로드가 이벤트의 data 필드에 표시됩니다.

예 이벤트 유형 JSON 페이로드

사용자가 스페이스에 'Hello world'라는 메시지를 게시합니다.

google.workspace.chat.message.v1.created

리소스 데이터가 포함됩니다.

{
    "message":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID",
        "sender":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "createTime": "2023-09-07T21:37:36.260127Z",
        "text": "Hello world",
        "thread":
        {
            "name": "spaces/SPACE_ID/threads/THREAD_ID"
        },
        "space":
        {
            "name": "spaces/SPACE_ID"
        },
        "argumentText": "Hello world"
    }
}

리소스 데이터를 제외합니다.

{
    "message":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID"
    }
}
사용자가 스페이스 관리자가 됩니다.

google.workspace.chat.membership.v1.updated

리소스 데이터가 포함됩니다.

{
    "membership":
    {
        "name": "spaces/SPACE_ID/members/MEMBER_ID",
        "state": "JOINED",
        "member":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "createTime": "1970-01-01T00:00:00Z",
        "role": "ROLE_MANAGER"
    }
}

리소스 데이터를 제외합니다.

{
    "membership":
    {
        "name": "spaces/SPACE_ID/members/MEMBER_ID"
    }
}
사용자가 스페이스 설명을 'Cymbal Labs 영업팀'으로 업데이트합니다. google.workspace.chat.space.v1.updated

리소스 데이터가 포함됩니다.

{
    "space":
    {
        "name": "spaces/SPACE_ID",
        "displayName": "Cymbal Sales",
        "spaceThreadingState": "THREADED_MESSAGES",
        "spaceType": "SPACE",
        "spaceDetails":
        {
            "description": "Sales team for Cymbal Labs."
        },
        "spaceHistoryState": "HISTORY_ON"
    }
}

리소스 데이터를 제외합니다.

{
    "space":
    {
        "name": "spaces/SPACE_ID"
    }
}
두 명의 Chat 사용자가 동시에 스페이스에 추가되었습니다. google.workspace.chat.membership.v1.batchCreated

리소스 데이터가 포함됩니다.

{
    "memberships": [
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID",
            "state": "JOINED",
            "member":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        },
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID",
            "state": "JOINED",
            "member":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        }
    ]
}

리소스 데이터를 제외합니다.

{
    "memberships": [
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID"
          }
        },
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID"
          }
        }
    ]
}
사용자가 😊 이모티콘으로 메시지에 반응합니다. google.workspace.chat.reaction.v1.created

리소스 데이터가 포함됩니다.

{
    "reaction":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
        "user":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "emoji":
        {
            "unicode": "😊"
        }
    }
}

리소스 데이터를 제외합니다.

{
    "reaction":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID"
    }
}
사용자가 😊 이모티콘과 😸 이모티콘으로 메시지에 반응합니다. google.workspace.chat.reaction.v1.batchCreated

리소스 데이터가 포함됩니다.

{
    "reactions": [
        {
          "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
            "user":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😊"
            }
          }
        },
        {
          "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
            "user":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😸"
            }
          }
        }
    ]
}

리소스 데이터를 제외합니다.

{
    "reactions": [
      {
        "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID"
        },
        "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
        }
      }
    ]
}

제한사항
  • 사용자 구독의 경우, 다이렉트 메시지 또는 이름이 지정되지 않은 그룹 채팅 (google.workspace.chat.membership.v1.created)의 새 회원에 관한 이벤트는 첫 번째 메시지가 게시된 후에만 트리거됩니다.
  • 멤버십 이벤트를 수신하려면 사용자 또는 Chat 앱이 스페이스의 직접 구성원이어야 합니다. Google 그룹을 통해 스페이스에 간접적으로 추가, 업데이트 또는 삭제된 경우 구독에서 이러한 멤버십 이벤트를 수신하지 않습니다. Google 그룹 멤버십의 작동 방식을 알아보려면 스페이스에 Google 그룹 추가하기를 참고하세요.