Method: people.connections.list

Enthält eine Liste der Kontakte des authentifizierten Nutzers.

Synchronisierungstoken laufen sieben Tage nach der vollständigen Synchronisierung ab. Eine Anfrage mit einem abgelaufenen Synchronisierungstoken erhält einen Fehler mit der Meldung google.rpc.ErrorInfo mit dem Grund "EXPIRED_SYNC_TOKEN". In diesem Fall sollten Clients eine vollständige Synchronisierungsanfrage ohne syncToken ausführen.

Die erste Seite einer vollständigen Synchronisierungsanfrage hat ein zusätzliches Kontingent. Wenn das Kontingent überschritten wird, wird ein 429-Fehler 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.

Bei Schreibvorgängen kann die Übertragungsverzögerung für Synchronisierungsanfragen mehrere Minuten betragen. Inkrementelle Synchronisierungen sind nicht für Anwendungsfälle „Lesen nach Schreiben“ gedacht.

Weitere Informationen finden Sie im Abschnitt Verwendung der geänderten Kontakte des Nutzers.

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 empfangen wurde: nextPageToken. 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 die Antwort aufgenommen werden sollen. Gültige Werte liegen im Bereich von 1 bis 1.000. Der Standardwert ist 100, wenn nicht oder 0 festgelegt.
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 nextSyncToken auf der letzten Seite der Ergebnisse zurückgeben soll. Damit können inkrementelle Änderungen seit der letzten Anfrage durch Festlegen der Anfrage syncToken abgerufen werden.

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 seit der letzten Anfrage geändert wurden.

Bei der Synchronisierung müssen alle anderen Parameter, die für people.connections.list bereitgestellt werden, 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. Eingestellt (nutzen Sie stattdessen personFields)

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

string (FieldMask format)

Erforderlich. Eine Feldmaske zur Einschränkung der zurückgegebenen Felder für jede Person. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Gültige Werte sind:

  • addresses
  • Altersbereiche
  • Biografien
  • Geburtstage
  • calendarUrls
  • Kundendaten
  • Cover Photos
  • emailAddresses
  • Veranstaltungen
  • Externe IDs
  • geschlechter
  • Kunden
  • interessen
  • locales
  • Standorte
  • mitgliedschaft
  • metadata
  • Sonstige Keywords
  • names
  • Spitznamen
  • Berufe
  • organizations
  • phoneNumbers
  • fotos
  • Beziehungen
  • sipAdressen
  • skills
  • URLs
  • Benutzerdefiniert
sources[]

enum (ReadSourceType)

Optional. Eine Maske, 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

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

Die Antwort auf eine Anfrage für die Verbindungen des authentifizierten Nutzers.

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 festgelegt sein, um das Synchronisierungstoken zurückzugeben. Wenn die Antwort paginiert ist, enthält nur die letzte Seite nextSyncToken.
totalPeople
(deprecated)

integer

EINGESTELLT (Gesamtanzahl der Elemente) Gesamtzahl der Nutzer 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 Autorisierungsleitfaden.

SortOrder

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

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