Method: people.searchDirectoryPeople
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يوفّر هذا الحقل قائمة بالملفات الشخصية للنطاقات وجهات اتصال النطاق في دليل نطاق المستخدم الذي تمّت المصادقة عليه والتي تتطابق مع طلب البحث.
طلب HTTP
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات طلب البحث
| المعلمات |
query |
string
مطلوب. طلب بحث بادئة يتطابق مع الحقول في الشخص لا يستخدم readMask لتحديد الحقول التي ستتم مطابقتها.
|
readMask |
string (FieldMask format)
مطلوب. قناع حقل لتقييد الحقول التي يتم عرضها لكل شخص يمكن تحديد حقول متعددة من خلال الفصل بينها بفواصل. القيم الصالحة هي:
- عناوين
- ageRanges
- السير الذاتية
- أعياد الميلاد
- calendarUrls
- clientData
- coverPhotos
- emailAddresses
- الفعاليات
- externalIds
- أنواع
- imClients
- الاهتمامات
- اللغات
- مواقع جغرافية
- للقناة
- البيانات الوصفية
- miscKeywords
- الأسماء
- الألقاب
- المهن
- المؤسسات
- phoneNumbers
- photos
- العلاقات
- sipAddresses
- مهارات
- عناوين url
- userDefined
|
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 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-11-08 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2024-11-08 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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)."]]
