Method: people.connections.list

توفّر هذه السياسة قائمة بجهات اتصال المستخدم الذي تمت المصادقة عليه.

تنتهي صلاحية الرموز المميّزة للمزامنة بعد 7 أيام من المزامنة الكاملة. إذا كان الطلب يتضمّن رمزًا مميّزًا للمزامنة منتهي الصلاحية، ستظهر رسالة خطأ تتضمّن google.rpc.ErrorInfo مع السبب "EXPIRED_SYNC_TOKEN". في حال حدوث هذا الخطأ، على البرامج إجراء طلب مزامنة كاملة بدون syncToken.

تحتوي الصفحة الأولى من طلب المزامنة الكاملة على حصة إضافية. وإذا تم تجاوز الحصة، سيتم عرض خطأ 429. هذه الحصة ثابتة ولا يمكن زيادتها.

عند تحديد syncToken، سيتم إرجاع الموارد المحذوفة منذ آخر مزامنة كشخص تم ضبط PersonMetadata.deleted على "صحيح".

عند تحديد 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
  • الاهتمامات
  • locales
  • المواقع الجغرافية
  • للقناة
  • البيانات الوصفية
  • miscKeywords
  • names
  • الألقاب
  • المهن
  • organizations
  • phoneNumbers
  • صور
  • علاقات
  • sipAddresses
  • مهارات
  • urls
  • 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 رتِّب الأشخاص حسب اسم العائلة.