Method: spaces.search
فهرستی از فضاهای یک سازمان Google Workspace را بر اساس جستجوی سرپرست برمیگرداند.
به احراز هویت کاربر با حقوق مدیر نیاز دارد. در درخواست، useAdminAccess
روی true
تنظیم کنید.
درخواست HTTP
GET https://chat.googleapis.com/v1/spaces:search
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
پارامترها |
---|
useAdminAccess | boolean وقتی true ، روش با استفاده از امتیازات سرپرست Google Workspace کاربر اجرا میشود. کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به chat.admin.spaces.readonly یا chat.admin.spaces OAuth 2.0 نیاز دارد. این روش در حال حاضر فقط از دسترسی ادمین پشتیبانی می کند، بنابراین فقط true برای این فیلد پذیرفته می شود. |
pageSize | integer حداکثر تعداد فاصله برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند. اگر نامشخص باشد، حداکثر 100 فاصله برگردانده می شود. حداکثر مقدار 1000 است. اگر از مقداری بیش از 1000 استفاده می کنید، به طور خودکار به 1000 تغییر می کند. |
pageToken | 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")
|
orderBy | string اختیاری. نحوه ترتیب لیست فضاها ویژگی های پشتیبانی شده برای سفارش عبارتند از: -
membershipCount.joined_direct_human_user_count — تعداد کاربران انسانی را که مستقیماً به یک فضا ملحق شده اند را نشان می دهد. -
lastActiveTime - نشان دهنده زمانی است که آخرین مورد واجد شرایط به هر موضوعی از این فضا اضافه می شود. -
createTime - زمان ایجاد فضا را نشان می دهد.
مقادیر عملیات سفارش معتبر عبارتند از: نحو پشتیبانی شده عبارتند از: -
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 ) صفحه ای از فضاهای درخواستی |
nextPageToken | string نشانه ای که می توان از آن برای بازیابی صفحه بعدی استفاده کرد. اگر این فیلد خالی باشد، هیچ صفحه بعدی وجود ندارد. |
totalSize | integer تعداد کل فضاهایی که با پرس و جو مطابقت دارند، در تمام صفحات. اگر نتیجه بیش از 10000 فاصله باشد، این مقدار تخمینی است. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/chat.admin.spaces
-
https://www.googleapis.com/auth/chat.admin.spaces.readonly
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-02-27 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-02-27 بهوقت ساعت هماهنگ جهانی."],[[["Returns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType."],["Requires administrator privileges and the `useAdminAccess` parameter set to `true` in the request."],["Utilizes the `GET https://chat.googleapis.com/v1/spaces:search` HTTP request with query parameters for customization."],["Needs authorization with either the `chat.admin.spaces` or `chat.admin.spaces.readonly` OAuth scope."],["Response body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces."]]],["To search for Google Workspace spaces, send a `GET` request to `https://chat.googleapis.com/v1/spaces:search`, ensuring admin privileges and setting `useAdminAccess` to `true`. Define the search using query parameters, including a required `query` to filter spaces (by `customer`, `displayName`, etc.), optional `pageSize` and `pageToken` for pagination, and optional `orderBy` for sorting. You must have one of the authorization scopes: `chat.admin.spaces` or `chat.admin.spaces.readonly`. The response will list spaces matching the query.\n"]]