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)

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

  • عنوان واحد
  • الفئات العمرية
  • سير ذاتية
  • أعياد ميلاد
  • عناوين URL للتقويم
  • بيانات العميل
  • صور الغلاف
  • عناوين البريد الإلكتروني
  • فعاليات
  • المعرّفات الخارجية
  • أنواع
  • عملاء IIM
  • الاهتمامات
  • اللغات
  • مواقع جغرافية
  • للقناة
  • البيانات الوصفية
  • كلمات رئيسية متنوعة
  • أسماء
  • الألقاب
  • مهن
  • المؤسسات
  • أرقام الهاتف
  • صور
  • علاقات
  • sipAddresses
  • مهارات
  • عناوين url
  • من تحديد المستخدم
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 تصنيف الأشخاص بحسب اسم العائلة.