Wyświetla listę kontaktów w zgrupowanych kontaktach uwierzytelnionego użytkownika, które pasują do zapytania. Zapytanie jest dopasowane do pól names, nickNames, emailAddresses, phoneNumbers i organizations kontaktu, które pochodzą ze źródła CONTACT.
WAŻNE: przed wyszukiwaniem klient powinien wysłać żądanie wczytania danych z wyprzedzeniem z pustym zapytaniem, aby zaktualizować pamięć podręczną. Więcej informacji znajdziesz na stronie https://developers.google.com/people/v1/contacts#search_the_users_contacts
Żądanie HTTP
GET https://people.googleapis.com/v1/people:searchContacts
Adres URL używa składni transkodowania gRPC.
Parametry zapytania
| Parametry | |
|---|---|
query |
To pole jest wymagane. Zapytanie tekstowe dotyczące żądania. Zapytanie jest używane do dopasowania wyrażeń prefiksu w polach osoby. Na przykład osoba o nazwie „foo name” odpowiada zapytaniu „f”, „fo”, „foo”, „foo n”, „nam” itp., ale nie „oo n”. |
pageSize |
Opcjonalnie. Liczba wyników do zwrócenia. Domyślna wartość to 10, jeśli pole nie jest ustawione, lub wartość 0. Wartości większe niż 30 zostaną ograniczone do 30. |
readMask |
To pole jest wymagane. Maska pola określająca, które pola każdej osoby mają być zwracane. Można określić wiele pól, rozdzielając je przecinkami. Prawidłowe wartości to:
|
sources[] |
Opcjonalnie. Maska typów źródeł do zwrócenia. Jeśli nie zostanie ustawiony, domyślna wartość to |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu SearchResponse.
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/contactshttps://www.googleapis.com/auth/contacts.readonly
Więcej informacji znajdziesz w przewodniku po autoryzacji.