Method: otherContacts.list

Listen Sie alle anderen Kontakte auf, die nicht zu einer Kontaktgruppe gehören. „Weitere Kontakte“ sind normalerweise automatisch erstellte Kontakte aus Interaktionen.

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.

Sehen Sie sich die Beispielverwendung unter Andere Kontakte des Nutzers auflisten, die geändert wurden an.

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 empfangen wurde: nextPageToken. 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 der weiteren Kontakte in der Antwort. Gültige Werte liegen im Bereich von 1 bis 1.000. Der Standardwert ist 100, wenn nicht oder 0 festgelegt.

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

Weitere Informationen zum Synchronisierungsverhalten finden Sie unter otherContacts.list.

readMask

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. Welche Werte gültig sind, hängt vom verwendeten ReadSourceType ab.

Wenn READ_SOURCE_TYPE_CONTACT verwendet wird, sind die folgenden Werte gültig:

  • emailAddresses
  • metadata
  • names
  • phoneNumbers
  • fotos

Wenn READ_SOURCE_TYPE_PROFILE verwendet wird, sind die folgenden Werte gültig:

  • 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 nichts festgelegt ist, wird standardmäßig 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

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

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

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

object (Person)

Die Liste „Weitere Kontakte“ wurde als Ressourcen der Person zurückgegeben. „Andere 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 festgelegt sein, um das Synchronisierungstoken zurückzugeben.

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 Autorisierungsleitfaden.