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

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

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

    gcloud init
    

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

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

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

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

Питон

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

Консоль Google Cloud

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

Включите API

gcloud

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

   gcloud auth login

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

   gcloud config set project PROJECT_ID

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

3. Включите API Google Workspace Events и 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.

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

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. Для событий чата: [email protected] .
      2. Для мероприятий Meet [email protected] .
   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, которое должно доставлять события в вашу подписку:

     • Чтобы получать события из чата, используйте [email protected] .
     • Чтобы получать события от Meet, используйте [email protected] .

   Обновление разрешений для вашей темы может занять несколько минут.

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, которую вы создали в своем облачном проекте. В формате projects/ PROJECT_ID /topics/ TOPIC_ID .

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

     • True : включает все данные ресурсов. Чтобы ограничить количество включенных полей, добавьте поле fieldMask и укажите хотя бы одно поле для измененного ресурса. Только подписки на ресурсы Chat поддерживают включение данных ресурсов.
     • 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('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 , на который вы подписываетесь, в формате полного имени ресурса. Например, чтобы подписаться на пространство Google Chat с идентификатором пространства 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 и укажите хотя бы одно поле для измененного ресурса. Только подписки на ресурсы Chat поддерживают включение данных ресурсов.
     • False : исключает данные ресурсов.

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

   python3 create_subscription.py

Консоль Google Cloud

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

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

   Перейти в паб/саб

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

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

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

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

6. Нажмите «Потянуть» . Создание сообщения 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/ SUBSCRIPTION_ID /subscriptions/ SUBSCRIPTION_ID .
   • MESSAGE_COUNT : максимальное количество сообщений Pub/Sub, которые вы хотите получить.

   Создание сообщения Pub/Sub может занять до нескольких минут.

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

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

    gcloud init
    

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

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

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

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

Питон

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

Консоль Google Cloud

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

Включите API

gcloud

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

   gcloud auth login

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

   gcloud config set project PROJECT_ID

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

3. Включите API Google Workspace Events и 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.

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

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. Для событий чата: [email protected] .
      2. Для мероприятий Meet [email protected] .
   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, которое должно доставлять события в вашу подписку:

     • Чтобы получать события из чата, используйте [email protected] .
     • Чтобы получать события от Meet, используйте [email protected] .

   Обновление разрешений для вашей темы может занять несколько минут.

3. Создайте подписку Pub/Sub для темы:

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME

   Замените следующее:

   • SUBSCRIPTION_NAME : имя для вашей подписки, такое как workspace-events-subscription .
   • TOPIC_NAME : имя вашей темы, которую вы создали на предыдущем шаге.

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

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

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

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

2. Чтобы создать подписку Google Workspace, запустите функцию createSubscription в вашем проекте сценария приложений.

Питон

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

   Перейти в паб/sub

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

3. В меню паба/подзадачи нажмите «Подписки» .

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

5. Нажмите на вкладку «Сообщения» .

6. Нажмите на развлечение . Это может занять несколько минут, чтобы событие сгенерировало паб/подраздел.

Gcloud

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

2. Выполните следующую команду:

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

   Замените следующее:

   • PUBSUB_SUBSCRIPTION_NAME : полное имя вашего Pub/ Sub Propply, отформатированное как projects/ SUBSCRIPTION_ID /subscriptions/ SUBSCRIPTION_ID .
   • MESSAGE_COUNT : максимальное количество пабов/подразделений, которые вы хотите вытащить.

   Это может занять несколько минут, чтобы событие сгенерировало паб/подраздел.