Method: people.listDirectoryPeople

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

אם צוין syncToken, משאבים יימחקו מאז הסנכרון האחרון יוחזרו כאדם ש-PersonMetadata.deleted מוגדר ל-True.

אם מציינים pageToken או syncToken, כל שאר הפרמטרים של הבקשה חייבים להתאים לקריאה הראשונה.

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

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

בקשת HTTP

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

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

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

פרמטרים
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 ל-1,000, כולל. אם הערך לא מוגדר או מוגדר ל-0, ברירת המחדל היא 100.
pageToken

string

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

במהלך העימוד, כל שאר הפרמטרים שצוינו ל-people.listDirectoryPeople חייבים להתאים לקריאה הראשונה שסיפקה את אסימון הדף.
requestSyncToken

boolean

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

פרטים נוספים על התנהגות הסנכרון זמינים בכתובת people.listDirectoryPeople.
syncToken

string

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

במהלך הסנכרון, כל הפרמטרים האחרים שסופקו ל-people.listDirectoryPeople חייבים להתאים לקריאה הראשונה שסיפקה את אסימון הסנכרון.

פרטים נוספים על התנהגות הסנכרון זמינים בכתובת people.listDirectoryPeople.

גוף הבקשה

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

גוף התשובה

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

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

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

object (Person)

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

string

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

string

אסימון, שניתן לשלוח בתור syncToken כדי לאחזר שינויים מאז הבקשה האחרונה. כדי להחזיר את אסימון הסנכרון, על הבקשה להגדיר את requestSyncToken.

היקפי הרשאות

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

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

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