Method: people.connections.list

Kimliği doğrulanan kullanıcının kişilerinin bir 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 bir google.rpc.ErrorInfo hatası alacak. Bu tür bir hata söz konusu olduğunda, istemcilerin syncToken olmadan tam senkronizasyon isteğinde bulunması gerekir.

Tam senkronizasyon isteğinin ilk sayfası için ek kota vardır. 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 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ı Kullanıcının değişen kişilerini listeleme bölümünde görebilirsiniz.

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 bu kodu sağlayın.

Sayfalara ayırma işlemi sırasında, people.connections.list için 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 1000 arasındaki değerlerdir (1 ve 1000 dahil). Ayarlanmazsa veya 0'a ayarlanırsa varsayılan olarak 100'dür.

sortOrder

enum (SortOrder)

İsteğe bağlı. Bağlantıların sıralanması gereken 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ü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.connections.list 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.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 sayfasında 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 kısıtlayan bir maske.

personFields

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 (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 olur.

İ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ı 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
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
Alanlar
connections[]

object (Person)

İstekte bulunan kişinin bağlı olduğu kişilerin 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. Yanıt sayfalara ayrıldığında, yalnızca son sayfada nextSyncToken öğesi bulunur.

totalPeople
(deprecated)

integer

KULLANIMDAN KALDIRILDI (Lütfen totalItems yöntemini kullanın) Listedeki, sayfalara ayırmadan toplam kişi sayısı.

totalItems

integer

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

SortOrder

Bağlantı listesinin sıralanması gereken sıra. Bu yalnızca senkronizasyon istenmediğinde kullanılır.

Sıralamalar
LAST_MODIFIED_ASCENDING Kişileri değiştirildikleri zamana göre sıralayın; öncelikle eski girişler.
LAST_MODIFIED_DESCENDING Kullanıcıları değiştirilme zamanına göre sıralayın; öncelikle yeni girişler.
FIRST_NAME_ASCENDING Kullanıcıları ada göre sıralayın.
LAST_NAME_ASCENDING Kişileri soyadına göre sıralayın.