Method: spaces.search

Google Workspace 組織内のスペースのリストを返します。例については、スペースを検索して管理するをご覧ください。

useAdminAccess が false に設定されている場合、結果は呼び出しユーザーが参加しているスペースに限定されます。管理者権限で検索するには、useAdminAccess を true に設定します。useAdminAccess を false に設定することは、デベロッパー プレビューで利用できます。

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

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 スコープが必要です。

useAdminAccess を false に設定することは、デベロッパー プレビューで利用できます。
pageSize

integer

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

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

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

string

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

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

string

必須。検索クエリ。

useAdminAccess が true に設定されている場合、次のパラメータを使用して検索できます。

  • createTime
  • customer
  • displayName
  • externalUserAllowed
  • lastActiveTime
  • spaceHistoryState
  • spaceType

useAdminAccess が false に設定されている場合:

  • displayName
  • externalUserAllowed
  • spaceType

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

useAdminAccess が true に設定されている場合は customer が必要です。これは、スペースを取得する顧客を示すために使用されます。サポートされる値は customers/my_customer のみです。

displayName は HAS（:）演算子のみを受け入れます。照合するテキストは、まずトークンにトークン化され、各トークンはスペースの displayName 内の任意の場所で、大文字と小文字を区別せずに独立して接頭辞照合されます。たとえば、Fun Eve は Fun event または The evening was fun と一致しますが、notFun event または even とは一致しません。useAdminAccess が false に設定されている場合、意味のある結果を取得するには displayName が必要です。それ以外の場合、デフォルトの動作は空のレスポンスを返すことです。

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" などの間隔を表す場合にのみ使用できます。

次のクエリの例は、useAdminAccess が true に設定されている場合に有効です。

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")

次のクエリの例は、useAdminAccess が false に設定されている場合に有効です。

displayName:"Hello World" AND spaceType = "SPACE"

(displayName:"Hello" OR displayName:"Fun") AND spaceType = "SPACE"

(externalUserAllowed = "true" AND spaceType = "SPACE") // Returns an
empty response.

(externalUserAllowed = "true" AND displayName:"Hello" AND spaceType =
"SPACE")
orderBy

string

省略可。スペースのリストの並べ替え方法。

並べ替えに使用できる属性は次のとおりです。

  • membershipCount.joined_direct_human_user_count - スペースに直接参加した人間のユーザーの数を表します。
  • lastActiveTime - このスペースのトピックに最後に適格なアイテムが追加された日時を示します。
  • createTime - スペースの作成時刻を示します。

useAdminAccess が false の場合、順序付けでサポートされるのは createTime と relevance のみです。管理者以外の検索では、これらのフィールドで DESC のみがサポートされています。

有効な順序付けオペレーションの値は次のとおりです。

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

  • 降順の場合は DESC。

サポートされている構文は、useAdminAccess が true に設定されている場合です。

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

useAdminAccess が false に設定されている場合:

  • createTime DESC
  • relevance DESC

リクエストの本文

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

レスポンスの本文

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

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

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

object (Space)

非推奨: 代わりに、新しい results フィールドを使用してください。リクエストされたスペースのページ。このフィールドは、useAdminAccess が true に設定され、新しい results フィールドに置き換えられた場合にのみ入力されます。
nextPageToken

string

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

integer

すべてのページにわたってクエリに一致するスペースの総数。結果が 10,000 スペースを超える場合、この値は推定値です。
results[]

object (SearchSpaceResult)

出力専用。

クエリに一致した検索結果のリスト。

認可スコープ

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

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

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

SearchSpaceResult

スペース検索の単一の結果アイテム。

JSON 表現 
{
  "space": {
    object (Space)
  }
}
フィールド
space

object (Space)

出力専用。一致したスペース。