מספקת רשימה של פרופילים בדומיין ואנשי קשר מהדומיין בספריית הדומיין של המשתמשים המאומתים שתואמים לשאילתת החיפוש.
בקשת HTTP
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
query |
חובה. תחילית של שאילתה שתואמת לשדות של האדם. לא משתמשת ב-readMask כדי לקבוע אילו שדות להתאים. |
readMask |
חובה. מסכת שדות כדי להגביל את השדות של כל אדם שיוחזרו. אפשר לציין כמה שדות ולהפריד ביניהם באמצעות פסיקים. הערכים החוקיים כוללים:
|
sources[] |
חובה. מקורות הספריות להחזרה. |
mergeSources[] |
זה שינוי אופציונלי. נתונים נוספים למיזוג עם מקורות הספריות, אם הם מחוברים באמצעות מפתחות מיזוג מאומתים כמו כתובות אימייל או מספרי טלפון. |
pageSize |
זה שינוי אופציונלי. מספר האנשים שאפשר לכלול בתשובה. הערכים החוקיים הם בין 1 ל-500, כולל. ערך ברירת המחדל הוא 100 אם הערך לא מוגדר או מוגדר כ-0. |
pageToken |
זה שינוי אופציונלי. אסימון דף, שהתקבל מתגובה קודמת במהלך החלוקה לדפים, כל שאר הפרמטרים שסופקו ל-[ |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התגובה לבקשה לאנשים בספריית הדומיין של המשתמש המאומת שתואמים לשאילתה שצוינה.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{
"people": [
{
object ( |
שדות | |
---|---|
people[] |
רשימת האנשים בספריית הדומיין שתואמים לשאילתה. |
nextPageToken |
אסימון שאפשר לשלוח כ- |
totalSize |
המספר הכולל של פריטים ברשימה ללא חלוקה לדפים. |
היקפי הרשאה
נדרש היקף הרשאות OAuth הבא:
https://www.googleapis.com/auth/directory.readonly
מידע נוסף זמין במדריך ההרשאות.