Краткое руководство по сценариям Google Apps

Создайте скрипт Google Apps Script , который будет отправлять запросы к API Google Chat.

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

В Apps Script в руководствах быстрого запуска Google Workspace используются расширенные сервисы Google для вызова API Google Workspace и обработки некоторых деталей процесса аутентификации и авторизации.

Цели

• Настройте среду.
• Создайте и настройте скрипт.
• Запустите скрипт.

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

• Проект Google Cloud .

• Корпоративный аккаунт Google Workspace с доступом к Google Chat .

Настройте свой облачный проект

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

Откройте свой облачный проект в консоли Google Cloud.

Если проект Cloud, который вы собираетесь использовать в этом примере, еще не открыт, откройте его:

1. В консоли Google Cloud перейдите на страницу «Выберите проект» .

   Выберите облачный проект

2. Выберите проект Google Cloud, который хотите использовать. Или нажмите «Создать проект» и следуйте инструкциям на экране. Если вы создаете проект Google Cloud, вам может потребоваться включить оплату для этого проекта .

Включите API чата

Перед использованием API Google необходимо включить их в проекте Google Cloud. В одном проекте Google Cloud можно включить один или несколько API.

• В консоли Google Cloud включите API Google Chat.

  Включить API

Настройте экран согласия OAuth.

1. В консоли Google Cloud перейдите в >Google Auth platform > Брендинг .

   Перейти к разделу «Брендинг»

2. Если вы уже настроили Google Auth platformВы можете настроить следующие параметры экрана согласия OAuth в разделах «Брендинг» , «Аудитория» и «Доступ к данным» . Если вы видите сообщение, в котором говорится... Google Auth platform Если конфигурация еще не выполнена , нажмите «Начать» :
1. В разделе «Информация о приложении» , в поле «Название приложения» , введите название для приложения.
2. В разделе «Электронная почта службы поддержки пользователей» выберите адрес электронной почты, по которому пользователи смогут связаться с вами, если у них возникнут вопросы относительно их согласия.
3. Нажмите «Далее» .
4. В разделе «Аудитория» выберите «Внутренняя» .
5. Нажмите «Далее» .
6. В поле «Контактная информация» укажите адрес электронной почты , на который вы сможете получать уведомления об изменениях в вашем проекте.
7. Нажмите «Далее» .
8. В разделе «Завершить» ознакомьтесь с Политикой использования пользовательских данных сервисов Google API и, если вы согласны, выберите «Я согласен с Политикой использования пользовательских данных сервисов Google API» .
9. Нажмите «Продолжить» .
10. Нажмите «Создать» .
3. На данный момент добавление областей действия можно пропустить. В будущем, при создании приложения для использования за пределами вашей организации Google Workspace, необходимо изменить тип пользователя на «Внешний» . Затем добавьте необходимые для вашего приложения области авторизации. Для получения дополнительной информации см. полное руководство по настройке согласия OAuth .

Настройте приложение Google Чат

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

1. В консоли Google Cloud перейдите на страницу « Конфигурация API чата»:

   Перейдите на страницу настройки API чата.

2. В разделе «Информация о приложении» введите следующие данные:

   1. В поле «Название приложения» введите Chat API quickstart app .
   2. В поле «URL-адрес аватара» введите https://developers.google.com/chat/images/quickstart-app-avatar.png .
   3. В поле «Описание» введите Quickstart for calling the Chat API .

3. В разделе «Интерактивные функции» переведите переключатель « Включить интерактивные функции» в положение «Выкл.», чтобы отключить интерактивные функции для приложения «Чат».

4. Нажмите « Сохранить ».

Создайте скрипт

1. Создайте новый скрипт в редакторе Apps Script, перейдя по адресу script.google.com/create .
2. Замените содержимое редактора скриптов следующим кодом:

chat/quickstart/Code.gs

Посмотреть на GitHub

/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken,
    });
    // Handle response pages
    if (responsePage.spaces) {
      for (const space of responsePage.spaces) {
        console.log(space);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

3. Нажмите «Сохранить». .
4. Щелкните по проекту без названия , введите Quickstart и нажмите «Переименовать» .

Настройте скрипт

Скопируйте номер облачного проекта.

1. В консоли Google Cloud перейдите в > IAM и администрирование > Настройки .

   Перейдите в раздел «Настройки IAM и администрирования».

2. В поле «Номер проекта» скопируйте значение.

Свяжите свой проект с Google Cloud.

1. Откройте проект Apps Script.
2. Нажмите проекта» .
3. В разделе «Проект Google Cloud Platform (GCP)» нажмите «Изменить проект» .
4. В поле "Номер проекта GCP" вставьте номер проекта Google Cloud.
5. Нажмите «Установить проект» .

Включите API чата Google.

Откройте проект Apps Script.

1. Нажмите проекта» .
2. В разделе «Общие настройки» включите параметр «Показывать файл манифеста "appsscript.json" в редакторе» .
3. Нажмите «Редактор , выберите файл appscript.json и замените его содержимое следующим кодом:

chat/quickstart/appsscript.json

Посмотреть на GitHub

{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": ["https://www.googleapis.com/auth/chat.spaces.readonly"],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [
      {
        "userSymbol": "Chat",
        "version": "v1",
        "serviceId": "chat"
      }
    ]
  }
}

Запустите образец

В редакторе Apps Script нажмите кнопку «Выполнить» .

При первом запуске примера вам будет предложено авторизовать доступ:

1. Нажмите «Проверить права доступа» .
2. Выберите учетную запись.
3. Нажмите «Разрешить» .

Журнал выполнения скрипта отображается в нижней части окна.

! Всё получилось!

Отлично! Для получения дополнительной информации ознакомьтесь с разделом "Дополнительная литература" ниже.

Возникла проблема.

Какая досада ! Сообщите нам, что пошло не так . В разделе устранения неполадок ниже вы найдете информацию о распространенных ошибках и способах их решения. Если вы обнаружили ошибку в коде, сообщите о ней на GitHub или отправьте запрос на слияние (pull request).

Следующие шаги

• Документация по расширенным сервисам Google Apps Script
• Попробуйте API Google Workspace в обозревателе API.