Method: otherContacts.list

Alle weiteren Kontakte auflisten, 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 der Fehler google.rpc.ErrorInfo mit dem Grund „EXPIRED_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 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.

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.

Ein Beispiel finden Sie unter Andere geänderte Kontakte des Nutzers auflisten.

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 erhalten 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. Anzahl der weiteren Kontakte die Sie in die Antwort aufnehmen möchten. Gültige Werte liegen zwischen 1 und 1.000 (einschließlich). Wenn kein Wert festgelegt oder auf 0 festgelegt, ist die Standardeinstellung 100.
requestSyncToken

boolean

Optional. Gibt an, ob die Antwort auf der letzten Seite der Ergebnisse nextSyncToken zurückgeben soll. Es kann verwendet werden, um inkrementelle Änderungen seit der letzten Anfrage abzurufen, indem es für die Anfrage syncToken festgelegt wird.

Weitere Informationen zum Synchronisierungsverhalten finden Sie unter otherContacts.list.
syncToken

string

Optional. Synchronisierungstoken, das von einer vorherigen Antwort erhalten wurde nextSyncToken Geben Sie dieses Token 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, der das Synchronisierungstoken bereitgestellt hat.

Weitere Informationen zum Synchronisierungsverhalten finden Sie unter otherContacts.list.
readMask

string (FieldMask format)

Erforderlich. Eine Feldmaske, um einzuschränken, 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.

Wenn READ_SOURCE_TYPE_CONTACT verwendet wird, sind folgende Werte gültig:

  • emailAddresses
  • Metadaten
  • Namen
  • phoneNumbers
  • Fotos

Wenn READ_SOURCE_TYPE_PROFILE verwendet wird, sind folgende Werte gültig:

  • Adressen
  • ageRanges
  • Biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • Interessen
  • locales
  • Standorte
  • mitgliedschaft
  • Metadaten
  • miscKeywords
  • Namen
  • Spitznamen
  • Berufe
  • Organisationen
  • phoneNumbers
  • Fotos
  • Beziehungen
  • sipAddresses
  • skills
  • URLs
  • userDefined
sources[]

enum (ReadSourceType)

Optional. Eine Maske der zurückzugebenden Quelltypen. Wird kein Wert festgelegt, ist die Standardeinstellung READ_SOURCE_TYPE_CONTACT.

Mögliche Werte für dieses Feld sind:

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort auf eine Anfrage für „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)

Liste „Weitere Kontakte“ werden als Personenressourcen zurückgegeben. „Weitere Kontakte“ eine begrenzte Teilmenge von Feldern. Detailliertere 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. Bei der Anfrage muss requestSyncToken so eingestellt werden, dass das Synchronisierungstoken zurückgegeben wird.
totalSize

integer

Die Gesamtzahl anderer 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.