مرجع سمات التفاعل

مرجع حقول كائنات التفاعل والرد التي تُرجعها نقاط نهاية التفاعلات.

تُرجع نقاط النهاية عرض قائمة التفاعلات لموقع وجلب التفاعلات المجمّعة وجلب التفاعلات حسب المعرّفات كائنات التفاعل. وتُغلّف نقطتا النهاية اللتان تدعمان تقسيم النتائج إلى صفحات هذه الكائنات ضمن بنية اتصال بأسلوب Relay: يحتوي كل من data.interactions (لكل موقع) وdata.rollupInteractions (للتجميع على مستوى الحساب) على edges[].node وpageInfo وtotalCount. ولا يدعم الجلب حسب المعرّفات تقسيم النتائج إلى صفحات؛ إذ إن data.interactionDetails كائن { "interactions": [ ... ] } بسيط لا يحتوي على edges أو pageInfo أو totalCount.

حقول التفاعل

الحقلالنوعالوصف
idStringمعرّف UUID الخاص بالتفاعل. مرّره بوصفه interactionId عند الرد
interactionIdStringمعرّف UUID نفسه الموجود في id
sourceStringاسم المضيف لموقع التقييمات أو التواصل الاجتماعي (مثل maps.google.com، yelp.com)
titleStringعنوان التفاعل، عندما يوفّره المصدر
contentStringنص التقييم أو المنشور
authorNameStringاسم العرض للكاتب
ratingIntegerالتقييم بالنجوم، من 1 إلى 5 (للتقييمات فقط)
dateStringالطابع الزمني للتفاعل بتنسيق ISO 8601
permalinkStringرابط مباشر إلى التفاعل على موقع المصدر
categoryStringفئة عامة، مثل Review أو Social
typeStringنوع التفاعل المحدّد، Review، Question، Comment، Recommendation، Post، Photo، Message، Response
respondedBooleanما إذا كان هناك رد من المالك
notesStringملاحظات مالك الحساب الخاصة
responsesArrayردود المالك المرفقة بهذا التفاعل (انظر أدناه)
responseCountIntegerعدد الردود المرفقة
canRespondBooleanما إذا كان يمكن نشر رد عبر Listings API لهذا المصدر
locationIdIntegerالمعرّف الرقمي في قاعدة البيانات للموقع الذي يتبعه التفاعل
flaggedReasonStringسبب وضع علامة على التفاعل، إن وُجد

حقول كائن الرد

كل عنصر في مصفوفة responses الخاصة بالتفاعل (وكذلك الكائن الذي تُرجعه نقطة النهاية الرد على تفاعل):

الحقلالنوعالوصف
idStringالمعرّف الفريد للرد (مرّره بوصفه responseId عند التعديل أو الأرشفة)
interactionIdStringمعرّف التفاعل الذي ينتمي إليه هذا الرد
contentStringنص الرد
authorNameStringالاسم المعروض بوصفه صاحب الرد
dateStringالطابع الزمني لإنشاء الرد
respondedWithStringمعرّف قالب الرد المستخدم، إن وُجد
respondedByIntegerمعرّف مستخدم Listings API الذي أرسل الرد
interactionStatusStringحالة دورة الحياة، CREATED أو FAILED أو COMPLETED أو CONFIRMED
editedResponseBooleanما إذا كان هذا الرد قد عُدّل منذ نشره لأول مرة
remarksStringملاحظات النظام (مثل تفاصيل الفشل)

تسلسل حالات الرد

يتتبّع الحقل interactionStatus الرد أثناء نشره على موقع المصدر:

  • CREATED → COMPLETED: نُشر على منصة النشر؛ لا يتوفر تأكيد مزدوج على تلك المنصة
  • CREATED → COMPLETED → CONFIRMED: نُشر ثم أكّدت منصة النشر نشره
  • CREATED → FAILED: لم ينجح الإرسال إلى منصة النشر؛ انظر remarks

قيم التعداد للتصفية

تقبل نقاط النهاية التي تدعم تقسيم النتائج إلى صفحات قيم التعداد التالية بوصفها عوامل تصفية:

  • responseStatus: RESPONDED, PENDING
  • sortOrder: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED
  • category: REVIEW (وفئات عامة أخرى متاحة لكل حساب)