Method: spaces.findGroupChats

spaceType == GROUP_CHAT を持ち、人間メンバーシップに呼び出しユーザーと FindGroupChatsRequest.memberships で指定されたユーザーが正確に含まれているすべてのスペースを返します。

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

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

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

  • 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 構文を使用します。

クエリ パラメータ

パラメータ
user[]

string

通話中のユーザーとのグループ チャットに参加しているすべてのユーザーのリソース名。Chat 用アプリはリクエストに含めることはできません。

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

呼び出しユーザーが Google Workspace ユーザーの場合、リクエストされたすべてのユーザーは、呼び出しユーザーと同じ Google Workspace 組織のメンバーである必要があります。
pageSize

integer

省略可。返すスペースの最大数。サービスが返す値はこれよりも少ないことがあります。

指定されていない場合は、最大で 100 個のスペースが返されます。

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

負の値は 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 リソース名のみを入力します。
SPACE_VIEW_EXPANDED Space リソースのフィールドに入力します。注: permissionSettings フィールドには値が入力されません。SPACE_VIEW_EXPANDED を指定するリクエストには、スペースデータの読み取りを許可するスコープ（https://www.googleapis.com/auth/chat.spaces や https://www.googleapis.com/auth/chat.spaces.readonly など）を含める必要があります。