提供已驗證使用者其他聯絡人中符合搜尋查詢的聯絡人清單。查詢與來自 OTHER_CONTACT
來源的聯絡人 names
、emailAddresses
和 phoneNumbers
欄位相符。
重要事項:搜尋之前,用戶端應以空白查詢傳送暖機要求,以便更新快取。詳情請參閱 https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts
HTTP 要求
GET https://people.googleapis.com/v1/otherContacts:search
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 | |
---|---|
query |
必要欄位。要求的純文字查詢。這項查詢可用來比對使用者欄位的前置字串詞組。舉例來說,名稱「foo name」的使用者符合「f」、「fo」、「foo」、「foo n」、「nam」等等的查詢條件,而不是「oo n」等等。 |
pageSize |
選用設定。要傳回的結果數量。如未設定欄位,預設值為 10,或設為 0。超過 30 的值上限為 30。 |
readMask |
必要欄位。欄位遮罩,用於限制傳回每個人上的欄位。如要指定多個欄位,請用半形逗號分隔。以下為有效值:
|
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體會包含 SearchResponse
的執行例項。
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/contacts.other.readonly
詳情請參閱授權指南。