Method: otherContacts.list

Listet alle weiteren Kontakte auf, d. h. Kontakte, die nicht zu einer Kontaktgruppe gehören. „Weitere Kontakte“ sind in der Regel automatisch aus Interaktionen erstellte Kontakte.

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 Andere Kontakte des Nutzers auflisten, die sich geändert haben.

HTTP-Anfrage

GET https://people.googleapis.com/v1/otherContacts

Die URL verwendet die Syntax der gRPC-Transcodierung.

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 otherContacts.list bereitgestellten Parameter mit dem ersten Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

pageSize

integer

Optional. Die Anzahl unter „Weitere Kontakte“, 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.

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 otherContacts.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 otherContacts.list bereitgestellten Parameter mit dem ersten Aufruf übereinstimmen, über den das Synchronisierungstoken bereitgestellt wurde.

Weitere Informationen zum Synchronisierungsverhalten finden Sie unter otherContacts.list.

readMask

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. Welche Werte gültig sind, hängt davon ab, welcher ReadSourceType verwendet wird.

Bei Verwendung von READ_SOURCE_TYPE_CONTACT sind folgende Werte gültig:

  • emailAddresses
  • Metadaten
  • names
  • phoneNumbers
  • fotos

Bei Verwendung von READ_SOURCE_TYPE_PROFILE sind folgende Werte gültig:

  • 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, wird der Standardwert READ_SOURCE_TYPE_CONTACT verwendet.

Mögliche Werte für dieses Feld sind:

Die Angabe von READ_SOURCE_TYPE_PROFILE ohne Angabe von READ_SOURCE_TYPE_CONTACT ist nicht zulässig.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort auf eine Anfrage für die „Weitere Kontakte“ des authentifizierten Nutzers.

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

JSON-Darstellung
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
Felder
otherContacts[]

object (Person)

Die Liste „Weitere Kontakte“, die als Personenressourcen zurückgegeben wird. „Weitere Kontakte“ unterstützen eine begrenzte Teilmenge von Feldern. Weitere Informationen finden Sie unter ListOtherContactsRequest.request_mask.

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.

totalSize

integer

Die Gesamtzahl der anderen Kontakte in der Liste ohne Paginierung.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.