Method: spaces.findDirectMessage

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

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

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

次のタイプの認証をサポートしています。

  • 認可スコープを使用したアプリ認証:

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

  • 次のいずれかの認可スコープを使用したユーザー認証:

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
name

string

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

形式: users/{user}。ここで、{user} は People API のユーザーの id または Directory API のユーザーの id です。たとえば、People API のプロフィール ID が 123456789 の場合、name として users/123456789 を使用して、そのユーザーとのダイレクト メッセージを検索できます。ユーザーとして認証されると、メールアドレスを {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

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