Method: people.listDirectoryPeople

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

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

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

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
readMask

string (FieldMask format)

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

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

enum (DirectorySourceType)

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

enum (DirectoryMergeSourceType)

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

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