Расширенный чат

Служба расширенного чата позволяет использовать API Google Chat в скриптах приложений. Этот API позволяет сценариям находить, создавать и изменять пространства чата, добавлять или удалять участников в пространствах, а также читать или публиковать сообщения с текстом, карточками, вложениями и реакциями.

Предварительные условия

Ссылка

Дополнительные сведения об этом сервисе см. в справочной документации Chat API . Как и все расширенные службы в Apps Script, служба Chat использует те же объекты, методы и параметры, что и общедоступный API.

Пример кода

В этих примерах показано, как выполнять распространенные действия API Google Chat с помощью расширенной службы.

Опубликовать сообщение с учетными данными пользователя

В следующем примере показано, как опубликовать сообщение в чате от имени пользователя.

  1. Добавьте область chat.messages.create в файл appsscript.json проекта Apps Script:

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

  2. Добавьте такую ​​функцию в код проекта Apps Script:

    продвинутый/chat.gs
    /**
 * Posts a new message to the specified space on behalf of the user.
 * @param {string} spaceName The resource name of the space.
 */
function postMessageWithUserCredentials(spaceName) {
  try {
    const message = {'text': 'Hello world!'};
    Chat.Spaces.Messages.create(message, spaceName);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to create message with error %s', err.message);
  }
}

Опубликовать сообщение с учетными данными приложения

В следующем примере показано, как опубликовать сообщение в пространстве чата от имени приложения. Использование расширенной службы чата с учетной записью службы не требует указания областей авторизации в appsscript.json . Подробную информацию об аутентификации с помощью сервисных учетных записей см. в разделе Аутентификация в качестве приложения Google Chat .

продвинутый/chat.gs
/**
 * Posts a new message to the specified space on behalf of the app.
 * @param {string} spaceName The resource name of the space.
 */
function postMessageWithAppCredentials(spaceName) {
  try {
    // See https://developers.google.com/chat/api/guides/auth/service-accounts
    // for details on how to obtain a service account OAuth token.
    const appToken = getToken_();
    const message = {'text': 'Hello world!'};
    Chat.Spaces.Messages.create(
        message,
        spaceName,
        {},
        // Authenticate with the service account token.
        {'Authorization': 'Bearer ' + appToken});
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to create message with error %s', err.message);
  }
}

Получите место

В следующем примере показано, как получить информацию о пространстве чата.

  1. Добавьте область авторизации chat.spaces.readonly в файл appsscript.json проекта Apps Script:

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

  2. Добавьте такую ​​функцию в код проекта Apps Script:

    продвинутый/chat.gs
    /**
 * Gets information about a Chat space.
 * @param {string} spaceName The resource name of the space.
 */
function getSpace(spaceName) {
  try {
    const space = Chat.Spaces.get(spaceName);
    console.log('Space display name: %s', space.displayName);
    console.log('Space type: %s', space.spaceType);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get space with error %s', err.message);
  }
}

Создайте пространство

В следующем примере показано, как создать пространство чата.

  1. Добавьте область chat.spaces.create в файл appsscript.json проекта Apps Script:

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

  2. Добавьте такую ​​функцию в код проекта Apps Script:

    продвинутый/chat.gs
    /**
 * Creates a new Chat space.
 */
function createSpace() {
  try {
    const space = {'displayName': 'New Space', 'spaceType': 'SPACE'};
    Chat.Spaces.create(space);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to create space with error %s', err.message);
  }
}

Список участников

В следующем примере показано, как составить список всех участников пространства чата.

  1. Добавьте область chat.memberships.readonly в файл appsscript.json проекта Apps Script:

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

  2. Добавьте такую ​​функцию в код проекта Apps Script:

    продвинутый/chat.gs
    /**
 * Lists all the members of a Chat space.
 * @param {string} spaceName The resource name of the space.
 */
function listMemberships(spaceName) {
  let response;
  let pageToken = null;
  try {
    do {
      response = Chat.Spaces.Members.list(spaceName, {
        pageSize: 10,
        pageToken: pageToken
      });
      if (!response.memberships || response.memberships.length === 0) {
        pageToken = response.nextPageToken;
        continue;
      }
      response.memberships.forEach((membership) => console.log(
          'Member resource name: %s (type: %s)',
          membership.name,
          membership.member.type));
      pageToken = response.nextPageToken;
    } while (pageToken);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed with error %s', err.message);
  }
}

Устранение неполадок

Если вы столкнулись с Error 400: invalid_scope с сообщением об ошибке Some requested scopes cannot be shown , это означает, что вы не указали какие-либо области авторизации в файле appsscript.json проекта Apps Script. В большинстве случаев Apps Script автоматически определяет, какие области необходимы сценарию, но при использовании расширенной службы Chat необходимо вручную добавить области авторизации, используемые вашим сценарием, в файл манифеста вашего проекта Apps Script. См. раздел Установка явных областей действия .

Чтобы устранить эту ошибку, добавьте соответствующие области авторизации в файл appsscript.json проекта Apps Script как часть массива oauthScopes . Например, чтобы вызвать метод spaces.messages.create , добавьте следующее: 

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

Ограничения и соображения

Служба расширенного чата не поддерживает:

Чтобы загрузить вложение к сообщению или вызвать метод предварительного просмотра разработчика, используйте вместо этого UrlFetchApp .