Method: otherContacts.search

Udostępnia listę innych kontaktów uwierzytelnionego użytkownika pasujących do zapytania. Zapytanie jest dopasowane do pól names, emailAddresses i phoneNumbers kontaktu, które pochodzą ze źródła OTHER_CONTACT.

WAŻNE: przed wyszukiwaniem klient powinien wysłać żądanie wczytania danych z wyprzedzeniem z pustym zapytaniem, aby zaktualizować pamięć podręczną. Zobacz https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts

Żądanie HTTP

GET https://people.googleapis.com/v1/otherContacts:search

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
query

string

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

integer

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

string (FieldMask format)

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:

  • emailAddresses
  • metadane
  • names
  • phoneNumbers

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu SearchResponse.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/contacts.other.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.