מספק מידע על רשימה של אנשים ספציפיים על ידי ציון רשימה של שמות המשאבים המבוקשים. אפשר להשתמש ב-people/me
כדי לציין את המשתמש המאומת.
אם לא צוין 'personFields', הבקשה תחזיר שגיאה 400.
בקשת HTTP
GET https://people.googleapis.com/v1/people:batchGet
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
resourceNames[] |
חובה. שמות המשאבים של האנשים שלגביהם צריך לספק מידע. אפשר לחזור על התהליך. פרמטר השאילתה של כתובת ה-URL צריך להיות
יש עד 200 שמות של משאבים. |
requestMask |
הוצא משימוש (יש להשתמש ב- מסיכה להגבלת התוצאות לקבוצת משנה של שדות אדם. |
personFields |
חובה. אנונימיזציה של שדות להגבלת השדות שמוחזרים עבור כל אחד מהאנשים. אפשר לציין כמה שדות על ידי הפרדה בפסיקים. הערכים החוקיים כוללים:
|
sources[] |
זה שינוי אופציונלי. מסכה של סוגי המקורות שיש להחזיר. אם המדיניות לא מוגדרת, ברירת המחדל היא |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התשובה לבקשה לקבלת רשימה של אנשים לפי שם המשאב.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"responses": [
{
object ( |
שדות | |
---|---|
responses[] |
התשובה לכל שם של משאב מבוקש. |
היקפי הרשאות
לא נדרשת הרשאה כדי לגשת לנתונים ציבוריים. כדי להשתמש בנתונים פרטיים, נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
https://www.googleapis.com/auth/contacts.other.readonly
https://www.googleapis.com/auth/directory.readonly
https://www.googleapis.com/auth/profile.agerange.read
https://www.googleapis.com/auth/profile.emails.read
https://www.googleapis.com/auth/profile.language.read
https://www.googleapis.com/auth/user.addresses.read
https://www.googleapis.com/auth/user.birthday.read
https://www.googleapis.com/auth/user.emails.read
https://www.googleapis.com/auth/user.gender.read
https://www.googleapis.com/auth/user.organization.read
https://www.googleapis.com/auth/user.phonenumbers.read
https://www.googleapis.com/auth/userinfo.email
https://www.googleapis.com/auth/userinfo.profile
https://www.googleapis.com/auth/profile.language.read
למידע נוסף, עיינו במדריך ההרשאות.