Method: people.searchDirectoryPeople

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

בקשת HTTP

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

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

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

פרמטרים
query

string

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

string

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

במהלך החלוקה לדפים, כל שאר הפרמטרים שסופקו ל-[people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] חייבים להתאים לקריאה הראשונה שסיפקה את אסימון הדף.

גוף הבקשה

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

גוף התשובה

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

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

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

object (Person)

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

string

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

integer

המספר הכולל של הפריטים ברשימה, ללא חלוקה לדפים.

היקפי ההרשאות

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

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

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