Method: people.listDirectoryPeople

Kimliği doğrulanmış kullanıcının alan dizinindeki alan profillerinin ve alan kişilerinin listesini sağlar.

syncToken belirtildiğinde, son senkronizasyondan sonra silinen kaynaklar, PersonMetadata.deleted 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.

Yazma işlemlerinde, senkronizasyon istekleri için birkaç dakikalık bir yayılma gecikmesi olabilir. Artımlı senkronizasyonlar, yazma sonrası okuma kullanım alanlarında kullanılamaz.

Örnek kullanımı Değişen dizin kişilerini listeleme bölümünde görebilirsiniz.

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 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 1000 arasındaki değerlerdir (1 ve 1000 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ırma işlemi sırasında, people.listDirectoryPeople için 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üp döndürmeyeceği. syncToken isteğinde ayarlayarak son istekten bu yana artımlı değişiklikler almak için kullanılabilir.

Senkronizasyon davranışı hakkında daha fazla bilgiyi people.listDirectoryPeople sayfasında 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 bunu sağlayın.

Senkronizasyon sırasında people.listDirectoryPeople için 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 sayfasında bulabilirsiniz.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

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

object (Person)

Alan dizinindeki kullanıcıların listesi.
nextPageToken

string

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

string

Son istekten sonraki değişiklikleri almak için syncToken olarak gönderilebilen bir jeton. İsteğin, senkronizasyon jetonunu döndürmesi için requestSyncToken ayarını yapması gerekir.

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.