Method: people.connections.list

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

Senkronizasyon jetonlarının süresi, tam senkronizasyondan 7 gün sonra dolar. Senkronizasyon jetonu süresi dolmuş bir istek, "EXPIRED_SYNC_TOKEN" nedeniyle google.rpc.ErrorInfo hatasını alır. Böyle bir hata olması durumunda, istemciler syncToken olmadan tam senkronizasyon isteğinde bulunmalıdır.

Tam senkronizasyon isteğinin ilk sayfasında ek kota bulunur. Kota aşılırsa 429 hatası döndürülür. Bu kota sabittir ve artırılamaz.

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 aramayla 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ı için tasarlanmamıştır.

Kullanıcının değişen kişilerini listeleme başlıklı makalede örnek kullanıma bakın.

HTTP isteği

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

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

Yol parametreleri

Parametreler
resourceName
(deprecated)

string

Zorunlu. Bağlantıların döndürüleceği kaynak adı. Yalnızca people/me geçerlidir.

Sorgu parametreleri

Parametreler
pageToken

string

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

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

pageSize

integer

İsteğe bağlı. Yanıta dahil edilecek bağlantı sayısı. Geçerli değerler 1 ile 1.000 arasında (1.000 de dahil) olmalıdır. Ayarlanmamışsa veya 0 olarak ayarlanmışsa varsayılan değeri 100'dür.

sortOrder

enum (SortOrder)

İsteğe bağlı. Bağlantıların sıralanacağı sıra. Varsayılan olarak LAST_MODIFIED_ASCENDING değerine ayarlanır.

requestSyncToken

boolean

İsteğe bağlı. Yanıtın, sonuçların son sayfasında 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.connections.list 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şen kaynakları almak için bunu sağlayın.

Senkronizasyon sırasında people.connections.list 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.connections.list adresinde bulabilirsiniz.

requestMask
(deprecated)

object (RequestMask)

İsteğe bağlı. KULLANIMDAN KALDIRILDI (Lütfen bunun yerine personFields kullanın)

Sonuçları, kişi alanlarının bir alt kümesiyle sınırlayan maske.

personFields

string (FieldMask format)

Zorunlu. Her bir kişide döndürülecek alanları kısıtlayan bir alan maskesi. Virgülle ayırarak birden çok alan 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 (ReadSourceType)

İsteğe bağlı. Döndürülecek kaynak türlerinin maskesi. Ayarlanmamışsa varsayılan olarak READ_SOURCE_TYPE_CONTACT ve READ_SOURCE_TYPE_PROFILE değerine ayarlanır.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Kimliği doğrulanmış kullanıcının bağlantılarıyla ilgili isteğe verilen yanıt.

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

JSON gösterimi
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
Alanlar
connections[]

object (Person)

İstekte bulunan kullanıcının bağlı olduğu kişilerin listesi.

nextPageToken

string

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

nextSyncToken

string

Son istekten sonraki değişiklikleri almak için syncToken olarak gönderilebilecek bir jeton. İsteğin, senkronizasyon jetonunu döndürmesi için requestSyncToken ayarını yapması gerekir. Yanıt sayfalara ayrıldığında yalnızca son sayfa nextSyncToken içerir.

totalPeople
(deprecated)

integer

DESTEKLENMİYOR (Lütfen totalItems parametresini kullanın.) Sayfalara ayırma olmadan listedeki toplam kişi sayısı.

totalItems

integer

Sayfalandırma olmadan listedeki toplam öğe sayısı.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

SortOrder

Bağlantı listesinin sıralanacağı sıra. Bu yalnızca senkronizasyon istenmiyorsa kullanılır.

Sıralamalar
LAST_MODIFIED_ASCENDING Kullanıcıları, değiştirildikleri zamana göre sıralayın. Eski girişler önce gelir.
LAST_MODIFIED_DESCENDING Kişileri değiştirildikleri zamana göre sıralayın; giriş yapmanız gerekir.
FIRST_NAME_ASCENDING Kullanıcıları adlarına göre sıralayın.
LAST_NAME_ASCENDING Kullanıcıları soyadına göre sıralayın.