Google Workspace 구독 만들기

Apps Script

• 이 가이드의 Google Cloud CLI 명령어를 사용하려면 다음 안내를 따르세요.
  1. Google Cloud CLI 설치
  2. gcloud CLI를 초기화하려면 다음 코드를 실행합니다.

    gcloud init
    

• 구독의 대상 리소스:
  • Google Chat 스페이스를 구독하려는 경우(인증된 사용자가 참여 중인 Chat 스페이스). 사용자는 Google Workspace 또는 Google 계정을 통해 스페이스의 구성원이어야 합니다. Google 그룹을 통해 스페이스에 참여 중인 사용자는 지원되지 않습니다.
  • Google Meet 회의 공간을 구독하려면 인증된 사용자가 소유자인 회의 공간이어야 합니다. 스페이스를 만들려면 Google Meet 문서에서 회의 공간 사용하기를 참고하세요.
  • Google Meet 사용자를 구독하려면 Cloud ID API의 user ID
• 결제가 사용 설정된 Google Cloud 프로젝트 Chat을 구독하려면 Cloud 프로젝트에서 Chat API를 사용 설정하고 앱 이름, 아바타 URL, 설명 필드도 구성해야 합니다. 자세한 내용은 Google Chat 앱 빌드를 참고하세요.
• 앱에 구성된 OAuth 동의 화면을 사용한 사용자 인증이 필요합니다. 동의 화면을 구성할 때 정기 결제의 각 이벤트 유형을 지원하는 범위를 지정해야 합니다. 동의 화면을 구성하고 필요한 범위를 식별하려면 범위 선택을 참고하세요.

• Apps Script 프로젝트:
  • Apps Script에서 자동으로 생성된 기본 프로젝트 대신 Google Cloud 프로젝트를 사용하세요.
  • OAuth 동의 화면을 구성하기 위해 추가한 범위의 경우 Apps Script 프로젝트의 appsscript.json 파일에도 범위를 추가해야 합니다. 예를 들면 다음과 같습니다.

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages.readonly"
  ]
      

  • Google Workspace Events 고급 서비스를 사용 설정합니다.

Python

• Python 3.6 이상
• pip 패키지 관리 도구
• 최신 Python용 Google 클라이언트 라이브러리입니다. 설치하거나 업데이트하려면 명령줄 인터페이스에서 다음 명령어를 실행하세요.

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

• 이 가이드의 Google Cloud CLI 명령어를 사용하려면 다음 안내를 따르세요.
  1. Google Cloud CLI 설치
  2. gcloud CLI를 초기화하려면 다음 코드를 실행합니다.

    gcloud init
    

• 구독의 대상 리소스:
  • Google Chat 스페이스를 구독하려는 경우(인증된 사용자가 참여 중인 Chat 스페이스). 사용자는 Google Workspace 또는 Google 계정을 통해 스페이스의 구성원이어야 합니다. Google 그룹을 통해 스페이스에 참여 중인 사용자는 지원되지 않습니다.
  • Google Meet 회의 공간을 구독하려면 인증된 사용자가 소유자인 회의 공간이어야 합니다. 스페이스를 만들려면 Google Meet 문서에서 회의 공간 사용하기를 참고하세요.
  • Google Meet 사용자를 구독하려면 Cloud ID API의 user ID
• 결제가 사용 설정된 Google Cloud 프로젝트 Chat을 구독하려면 Cloud 프로젝트에서 Chat API를 사용 설정하고 앱 이름, 아바타 URL, 설명 필드도 구성해야 합니다. 자세한 내용은 Google Chat 앱 빌드를 참고하세요.
• 앱에 구성된 OAuth 동의 화면을 사용한 사용자 인증이 필요합니다. 동의 화면을 구성할 때 정기 결제의 각 이벤트 유형을 지원하는 범위를 지정해야 합니다. 동의 화면을 구성하고 필요한 범위를 식별하려면 범위 선택을 참고하세요.

Google Cloud 콘솔

Google Cloud 콘솔에서 앱의 Google Cloud 프로젝트를 열고 Google Workspace Events API 및 Pub/Sub API를 사용 설정합니다.

API 사용 설정

gcloud

1. 작업 디렉터리에서 Google 계정에 로그인합니다.

   gcloud auth login
   

2. 프로젝트를 앱의 Cloud 프로젝트로 설정합니다.

   gcloud config set project PROJECT_ID
   

   PROJECT_ID를 앱의 Cloud 프로젝트의 프로젝트 ID로 바꿉니다.

3. Google Workspace Events API 및 Google Cloud Pub/Sub API를 사용 설정합니다.

   gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com
   

Google Cloud 콘솔

1. Google Cloud 콘솔에서 Pub/Sub 페이지로 이동합니다.

   Google Cloud Pub/Sub로 이동

   앱의 Cloud 프로젝트가 선택되어 있는지 확인합니다.

2. add_box 주제 만들기를 클릭하고 다음을 수행합니다.

   1. 주제의 이름을 입력합니다(예: workspace-events-topic).
   2. 기본 구독 추가를 선택된 상태로 둡니다. Pub/Sub는 이 기본 구독의 이름을 주제 이름과 비슷하게 지정합니다(예: workspace-events-topic-sub).
   3. 선택사항: 주제의 추가 속성을 업데이트하거나 구성합니다.

3. 만들기를 클릭합니다. 전체 주제 이름은 projects/PROJECT_ID/topics/TOPIC_ID 형식으로 지정됩니다. 이후 단계에서 이 전체 이름을 사용합니다.

4. 주제에 Pub/Sub 메시지를 게시할 수 있는 액세스 권한을 부여합니다.

   1. 주제 페이지에서 측면 패널로 이동하여 권한 탭을 엽니다.
   2. 주 구성원 추가를 클릭합니다.
   3. 주 구성원 추가 필드에 구독에 이벤트를 전송하는 Google Workspace 애플리케이션의 서비스 계정을 추가합니다.
      1. Chat 이벤트의 경우 chat-api-push@system.gserviceaccount.com
      2. Meet 이벤트의 경우 meet-api-event-push@system.gserviceaccount.com.
   4. 역할 할당 메뉴에서 Pub/Sub Publisher를 선택합니다.
   5. 저장을 클릭합니다. 주제에 대한 권한을 업데이트하는 데 몇 분 정도 걸릴 수 있습니다.

gcloud

1. Cloud 프로젝트에서 다음 명령어를 실행하여 주제를 만듭니다.

   gcloud pubsub topics create TOPIC_ID
   

   TOPIC_ID를 주제의 고유 ID(예: workspace-events-topic)로 바꿉니다.

   출력에 projects/PROJECT_ID/topics/TOPIC_ID 형식의 전체 주제 이름이 표시됩니다. 이름을 확인하고 PROJECT_ID 값이 앱의 Cloud 프로젝트 ID인지 확인합니다. 다음 단계에서 주제 이름을 사용하고 나중에 Google Workspace 구독을 만들 때 주제 이름을 사용합니다.

2. 주제에 메시지를 게시할 수 있는 액세스 권한을 부여합니다.

   gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'
   

   다음을 바꿉니다.

   • TOPIC_NAME: 전체 주제 이름으로, 이전 단계의 출력입니다. projects/PROJECT_ID/topics/TOPIC_ID 형식으로 지정됩니다.

   • GOOGLE_WORKSPACE_APPLICATION: 구독에 이벤트를 전송해야 하는 Google Workspace 애플리케이션입니다.

     • Chat에서 이벤트를 수신하려면 chat-api-push@system.gserviceaccount.com를 사용합니다.
     • Meet에서 이벤트를 수신하려면 meet-api-event-push@system.gserviceaccount.com를 사용합니다.

   주제의 권한을 업데이트하는 데 몇 분 정도 걸릴 수 있습니다.

3. 주제의 Pub/Sub 구독을 만듭니다.

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME
   

   다음을 바꿉니다.

   • SUBSCRIPTION_NAME: 정기 결제의 이름입니다(예: workspace-events-subscription).
   • TOPIC_NAME: 이전 단계에서 만든 주제의 이름입니다.

Apps Script

1. Apps Script 프로젝트에서 createSubscription라는 새 스크립트 파일을 만들고 다음 코드를 추가합니다.

   function createSubscription() {
     // The Google Workspace resource to monitor for events.
     const targetResource = 'TARGET_RESOURCE';
   
     // The types of events to receive.
     const eventTypes = [EVENT_TYPES];
   
     // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
     const pubsubTopic = 'TOPIC_NAME';
   
     // Whether to include resource data or not.
     const resourceData = RESOURCE_DATA;
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.create({
       targetResource: targetResource,
       eventTypes: eventTypes,
       notificationEndpoint: {
         pubsubTopic: pubsubTopic,
       },
       payloadOptions: {
         includeResource: resourceData
       }
     });
     console.log(response);
   }
   

   다음을 바꿉니다.

   • TARGET_RESOURCE: 구독 중인 Google Workspace 리소스로, 전체 리소스 이름으로 형식이 지정됩니다. 예를 들어 스페이스 ID가 AAAABBBB인 Google Chat 스페이스를 구독하려면 //chat.googleapis.com/spaces/AAAABBBB를 사용합니다.
   • EVENT_TYPES: 타겟 리소스에서 구독할 하나 이상의 이벤트 유형입니다. 'google.workspace.chat.message.v1.created'와 같은 문자열 배열 형식으로 형식을 지정합니다.
   • TOPIC_NAME: Cloud 프로젝트에서 만든 Pub/Sub 주제의 전체 이름입니다. projects/PROJECT_ID/topics/TOPIC_ID 형식으로 지정됩니다.

   • RESOURCE_DATA: 정기 결제의 페이로드에 리소스 데이터가 포함되어 있는지 여부를 지정하는 불리언입니다.

     • True: 모든 리소스 데이터를 포함합니다. 포함할 필드를 제한하려면 fieldMask 필드를 추가하고 변경된 리소스에 필드를 하나 이상 지정합니다. 리소스 데이터를 포함한 Chat 리소스 구독만 지원됩니다.
     • False: 리소스 데이터를 제외합니다.

2. Google Workspace 구독을 만들려면 Apps Script 프로젝트에서 createSubscription 함수를 실행합니다.

Python

1. 작업 디렉터리에서 create_subscription.py라는 파일을 만들고 다음 코드를 추가합니다.

   """Create subscription."""
   
   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = [SCOPES]
   
   # Authenticate with Google Workspace and get user authentication.
   flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
   CREDENTIALS = flow.run_local_server()
   
   # The Google Workspace resource to monitor for events.
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   # The types of events to receive.
   EVENT_TYPES = [EVENT_TYPES]
   
   # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
   TOPIC = 'TOPIC_NAME'
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
   )
   
   BODY = {
       'target_resource': TARGET_RESOURCE,
       'event_types': EVENT_TYPES,
       'notification_endpoint': {'pubsub_topic': TOPIC},
       'payload_options': {'include_resource': RESOURCE_DATA},
   }
   response = service.subscriptions().create(body=BODY).execute()
   print(response)
   

   다음을 바꿉니다.

   • SCOPES: 구독에 대한 각 이벤트 유형을 지원하는 하나 이상의 OAuth 범위입니다. 문자열 배열로 형식이 지정됩니다. 여러 범위를 나열하려면 쉼표로 구분하세요. 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'를 예로 들 수 있습니다.
   • TARGET_RESOURCE: 구독 중인 Google Workspace 리소스로, 전체 리소스 이름으로 형식이 지정됩니다. 예를 들어 스페이스 ID가 AAAABBBB인 Google Chat 스페이스를 구독하려면 //chat.googleapis.com/spaces/AAAABBBB를 사용합니다.
   • EVENT_TYPES: 타겟 리소스에서 구독할 하나 이상의 이벤트 유형입니다. 'google.workspace.chat.message.v1.created'와 같은 문자열 배열 형식으로 형식을 지정합니다.
   • TOPIC_NAME: Cloud 프로젝트에서 만든 Pub/Sub 주제의 전체 이름입니다. projects/PROJECT_ID/topics/TOPIC_ID 형식으로 지정됩니다.

   • RESOURCE_DATA: 정기 결제의 페이로드에 리소스 데이터가 포함되어 있는지 여부를 지정하는 불리언입니다.

     • True: 모든 리소스 데이터를 포함합니다. 포함할 필드를 제한하려면 fieldMask 필드를 추가하고 변경된 리소스에 필드를 하나 이상 지정합니다. 리소스 데이터를 포함한 Chat 리소스 구독만 지원됩니다.
     • False: 리소스 데이터를 제외합니다.

2. Google Workspace 구독을 만들려면 터미널에서 다음을 실행합니다.

   python3 create_subscription.py
   

Google Cloud 콘솔

1. Google Workspace 구독의 대상 리소스에서 하나 이상의 이벤트 유형을 트리거합니다. 예를 들어 Chat 스페이스에서 새 메시지를 구독한 경우 해당 스페이스에 메시지를 게시합니다.

2. Google Cloud 콘솔에서 Pub/Sub 페이지로 이동합니다.

   Pub/Sub로 이동

   앱의 Cloud 프로젝트가 선택되어 있는지 확인합니다.

3. Pub/Sub 메뉴에서 구독을 클릭합니다.

4. 표에서 주제에 대한 Pub/Sub 구독을 찾아 구독 이름을 클릭합니다.

5. 메시지 탭을 클릭합니다.

6. 가져오기를 클릭합니다. 이벤트가 Pub/Sub 메시지를 생성하는 데 최대 몇 분이 걸릴 수 있습니다.

gcloud

1. Google Workspace 구독의 대상 리소스에서 하나 이상의 이벤트 유형을 트리거합니다. 예를 들어 Chat 스페이스에서 새 메시지를 구독한 경우 스페이스에 메시지를 게시합니다.

2. 다음 명령어를 실행합니다.

   gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack
   

   다음을 바꿉니다.

   • PUBSUB_SUBSCRIPTION_NAME: Pub/Sub 구독의 전체 이름으로, projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID 형식입니다.
   • MESSAGE_COUNT: 가져올 최대 Pub/Sub 메시지 수입니다.

   이벤트가 Pub/Sub 메시지를 생성하는 데 최대 몇 분이 걸릴 수 있습니다.