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

Apps Script

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

    gcloud init
    

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

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

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

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

Python

• 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 выполните следующий код:

    gcloud init
    

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

Консоль Google Cloud

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

Включите API

gcloud

1. В своей рабочей директории войдите в свой аккаунт Google:

   gcloud auth login

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

   gcloud config set project PROJECT_ID

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

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

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

Консоль Google API

1. В консоли Google API перейдите на страницу «Публикация/Подписка»:

   Перейдите на страницу Google Cloud Pub/Sub.

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

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 является надстройкой Google Workspace, расширяющей функциональность Chat, используйте адрес электронной почты сервисной учетной записи на странице конфигурации API Chat . Для получения дополнительной информации см. раздел «Создание приложения Google 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 на уникальный идентификатор вашей темы, например, 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 является надстройкой Google Workspace, расширяющей функциональность Chat, используйте адрес электронной почты сервисной учетной записи на странице конфигурации API Chat . Для получения дополнительной информации см. раздел «Создание приложения Google Chat с использованием модели публикации/подписки» .
       • Если ваше приложение для чата использует события взаимодействия Chat API , используйте chat-api-push@system.gserviceaccount.com .
     • Предварительная версия для разработчиков: Чтобы получать события из Google 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 , на который вы подписываетесь, в формате полного имени ресурса. Например, чтобы подписаться на пространство чата с идентификатором AAAABBBB , используйте //chat.googleapis.com/spaces/AAAABBBB .
   • EVENT_TYPES : Один или несколько типов событий , на которые вы хотите подписаться в целевом ресурсе. Формат: массив строк, например, 'google.workspace.chat.message.v1.created' .
   • TOPIC_NAME : Полное имя темы Pub/Sub, созданной в вашем облачном проекте. Формат: projects/ PROJECT_ID /topics/ TOPIC_ID .

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

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

2. Для создания подписки на Google Workspace запустите функцию createSubscription в вашем проекте Apps Script.

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

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

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

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

   python3 create_subscription.py

Консоль Google API

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

2. В консоли Google API перейдите на страницу «Публикация/Подписка»:

   Перейти в раздел "Публикация/Подписка"

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

3. В меню «Публикация/Подписка» нажмите «Подписки» .

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 по событию может потребоваться до нескольких минут.

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)