Method: people.getBatchGet

מספקת מידע על רשימה של אנשים ספציפיים על ידי ציון רשימה של שמות המשאבים המבוקשים. משתמשים ב-people/me כדי לציין את המשתמש המאומת.

אם לא צוין 'personFields', הבקשה תחזיר שגיאה 400.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
resourceNames[]

string

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

resourceNames=<name1>&resourceNames=<name2>&...

  • כדי לקבל מידע על המשתמש המאומת, מציינים את people/me.
  • כדי לקבל מידע על חשבון Google, יש לציין people/{account_id}.
  • כדי לקבל מידע על איש קשר, יש לציין את שם המשאב שמזהה את איש הקשר כפי שמוחזר על ידי people.connections.list.

אפשר להוסיף עד 200 שמות של משאבים.
requestMask
(deprecated)

object (RequestMask)

הוצא משימוש (במקום זאת, יש להשתמש ב-personFields)

מסכה להגבלת התוצאות לקבוצת משנה של שדות של אנשים.
personFields

string (FieldMask format)

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

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

enum (ReadSourceType)

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

גוף הבקשה

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

גוף התשובה

התגובה לבקשת אחזור של רשימת אנשים לפי שם המשאב.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "responses": [
    {
      object (PersonResponse)
    }
  ]
}
שדות
responses[]

object (PersonResponse)

התשובה לכל שם משאב מבוקש.

היקפי ההרשאות

לא נדרשת הרשאה כדי לגשת לנתונים ציבוריים. לנתונים פרטיים, נדרש אחד מההיקפים הבאים של 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

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