Method: spaces.findDirectMessage

指定したユーザーの既存のダイレクト メッセージを返します。ダイレクト メッセージ スペースが見つからない場合は、404 NOT_FOUND エラーを返します。例については、ダイレクト メッセージを検索するをご覧ください。

ユーザー認証では、指定されたユーザーと認証されたユーザーの間のダイレクト メッセージ スペースを返します。

アプリ認証では、指定したユーザーと呼び出し元の Chat アプリとの間のダイレクト メッセージ スペースを返します。

ユーザー認証またはアプリの認証が必要です。

HTTP リクエスト

GET https://chat.googleapis.com/v1/spaces:findDirectMessage

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
name

string

必須。ダイレクト メッセージを検索するユーザーのリソース名。

形式: users/{user}。ここで、{user} は People API の id （ユーザー）または user （Directory API）です。idたとえば、People API のプロファイル ID が 123456789 の場合、users/123456789 を name として使用すると、そのユーザーとのダイレクト メッセージを検索できます。ユーザーとして認証されると、そのメールを {user} のエイリアスとして使用できます。たとえば、users/example@gmail.com のようにします。ここで、example@gmail.com は Google Chat ユーザーのメールアドレスです。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Space のインスタンスが含まれます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

詳しくは、承認ガイドをご覧ください。