Обзор API Google Чата

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

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

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

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

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

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

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

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

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

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

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

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

Версии API

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

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

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

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

,

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

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

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

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

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

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

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

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

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

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

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

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

Версии API

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

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

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

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