Liefert eine Liste der Kontakte des authentifizierten Nutzers, die mit der Suchanfrage übereinstimmen. Die Abfrage stimmt mit den Feldern names
, emailAddresses
und phoneNumbers
eines Kontakts überein, die aus der OTHER_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/other-contacts#search_the_users_other_contacts.
HTTP-Anfrage
GET https://people.googleapis.com/v1/otherContacts:search
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
Parameter | |
---|---|
query |
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 |
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 |
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:
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von SearchResponse
.
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/contacts.other.readonly
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.