Method: otherContacts.list

فهرست همه «مخاطبین دیگر»، یعنی مخاطبینی که در یک گروه مخاطب نیستند. "مخاطبین دیگر" معمولاً مخاطبینی هستند که به صورت خودکار از تعاملات ایجاد می شوند.

نشانه‌های همگام‌سازی ۷ روز پس از همگام‌سازی کامل منقضی می‌شوند. درخواستی با نشانه همگام‌سازی منقضی شده با یک google.rpc.ErrorInfo با دلیل "EXPIRED_SYNC_TOKEN" خطایی دریافت می‌کند. در صورت بروز چنین خطایی، کلاینت‌ها باید یک درخواست همگام‌سازی کامل بدون syncToken ارائه دهند.

صفحه اول درخواست همگام سازی کامل دارای یک سهمیه اضافی است. در صورت تجاوز از سهمیه، خطای 429 برگردانده می شود. این سهمیه ثابت است و قابل افزایش نیست.

وقتی syncToken مشخص شد، منابع حذف شده از زمان آخرین همگام‌سازی به‌عنوان شخصی با تنظیم PersonMetadata.deleted روی true برگردانده می‌شوند.

وقتی pageToken یا syncToken مشخص می‌شود، تمام پارامترهای درخواست دیگر باید با اولین تماس مطابقت داشته باشند.

نوشته‌ها ممکن است برای درخواست‌های همگام‌سازی چند دقیقه تاخیر در انتشار داشته باشند. همگام‌سازی‌های افزایشی برای موارد استفاده خواندن پس از نوشتن در نظر گرفته نشده‌اند.

نمونه استفاده را در فهرست سایر مخاطبین کاربر که تغییر کرده اند ببینید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
pageToken

string

اختیاری. یک نشانه صفحه، دریافت شده از پاسخ قبلی nextPageToken . این را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به otherContacts.list باید با اولین تماسی که نشانه صفحه را ارائه کرده است مطابقت داشته باشد.

pageSize

integer

اختیاری. تعداد «مخاطبین دیگر» که باید در پاسخ لحاظ شود. مقادیر معتبر شامل 1 تا 1000 است. در صورت تنظیم نشدن، 100 پیش‌فرض می‌شود یا روی 0 تنظیم می‌شود.

requestSyncToken

boolean

اختیاری. اینکه آیا پاسخ باید nextSyncToken در آخرین صفحه نتایج بازگرداند یا خیر. می توان از آن برای دریافت تغییرات افزایشی از آخرین درخواست با تنظیم آن در درخواست syncToken استفاده کرد.

جزئیات بیشتر در مورد رفتار همگام سازی در otherContacts.list .

syncToken

string

اختیاری. یک نشانه همگام‌سازی، دریافت شده از پاسخ قبلی nextSyncToken این را برای بازیابی فقط منابع تغییر یافته از آخرین درخواست ارائه دهید.

هنگام همگام‌سازی، تمام پارامترهای دیگر ارائه شده به otherContacts.list باید با اولین تماسی که کد همگام‌سازی را ارائه می‌کند مطابقت داشته باشد.

جزئیات بیشتر در مورد رفتار همگام سازی در otherContacts.list .

readMask

string ( FieldMask format)

مورد نیاز. یک فیلد ماسک برای محدود کردن اینکه کدام فیلد برای هر فرد بازگردانده می شود. چندین فیلد را می توان با جدا کردن آنها با کاما مشخص کرد. اینکه چه مقادیری معتبر هستند بستگی به نوع ReadSourceType دارد.

اگر از READ_SOURCE_TYPE_CONTACT استفاده شود، مقادیر معتبر عبارتند از:

  • آدرس های ایمیل
  • ابرداده
  • نام ها
  • شماره تلفن
  • عکس ها

اگر از READ_SOURCE_TYPE_PROFILE استفاده شود، مقادیر معتبر عبارتند از:

  • آدرس ها
  • محدوده سنی
  • بیوگرافی ها
  • تولدها
  • calendarUrls
  • کلاینت دیتا
  • جلدعکس ها
  • آدرس های ایمیل
  • رویدادها
  • شناسه های خارجی
  • جنسیت ها
  • imClients
  • منافع
  • مناطق
  • مکان ها
  • عضویت ها
  • ابرداده
  • کلمات کلیدی اشتباه
  • نام ها
  • نام مستعار
  • مشاغل
  • سازمان ها
  • شماره تلفن
  • عکس ها
  • روابط
  • آدرس های sip
  • مهارت ها
  • آدرس های اینترنتی
  • 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_mask مراجعه کنید.

nextPageToken

string

یک نشانه، که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

nextSyncToken

string

یک نشانه، که می تواند به عنوان syncToken برای بازیابی تغییرات از آخرین درخواست ارسال شود. درخواست باید requestSyncToken را تنظیم کند تا نشانه همگام‌سازی را برگرداند.

totalSize

integer

تعداد کل مخاطبین دیگر در لیست بدون صفحه بندی.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.