Method: spaces.search

boolean

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

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

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

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

integer

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

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

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

string

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

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

string

必須。検索語句。

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

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

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

• displayName
• externalUserAllowed

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 は、historyState リソースの space フィールドの値のみを受け入れます。

useAdminAccess が true に設定されている場合は 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"

(displayName:"Hello" OR displayName:"Fun")

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

(externalUserAllowed = "true" AND displayName:"Hello")

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

object (Space)

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