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 بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
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)

مطلوب. قناع حقل لتقييد الحقول التي يتم عرضها في كل شخص. يمكن تحديد حقول متعددة من خلال الفصل بينها بفواصل. القيم الصالحة هي:

  • عناوين
  • ageRanges
  • السير الذاتية
  • أعياد الميلاد
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • الفعاليات
  • externalIds
  • أنواع
  • imClients
  • الاهتمامات
  • اللغات
  • مواقع جغرافية
  • للقناة
  • البيانات الوصفية
  • miscKeywords
  • الأسماء
  • الألقاب
  • المهن
  • المؤسسات
  • phoneNumbers
  • photos
  • علاقات
  • sipAddresses
  • مهارات
  • عناوين url
  • 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

الترتيب الذي يجب ترتيب قائمة الاتصالات به ولا يتم استخدام هذا الإعداد إلا إذا لم يتم طلب المزامنة.

عمليات التعداد
LAST_MODIFIED_ASCENDING فرز الأشخاص حسب وقت تغييرهم؛ الإدخالات الأقدم أولاً.
LAST_MODIFIED_DESCENDING ترتيب المستخدمين حسب وقت التغيير، مع عرض الإدخالات الأحدث أولاً
FIRST_NAME_ASCENDING فرز الأشخاص حسب الاسم الأول.
LAST_NAME_ASCENDING ترتيب المستخدمين حسب اسم العائلة