Method: people.connections.list

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

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

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

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

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

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

שימוש לדוגמה זמין בקטע רשימת אנשי הקשר של המשתמש שהשתנו.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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
  • תחומי עניין
  • לוקאלים
  • locations
  • מינויים
  • מטא נתונים
  • miscKeywords
  • שמות
  • כינויים
  • מקצועות
  • ארגונים
  • phoneNumbers
  • תמונות, תצלומים, צילומים, פוטוס
  • קשרים
  • sipAddresses
  • מיומנויות
  • כתובות אתרים
  • 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

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

טיפוסים בני מנייה (enum)
LAST_MODIFIED_ASCENDING מיון האנשים לפי מועד השינוי שלהם, כאשר הרשומות הישנות מופיעות קודם.
LAST_MODIFIED_DESCENDING מיון האנשים לפי מועד השינוי שלהם, כאשר הרשומות החדשות יותר מופיעות קודם.
FIRST_NAME_ASCENDING אפשר למיין אנשים לפי שם פרטי.
LAST_NAME_ASCENDING מיון האנשים לפי שם משפחה.