מספקת רשימה של אנשי קשר ברשימת אנשי הקשר האחרים של המשתמש המאומת שתואמים לשאילתת החיפוש. השאילתה תואמת בשדות names, emailAddresses ו-phoneNumbers של איש קשר שהם מהמקור OTHER_CONTACT.
חשוב: לפני החיפוש, הלקוחות צריכים לשלוח בקשת הפעלה עם שאילתה ריקה כדי לעדכן את המטמון. פרטים נוספים זמינים בכתובת https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts
בקשת HTTP
GET https://people.googleapis.com/v1/otherContacts:search
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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
למידע נוסף, עיינו במדריך ההרשאות.