Получите подробную информацию о мероприятии в Google Chat

В этом руководстве объясняется, как использовать метод get() ресурса SpaceEvent API Google Chat для получения сведений о событии из пространства Google Chat.

Ресурс SpaceEvent представляет изменение пространства или его дочерних ресурсов, таких как сообщения, реакции и членство. Сведения о поддерживаемых типах событий см. в поле eventType справочной документации по ресурсу SpaceEvent .

Вы можете запросить события за 28 дней до момента запроса. Событие содержит самую последнюю версию ресурса, который изменился. Например, если вы запрашиваете событие о новом сообщении, но сообщение было позже обновлено, сервер вернет обновлённый ресурс Message в полезной нагрузке события.

Для вызова этого метода необходимо использовать аутентификацию пользователя . Чтобы получить событие, аутентифицированный пользователь должен быть участником пространства, в котором произошло событие.

Предпосылки

Node.js

Питон

Получить подробную информацию о космическом событии (аутентификация пользователя)

Чтобы получить подробную информацию о космическом мероприятии в Google Chat, передайте в запросе следующее:

  • Укажите область авторизации, поддерживающую тип события в вашем запросе. Рекомендуется выбрать наиболее строгую область, которая позволит вашему приложению функционировать.
  • Вызовите метод GetSpaceEvent() , передав name события пространства, которое нужно получить.

В следующем примере получаем космическое событие:

Node.js

В этом примере кода Node.js используется API чата RPC .

chat/client-libraries/cloud/get-space-event-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Replace SCOPE_NAME here with an authorization scope based on the event type
const USER_AUTH_OAUTH_SCOPES = ['SCOPE_NAME'];

// This sample shows how to get space event with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and SPACE_EVENT_NAME here
    name: 'spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',
  };

  // Make the request
  const response = await chatClient.getSpaceEvent(request);

  // Handle the response
  console.log(response);
}

await main();

Чтобы запустить этот пример, замените следующее:

  • SCOPE_NAME : область авторизации, основанная на типе события. Например, если вы получаете событие чат-группы о новом членстве, используйте область chat.memberships.readonly в формате https://www.googleapis.com/auth/chat.memberships.readonly . Тип события можно получить с помощью метода ListSpaceEvents() . Чтобы узнать, как использовать этот метод, см. раздел Список событий чат-группы .
  • SPACE_NAME : идентификатор из name пространства. Идентификатор можно получить, вызвав метод ListSpaces() или указав URL пространства.
  • SPACE_EVENT_NAME : идентификатор из name события пространства. Идентификатор можно получить с помощью метода ListSpaceEvents() . Чтобы узнать, как использовать этот метод, см. раздел Список событий пространства .

API чата возвращает экземпляр SpaceEvent с подробностями о событии.

Получите подробную информацию о космическом мероприятии (аутентификация через чат-приложение)

Аутентификация приложения требует однократного одобрения администратора .

Чтобы получить сведения о событии в пространстве из пространства с аутентификацией приложения с помощью API REST чата , передайте в запросе следующее:

  • Укажите одну или несколько областей авторизации для поддержки каждого типа событий в вашем запросе. Рекомендуется выбирать наиболее строгую область, которая позволит вашему приложению функционировать. Подробнее о выборе области см. в разделе «Обзор аутентификации и авторизации» .
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.spaces
  • Вызовите метод get для ресурса spaceEvents .
  • Передайте name пространства, из которого необходимо получить сведения о событии.

Создать ключ API

Для вызова метода API Developer Preview необходимо использовать закрытую версию документа API Discovery, доступную для разработчиков. Для аутентификации запроса необходимо передать ключ API.

Чтобы создать ключ API, откройте проект Google Cloud вашего приложения и выполните следующие действия:

  1. В консоли Google Cloud перейдите в > API и службы > Учетные данные .

    Перейти к учетным данным

  2. Нажмите Создать учетные данные > Ключ API .
  3. Отобразится ваш новый ключ API.
    • Нажмите «Копировать , чтобы скопировать ключ API для использования в коде вашего приложения. Ключ API также можно найти в разделе «Ключи API» учётных данных вашего проекта.
    • Чтобы предотвратить несанкционированное использование, мы рекомендуем ограничить, где и для каких API можно использовать ключ API. Подробнее см. в разделе «Добавление ограничений API» .

Напишите скрипт, который вызывает Chat API

Вот как получить подробную информацию о космическом мероприятии с помощью аутентификации приложения и API REST чата :

Питон

В этом примере кода Python используется Chat REST API .

  1. В рабочем каталоге создайте файл с именем chat_spaceevents_get_app.py .

  2. Включите следующий код в chat_spaceevents_get_app.py :

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

# Define your app's authorization scopes.
# Set authorization scopes based on the
# event type. For example, if you are getting a space event
# about a new membership, use the `chat.app.memberships.readonly` scope.
#
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships",
          "https://www.googleapis.com/auth/chat.app.messages.readonly",
          "https://www.googleapis.com/auth/chat.app.spaces"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then lists space events from a specified space.
    '''

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

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # Use the service endpoint to call Chat API.
    result = chat.spaces().spaceEvents().get(

        # The space to get event details from.
        #
        # Replace SPACE_NAME with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        name='spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',

    ).execute()

    # Print Chat API's response in your command line interface.
    print(result)

if __name__ == '__main__':
    main()

  3. В коде замените следующее:

    • API_KEY : ключ API, созданный вами для создания конечной точки службы для API чата.
    • SPACE_NAME : имя пространства, которое можно получить из метода spaces.list в API чата или из URL-адреса пространства.
    • SPACE_EVENT_NAME : идентификатор из name события пространства. Идентификатор можно получить с помощью метода ListSpaceEvents() . Чтобы узнать, как использовать этот метод, см. раздел Список событий пространства .

  4. В вашем рабочем каталоге соберите и запустите пример:

    python3 chat_spaceevents_get_app.py

API чата возвращает постраничный список событий в пространстве, касающихся новых участников и сообщений.