Обзор API Google Чата

На этой странице представлен обзор использования API Google Chat и его справочная документация.

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

Клиентские библиотеки

Большинству разработчиков рекомендуется вызывать API Google Chat с помощью наших официально поддерживаемых облачных клиентских библиотек для предпочитаемого вами языка, например Python, Java или Node.js.

Если вы пишете код с помощью Google Apps Script, используйте службу Advanced Chat вместо установки клиентской библиотеки.

Тип, метод и имена полей

В зависимости от того, используете ли вы клиентские библиотеки, gRPC или REST, типы, методы и имена полей для API Google Chat могут несколько различаться:

  • Клиентские библиотеки Cloud организованы по сервисам gRPC и их методам. Клиентские библиотеки Google API организованы как сервисы, содержащие объекты или классы, соответствующие ресурсам REST, которые также содержат соответствующие методы.
  • gRPC упорядочен по службам и их методам.
  • REST организован по иерархиям ресурсов и их методов.
  • Имена полей gRPC используют «змеиный» регистр.
  • Названия полей REST используют «camelCase», хотя служба API принимает как «camelCase», так и «snakeCase».
  • Названия полей клиентской библиотеки используют либо заглавные буквы, либо верблюжьи, либо змеиные, в зависимости от того, какое название является идиоматичным для данного языка.

Буферы протоколов

Независимо от того, используете ли вы клиентские библиотеки, REST или gRPC, базовая служба определяется с помощью буферов протокола . В частности, служба использует proto3 .

При вызове API некоторые поля запроса или ответа могут потребовать базового понимания известных типов буферов протокола .

Кроме того, при вызове REST API поведение буферов протокола , использующих значения по умолчанию, может привести к пропуску полей в JSON-ответе. Эти поля имеют значения по умолчанию и поэтому не включаются в ответ.

версии API

Доступны следующие версии API:

  • v1 : Стабильная.

Предварительный просмотр для разработчиков

В документации вы можете встретить методы или поля API, доступные только в рамках программы Developer Preview. Чтобы протестировать и ознакомиться с последними функциями предварительной версии, а также оставить отзыв о них, присоединитесь к программе Developer Preview .