Method: people.connections.list

מספקת רשימה של אנשי הקשר של המשתמש המאומת.

התוקף של אסימוני סנכרון פג 7 ימים לאחר הסנכרון המלא. בקשה עם אסימון סנכרון שפג תוקפו תקבל שגיאה עם google.rpc.ErrorInfo עם הסיבה CCPAD_SYNC_TOKEN. במקרה של שגיאה כזו, הלקוחות צריכים לשלוח בקשה לסנכרון מלא ללא syncToken.

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

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

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

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

ראו שימוש לדוגמה במאמר רשימת אנשי הקשר של המשתמש שהשתנו.

בקשת HTTP

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

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

פרמטרים של נתיב

פרמטרים
resourceName
(deprecated)

string

חובה. שם המשאב שעבורו יש להחזיר חיבורים. רק people/me תקף.

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

פרמטרים
pageToken

string

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

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

integer

זה שינוי אופציונלי. מספר החיבורים שיש לכלול בתגובה. הערכים החוקיים הם בין 1 ל-1,000, כולל. אם הערך לא מוגדר או מוגדר ל-0, ברירת המחדל היא 100.
sortOrder

enum (SortOrder)

זה שינוי אופציונלי. הסדר שבו יש למיין את החיבורים. ברירת המחדל היא LAST_MODIFIED_ASCENDING.
requestSyncToken

boolean

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

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

string

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

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

פרטים נוספים על התנהגות הסנכרון זמינים בכתובת people.connections.list.
requestMask
(deprecated)

object (RequestMask)

זה שינוי אופציונלי. הוצא משימוש (יש להשתמש ב-personFields במקום)

מסיכה להגבלת התוצאות לקבוצת משנה של שדות אדם.
personFields

string (FieldMask format)

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

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

enum (ReadSourceType)

זה שינוי אופציונלי. מסכה של סוגי המקורות שיש להחזיר. אם המדיניות לא מוגדרת, ברירת המחדל היא READ_SOURCE_TYPE_CONTACT ו-READ_SOURCE_TYPE_PROFILE.

גוף הבקשה

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

גוף התשובה

התגובה לבקשה לחיבורים של המשתמש המאומת.

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

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

object (Person)

רשימת האנשים שאליהם מגיש הבקשה מחובר.
nextPageToken

string

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

string

אסימון, שניתן לשלוח בתור syncToken כדי לאחזר שינויים מאז הבקשה האחרונה. כדי להחזיר את אסימון הסנכרון, על הבקשה להגדיר את requestSyncToken. כשהתשובה מחולקת לדפים, רק הדף האחרון יכלול את nextSyncToken.
totalPeople
(deprecated)

integer

הוצא משימוש (יש להשתמש ב-totalItems) המספר הכולל של האנשים ברשימה ללא עימוד.
totalItems

integer

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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 מיון האנשים לפי שם משפחה.