- HTTP-Anfrage
- Pfadparameter
- Anfrageparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- SortOrder
- Testen!
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
senden.syncToken
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
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
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 |
Erforderlich. Der Ressourcenname, für den Verbindungen zurückgegeben werden sollen. Nur |
Abfrageparameter
Parameter | |
---|---|
pageToken |
Optional. Ein Seitentoken, das von einer vorherigen Antwort Beim Paginieren müssen alle anderen für |
pageSize |
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 |
Optional. Die Reihenfolge, in der die Verbindungen sortiert werden sollen. Die Standardeinstellung ist |
requestSyncToken |
Optional. Gibt an, ob in der 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 für Weitere Informationen zum Synchronisierungsverhalten finden Sie unter |
requestMask |
Optional. VERWORFEN (verwenden Sie stattdessen Eine Maske, mit der die Ergebnisse auf eine Teilmenge der Personenfelder beschränkt werden. |
personFields |
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:
|
sources[] |
Optional. Eine Maske, die angibt, welche Quelltypen zurückgegeben werden sollen. Wenn kein Wert festgelegt ist, werden standardmäßig |
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 ( |
Felder | |
---|---|
connections[] |
Die Liste der Personen, mit denen der Antragsteller verbunden ist. |
nextPageToken |
Ein Token, das als |
nextSyncToken |
Ein Token, das als |
totalPeople |
EINGESTELLT (bitte verwenden: totalItems) Die Gesamtzahl der Personen 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 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. |