Method: people.listDirectoryPeople

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

syncToken belirtildiğinde, son senkronizasyondan beri silinen kaynaklar, PersonMetadata.deleted değeri "true" olarak 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 yayılma gecikmesi birkaç dakika olabilir. Ek senkronizasyonlar, yazma sonrası kullanım alanlarına yönelik değildir.

Değişen dizin kişilerini listeleme başlıklı makalede örnek kullanımlara göz atabilirsiniz.

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şideki hangi alanların döndürüleceğini kısıtlayan bir alan maskesi. Alanları virgülle ayırarak birden fazla alanı belirtebilirsiniz. Valid values are:

  • addresses
  • yaş grupları
  • biyografiler
  • doğum günleri
  • calendarUrls
  • istemciverileri
  • kapakFotoğraflar
  • e-postaAdresleri
  • etkinlikler
  • harici kimlikler
  • cinsiyetler
  • imİstemcileri
  • ilgi alanları
  • locales
  • yerler
  • memberships
  • metadata
  • ÇeşitliAnahtar Kelimeler
  • adlar
  • takma adlar
  • meslekler
  • organizations
  • telefonNumaraları
  • fotoğraflar
  • ilişkiler
  • sipAdresleri
  • beceriler
  • urller
  • kullanıcı tanımlı
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ış dizin kaynaklarında birleştirilecek ek veriler.

pageSize

integer

İsteğe bağlı. Yanıta dahil edilecek kullanıcı sayısı. Geçerli değerler, 1-1000 arasındadır (bu değerler dahil). Ayarlanmazsa veya 0 olarak ayarlanırsa varsayılan olarak 100 olur.

pageToken

string

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

Sayfalara ayırma işleminde, people.listDirectoryPeople öğesine 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 itibarıyla döndürülüp döndürülmeyeceği. Bu değer, son istekten itibaren syncToken isteğinde ayarlayarak artımlı değişiklikler 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 sonra değiştirilen kaynakları almak için bunu sağlayın.

Senkronizasyon sırasında, people.listDirectoryPeople hesabına 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 metni

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Kimliği doğrulanmış kullanıcının alan diziniyle ilgili bir isteğe verilen yanıt.

JSON gösterimi
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
Alanlar
people[]

object (Person)

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

nextPageToken

string

Sonraki sayfayı almak için pageToken olarak gönderilebilen jeton. Bu alan çıkarılırsa sonraki sayfalar gösterilmez.

nextSyncToken

string

Son istekten bu yana yapılan değişiklikleri almak için syncToken olarak gönderilebilen jeton. İstek, senkronizasyon jetonunu döndürecek şekilde requestSyncToken içermelidir.

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.