Google Chat API 概览

本页面简要介绍了如何使用 Google Chat API 及其参考文档。

Google Chat API 同时支持 gRPC 和 REST 接口，以及同时支持这两种接口的客户端库。您还可以根据需要编写使用 gRPC 或 REST 接口的自己的客户端库，前提是提供的客户端库无法满足您的需求。

客户端库

对于大多数开发者，建议使用我们官方支持的 Cloud 客户端库（适用于您的首选语言，例如 Python、Java 或 Node.js）调用 Google Chat API。

如果您使用 Google Apps 脚本进行编码，请使用高级 Chat 服务，而不是安装客户端库。

类型、方法和字段名称

根据您使用的是客户端库、gRPC 还是 REST，Google Chat API 的类型、方法和字段名称略有不同：

  • Cloud 客户端库按 gRPC 服务及其方法进行排列。Google API 客户端库被安排为服务，其中包含与 REST 资源对应的对象或类，这些资源也包含相应的方法。
  • gRPC 按服务及其方法进行安排。
  • REST 按资源层次结构及其方法进行安排。
  • gRPC 字段名称使用蛇形命名法。
  • REST 字段名称使用驼峰式命名法，但 API 服务将接受驼峰式命名法或蛇形命名法。
  • 客户端库字段名称使用词首字母大写形式、驼峰式命名法或蛇形命名法，取决于哪种名称对于语言是惯用的。

Protocol Buffers

无论您使用的是客户端库、REST 还是 gRPC，底层服务都是使用协议缓冲区定义的。具体而言，该服务使用 proto3。

调用 API 时，某些请求或响应字段可能需要您对协议缓冲区知名类型有基本的了解。

此外，调用 REST API 时，协议缓冲区的默认值行为可能会导致 JSON 响应中缺少字段。这些字段会设为默认值，因此不会包含在响应中。

API 版本

可用的 API 版本如下：

  • v1：稳定版。

开发者预览版

在文档中，您可能会看到仅通过开发者预览计划提供的 API 方法或字段。如需测试、预览最新的预览版功能并提供反馈，请加入开发者预览版计划。