На этой странице представлен обзор использования Google Chat API и справочная документация.
API Google Chat поддерживает как gRPC , так и REST- интерфейсы, а также клиентские библиотеки , работающие с обоими. При желании, если предоставленные клиентские библиотеки не соответствуют вашим потребностям, вы можете написать собственные клиентские библиотеки, использующие gRPC или REST-интерфейс.
Клиентские библиотеки
Для большинства разработчиков рекомендуемый способ вызова API Google Chat — использование официально поддерживаемых нами облачных клиентских библиотек для предпочитаемого языка программирования, например Python, Java или Node.js.
Если вы используете Google Apps Script для программирования, воспользуйтесь сервисом Advanced Chat вместо установки клиентской библиотеки.
Названия типов, методов и полей
В зависимости от того, используете ли вы клиентские библиотеки, gRPC или REST, названия типов, методов и полей для Google Chat API несколько различаются:
- Клиентские библиотеки облачных сервисов организованы по gRPC-сервисам и их методам. Клиентские библиотеки API Google организованы как сервисы, содержащие объекты или классы, соответствующие REST-ресурсам, которые, в свою очередь, содержат соответствующие методы.
- gRPC организован по сервисам и их методам.
- REST-система построена на основе иерархии ресурсов и используемых в ней методов.
- В названиях полей gRPC используется регистр "snake case".
- В REST-запросах для именования полей используется стиль camel case, хотя API-сервис принимает как camel case, так и snake case.
- В зависимости от того, какое название является общепринятым для данного языка, в названиях полей клиентской библиотеки используется регистр title case, camel case или snake case.
Протокольные буферы
Независимо от того, используете ли вы клиентские библиотеки, REST или gRPC, базовый сервис определяется с помощью протокола Protocol Buffers . В частности, сервис использует протокол Proto3 .
При вызове API для некоторых полей запроса или ответа может потребоваться базовое понимание общеизвестных типов протокола Protocol Buffer .
Кроме того, при вызове REST API поведение протокола Protocol Buffers по умолчанию может привести к отсутствию полей в JSON-ответе. Эти поля устанавливаются на значение по умолчанию, поэтому они не включаются в ответ.
версии API
Доступны следующие версии API:
- v1 : Стабильная версия.
Предварительная версия для разработчиков
В документации вы можете встретить методы или поля API, доступные только в рамках программы предварительного просмотра для разработчиков. Чтобы протестировать, предварительно ознакомиться и оставить отзыв о новых функциях предварительной версии, присоединитесь к программе предварительного просмотра для разработчиков .