Method: people.listDirectoryPeople

Kimlik doğrulaması yapılmış kullanıcının alan dizininde alan profillerinin ve alan kişilerinin listesini sağlar.

syncToken belirtildiğinde, son senkronizasyondan sonra silinen kaynaklar, PersonMetadata.deleted özelliği doğru değerine ayarlanmış bir kişi olarak döndürülür.

pageToken veya syncToken belirtildiğinde diğer tüm istek parametreleri ilk çağrıyla eşleşmelidir.

Senkronizasyon istekleri için yazma işlemlerinde birkaç dakikalık bir dağıtım gecikmesi olabilir. Artımlı senkronizasyonlar, yazma sonrası okuma kullanım alanları için tasarlanmamıştır.

Değiştirilen dizin kullanıcılarını listeleme başlıklı makalede örnek kullanıma bakın.

HTTP isteği

GET https://people.googleapis.com/v1/people:listDirectoryPeople

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Sorgu parametreleri

Parametreler
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 1.000 (bu değerler dahil) arasındadır. Ayarlanmamışsa veya 0 olarak ayarlanmışsa varsayılan değeri 100'dür.
pageToken

string

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

Sayfalandırma sırasında people.listDirectoryPeople işlevine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan ilk çağrıyla eşleşmelidir.
requestSyncToken

boolean

İsteğe bağlı. Yanıtın nextSyncToken döndürülüp döndürülmeyeceği. syncToken isteğinde ayarlanarak son istekten bu yana yapılan artımlı değişiklikleri almak için kullanılabilir.

Senkronizasyon davranışı hakkında daha fazla bilgiyi people.listDirectoryPeople adresinde bulabilirsiniz.
syncToken

string

İsteğe bağlı. Önceki bir yanıttan alınan senkronizasyon jetonu nextSyncToken Yalnızca son istekten bu yana değiştirilen kaynakları almak için bu seçeneği sağlayın.

Senkronizasyon sırasında people.listDirectoryPeople öğesine sağlanan diğer tüm parametreler, senkronizasyon jetonunu sağlayan ilk çağrıyla eşleşmelidir.

Senkronizasyon davranışı hakkında daha fazla bilgiyi people.listDirectoryPeople adresinde bulabilirsiniz.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Kimliği doğrulanmış kullanıcının alan dizini için yapılan bir 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,
  "nextSyncToken": string
}
Alanlar
people[]

object (Person)

Alan dizininde bulunan kullanıcıların listesi.
nextPageToken

string

Sonraki sayfayı almak için pageToken olarak gönderilebilecek bir jeton. Bu alan atlanırsa sonraki sayfalar olmaz.
nextSyncToken

string

Son istekten sonraki değişiklikleri almak için syncToken olarak gönderilebilecek bir jeton. İstek, senkronizasyon jetonunu döndürmek için requestSyncToken değerini ayarlamalıdır.

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.