Method: people.searchDirectoryPeople
সেভ করা পৃষ্ঠা গুছিয়ে রাখতে 'সংগ্রহ' ব্যবহার করুন
আপনার পছন্দ অনুযায়ী কন্টেন্ট সেভ করুন ও সঠিক বিভাগে রাখুন।
প্রমাণীকৃত ব্যবহারকারীর ডোমেন ডিরেক্টরিতে ডোমেন প্রোফাইল এবং ডোমেন পরিচিতিগুলির একটি তালিকা প্রদান করে যা অনুসন্ধান ক্যোয়ারির সাথে মেলে৷
HTTP অনুরোধ
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
URL gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করে।
ক্যোয়ারী প্যারামিটার
| পরামিতি |
|---|
query | string প্রয়োজন। প্রিফিক্স কোয়েরি যা ব্যক্তির ক্ষেত্রের সাথে মেলে। কোন ক্ষেত্রগুলি মেলে তা নির্ধারণের জন্য readMask ব্যবহার করে না। |
readMask | string ( FieldMask format) প্রয়োজন। প্রতিটি ব্যক্তির কোন ক্ষেত্রগুলি ফেরত দেওয়া হবে তা সীমাবদ্ধ করার জন্য একটি ফিল্ড মাস্ক৷ একাধিক ক্ষেত্র কমা দিয়ে আলাদা করে নির্দিষ্ট করা যেতে পারে। বৈধ মান হল: - ঠিকানা
- বয়সসীমা
- জীবনী
- জন্মদিন
- ক্যালেন্ডার ইউআরএল
- ক্লায়েন্ট ডেটা
- কভারফটো
- ইমেইল ঠিকানা
- ঘটনা
- বাহ্যিক আইডি
- লিঙ্গ
- ক্লায়েন্ট
- স্বার্থ
- লোকেল
- অবস্থান
- সদস্যপদ
- মেটাডেটা
- মিসকিওয়ার্ড
- নাম
- ডাকনাম
- পেশা
- সংগঠন
- ফোন নম্বর
- ফটো
- সম্পর্ক
- sip ঠিকানা
- দক্ষতা
- ইউআরএল
- ব্যবহারকারী সংজ্ঞায়িত
|
sources[] | enum ( DirectorySourceType ) প্রয়োজন। ফিরতি নির্দেশিকা সূত্র. |
mergeSources[] | enum ( DirectoryMergeSourceType ) ঐচ্ছিক। নির্দেশিকা উত্সগুলিতে একত্রিত করার জন্য অতিরিক্ত ডেটা যদি সেগুলি যাচাইকৃত জয়েন কীগুলির মাধ্যমে সংযুক্ত থাকে যেমন ইমেল ঠিকানা বা ফোন নম্বর৷ |
pageSize | integer ঐচ্ছিক। প্রতিক্রিয়ায় অন্তর্ভুক্ত করার জন্য লোকের সংখ্যা। বৈধ মান 1 থেকে 500 এর মধ্যে, অন্তর্ভুক্ত। ডিফল্ট 100 সেট না থাকলে বা 0 এ সেট করা হয়। |
pageToken | string ঐচ্ছিক। একটি পৃষ্ঠা টোকেন, একটি পূর্ববর্তী প্রতিক্রিয়া nextPageToken পেজিন করার সময়, [ people.searchDirectoryPeople ][google.people.v1.SearchDirectoryPeople] কে প্রদত্ত অন্যান্য সমস্ত প্যারামিটার অবশ্যই পৃষ্ঠার টোকেন প্রদানকারী প্রথম কলের সাথে মেলে। |
শরীরের অনুরোধ
অনুরোধের বডি খালি হতে হবে।
প্রতিক্রিয়া শরীর
প্রমাণীকৃত ব্যবহারকারীর ডোমেন ডিরেক্টরির লোকেদের অনুরোধের প্রতিক্রিয়া যা নির্দিষ্ট প্রশ্নের সাথে মেলে।
সফল হলে, প্রতিক্রিয়া বডিতে নিম্নলিখিত কাঠামোর সাথে ডেটা থাকে:
| JSON প্রতিনিধিত্ব |
|---|
{
"people": [
{
object (Person)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| ক্ষেত্র |
|---|
people[] | object ( Person ) ডোমেন ডিরেক্টরিতে থাকা লোকেদের তালিকা যা কোয়েরির সাথে মেলে। |
nextPageToken | string একটি টোকেন, যা পরবর্তী পৃষ্ঠা পুনরুদ্ধার করতে pageToken হিসাবে পাঠানো যেতে পারে। যদি এই ক্ষেত্রটি বাদ দেওয়া হয়, তাহলে পরবর্তী পৃষ্ঠা থাকবে না। |
totalSize | integer পেজিনেশন ছাড়া তালিকায় মোট আইটেম সংখ্যা. |
অনুমোদনের সুযোগ
নিম্নলিখিত OAuth সুযোগ প্রয়োজন:
-
https://www.googleapis.com/auth/directory.readonly
আরও তথ্যের জন্য, অনুমোদন নির্দেশিকা দেখুন।
অন্য কিছু উল্লেখ না করা থাকলে, এই পৃষ্ঠার কন্টেন্ট Creative Commons Attribution 4.0 License-এর অধীনে এবং কোডের নমুনাগুলি Apache 2.0 License-এর অধীনে লাইসেন্স প্রাপ্ত। আরও জানতে, Google Developers সাইট নীতি দেখুন। Java হল Oracle এবং/অথবা তার অ্যাফিলিয়েট সংস্থার রেজিস্টার্ড ট্রেডমার্ক।
2024-11-14 UTC-তে শেষবার আপডেট করা হয়েছে।
[null,null,["2024-11-14 UTC-তে শেষবার আপডেট করা হয়েছে।"],[[["\u003cp\u003eSearch for people in your domain directory using a prefix query that matches various person fields.\u003c/p\u003e\n"],["\u003cp\u003eCustomize the search by specifying fields to return, directory sources, and optional data merging.\u003c/p\u003e\n"],["\u003cp\u003eResults are paginated with controls for page size and retrieval of subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/directory.readonly\u003c/code\u003e scope for read access to the directory.\u003c/p\u003e\n"]]],["This describes how to search for people in a domain directory. Use a `GET` request to `https://people.googleapis.com/v1/people:searchDirectoryPeople`. Required query parameters include `query`, `readMask`, and `sources`. Optional parameters are `mergeSources`, `pageSize`, and `pageToken`. The request body is empty. The response contains a list of matching `people`, `nextPageToken` for pagination, and `totalSize`. Requires `directory.readonly` authorization scope.\n"],null,["# Method: people.searchDirectoryPeople\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchDirectoryPeopleResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nProvides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.\n\n### HTTP request\n\n`GET https://people.googleapis.com/v1/people:searchDirectoryPeople`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `string` Required. Prefix query that matches fields in the person. Does NOT use the readMask for determining what fields to match. |\n| `readMask` | `string (`[FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: - addresses - ageRanges - biographies - birthdays - calendarUrls - clientData - coverPhotos - emailAddresses - events - externalIds - genders - imClients - interests - locales - locations - memberships - metadata - miscKeywords - names - nicknames - occupations - organizations - phoneNumbers - photos - relations - sipAddresses - skills - urls - userDefined |\n| `sources[]` | `enum (`[DirectorySourceType](/people/api/rest/v1/DirectorySourceType)`)` Required. Directory sources to return. |\n| `mergeSources[]` | `enum (`[DirectoryMergeSourceType](/people/api/rest/v1/DirectoryMergeSourceType)`)` Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. |\n| `pageSize` | `integer` Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0. |\n| `pageToken` | `string` Optional. A page token, received from a previous response [`nextPageToken`](/people/api/rest/v1/people/searchDirectoryPeople#body.SearchDirectoryPeopleResponse.FIELDS.next_page_token). Provide this to retrieve the subsequent page. When paginating, all other parameters provided to \\[`people.searchDirectoryPeople`\\]\\[google.people.v1.SearchDirectoryPeople\\] must match the first call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response to a request for people in the authenticated user's domain directory that match the specified query.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"people\": [ { object (/people/api/rest/v1/people#Person) } ], \"nextPageToken\": string, \"totalSize\": integer } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `people[]` | `object (`[Person](/people/api/rest/v1/people#Person)`)` The list of people in the domain directory that match the query. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n| `totalSize` | `integer` The total number of items in the list without pagination. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/directory.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
