Method: people.listDirectoryPeople
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
מספקת רשימה של פרופילים בדומיין ואנשי קשר מהדומיין בספריית הדומיין של המשתמש המאומת.
כשמציינים את syncTokenPersonMetadata.deleted
כשמציינים את הפרמטר pageTokensyncToken
יכול להיות עיכוב בהפצה של כמה דקות בבקשות סנכרון של פעולות כתיבה. סנכרונים מצטברים לא מיועדים לתרחישים של קריאה אחרי כתיבה.
דוגמה לשימוש מפורטת במאמר הצגת רשימה של האנשים בספרייה שהשתנו.
בקשת 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
זה שינוי אופציונלי. אם התשובה צריכה להחזיר את הערך nextSyncTokensyncToken פרטים נוספים על אופן הפעולה של הסנכרון זמינים בכתובת 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
מידע נוסף זמין במדריך להרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-11-08 (שעון UTC).
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2024-11-08 (שעון UTC)."],[[["Lists domain profiles and contacts within the authenticated user's domain directory."],["Allows for filtering and pagination of results using query parameters like `readMask`, `sources`, `pageSize`, `pageToken`, and `syncToken`."],["Supports incremental synchronization to retrieve changes since the last request using the `syncToken` and `requestSyncToken` parameters."],["Returns a list of `Person` objects containing directory information, along with pagination and synchronization tokens."],["Requires the `https://www.googleapis.com/auth/directory.readonly` OAuth scope for authorization."]]],["This outlines how to list domain profiles and contacts via a `GET` request to `https://people.googleapis.com/v1/people:listDirectoryPeople`. Key actions include specifying `readMask`, `sources`, `mergeSources`, `pageSize`, `pageToken`, `requestSyncToken`, and `syncToken` as query parameters. An empty request body is required. The response, containing an array of `people`, `nextPageToken`, and `nextSyncToken` fields, allows for pagination and synchronization of changes. The `https://www.googleapis.com/auth/directory.readonly` authorization scope is required.\n"]]
