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
  • البيانات الوصفية
  • الأسماء
  • phoneNumbers
  • صور

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

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

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