Method: spaces.search

boolean

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

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

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

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

integer

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

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

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

string

前回の search spaces 呼び出しから受け取ったトークン。このパラメータを指定すると、後続のページを取得できます。

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

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

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