Method: otherContacts.list

إدراج جميع "جهات الاتصال الأخرى"، أي جهات الاتصال التي ليست في مجموعة جهات اتصال. عادةً ما تكون "جهات الاتصال الأخرى" جهات اتصال يتم إنشاؤها تلقائيًا من التفاعلات.

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

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

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

عند تحديد pageToken أو syncToken، يجب أن تتطابق جميع مَعلمات الطلب الأخرى مع الاستدعاء الأول.

قد يتأخر نشر طلبات المزامنة لعدة دقائق. عمليات المزامنة التدريجية غير مخصصة لحالات الاستخدام للقراءة بعد الكتابة.

يمكنك الاطّلاع على مثال للاستخدام في إدراج جهات الاتصال الأخرى للمستخدم التي تم تغييرها.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز gRPC.

معلمات طلب البحث

المَعلمات
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، تكون القيم الصالحة كما يلي:

  • emailAddresses
  • البيانات الوصفية
  • names
  • phoneNumbers
  • صور

في حالة استخدام READ_SOURCE_TYPE_PROFILE، تكون القيم الصالحة كما يلي:

  • عنوان واحد
  • 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 بدون تحديد 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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.