Google Chat API 客户端库

客户端库可减少您必须编写的样板代码,从而优化调用 Google Chat API 的开发者体验。本指南介绍了客户端库,并说明了如何安装这些库。

Chat API 具有 gRPCREST 接口,以及同时支持这两者的客户端库。Cloud 客户端库支持 gRPC 和 REST 接口,Google API 客户端库仅支持 REST 接口,但您可以在同一个项目中使用这两种客户端库。您还可以根据需要编写使用 gRPC 或 REST 接口的客户端库,如果提供的客户端库无法满足您的需求。

如需详细了解 Google 支持的客户端库类型,请参阅客户端库说明

安装 Cloud 客户端库(推荐)

Cloud 客户端库是我们推荐用于调用 Chat API 的最新客户端库。Cloud 客户端库同时支持 gRPC 和 REST 接口。

Chat API 提供以下语言的 Cloud 客户端库。 选择您要使用的语言:

Node.js

如需安装客户端库,请执行以下操作:

npm install @google-apps/chat

了解详情:

Python

如需安装客户端库,请执行以下操作:

python -m venv <your-env>
source <your-env>/bin/activate
pip install google-apps-chat

了解详情:

Java

从以下标签页中选择您的构建环境。无论您使用哪种方式,请务必将版本更新到 GitHub 上提供的最新版本。

带有 BOM 的 Maven

如果您使用的是带有 BOM 的 Maven,请将以下代码添加到您的 pom.xml 文件中:

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>libraries-bom</artifactId>
        <version>26.42.0</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>google-cloud-chat</artifactId>
    </dependency>
<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-chat</artifactId>
  <version>0.10.0</version>
</dependency>

不带 BOM 的 Maven

如果您使用的是不带 BOM 的 Maven,请将以下代码添加到您的依赖项中:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-chat</artifactId>
  <version>0.9.0</version>
</dependency>

Gradle

如果您使用的是不带 BOM 的 Gradle,请将以下内容添加到您的依赖项中:

implementation 'com.google.cloud:google-cloud-chat:0.10.0'

SBT

如果您使用的是 SBT,请将以下内容添加到您的依赖项中:

libraryDependencies += "com.google.cloud" % "google-cloud-chat" % "0.10.0"

了解详情:

Go

导入适用于 Google Cloud 服务的 Go 软件包。

import "cloud.google.com/go"

如需在系统上安装该软件包,请执行以下操作:

  1. 切换到您的项目目录:cd /my/cloud/project
  2. 获取要使用的软件包:
go get cloud.google.com/go/chat

了解详情:

Ruby

如需安装客户端库,请执行以下操作:

gem install google-apps-chat

了解详情:

PHP

如需安装客户端库,请执行以下操作:

  1. 如有必要,请安装依赖项管理器 Composer
  2. 在命令行界面中,运行以下命令:
composer require google/apps-chat

了解详情:

.NET

如需安装客户端库,请执行以下操作:

安装 NuGet 提供的 Google.Apps.Chat.V1 软件包。以常规方式将其添加到您的项目中(例如,在 Visual Studio 中右键点击项目并选择“Manage NuGet Packages...”)。确保启用了预发布版软件包(例如,在 Visual Studio NuGet 界面中,选中“Include prerelease”复选框)。

如需安装 NuGet 软件包,请访问 NuGet.org 上的 Google.Apis

了解详情:

安装 Google API 客户端库

Google API 客户端库是 Cloud 客户端库的替代方案,可使用 REST 资源和方法以编程方式访问 Chat API。如果您使用的语言没有 Cloud 客户端库,或者您要扩展已在使用这些库的项目,则可能更倾向于使用 Google API 客户端库。

Chat API 为以下语言提供了 Google API 客户端库。选择您要使用的语言:

Go

获取最新的 Go 版 Google Chat API 客户端库(alpha 版)。阅读该客户端库的开发者指南

Java

本页内容介绍了如何通过使用 Java 版 Google API 客户端库开始使用 Google Chat API。如需了解详情,请参阅以下文档:

将客户端库添加到您的项目中

从以下标签页中选择构建环境(Maven 或 Gradle):

JavaScript

阅读该客户端库的开发者指南

.NET

本页内容介绍了如何通过使用 .NET 版 Google API 客户端库开始使用 Google Chat API。如需了解详情,请参阅以下文档:

下载库

安装 NuGet 软件包:Google.Apis

Node.js

获取最新的 Node.js 版 Google Chat API 客户端库。阅读该客户端库的开发者指南

Obj-C

获取最新的 Objective-C 版 Google Chat API 客户端库。阅读该客户端库的开发者指南

PHP

获取最新的 PHP 版 Google Chat API 客户端库。阅读该客户端库的开发者指南

Python

本页内容介绍了如何通过使用 Python 版 Google API 客户端库开始使用 Google Chat API。如需了解详情,请参阅以下文档:

系统要求

安装客户端库

您既可以使用软件包管理器,也可以手动下载并安装 Python 客户端库:

托管安装

利用 pip 或 setuptools 管理安装流程,您可能需要先运行 sudo

  • pip(首选):
    pip install --upgrade google-api-python-client
  • Setuptools
    easy_install --upgrade google-api-python-client

手动安装

  1. 下载最新的 Python 版客户端库
  2. 解压缩代码。
  3. 安装:
    python setup.py install

App Engine

由于 App Engine Python 运行时环境中未安装 Python 客户端库,因此您必须像使用第三方库一样将这些库复制到您的应用中

Ruby

本页内容介绍了如何通过使用 Ruby 版 Google API 客户端库开始使用 Google Chat API。如需了解详情,请参阅以下文档:

安装 google-api-client gem

您可能需要在这些命令前面加上 sudo,具体取决于您的系统。

如果您之前未安装过 Ruby 版 Google API 客户端库,请使用 RubyGems 进行安装:

gem install google-api-client

如果您已安装 gem,请更新至最新版本:

gem update -y google-api-client

Ruby 版 Google API 客户端库使用入门

如需了解如何发出第一个请求,请参阅入门指南

Apps 脚本和客户端库

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

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

身份验证

调用 Chat API 需要进行身份验证。每个 Chat API 方法都需要进行用户身份验证(以代表用户执行操作或访问数据)或应用身份验证(以 Chat 应用身份执行操作或访问数据)。某些方法同时支持用户身份验证和应用身份验证。

如需详细了解 Chat 中的身份验证,请参阅身份验证概览