Google Workspace 구독 만들기

Apps Script

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

    gcloud init
    

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

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

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

• 결제가 사용 설정된 Google Cloud 프로젝트 Chat 구독의 경우 Cloud 프로젝트에서 Chat API를 사용 설정하고 앱 이름, 아바타 URL, 설명 필드를 구성해야 합니다. 자세한 내용은 Google Chat 앱 빌드를 참고하세요.
• 인증과 구독의 각 이벤트 유형에 적합한 승인 범위가 필요합니다.
  • 일반적으로 앱에 대해 구성된 OAuth 동의 화면을 사용한 사용자 인증이 필요합니다. 동의 화면을 구성할 때 정기 결제의 각 이벤트 유형을 지원하는 범위를 지정해야 합니다. 동의 화면을 구성하고 필수 범위를 식별하려면 범위 선택을 참고하세요.
  • 채팅 앱으로 채팅 이벤트를 구독하려면 일회성 관리자 승인을 통한 앱 인증이 필요합니다.

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 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 API 콘솔

1. Google API 콘솔에서 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. 채팅 이벤트의 경우:
         • 채팅 앱이 채팅을 확장하는 Google Workspace 부가기능인 경우 Chat API 구성 페이지에서 서비스 계정 이메일을 사용하세요. 자세한 내용은 Pub/Sub를 사용하는 Google Chat 앱 빌드를 참고하세요.
         • Chat 앱이 Chat API 상호작용 이벤트를 사용하는 경우 chat-api-push@system.gserviceaccount.com를 사용하세요.
      2. 개발자 프리뷰: Drive 이벤트의 경우 drive-api-event-push@system.gserviceaccount.com입니다.
      3. 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에서 이벤트를 수신하려면 다음 서비스 계정 중 하나를 사용하세요.
       • 채팅 앱이 채팅을 확장하는 Google Workspace 부가기능인 경우 Chat API 구성 페이지에서 서비스 계정 이메일을 사용하세요. 자세한 내용은 Pub/Sub를 사용하는 Google Chat 앱 빌드를 참고하세요.
       • Chat 앱이 Chat API 상호작용 이벤트를 사용하는 경우 chat-api-push@system.gserviceaccount.com를 사용하세요.
     • 개발자 프리뷰: Drive에서 이벤트를 수신하려면 drive-api-event-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인 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('credentials.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인 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 API 콘솔

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

2. Google API 콘솔에서 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/PROJECT_ID/subscriptions/SUBSCRIPTION_ID입니다.
   • MESSAGE_COUNT: 가져오려는 Pub/Sub 메시지의 최대 개수입니다.

   이벤트에서 Pub/Sub 메시지를 생성하는 데 몇 분 정도 걸릴 수 있습니다.

Python

  """Create subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = ['https://www.googleapis.com/auth/chat.app.messages.readonly']

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # The Google Workspace resource to monitor for events.
  TARGET_RESOURCE = '//chat.googleapis.com/spaces/SPACE_ID'

  # The types of events to receive.
  EVENT_TYPES = [
                  'google.workspace.chat.message.v1.created',
                  'google.workspace.chat.message.v1.updated',
                  'google.workspace.chat.message.v1.deleted',
                ]

  # 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',
      'v1beta',
      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)