Method: otherContacts.list

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

התוקף של אסימוני הסנכרון פג 7 ימים אחרי הסנכרון המלא. בקשה עם אסימון סנכרון שפג תוקפו תקבל שגיאה עם google.rpc.ErrorInfo עם הסיבה 'EXPIRED_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, כולל. ערך ברירת המחדל הוא 100 אם הערך לא מוגדר או מוגדר כ-0.
requestSyncToken

boolean

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

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

string

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

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

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

string (FieldMask format)

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

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

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

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

  • כתובות
  • ageRanges
  • ביוגרפיות
  • ימי הולדת
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • אירועים
  • externalIds
  • מינים
  • imClients
  • תחומי עניין
  • לוקאלים
  • locations
  • מועדוני חברים
  • מטא נתונים
  • miscKeywords
  • שמות
  • כינויים
  • מקצועות
  • ארגונים
  • phoneNumbers
  • תמונות, תצלומים, צילומים, פוטוס
  • קשרים
  • sipAddresses
  • מיומנויות
  • כתובות אתרים
  • 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)

הרשימה 'אנשי קשר נוספים' מוחזרים כמשאבים של אנשים. 'אנשי קשר נוספים' לתמוך בקבוצת משנה מוגבלת של שדות. למידע מפורט יותר, ראו ListOtherRequest.request_mask.
nextPageToken

string

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

string

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

integer

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

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

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

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

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