Method: people.connections.list

لیستی از مخاطبین کاربر احراز هویت شده را ارائه می دهد.

نشانه‌های همگام‌سازی ۷ روز پس از همگام‌سازی کامل منقضی می‌شوند. درخواستی با نشانه همگام‌سازی منقضی شده با یک 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 از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
resourceName
(deprecated)

string

مورد نیاز. نام منبع برای بازگشت اتصالات. فقط people/me معتبر است.

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

پارامترها
pageToken

string

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

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

pageSize

integer

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

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)

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

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

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

مرتب سازی

ترتیبی که فهرستی از اتصالات باید مرتب شوند. این فقط در صورتی استفاده می شود که همگام سازی درخواست نشود.

Enums
LAST_MODIFIED_ASCENDING افراد را بر اساس زمان تغییر مرتب کنید. ابتدا ورودی های قدیمی تر
LAST_MODIFIED_DESCENDING افراد را بر اساس زمان تغییر مرتب کنید. ابتدا ورودی های جدیدتر
FIRST_NAME_ASCENDING افراد را با نام کوچک مرتب کنید.
LAST_NAME_ASCENDING افراد را بر اساس نام خانوادگی مرتب کنید.
،

لیستی از مخاطبین کاربر احراز هویت شده را ارائه می دهد.

نشانه‌های همگام‌سازی ۷ روز پس از همگام‌سازی کامل منقضی می‌شوند. درخواستی با نشانه همگام‌سازی منقضی شده با یک 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 از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
resourceName
(deprecated)

string

مورد نیاز. نام منبع برای بازگشت اتصالات. فقط people/me معتبر است.

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

پارامترها
pageToken

string

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

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

pageSize

integer

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

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)

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

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

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

مرتب سازی

ترتیبی که فهرستی از اتصالات باید مرتب شوند. این فقط در صورتی استفاده می شود که همگام سازی درخواست نشود.

Enums
LAST_MODIFIED_ASCENDING افراد را بر اساس زمان تغییر مرتب کنید. ابتدا ورودی های قدیمی تر
LAST_MODIFIED_DESCENDING افراد را بر اساس زمان تغییر مرتب کنید. ابتدا ورودی های جدیدتر
FIRST_NAME_ASCENDING افراد را با نام کوچک مرتب کنید.
LAST_NAME_ASCENDING افراد را بر اساس نام خانوادگی مرتب کنید.
،

لیستی از مخاطبین کاربر احراز هویت شده را ارائه می دهد.

نشانه‌های همگام‌سازی ۷ روز پس از همگام‌سازی کامل منقضی می‌شوند. درخواستی با نشانه همگام‌سازی منقضی شده با یک 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 از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
resourceName
(deprecated)

string

مورد نیاز. نام منبع برای بازگشت اتصالات. فقط people/me معتبر است.

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

پارامترها
pageToken

string

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

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

pageSize

integer

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

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)

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

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

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

مرتب سازی

ترتیبی که فهرستی از اتصالات باید مرتب شوند. این فقط در صورتی استفاده می شود که همگام سازی درخواست نشود.

Enums
LAST_MODIFIED_ASCENDING افراد را بر اساس زمان تغییر مرتب کنید. ابتدا ورودی های قدیمی تر
LAST_MODIFIED_DESCENDING افراد را بر اساس زمان تغییر مرتب کنید. ابتدا ورودی های جدیدتر
FIRST_NAME_ASCENDING افراد را بر اساس نام مرتب کنید.
LAST_NAME_ASCENDING افراد را بر اساس نام خانوادگی مرتب کنید.
،

لیستی از مخاطبین کاربر احراز هویت شده را ارائه می دهد.

نشانه‌های همگام‌سازی ۷ روز پس از همگام‌سازی کامل منقضی می‌شوند. درخواستی با نشانه همگام‌سازی منقضی شده با یک 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 از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
resourceName
(deprecated)

string

مورد نیاز. نام منبع برای بازگشت اتصالات. فقط people/me معتبر است.

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

پارامترها
pageToken

string

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

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

pageSize

integer

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

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)

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

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

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

مرتب سازی

ترتیبی که فهرستی از اتصالات باید مرتب شوند. این فقط در صورتی استفاده می شود که همگام سازی درخواست نشود.

Enums
LAST_MODIFIED_ASCENDING افراد را بر اساس زمان تغییر مرتب کنید. ابتدا ورودی های قدیمی تر
LAST_MODIFIED_DESCENDING افراد را بر اساس زمان تغییر مرتب کنید. ابتدا ورودی های جدیدتر
FIRST_NAME_ASCENDING افراد را بر اساس نام مرتب کنید.
LAST_NAME_ASCENDING افراد را بر اساس نام خانوادگی مرتب کنید.