- HTTP-Anfrage
- Pfadparameter
- Anfrageparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- Sortierreihenfolge
- Testen!
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
ausführen.syncToken
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
angegeben ist, werden Ressourcen, die seit der letzten Synchronisierung gelöscht wurden, als Person zurückgegeben, wobei syncToken
auf „true“ gesetzt ist.PersonMetadata.deleted
Wenn
oder pageToken
angegeben ist, müssen alle anderen Anfrageparameter mit dem ersten Aufruf übereinstimmen.syncToken
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 |
Erforderlich. Der Ressourcenname, für den Verbindungen zurückgegeben werden sollen. Nur |
Abfrageparameter
Parameter | |
---|---|
pageToken |
Optional. Ein Seitentoken, das von einer vorherigen Antwort empfangen wurde: Beim Paginieren müssen alle anderen für |
pageSize |
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 |
Optional. Die Reihenfolge, in der die Verbindungen sortiert werden sollen. Die Standardeinstellung ist |
requestSyncToken |
Optional. Gibt an, ob die Antwort Weitere Informationen zum Synchronisierungsverhalten finden Sie unter |
syncToken |
Optional. Ein Synchronisierungstoken, das von einer vorherigen Antwort empfangen wurde Bei der Synchronisierung müssen alle anderen Parameter, die für Weitere Informationen zum Synchronisierungsverhalten finden Sie unter |
requestMask |
Optional. Eingestellt (nutzen Sie stattdessen Eine Maske, die Ergebnisse auf eine Teilmenge von Personenfeldern beschränkt. |
personFields |
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:
|
sources[] |
Optional. Eine Maske, welche Quelltypen zurückgegeben werden sollen. Wenn kein Wert festgelegt ist, werden standardmäßig |
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 ( |
Felder | |
---|---|
connections[] |
Die Liste der Personen, mit denen der Anfragende verbunden ist. |
nextPageToken |
Ein Token, das als |
nextSyncToken |
Ein Token, das als |
totalPeople |
EINGESTELLT (Gesamtanzahl der Elemente) Gesamtzahl der Nutzer in der Liste ohne Seitenumbruch. |
totalItems |
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 |