useAdminAccess
を true
に設定します。
HTTP リクエスト
GET https://chat.googleapis.com/v1/spaces:search
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
useAdminAccess |
通話ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
このメソッドは現在、管理者権限のみをサポートしているため、このフィールドに使用できるのは |
pageSize |
返されるスペースの最大数。サービスはこの値よりも少ない数を返す場合があります。 指定しない場合は、最大 100 個のスペースが返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 |
pageToken |
前の検索スペース呼び出しから受け取ったトークン。このパラメータを指定して、後続のページを取得します。 ページ分割の際に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。 |
query |
必須。検索クエリ。 次のパラメータを使用して検索できます。-
さまざまなフィールドで 同じフィールドの中で、 次の例のクエリは有効です。
|
orderBy |
省略可。スペースのリストの順序。 並べ替えにサポートされている属性は次のとおりです。
並べ替えオペレーションの有効な値は次のとおりです。
サポートされている構文は次のとおりです。
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
検索スペースのリクエストに対応するスペースのリストを含むレスポンス。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{
"spaces": [
{
object ( |
フィールド | |
---|---|
spaces[] |
リクエストされたスペースのページ。 |
nextPageToken |
次のページを取得するために使用できるトークン。このフィールドが空の場合、後続のページはありません。 |
totalSize |
すべてのページにおける、クエリに一致するスペースの合計数。結果が 10,000 スペースを超える場合、この値は推定値です。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
詳しくは、承認ガイドをご覧ください。