Google Chat API 概览

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

Google Chat API 同时包含 gRPC 和 REST 接口以及 同时支持两者的客户端库。（可选）如果 提供的客户端库未能满足您的需求，您可以自行编写 使用 gRPC 或 REST 接口的客户端库中。

客户端库

建议大多数开发者调用 Google Chat API 是基于我们官方支持的 Cloud 客户端库 （例如 Python、Java 或 Node.js）

如果您使用 Google Apps 脚本编写代码，请使用 高级 Chat 服务 而无需安装客户端库

类型、方法和字段名称

具体类型取决于您使用的是客户端库、gRPC 还是 REST。 方法和字段名称存在一定差异：

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

Protocol Buffers

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

调用 API 时，某些请求或响应字段可能需要 理解 协议缓冲区常用类型。

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

API 版本

您可以使用以下 API 版本：

  • v1：稳定。

开发者预览版

在文档中，您可能会看到 。测试并预览 欢迎提供有关最新预览版功能的反馈，请加入 开发者预览版计划。