Method: people.connections.list

Liefert eine Liste der Kontakte des authentifizierten Nutzers.

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

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

Wenn syncToken angegeben ist, werden Ressourcen, die seit der letzten Synchronisierung gelöscht wurden, als Person zurückgegeben, für die 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 bei der Weitergabe von mehreren Minuten haben. Inkrementelle Synchronisierungen sind nicht für Anwendungsfälle mit Lese-/Schreibzugriff vorgesehen.

Anwendungsbeispiele 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 Verbindungen, die in der Antwort enthalten sein sollen. Gültige Werte liegen zwischen 1 und 1.000 (einschließlich). Wenn die Richtlinie nicht konfiguriert oder auf „0“ festgelegt ist, ist die Standardeinstellung 100.
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 die Antwort auf der letzten Ergebnisseite nextSyncToken zurückgeben soll. Sie kann verwendet werden, um inkrementelle Änderungen seit der letzten Anfrage abzurufen, indem Sie sie in der Anfrage syncToken festlegen.

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

string

Optional. Ein von einer vorherigen Antwort erhaltenes Synchronisierungstoken nextSyncToken Geben Sie dieses an, um nur die Ressourcen abzurufen, die seit der letzten Anfrage geändert wurden.

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

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

object (RequestMask)

Optional. EINGESTELLT (Verwenden Sie stattdessen personFields.)

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

string (FieldMask format)

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

  • addresses
  • ageRanges
  • biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • interessen
  • locales
  • Standorte
  • mitgliedschaft
  • Metadaten
  • miscKeywords
  • names
  • Spitznamen
  • Berufe
  • organizations
  • 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 wird, 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 für die 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 Anfragende 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 werden, dass das Synchronisierungstoken zurückgegeben wird. Bei einer paginierten Antwort enthält nur die letzte Seite nextSyncToken.
totalPeople
(deprecated)

integer

EINGESTELLT (Verwenden Sie totalItems) Die Gesamtzahl der Nutzer in der Liste ohne Paginierung.
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. Diese Option wird nur verwendet, wenn keine Synchronisierung angefordert wird.

Enums
LAST_MODIFIED_ASCENDING Personen nach Änderungszeitpunkt sortieren; ältere Einträge zuerst.
LAST_MODIFIED_DESCENDING Personen nach Änderung sortieren; neuere Einträge zuerst.
FIRST_NAME_ASCENDING Personen nach Vornamen sortieren.
LAST_NAME_ASCENDING Personen nach Nachnamen sortieren.