Method: spaces.search

فهرستی از فضاهای یک سازمان Google Workspace را بر اساس جستجوی سرپرست برمی‌گرداند.

به احراز هویت کاربر با حقوق مدیر نیاز دارد. در درخواست، useAdminAccess روی true تنظیم کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
use Admin Access

boolean

وقتی true ، روش با استفاده از امتیازات سرپرست Google Workspace کاربر اجرا می‌شود.

کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد.

به chat.admin.spaces.readonly یا chat.admin.spaces OAuth 2.0 نیاز دارد.

این روش در حال حاضر فقط از دسترسی ادمین پشتیبانی می کند، بنابراین فقط true برای این فیلد پذیرفته می شود.

page Size

integer

حداکثر تعداد فاصله برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند.

اگر نامشخص باشد، حداکثر 100 فاصله برگردانده می شود.

حداکثر مقدار 1000 است. اگر از مقداری بیش از 1000 استفاده می کنید، به طور خودکار به 1000 تغییر می کند.

page Token

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 فقط مقادیر را از قسمت historyState یک منبع space می پذیرد.

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

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 )

صفحه ای از فضاهای درخواستی

next Page Token

string

نشانه ای که می توان از آن برای بازیابی صفحه بعدی استفاده کرد. اگر این فیلد خالی باشد، هیچ صفحه بعدی وجود ندارد.

total Size

integer

تعداد کل فضاهایی که با پرس و جو مطابقت دارند، در تمام صفحات. اگر نتیجه بیش از 10000 فاصله باشد، این مقدار تخمینی است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.