Method: people.searchContacts

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Eine Liste der Kontakte in den gruppierten Kontakten des authentifizierten Nutzers, die der Suchanfrage entsprechen Die Abfrage stimmt mit den Feldern names, nickNames, emailAddresses, phoneNumbers und organizations eines Kontakts aus der Quelle CONTACT überein.

WICHTIG: Vor der Suche sollten Clients eine Aufwärmanfrage mit einer leeren Abfrage senden, um den Cache zu aktualisieren. Weitere Informationen finden Sie unter https://developers.google.com/people/v1/contacts#search_the_users_contacts.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
query

string

Erforderlich. Die Nur-Text-Abfrage für die Anfrage. Mit der Abfrage werden Präfixsätze der Felder einer Person abgeglichen. Eine Person mit dem Namen „foo name“ stimmt beispielsweise mit Suchanfragen wie „f“, „fo“, „foo“, „foo n“, „nam“ usw. überein, aber nicht mit „oo n“.

pageSize

integer

Optional. Die Anzahl der zurückzugebenden Ergebnisse. Der Standardwert ist 10, wenn das Feld nicht festgelegt oder auf 0 festgelegt ist. Werte über 30 werden auf 30 begrenzt.

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. Gültige Werte sind:

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von SearchResponse.

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.