به chat.admin.spaces.readonly یا chat.admin.spacesOAuth 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 .
externalUserAllowedtrue یا 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 - نشان دهنده زمانی است که آخرین مورد واجد شرایط به هر موضوعی از این فضا اضافه می شود.
تاریخ آخرین بهروزرسانی 2025-01-24 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2025-01-24 بهوقت ساعت هماهنگ جهانی."],[[["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."]]],[]]