Создайте подписку на Google Workspace

Скрипт приложений

• Чтобы использовать команды Google Cloud CLI в этом руководстве:
  1. Установите Google Cloud CLI .
  2. Чтобы инициализировать gcloud CLI, выполните следующий код:

    gcloud init
    

• Проект Apps Script:
  • Используйте свой проект Google Cloud вместо проекта по умолчанию, созданного автоматически Apps Script.
  • Для всех областей действия, добавленных для настройки экрана согласия OAuth, необходимо также добавить их в файл appsscript.json в проекте Apps Script. Например, если вы указали область действия chat.messages , добавьте следующее:

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

  • Включите расширенную службу Google Workspace Events .

• Проект Google Cloud с включённым биллингом. Для подписок на Chat необходимо также включить Chat API в вашем проекте Cloud и настроить поля «Название приложения» , «URL аватара» и «Описание» . Подробнее см. в статье «Создание приложения Google Chat» .
• Требуется аутентификация и соответствующая область авторизации для каждого типа событий в подписке:
  • Обычно требуется аутентификация пользователя с помощью экрана согласия OAuth, настроенного для приложения. При настройке экрана согласия необходимо указать область действия для поддержки каждого типа событий подписки. Чтобы настроить экран согласия и определить необходимые области действия, см. раздел Выбор областей действия .
  • Для подписки на событие чата через приложение чата требуется аутентификация приложения с однократным одобрением администратора . Подписка на событие чата через приложение чата доступна в версии Developer Preview .

Питон

• Python 3.6 или выше
• Инструмент управления пакетами pip
• Последние клиентские библиотеки Google для Python. Чтобы установить или обновить их, выполните следующую команду в командной строке:

    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 необходимо также включить Chat API в вашем проекте Cloud и настроить поля «Название приложения» , «URL аватара» и «Описание» . Подробнее см. в статье «Создание приложения Google Chat» .
• Требуется аутентификация и соответствующая область авторизации для каждого типа событий в подписке:
  • Обычно требуется аутентификация пользователя с помощью экрана согласия OAuth, настроенного для приложения. При настройке экрана согласия необходимо указать область действия для поддержки каждого типа событий подписки. Чтобы настроить экран согласия и определить необходимые области действия, см. раздел Выбор областей действия .
  • Для подписки на событие чата через приложение чата требуется аутентификация приложения с однократным одобрением администратора . Подписка на событие чата через приложение чата доступна в версии Developer Preview .

Консоль Google Cloud

В консоли Google Cloud откройте проект Google Cloud для своего приложения и включите API событий Google Workspace и API Pub/Sub:

Включить API

gcloud

1. В рабочем каталоге войдите в свою учетную запись Google:

   gcloud auth login

2. Настройте свой проект как облачный проект для вашего приложения:

   gcloud config set project PROJECT_ID

   Замените PROJECT_ID на идентификатор облачного проекта для вашего приложения.

3. Включите API событий Google Workspace и API Google Cloud Pub/Sub:

   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-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. В своем облачном проекте создайте тему, выполнив следующую команду:

   gcloud pubsub topics create TOPIC_ID

   Замените TOPIC_ID уникальным идентификатором вашей темы, например, workspace-events-topic .

   В выводе отображается полное название темы в формате projects/ PROJECT_ID /topics/ TOPIC_ID . Запишите название и убедитесь, что значение PROJECT_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-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 : Название темы, созданной на предыдущем шаге.

Скрипт приложений

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 , на который вы подписываетесь, отформатированный как его полное имя. Например, чтобы подписаться на пространство Google Chat с идентификатором AAAABBBB , используйте //chat.googleapis.com/spaces/AAAABBBB .
   • EVENT_TYPES : Один или несколько типов событий , на которые вы хотите подписаться в целевом ресурсе. Форматируйте как массив строк, например, 'google.workspace.chat.message.v1.created' .
   • TOPIC_NAME : Полное имя темы Pub/Sub, созданной в вашем проекте Cloud. Формат: projects/ PROJECT_ID /topics/ TOPIC_ID .

   • RESOURCE_DATA : логическое значение, которое указывает, включает ли подписка данные о ресурсах в полезную нагрузку:

     • True : включает все данные ресурсов. Чтобы ограничить количество включаемых полей, добавьте поле fieldMask и укажите хотя бы одно поле для изменённого ресурса. Включение данных ресурсов поддерживается только подписками на ресурсы чата.
     • False : исключает данные о ресурсах.

2. Чтобы создать подписку Google Workspace, запустите функцию createSubscription в проекте Apps Script.

Питон

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 , на который вы подписываетесь, отформатированный как его полное имя. Например, чтобы подписаться на пространство Google Chat с идентификатором AAAABBBB , используйте //chat.googleapis.com/spaces/AAAABBBB .
   • EVENT_TYPES : Один или несколько типов событий , на которые вы хотите подписаться в целевом ресурсе. Форматируйте как массив строк, например, 'google.workspace.chat.message.v1.created' .
   • TOPIC_NAME : Полное имя темы Pub/Sub, созданной в вашем проекте Cloud. Формат: projects/ PROJECT_ID /topics/ TOPIC_ID .

   • RESOURCE_DATA : логическое значение, которое указывает, включает ли подписка данные о ресурсах в полезную нагрузку:

     • True : включает все данные ресурсов. Чтобы ограничить количество включаемых полей, добавьте поле fieldMask и укажите хотя бы одно поле для изменённого ресурса. Включение данных ресурсов поддерживается только подписками на ресурсы чата.
     • False : исключает данные о ресурсах.

2. Чтобы создать подписку Google Workspace, выполните в терминале следующее:

   python3 create_subscription.py

Консоль Google Cloud

1. Запустите один или несколько типов событий в целевом ресурсе вашей подписки на Google Workspace. Например, если вы подписались на новые сообщения в чат-группе, опубликуйте сообщение в этой чат-группе.

2. В консоли Google Cloud перейдите на страницу Pub/Sub:

   Перейти в Pub/Sub

   Убедитесь, что для вашего приложения выбран проект Cloud.

3. В меню Pub/Sub нажмите Подписки .

4. В таблице найдите подписку Pub/Sub для вашей темы и щелкните название подписки.

5. Откройте вкладку «Сообщения» .

6. Нажмите «Pull» . Генерация сообщения Pub/Sub может занять несколько минут.

gcloud

1. Запустите один или несколько типов событий в целевом ресурсе вашей подписки на Google Workspace. Например, если вы подписались на новые сообщения в чат-группе, опубликуйте сообщение в этой чат-группе.

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 может занять до нескольких минут.

Питон

  """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,
      discoveryServiceUrl='https://workspaceevents.googleapis.com/$discovery/rest?version=v1beta&labels=DEVELOPER_PREVIEW&key=API_KEY',
  )

  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)