Method: spaces.search

একটি গুগল ওয়ার্কস্পেস অর্গানাইজেশনের স্পেসগুলির একটি তালিকা ফেরত দেয়। একটি উদাহরণের জন্য, ‘স্পেস অনুসন্ধান ও পরিচালনা’ দেখুন।

যখন useAdminAccess false এ সেট করা হয়, তখন ফলাফল সেইসব স্পেসের মধ্যে সীমাবদ্ধ থাকে যেখানে আহ্বানকারী ব্যবহারকারী একজন যোগদানকারী সদস্য। অ্যাডমিনিস্ট্রেটর অধিকার সহ অনুসন্ধান করতে, useAdminAccess true তে সেট করুন। useAdminAccess কে false এ সেট করার সুবিধাটি ডেভেলপার প্রিভিউ-তে উপলব্ধ।

নিম্নলিখিত ধরণের প্রমাণীকরণ সমর্থন করে:

HTTP অনুরোধ

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

URL-টিতে gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করা হয়েছে।

কোয়েরি প্যারামিটার

প্যারামিটার
useAdminAccess

boolean

যখন true , তখন মেথডটি ব্যবহারকারীর গুগল ওয়ার্কস্পেস অ্যাডমিনিস্ট্রেটর প্রিভিলেজ ব্যবহার করে রান করে।

কলকারী ব্যবহারকারীকে অবশ্যই একজন গুগল ওয়ার্কস্পেস অ্যাডমিনিস্ট্রেটর হতে হবে, যার চ্যাট এবং স্পেস কথোপকথন পরিচালনা করার বিশেষাধিকার রয়েছে

এর জন্য chat.admin.spaces.readonly অথবা chat.admin.spaces OAuth 2.0 স্কোপ প্রয়োজন।

useAdminAccess কে false এ সেট করার সুবিধাটি ডেভেলপার প্রিভিউ-তে উপলব্ধ।

pageSize

integer

ফেরত দেওয়ার জন্য সর্বাধিক সংখ্যক স্পেস। পরিষেবাটি এই মানের চেয়ে কমও ফেরত দিতে পারে।

অনির্দিষ্ট থাকলে, সর্বাধিক ১০০টি স্পেস ফেরত দেওয়া হয়।

সর্বোচ্চ মান হলো ১০০০। আপনি যদি ১০০০-এর বেশি কোনো মান ব্যবহার করেন, তবে তা স্বয়ংক্রিয়ভাবে ১০০০-এ পরিবর্তিত হয়ে যাবে।

pageToken

string

পূর্ববর্তী সার্চ স্পেস কল থেকে প্রাপ্ত একটি টোকেন। পরবর্তী পৃষ্ঠাটি পুনরুদ্ধার করতে এই প্যারামিটারটি প্রদান করুন।

পেজিনেশন করার সময়, প্রদত্ত অন্যান্য সমস্ত প্যারামিটার অবশ্যই সেই কলের সাথে মিলতে হবে যা পেজ টোকেনটি প্রদান করেছে। অন্যান্য প্যারামিটারগুলিতে ভিন্ন মান দিলে অপ্রত্যাশিত ফলাফল হতে পারে।

query

string

আবশ্যক। একটি অনুসন্ধান ক্যোয়ারি।

যখন useAdminAccess true সেট করা থাকে, তখন আপনি নিম্নলিখিত প্যারামিটারগুলো ব্যবহার করে অনুসন্ধান করতে পারেন:

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

যখন useAdminAccess false সেট করা থাকে :

  • displayName
  • externalUserAllowed

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 শুধুমাত্র একটি space রিসোর্সের historyState ফিল্ড থেকে মান গ্রহণ করে।

যখন useAdminAccess true সেট করা থাকে, তখন spaceType আবশ্যক, এবং এর একমাত্র বৈধ মান হলো SPACE

বিভিন্ন ফিল্ড জুড়ে শুধুমাত্র AND অপারেটর সমর্থিত। একটি বৈধ উদাহরণ হলো spaceType = "SPACE" AND displayName:"Hello" এবং একটি অবৈধ উদাহরণ হলো spaceType = "SPACE" OR displayName:"Hello"

একই ফিল্ডের মধ্যে, spaceType AND বা OR অপারেটর সাপোর্ট করে না। displayName , 'spaceHistoryState', এবং 'externalUserAllowed' শুধুমাত্র OR অপারেটর সাপোর্ট করে। lastActiveTime এবং createTime ANDOR উভয় অপারেটরই সাপোর্ট করে। 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"

(displayName:"Hello" OR displayName:"Fun")

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

(externalUserAllowed = "true" AND displayName:"Hello")
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 সেট করা থাকে :

  • createTime DESC
  • relevance DESC

অনুরোধকারী শরীর

অনুরোধের মূল অংশ অবশ্যই খালি হতে হবে।

প্রতিক্রিয়া সংস্থা

অনুসন্ধানের স্থানগুলোর অনুরোধ অনুযায়ী স্থানগুলোর একটি তালিকা সহ প্রতিক্রিয়া।

সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:

JSON উপস্থাপনা
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer,
  "results": [
    {
      object (SearchSpaceResult)
    }
  ]
}
ক্ষেত্র
spaces[]
(deprecated)

object ( Space )

অপ্রচলিত: অনুগ্রহ করে এর পরিবর্তে নতুন results ক্ষেত্রটি ব্যবহার করুন। অনুরোধকৃত স্থানগুলোর একটি পৃষ্ঠা। এই ক্ষেত্রটি শুধুমাত্র তখনই পূরণ করা হবে যখন useAdminAccess true তে সেট করা হবে এবং নতুন results ক্ষেত্রের পক্ষে এটি অপ্রচলিত।

nextPageToken

string

একটি টোকেন যা পরবর্তী পৃষ্ঠা আনার জন্য ব্যবহার করা যেতে পারে। এই ক্ষেত্রটি খালি থাকলে, এর পরে আর কোনো পৃষ্ঠা নেই।

totalSize

integer

সমস্ত পৃষ্ঠা জুড়ে, কোয়েরির সাথে মিলে যাওয়া স্পেসের মোট সংখ্যা। যদি ফলাফল ১০,০০০ স্পেসের বেশি হয়, তবে এই মানটি একটি আনুমানিক হিসাব।

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 )

শুধুমাত্র আউটপুট। মিলে যাওয়া স্থানটি।