Method: spaces.search

ユーザーの検索に基づくスペースのリストを返します。ユーザー認証が必要です。対象ユーザーは Google Workspace 組織の管理者である必要があります。リクエストで、useAdminAccess を true に設定します。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
useAdminAccess

boolean

true の場合、このメソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

通話ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。

chat.admin.spaces.readonly または chat.admin.spaces の OAuth 2.0 スコープが必要です。

このメソッドは現在、管理者権限のみをサポートしているため、このフィールドに使用できるのは true のみです。
pageSize

integer

返されるスペースの最大数。サービスはこの値よりも少ない数を返す場合があります。

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

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

string

前の検索スペース呼び出しから受け取ったトークン。このパラメータを指定して、後続のページを取得します。

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

string

必須。検索クエリ。

次のパラメータを使用して検索できます。- createTime - customer - displayName - externalUserAllowed - lastActiveTime - spaceHistoryState - spaceType

createTime と lastActiveTime は、RFC-3339 形式のタイムスタンプを受け入れます。サポートされている比較演算子は、=、<、>、<=、>= です。

customer は必須で、スペースを取得する顧客を示すために使用されます。サポートされている値は customers/my_customer のみです。

displayName は、HAS（:）演算子のみを受け入れます。照合するテキストはまずトークンにトークン化されます。各トークンは、スペースの displayName 内の任意の場所の部分文字列として、大文字と小文字を区別せずに、独立して接頭辞で照合されます。たとえば、Fun Eve は Fun event や The evening was fun と一致しますが、notFun event や even とは一致しません。

externalUserAllowed は、true または false のいずれかを受け入れます。

spaceHistoryState は、space リソースの historyState フィールドの値のみを受け入れます。

spaceType は必須で、有効な値は SPACE のみです。

さまざまなフィールドで AND 演算子のみがサポートされます。有効な例は spaceType = "SPACE" AND displayName:"Hello" で、無効な例は spaceType = "SPACE" OR displayName:"Hello" です。

同じフィールドの中で、spaceType は AND 演算子と OR 演算子をサポートしていません。displayName、spaceHistoryState、externalUserAllowed は OR 演算子のみをサポートしています。lastActiveTime と createTime は、AND と OR の両方の演算子をサポートしています。AND は、lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00" などの間隔を表す場合にのみ使用できます。

次の例のクエリは有効です。

customer = "customers/my_customer" AND spaceType = "SPACE"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")
orderBy

string

省略可。スペースのリストの順序。

並べ替えにサポートされている属性は次のとおりです。

  • membershipCount.joined_direct_human_user_count - スペースに直接参加したユーザーの数を示します。
  • lastActiveTime - このスペースのいずれかのトピックに最後の対象アイテムが追加された時刻を示します。
  • createTime - スペースが作成された時刻を示します。

並べ替えオペレーションの有効な値は次のとおりです。

  • 昇順の場合は ASC。デフォルト値。

  • DESC: 降順

サポートされている構文は次のとおりです。

  • membershipCount.joined_direct_human_user_count DESC
  • membershipCount.joined_direct_human_user_count ASC
  • lastActiveTime DESC
  • lastActiveTime ASC
  • createTime DESC
  • createTime ASC

リクエスト本文

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

レスポンスの本文

検索スペースのリクエストに対応するスペースのリストを含むレスポンス。

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

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

object (Space)

リクエストされたスペースのページ。
nextPageToken

string

次のページを取得するために使用できるトークン。このフィールドが空の場合、後続のページはありません。
totalSize

integer

すべてのページにおける、クエリに一致するスペースの合計数。結果が 10,000 スペースを超える場合、この値は推定値です。

認可スコープ

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

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

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