Method: people.searchDirectoryPeople

Kimliği doğrulanmış kullanıcının alan dizinindeki, arama sorgusuyla eşleşen alan adı profillerinin ve alan kişilerinin bir 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 önek sorgusu. Hangi alanların eşleştirileceğini belirlemek için readMask'i KULLANMAZ.
readMask

string (FieldMask format)

Zorunlu. Her kişide hangi alanların döndürüleceğini sınırlayan bir alan maskesi. Virgülle ayırarak birden çok alan belirtilebilir. Valid values are:

  • addresses
  • ageRanges
  • biyografiler
  • doğum günleri
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • etkinlikler
  • externalIds
  • cinsiyetler
  • imClients
  • ilgi alanları
  • locales
  • konumlar
  • memberships
  • metadata
  • miscKeywords
  • names
  • takma adlar
  • meslekler
  • organizations
  • phoneNumbers
  • fotoğraflar
  • ilişkiler
  • sipAddresses
  • beceriler
  • urls
  • 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ı ile bağlanmışlarsa 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ındaki değerlerdir (1 ve 500 dahil). Ayarlanmazsa veya 0'a ayarlanırsa varsayılan olarak 100'dür.
pageToken

string

İsteğe bağlı. Önceki bir yanıttan (nextPageToken) alınan sayfa jetonu. Sonraki sayfayı almak için bu kodu sağlayın.

Sayfalara ayırırken, [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] ile paylaşılan 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 yapılan isteğe verilen 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önderilebilecek bir jeton. Bu alan atlanırsa sonraki sayfa yoktur.
totalSize

integer

Listedeki, sayfalara ayırmadan elde edilen 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ılavuzu'na bakın.