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