Google Chat API 用戶端程式庫

用戶端程式庫會減少您必須編寫的樣板程式碼，藉此改善開發人員呼叫 Google Chat API 的體驗。本指南將介紹用戶端程式庫，並說明如何安裝這些程式庫。

Chat API 提供 gRPC 和 REST 介面，以及支援這兩種介面的用戶端程式庫。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 上提供的最新版本。

Maven 與 BOM

如果您使用 Maven 搭配 BOM，請將下列指令新增至 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

如果您使用 Maven 而不使用 BOM，請在依附元件中加入以下指令：

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

Gradle

如果您使用 Gradle 而不使用 BOM，請在依附元件中加入以下指令：

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

瞭解詳情：

小茹

如要安裝用戶端程式庫，請按照下列步驟操作：

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)：

Maven

請將以下內容新增到 pom.xml 檔案中：

您可以在這裡找到 Maven Central Repository 提供的所有版本。

Gradle

請將以下內容新增到 build.gradle 檔案中：

您可以在這裡找到 Maven Central Repository 提供的所有版本。

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 的 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 Script 和用戶端程式庫

對於大多數開發人員而言，建議您使用官方支援的 Cloud 用戶端程式庫，以您偏好的語言 (例如 Python、Java 或 Node.js) 呼叫 Google Chat API。

如果您使用 Google Apps Script 編寫程式碼，請使用進階 Chat 服務，而非安裝用戶端程式庫。

驗證

呼叫 Chat API 需要驗證。每個 Chat API 方法都需要使用者驗證 (代表使用者執行動作或存取資料) 或應用程式驗證 (以 Chat 應用程式身分執行動作或存取資料)。部分方法同時支援使用者驗證和應用程式驗證。

如要進一步瞭解 Chat 中的驗證機制，請參閱「驗證總覽」。