Method: people.searchContacts

מספק רשימה של אנשי קשר בקבוצות של אנשי הקשר של המשתמש המאומת אשר תואמים לשאילתת החיפוש. השאילתה תואמת בשדות names, nickNames, emailAddresses, phoneNumbers ו-organizations של איש קשר שהם מהמקור CONTACT.

חשוב: לפני החיפוש, הלקוחות צריכים לשלוח בקשת הפעלה עם שאילתה ריקה כדי לעדכן את המטמון. פרטים נוספים זמינים בכתובת https://developers.google.com/people/v1/contacts#search_the_users_contacts

בקשת HTTP

GET https://people.googleapis.com/v1/people:searchContacts

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של שאילתה

פרמטרים
query

string

חובה. השאילתה בטקסט פשוט של הבקשה. השאילתה משמשת להתאמת תחילית לביטויים של שדות לגבי משתמש. לדוגמה, משתמש ששמו "foo name" מתאים לשאילתות כמו "f", "fo", "foo", "foo n", "nam" וכו', אבל לא "oo n".
pageSize

integer

זה שינוי אופציונלי. מספר התוצאות שיש להחזיר. ברירת המחדל היא 10 אם השדה לא מוגדר, או מוגדר ל-0. ערכים גדולים מ-30 יוגבלו ל-30.
readMask

string (FieldMask format)

חובה. אנונימיזציה של שדות להגבלת השדות שמוחזרים עבור כל אחד מהאנשים. אפשר לציין כמה שדות על ידי הפרדה בפסיקים. הערכים החוקיים כוללים:

  • כתובות
  • ageRanges
  • ביוגרפיות
  • ימי הולדת
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • אירועים
  • externalIds
  • מינים
  • imClients
  • תחומי עניין
  • locales
  • locations
  • מינויים
  • מטא נתונים
  • miscKeywords
  • names
  • כינויים
  • מקצועות
  • organizations
  • phoneNumbers
  • תמונות, תצלומים, צילומים, פוטוס
  • יחסים
  • sipAddresses
  • מיומנויות
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

זה שינוי אופציונלי. מסכה של סוגי המקורות שיש להחזיר. אם הפרמטר לא מוגדר, ערך ברירת המחדל הוא READ_SOURCE_TYPE_CONTACT.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של SearchResponse.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

למידע נוסף, עיינו במדריך ההרשאות.