Method: otherContacts.list

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

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

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

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

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

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

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

בקשת HTTP

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

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

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

פרמטרים
pageToken

string

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

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

integer

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

boolean

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

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

string

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

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

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

string (FieldMask format)

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

אם נעשה שימוש ב-READ_SOURCE_TYPE_CONTACT, הערכים החוקיים הם:

  • emailAddresses
  • מטא נתונים
  • names
  • phoneNumbers
  • תמונות, תצלומים, צילומים, פוטוס

אם נעשה שימוש ב-READ_SOURCE_TYPE_PROFILE, הערכים החוקיים הם:

  • כתובות
  • 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 בלי לציין את הערך READ_SOURCE_TYPE_CONTACT.

גוף הבקשה

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

גוף התשובה

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

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

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

object (Person)

הרשימה של 'אנשי קשר אחרים' שהוחזרה כמשאבי אדם. האפשרות 'אנשי קשר אחרים' תומכת בקבוצת משנה מוגבלת של שדות. לפרטים נוספים, יש לעיין ב-ListOtherContactsRequest.request_security.
nextPageToken

string

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

string

אסימון, שניתן לשלוח בתור syncToken כדי לאחזר שינויים מאז הבקשה האחרונה. כדי להחזיר את אסימון הסנכרון, על הבקשה להגדיר את requestSyncToken.
totalSize

integer

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/contacts.other.readonly

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