- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- SortOrder
- רוצים לנסות?
מספקת רשימה של אנשי הקשר של המשתמש המאומת.
התוקף של אסימוני סנכרון פג 7 ימים לאחר הסנכרון המלא. בקשה עם אסימון סנכרון שפג תוקפו תקבל שגיאה עם google.rpc.ErrorInfo עם הסיבה CCPAD_SYNC_TOKEN. במקרה של שגיאה כזו, הלקוחות צריכים לשלוח בקשה לסנכרון מלא ללא
.syncToken
בדף הראשון של בקשת סנכרון מלא יש מכסה נוספת. אם תחרגו מהמכסה, תוחזר שגיאה 429. המכסה הזו קבועה ואי אפשר להגדיל אותה.
אם צוין
, משאבים יימחקו מאז הסנכרון האחרון יוחזרו כאדם ש-syncToken
מוגדר ל-True.PersonMetadata.deleted
אם מציינים
או pageToken
, כל שאר הפרמטרים של הבקשה חייבים להתאים לקריאה הראשונה.syncToken
ייתכן עיכוב של כמה דקות בהפצה של בקשות לסנכרון. סנכרונים מצטברים לא מיועדים לתרחישים לדוגמה של קריאה אחרי כתיבה.
ראו שימוש לדוגמה במאמר רשימת אנשי הקשר של המשתמש שהשתנו.
בקשת HTTP
GET https://people.googleapis.com/v1/{resourceName=people/*}/connections
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
resourceName |
חובה. שם המשאב שעבורו יש להחזיר חיבורים. רק |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageToken |
זה שינוי אופציונלי. אסימון דף שהתקבל מתגובה קודמת במהלך העימוד, כל שאר הפרמטרים שצוינו ל- |
pageSize |
זה שינוי אופציונלי. מספר החיבורים שיש לכלול בתגובה. הערכים החוקיים הם בין 1 ל-1,000, כולל. אם הערך לא מוגדר או מוגדר ל-0, ברירת המחדל היא 100. |
sortOrder |
זה שינוי אופציונלי. הסדר שבו יש למיין את החיבורים. ברירת המחדל היא |
requestSyncToken |
זה שינוי אופציונלי. האם התגובה צריכה להחזיר פרטים נוספים על התנהגות הסנכרון זמינים בכתובת |
syncToken |
זה שינוי אופציונלי. אסימון סנכרון שהתקבל מתגובה קודמת במהלך הסנכרון, כל הפרמטרים האחרים שסופקו ל- פרטים נוספים על התנהגות הסנכרון זמינים בכתובת |
requestMask |
זה שינוי אופציונלי. הוצא משימוש (יש להשתמש ב- מסיכה להגבלת התוצאות לקבוצת משנה של שדות אדם. |
personFields |
חובה. אנונימיזציה של שדות להגבלת השדות שמוחזרים עבור כל אחד מהאנשים. אפשר לציין כמה שדות על ידי הפרדה בפסיקים. הערכים החוקיים כוללים:
|
sources[] |
זה שינוי אופציונלי. מסכה של סוגי המקורות שיש להחזיר. אם המדיניות לא מוגדרת, ברירת המחדל היא |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התגובה לבקשה לחיבורים של המשתמש המאומת.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"connections": [
{
object ( |
שדות | |
---|---|
connections[] |
רשימת האנשים שאליהם מגיש הבקשה מחובר. |
nextPageToken |
אסימון, שיכול להישלח בתור |
nextSyncToken |
אסימון, שניתן לשלוח בתור |
totalPeople |
הוצא משימוש (יש להשתמש ב-totalItems) המספר הכולל של האנשים ברשימה ללא עימוד. |
totalItems |
המספר הכולל של הפריטים ברשימה ללא עימוד. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
למידע נוסף, עיינו במדריך ההרשאות.
SortOrder
הסדר שבו יש למיין את רשימת החיבורים. משמש רק אם לא נשלחה בקשה לסנכרון.
טיפוסים בני מנייה (enums) | |
---|---|
LAST_MODIFIED_ASCENDING |
אפשר למיין אנשים לפי מועד השינוי שלהם. ערכים ישנים יותר יופיעו קודם. |
LAST_MODIFIED_DESCENDING |
מיון אנשים לפי מועד השינוי שלהם, תחילה ערכים חדשים יותר. |
FIRST_NAME_ASCENDING |
מיון המשתתפים לפי שם פרטי. |
LAST_NAME_ASCENDING |
מיון האנשים לפי שם משפחה. |