Method: people.searchDirectoryPeople
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Kimliği doğrulanan kullanıcının alan dizinindeki ve arama sorgusuyla eşleşen alan adı profillerinin ve alan kişilerinin listesini sağlar.
HTTP isteği
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Sorgu parametreleri
| Parametreler |
query |
string
Zorunlu. Kişideki alanlarla eşleşen ön ek sorgusu. Hangi alanların eşleştirileceğini belirlemek için readMask kullanılMAZ.
|
readMask |
string (FieldMask format)
Zorunlu. Her kullanıcının hangi alanlarının döndürüleceğini kısıtlayan bir alan maskesi. Birden fazla alan virgülle ayrılarak belirtilebilir. Geçerli değerler şunlardır:
- adresler
- ageRanges
- biyografiler
- doğum günleri
- calendarUrls
- clientData
- coverPhotos
- emailAddresses
- etkinlikler
- externalIds
- cinsiyetler
- imClients
- ilgi alanları
- locales
- konumlar
- memberships
- meta veri
- miscKeywords
- isimler
- takma adlar
- meslekler
- kuruluşlar
- phoneNumbers
- fotoğraflar
- ilişkiler
- sipAddresses
- beceriler
- urller
- userDefined
|
sources[] |
enum (DirectorySourceType)
Zorunlu. Döndürülecek dizin kaynakları.
|
mergeSources[] |
enum (DirectoryMergeSourceType)
İsteğe bağlı. E-posta adresleri veya telefon numaraları gibi doğrulanmış birleştirme anahtarları aracılığıyla bağlanmışsa dizin kaynaklarıyla birleştirilecek ek veriler.
|
pageSize |
integer
İsteğe bağlı. Yanıta dahil edilecek kişi sayısı. Geçerli değerler 1 ile 500 arasındadır (1 ve 500 dahil). Ayarlanmamışsa veya 0 olarak ayarlanmışsa varsayılan değeri 100'dür.
|
pageToken |
string
İsteğe bağlı. Önceki bir yanıttan (nextPageToken Sayfalara ayırma işlemi sırasında [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] için sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan ilk çağrıyla eşleşmelidir.
|
İstek içeriği
İstek metni boş olmalıdır.
Yanıt gövdesi
Kimliği doğrulanmış kullanıcının alan dizininde, belirtilen sorguyla eşleşen kişiler için istek yanıtı.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
| JSON gösterimi |
{
"people": [
{
object (Person)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Alanlar |
people[] |
object (Person)
Alan dizininde sorguyla eşleşen kişilerin listesi.
|
nextPageToken |
string
Sonraki sayfayı almak için pageToken olarak gönderilebilen bir jeton. Bu alan atlanırsa sonraki sayfalar olmaz.
|
totalSize |
integer
Sayfalara ayırmadan listedeki toplam öğe sayısı.
|
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamını gerektirir:
https://www.googleapis.com/auth/directory.readonly
Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2024-11-08 UTC.
[null,null,["Son güncelleme tarihi: 2024-11-08 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)."]]
