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
  • תחומי עניין
  • לוקאלים
  • locations
  • מינויים
  • מטא נתונים
  • miscKeywords
  • שמות
  • כינויים
  • מקצועות
  • ארגונים
  • phoneNumbers
  • תמונות, תצלומים, צילומים, פוטוס
  • יחסי
  • sipAddresses
  • מיומנויות
  • כתובות אתרים
  • userDefined
sources[]

enum (DirectorySourceType)

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

enum (DirectoryMergeSourceType)

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

integer

זה שינוי אופציונלי. מספר האנשים שאפשר לכלול בתשובה. הערכים החוקיים הם בין 1 ל-500, כולל. ערך ברירת המחדל הוא 100 אם הערך לא מוגדר או מוגדר כ-0.
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

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