Method: people.searchContacts

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

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. Die Abfrage wird verwendet, um Präfixsätze der Felder einer Person abzugleichen. 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. Die Standardeinstellung ist 10, wenn das Feld nicht festgelegt ist, oder auf 0 gesetzt. Werte über 30 werden auf 30 begrenzt.
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. Gültige Werte sind:

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

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 Leitfaden zur Autorisierung.