Method: people.connections.list

Stellt eine Liste der Kontakte des authentifizierten Nutzers bereit.

Synchronisierungstokens laufen 7 Tage nach der vollständigen Synchronisierung ab. Bei einer Anfrage mit einem abgelaufenen Synchronisierungstoken wird ein Fehler mit google.rpc.ErrorInfo und dem Grund „EXPIRED_SYNC_TOKEN“ zurückgegeben. In diesem Fall sollten Clients eine vollständige Synchronisierungsanfrage ohne syncToken senden.

Die erste Seite einer vollständigen Synchronisierungsanfrage hat ein zusätzliches Kontingent. Wenn das Kontingent überschritten wird, wird der Fehler 429 zurückgegeben. Dieses Kontingent ist festgelegt und kann nicht erhöht werden.

Wenn syncToken angegeben ist, werden Ressourcen, die seit der letzten Synchronisierung gelöscht wurden, als Person zurückgegeben, wobei PersonMetadata.deleted auf „true“ gesetzt ist.

Wenn pageToken oder syncToken angegeben ist, müssen alle anderen Anfrageparameter mit dem ersten Aufruf übereinstimmen.

Schreibvorgänge können bei Synchronisierungsanfragen eine Verzögerung von mehreren Minuten haben. Inkrementelle Synchronisierungen sind nicht für Lese-nach-Schreib-Anwendungsfälle vorgesehen.

Weitere Informationen zur Verwendung finden Sie unter Kontakte des Nutzers auflisten, die sich geändert haben.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
resourceName
(deprecated)

string

Erforderlich. Der Ressourcenname, für den Verbindungen zurückgegeben werden sollen. Nur people/me ist gültig.

Abfrageparameter

Parameter
pageToken

string

Optional. Ein Seitentoken, das von einer vorherigen Antwort nextPageToken empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für people.connections.list bereitgestellten Parameter mit dem ersten Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
pageSize

integer

Optional. Die Anzahl der in die Antwort aufzunehmenden Verbindungen. Gültige Werte liegen zwischen 1 und 1.000 (einschließlich). Wenn kein Wert festgelegt ist oder der Wert 0 ist, wird der Standardwert 100 verwendet.
sortOrder

enum (SortOrder)

Optional. Die Reihenfolge, in der die Verbindungen sortiert werden sollen. Die Standardeinstellung ist LAST_MODIFIED_ASCENDING.
requestSyncToken

boolean

Optional. Gibt an, ob in der Antwort nextSyncToken auf der letzten Ergebnisseite zurückgegeben werden soll. Es kann verwendet werden, um inkrementelle Änderungen seit der letzten Anfrage abzurufen, indem es für die Anfrage syncToken festgelegt wird.

Weitere Informationen zum Synchronisierungsverhalten finden Sie unter people.connections.list.
syncToken

string

Optional. Ein Synchronisierungstoken, das von einer vorherigen Antwort empfangen wurde nextSyncToken Geben Sie dieses an, um nur die Ressourcen abzurufen, die sich seit der letzten Anfrage geändert haben.

Bei der Synchronisierung müssen alle anderen für people.connections.list bereitgestellten Parameter mit dem ersten Aufruf übereinstimmen, der das Synchronisierungstoken bereitgestellt hat.

Weitere Informationen zum Synchronisierungsverhalten finden Sie unter people.connections.list.
requestMask
(deprecated)

object (RequestMask)

Optional. VERWORFEN (verwenden Sie stattdessen personFields)

Eine Maske, mit der die Ergebnisse auf eine Teilmenge der Personenfelder beschränkt werden.
personFields

string (FieldMask format)

Erforderlich. Eine Feldmaske, mit der eingeschränkt wird, welche Felder zu den einzelnen Personen zurückgegeben werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Gültige Werte sind:

  • Adressen
  • ageRanges
  • Biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • Interessen
  • locales
  • Standorte
  • mitgliedschaft
  • Metadaten
  • miscKeywords
  • Namen
  • Aliasse
  • Berufe
  • Organisationen
  • phoneNumbers
  • Fotos
  • Beziehungen
  • sipAddresses
  • skills
  • URLs
  • userDefined
sources[]

enum (ReadSourceType)

Optional. Eine Maske, die angibt, welche Quelltypen zurückgegeben werden sollen. Wenn kein Wert festgelegt ist, werden standardmäßig READ_SOURCE_TYPE_CONTACT und READ_SOURCE_TYPE_PROFILE verwendet.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort auf eine Anfrage nach den Verbindungen des authentifizierten Nutzers.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
Felder
connections[]

object (Person)

Die Liste der Personen, mit denen der Antragsteller verbunden ist.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.
nextSyncToken

string

Ein Token, das als syncToken gesendet werden kann, um Änderungen seit der letzten Anfrage abzurufen. In der Anfrage muss requestSyncToken so festgelegt sein, dass das Synchronisierungstoken zurückgegeben wird. Bei einer paginierten Antwort enthält nur die letzte Seite nextSyncToken.
totalPeople
(deprecated)

integer

EINGESTELLT (bitte verwenden: totalItems) Die Gesamtzahl der Personen in der Liste ohne Seitenumbruch.
totalItems

integer

Die Gesamtzahl der Elemente in der Liste ohne Paginierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

SortOrder

Die Reihenfolge, in der eine Liste von Verbindungen sortiert werden soll. Dieser Wert wird nur verwendet, wenn keine Synchronisierung angefordert wird.

Enums
LAST_MODIFIED_ASCENDING Personen nach dem Datum der Änderung sortieren, ältere Einträge zuerst.
LAST_MODIFIED_DESCENDING Personen nach dem Datum der Änderung sortieren, neuere Einträge zuerst.
FIRST_NAME_ASCENDING Personen nach Vornamen sortieren.
LAST_NAME_ASCENDING Personen nach Nachnamen sortieren.