Method: people.searchDirectoryPeople

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) alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın.

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.