Method: spaces.search

فهرستی از فضاها را در یک سازمان‌دهی Google Workspace برمی‌گرداند. برای مثال، به «جستجو و مدیریت فضاها» مراجعه کنید.

وقتی useAdminAccess روی false تنظیم شده باشد، نتایج به فضاهایی محدود می‌شوند که کاربر فراخوانی‌کننده، عضو پیوسته باشد. برای جستجو با امتیازات مدیر، useAdminAccess روی true تنظیم کنید.

از انواع احراز هویت زیر پشتیبانی می‌کند:

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
useAdminAccess

boolean

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

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

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

pageSize

integer

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

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

وقتی useAdminAccess روی true تنظیم شده باشد، حداکثر مقدار ۱۰۰۰ است. در غیر این صورت، حداکثر مقدار ۱۰۰ است. اگر مقداری بیشتر از حداکثر مقدار استفاده کنید، به طور خودکار به حداکثر مقدار تغییر می‌کند.

pageToken

string

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

هنگام صفحه‌بندی، تمام پارامترهای دیگر ارائه شده باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشند. ارسال مقادیر متفاوت به سایر پارامترها ممکن است منجر به نتایج غیرمنتظره‌ای شود.

query

string

الزامی. یک عبارت جستجو.

وقتی useAdminAccess روی true تنظیم شده باشد، می‌توانید با استفاده از پارامترهای زیر جستجو کنید:

  • createTime
  • customer
  • displayName
  • externalUserAllowed
  • lastActiveTime
  • spaceHistoryState
  • spaceType

وقتی useAdminAccess روی false تنظیم شده باشد:

  • displayName
  • externalUserAllowed
  • spaceType

createTime و lastActiveTime یک مهر زمانی با فرمت RFC-3339 می‌پذیرند و عملگرهای مقایسه‌ای پشتیبانی‌شده عبارتند از: = ، < ، > ، <= ، >= .

وقتی useAdminAccess روی true تنظیم شده باشد، customer الزامی است و برای نشان دادن اینکه از کدام مشتری باید فضاها را دریافت کرد، استفاده می‌شود. customers/my_customer تنها مقدار پشتیبانی شده است.

displayName فقط عملگر HAS ( : ) را می‌پذیرد. متنی که باید مطابقت داده شود، ابتدا به توکن‌ها تبدیل می‌شود و هر توکن بدون حساسیت به حروف بزرگ و کوچک، به صورت پیشوندی و مستقل به عنوان یک زیررشته در هر کجای فضای displayName تطبیق داده می‌شود. برای مثال، Fun Eve با Fun event یا The evening was fun مطابقت دارد، اما notFun event یا even مطابقت ندارد. وقتی useAdminAccess روی false تنظیم شده باشد، displayName برای بازیابی نتایج معنادار مورد نیاز است. در غیر این صورت، رفتار پیش‌فرض، بازگرداندن یک پاسخ خالی است.

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

کوئری‌های مثال زیر زمانی معتبر هستند که useAdminAccess روی true تنظیم شده باشد:

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

کوئری‌های مثال زیر زمانی معتبر هستند که useAdminAccess روی false تنظیم شده باشد:

displayName:"Hello World" AND spaceType = "SPACE"

(displayName:"Hello" OR displayName:"Fun") AND spaceType = "SPACE"

(externalUserAllowed = "true" AND spaceType = "SPACE") // Returns an
empty response.

(externalUserAllowed = "true" AND displayName:"Hello" AND spaceType =
"SPACE")

حداکثر طول پرس و جو ۱۰۰۰ کاراکتر است.

درخواست‌های نامعتبر توسط سرور با خطای INVALID_ARGUMENT رد می‌شوند.

orderBy

string

اختیاری. نحوه‌ی مرتب شدن لیست فاصله‌ها.

ویژگی‌های پشتیبانی‌شده برای سفارش بر اساس موارد زیر هستند:

  • membershipCount.joined_direct_human_user_count — تعداد کاربران انسانی را که مستقیماً به یک فضا پیوسته‌اند، نشان می‌دهد.
  • lastActiveTime — نشان دهنده زمانی است که آخرین مورد واجد شرایط به هر موضوعی از این فضا اضافه شده است.
  • createTime — زمان ایجاد فضا را نشان می‌دهد.

وقتی useAdminAccess false باشد، فقط createTime و relevance برای مرتب‌سازی پشتیبانی می‌شوند. فقط DESC برای این فیلدها در جستجوهای غیر مدیر پشتیبانی می‌شود.

مقادیر معتبر عملیات سفارش عبارتند از:

  • ASC برای نمایش صعودی. مقدار پیش‌فرض.

  • DESC برای نزولی.

سینتکس پشتیبانی شده زمانی است که useAdminAccess روی true تنظیم شده باشد:

  • membershipCount.joined_direct_human_user_count DESC
  • membershipCount.joined_direct_human_user_count ASC
  • lastActiveTime DESC
  • lastActiveTime ASC
  • createTime DESC
  • createTime ASC

وقتی useAdminAccess روی false تنظیم شده باشد:

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پاسخ با فهرستی از فضاهای مربوط به درخواست فضاهای جستجو.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer,
  "results": [
    {
      object (SearchSpaceResult)
    }
  ]
}
فیلدها
spaces[]
(deprecated)

object ( Space )

منسوخ شده: لطفاً به جای آن از فیلد results جدید استفاده کنید. صفحه‌ای از فضاهای درخواستی. این فیلد فقط زمانی پر می‌شود که useAdminAccess روی true تنظیم شده باشد و به نفع فیلد results جدید منسوخ شده باشد.

nextPageToken

string

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

فقط زمانی که useAdminAccess روی true تنظیم شده باشد، پر می‌شود.

totalSize

integer

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

فقط زمانی که useAdminAccess روی true تنظیم شده باشد، پر می‌شود.

results[]

object ( SearchSpaceResult )

فقط خروجی. فهرست نتایج جستجو که با عبارت جستجو شده مطابقت دارند.

دامنه‌های مجوز

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

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

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

نتیجه جستجوفضا

یک مورد نتیجه واحد از جستجوی فضا.

نمایش JSON 
{
  "space": {
    object (Space)
  }
}
فیلدها
space

object ( Space )

فقط خروجی. فضای منطبق.