クライアント ライブラリを使用すると、記述する必要があるボイラープレート コードを減らして、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 で入手可能な最新リリースにバージョンを更新してください。
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"
パッケージをシステムにインストールするには:
- プロジェクト ディレクトリ
cd /my/cloud/project
に移動します。 - 使用するパッケージを取得します。
go get cloud.google.com/go/chat
詳細:
Ruby
クライアント ライブラリをインストールするには:
gem install google-apps-chat
詳細:
PHP
クライアント ライブラリをインストールするには:
- 必要に応じて、依存関係マネージャー Composer をインストールします。
- コマンドライン インターフェースから、次のコマンドを実行します。
composer require google/apps-chat
詳細:
.NET
クライアント ライブラリをインストールするには:
NuGet から Google.Apps.Chat.V1
パッケージをインストールします。通常の方法でプロジェクトに追加します(たとえば、Visual Studio でプロジェクトを右クリックして [NuGet パッケージの管理...] を選択します)。プレリリース版パッケージを有効にします(たとえば、Visual Studio NuGet ユーザー インターフェースで [プレリリースを含める] ボックスをオンにします)。
NuGet パッケージをインストールするには、NuGet.org の Google.Apis にアクセスしてください。
詳細:
Google API クライアント ライブラリをインストールする
Cloud クライアント ライブラリの代替として、Google API クライアント ライブラリを使用すると、REST リソースとメソッドを使用して Chat API にプログラムでアクセスできます。Cloud クライアント ライブラリがない言語を使用している場合や、すでに Cloud クライアント ライブラリを使用しているプロジェクトを拡張する場合は、Google API クライアント ライブラリの使用をおすすめします。
Chat API には、次の言語用の Google API クライアント ライブラリが用意されています。使用する言語を選択します。
Go
最新の Go 用 Google Chat API クライアント ライブラリ(アルファ版)を入手します。クライアント ライブラリのデベロッパー ガイドをご覧ください。
Java
このページには、Java 用 Google API クライアント ライブラリを使用して Google Chat API の使用を開始するための情報が記載されています。詳しくは以下のドキュメントをご覧ください。
クライアント ライブラリをプロジェクトに追加する
以下のタブからビルド環境(Maven または Gradle)を選択します。
次のコードを pom.xml
ファイルに追加します。
次のコードを build.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 の使用を開始するための情報が記載されています。詳しくは以下のドキュメントをご覧ください。
システム要件
- オペレーティング システム:
- Linux
- macOS X
- Windows
- Python 2.7 または 3.4 以降
クライアント ライブラリをインストールする
パッケージ マネージャーを使用するか、Python クライアント ライブラリを手動でダウンロードしてインストールできます。
マネージド インストール
pip または setuptools を使用してインストールを管理します。最初に sudo
を実行しなければならない場合があります。
- pip(推奨):
pip install --upgrade google-api-python-client
- setuptools:
easy_install --upgrade google-api-python-client
手動インストール
- 最新の Python 用クライアント ライブラリをダウンロードします。
- コードを解凍します。
- 以下をインストールします。
python setup.py install
App Engine
Python クライアント ライブラリは App Engine 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 Script とクライアント ライブラリ
ほとんどのデベロッパーが Google Chat API を呼び出すには、Python、Java、Node.js などの任意の言語で公式にサポートされている Cloud クライアント ライブラリを使用することをおすすめします。
Google Apps Script でコーディングする場合は、クライアント ライブラリをインストールする代わりに、Advanced Chat サービスを使用します。
認証
Chat API を呼び出すには認証が必要です。各 Chat API メソッドでは、ユーザー認証(ユーザーに代わってアクションを実行する、またはユーザーに代わってデータにアクセスする)またはアプリ認証(Chat アプリとしてアクションを実行する、または Chat アプリとしてデータにアクセスする)のいずれかが必要です。一部の方法は、ユーザー認証とアプリ認証の両方をサポートしています。
Chat での認証の詳細については、認証の概要をご覧ください。