Google Chat API  |  Google for Developers (original) (raw)

Google Chat API を使用すると、チャットアプリを構築して、Google Chat とサービスを統合し、スペース、メンバー、メッセージなどのチャット リソースを管理できます。

サービス: chat.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次のディスカバリ ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することもあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

REST リソース: v1.customEmojis

メソッド
create POST /v1/customEmojis カスタム絵文字を作成します。
delete DELETE /v1/{name=customEmojis/*} カスタム絵文字を削除します。
get GET /v1/{name=customEmojis/*} カスタム絵文字の詳細を返します。
list GET /v1/customEmojis 認証済みユーザーに表示されるカスタム絵文字を一覧表示します。
メソッド
download GET /v1/media/{resourceName=**} メディアをダウンロードします。
upload POST /upload/v1/{parent=spaces/*}/attachments:upload 添付ファイルをアップロードします。

REST リソース: v1.spaces

メソッド
completeImport POST /v1/{name=spaces/*}:completeImport 指定されたスペースのインポート プロセスを完了し、ユーザーに表示できるようにします。
create POST /v1/spaces スペースを作成します。
delete DELETE /v1/{name=spaces/*} 名前付きスペースを削除します。
findDirectMessage GET /v1/spaces:findDirectMessage 指定されたユーザーとの既存のダイレクト メッセージを返します。
findGroupChats GET /v1/spaces:findGroupChats spaceType == GROUP_CHAT を持ち、人間メンバーシップに呼び出しユーザーと FindGroupChatsRequest.memberships で指定されたユーザーが正確に含まれているすべてのスペースを返します。
get GET /v1/{name=spaces/*} スペースの詳細を返します。
list GET /v1/spaces 呼び出し元がメンバーになっているスペースを一覧表示します。
patch PATCH /v1/{space.name=spaces/*} スペースを更新します。
search GET /v1/spaces:search 管理者の検索に基づいて、Google Workspace 組織内のスペースのリストを返します。
setup POST /v1/spaces:setup スペースを作成し、指定したユーザーを追加します。

REST リソース: v1.spaces.members

メソッド
create POST /v1/{parent=spaces/*}/members 呼び出し元の Chat 用アプリ、ユーザー、Google グループのメンバーシップを作成します。
delete DELETE /v1/{name=spaces/*/members/*} メンバーシップを削除します。
get GET /v1/{name=spaces/*/members/*} メンバーシップの詳細を返します。
list GET /v1/{parent=spaces/*}/members スペースのメンバーシップを一覧表示します。
patch PATCH /v1/{membership.name=spaces/*/members/*} メンバーシップを更新します。

REST リソース: v1.spaces.messages

メソッド
create POST /v1/{parent=spaces/*}/messages Google Chat スペースにメッセージを作成します。
delete DELETE /v1/{name=spaces/*/messages/*} メッセージを削除します。
get GET /v1/{name=spaces/*/messages/*} メッセージの詳細を返します。
list GET /v1/{parent=spaces/*}/messages 呼び出し元がメンバーであるスペース内のメッセージを一覧表示します。ブロックされたメンバーやスペースからのメッセージも含まれます。
patch PATCH /v1/{message.name=spaces/*/messages/*} メッセージを更新します。
update PUT /v1/{message.name=spaces/*/messages/*} メッセージを更新します。

REST リソース: v1.spaces.messages.attachments

メソッド
get GET /v1/{name=spaces/*/messages/*/attachments/*} メッセージの添付ファイルのメタデータを取得します。

REST リソース: v1.spaces.messages.reactions

メソッド
create POST /v1/{parent=spaces/*/messages/*}/reactions リアクションを作成してメッセージに追加します。
delete DELETE /v1/{name=spaces/*/messages/*/reactions/*} メッセージに対するリアクションを削除します。
list GET /v1/{parent=spaces/*/messages/*}/reactions メッセージに対するリアクションを一覧表示します。

REST リソース: v1.spaces.spaceEvents

メソッド
get GET /v1/{name=spaces/*/spaceEvents/*} Google Chat スペースからイベントを返します。
list GET /v1/{parent=spaces/*}/spaceEvents Google Chat スペースのイベントを一覧表示します。

REST リソース: v1.users.sections

メソッド
create POST /v1/{parent=users/*}/sections Google Chat にセクションを作成します。
delete DELETE /v1/{name=users/*/sections/*} CUSTOM_SECTION 型のセクションを削除します。
list GET /v1/{parent=users/*}/sections Chat ユーザーが利用できるセクションを一覧表示します。
patch PATCH /v1/{section.name=users/*/sections/*} セクションを更新します。
position POST /v1/{name=users/*/sections/*}:position セクションの並べ替え順序を変更します。

REST リソース: v1.users.sections.items

メソッド
list GET /v1/{parent=users/*/sections/*}/items セクション内のアイテムをリスト表示します。
move POST /v1/{name=users/*/sections/*/items/*}:move アイテムをセクション間で移動します。

REST リソース: v1.users.spaces

メソッド
getSpaceReadState GET /v1/{name=users/*/spaces/*/spaceReadState} スペース内のユーザーの既読状態に関する詳細を返します。既読メッセージと未読メッセージの識別に使用されます。
updateSpaceReadState PATCH /v1/{spaceReadState.name=users/*/spaces/*/spaceReadState} スペース内のユーザーの既読状態を更新します。既読メッセージと未読メッセージの識別に使用されます。

REST リソース: v1.users.spaces.spaceNotificationSetting

メソッド
get GET /v1/{name=users/*/spaces/*/spaceNotificationSetting} スペースの通知設定を取得します。
patch PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting} スペースの通知設定を更新します。

REST リソース: v1.users.spaces.threads

メソッド
getThreadReadState GET /v1/{name=users/*/spaces/*/threads/*/threadReadState} スレッド内のユーザーの既読状態に関する詳細を返します。既読メッセージと未読メッセージの識別に使用されます。