Method: spaces.findGroupChats

spaceType == GROUP_CHAT のすべてのスペースを返します。これらのスペースのユーザー メンバーシップには、呼び出し元のユーザーと FindGroupChatsRequest.users で指定されたユーザーが正確に含まれています。会話に参加しているメンバーのみがサポートされます。例については、グループ チャットを検索するをご覧ください。

呼び出し元のユーザーが一部のユーザーをブロックしている場合、または一部のユーザーによってブロックされている場合、指定されたユーザーのセット全体を含むスペースが見つからない場合、このメソッドはブロックされたユーザーまたはブロックしているユーザーを含まないスペースを返します。

指定されたユーザーのセットには、ユーザー（アプリ以外）のメンバーシップのみを含める必要があります。ユーザー以外のユーザーを含むリクエストは、スペースを返しません。

次のいずれかの認可スコープでユーザー認証が必要です。

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
users[]

string

省略可。呼び出し元のユーザーとのグループ チャットに参加しているすべてのユーザーのリソース名。Chat アプリをリクエストに含めることはできません。

1 回のリクエストで指定できるユーザーの最大数は 49 です。

形式: users/{user}。{user} は、People API の ユーザーの id または Directory API の ユーザーの id です。たとえば、呼び出し元のユーザーと他の 2 人のユーザー（People API プロファイル ID が 123456789 と 987654321）とのすべてのグループ チャットを検索するには、users/123456789 と users/987654321 を使用します。メールアドレスを {user} のエイリアスとして使用することもできます。たとえば、users/example@gmail.com の場合、example@gmail.com は Google Chat ユーザーのメールアドレスです。
pageSize

integer

省略可。返されるスペースの最大数。サービスから返される値は、この値よりも小さくなる可能性があります。

指定しない場合、最大 10 個のスペースが返されます。

最大値は 30 です。30 を超える値を使用すると、自動的に 30 に変更されます。

負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
pageToken

string

省略可。グループ チャットの検索に対する前回の呼び出しから受け取ったページトークン。このパラメータを指定すると、次のページを取得できます。

ページ分割を行う場合、指定した他のパラメータはすべて、トークンを提供した呼び出しと一致する必要があります。異なる値を渡すと、予期しない結果が生じる可能性があります。
spaceView

enum (SpaceView)

リクエストされたスペースビューのタイプ。設定されていない場合、デフォルトは SPACE_VIEW_RESOURCE_NAME_ONLY です。SPACE_VIEW_EXPANDED を指定するリクエストには、スペースデータの読み取りを許可するスコープ（https://www.googleapis.com/auth/chat.spaces や https://www.googleapis.com/auth/chat.spaces.readonly など）を含める必要があります。

リクエストの本文

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

レスポンスの本文

呼び出し元のユーザーとリクエストされたユーザーが正確に含まれるグループ チャット スペースを含むレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
フィールド
spaces[]

object (Space)

リクエストされたページ（または最初のページ）のスペースのリスト。
nextPageToken

string

pageToken として送信して、結果の次のページを取得できるトークン。空の場合、後続のページはありません。

認可スコープ

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

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

詳細については、認可ガイドをご覧ください。

SpaceView

Space リソースに設定するフィールドを指定するビュー。今後のリリースとの互換性を確保するため、コードで追加の値を考慮することをおすすめします。

列挙型
SPACE_VIEW_UNSPECIFIED デフォルト値 / 未設定の値。
SPACE_VIEW_RESOURCE_NAME_ONLY スペースのリソース名のみを設定します。
SPACE_VIEW_EXPANDED スペースのリソース フィールドを設定します。注: permissionSettings フィールドは設定されません。SPACE_VIEW_EXPANDED を指定するリクエストには、スペースデータの読み取りを許可するスコープ（https://www.googleapis.com/auth/chat.spaces や https://www.googleapis.com/auth/chat.spaces.readonly など）を含める必要があります。