Method: people.searchDirectoryPeople

מספק רשימה של פרופילים בדומיין ואנשי קשר מהדומיין של המשתמש המאומת בספריית הדומיין של המשתמש המאומת.

בקשת HTTP

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

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

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

פרמטרים
query

string

חובה. תחילית של שאילתה שתואמת לשדות של המשתמש. לא משתמשים ב-readMask כדי לקבוע לאילו שדות התאמה.
readMask

string (FieldMask format)

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

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

enum (DirectorySourceType)

חובה. מקורות ספרייה שיש להחזיר.
mergeSources[]

enum (DirectoryMergeSourceType)

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

integer

זה שינוי אופציונלי. מספר האנשים שיש לכלול בתשובה. הערכים החוקיים הם בין 1 ל-500, כולל. אם הערך לא מוגדר או מוגדר ל-0, ברירת המחדל היא 100.
pageToken

string

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

במהלך העימוד, כל הפרמטרים האחרים שמסופקים ל-[people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] חייבים להתאים לקריאה הראשונה שסיפקה את אסימון הדף.

גוף הבקשה

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

גוף התשובה

התשובה לבקשה של אנשים בספריית הדומיין של המשתמש המאומת שתואמת לשאילתה שצוינה.

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

ייצוג JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
שדות
people[]

object (Person)

רשימת האנשים בספריית הדומיין שתואמים לשאילתה.
nextPageToken

string

אסימון, שיכול להישלח בתור pageToken כדי לאחזר את הדף הבא. אם השדה הזה יושמט, לא יהיו דפים עוקבים.
totalSize

integer

המספר הכולל של הפריטים ברשימה ללא עימוד.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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