قراءة حزمة تطوير البرامج (SDK) للتفاعل: تعليمات الدمج الفني للجهات الخارجية

يمكنك زيادة التفاعل مع تطبيقك من خلال الوصول إلى المستخدمين أينما كانوا. يمكنك دمج حزمة Engage SDK لتقديم اقتراحات مخصّصة ومحتوى يمكن للمستخدمين مواصلته مباشرةً على مساحات عرض متعددة على الجهاز فقط، مثل المجموعات ومساحة الترفيه و"متجر Google Play". يضيف التكامل أقل من 50 كيلوبايت (مضغوطة) إلى متوسط حجم حزمة APK، ويستغرق معظم التطبيقات حوالي أسبوع من وقت المطوّر. يمكنك الاطّلاع على مزيد من المعلومات في موقعنا الإلكتروني للأنشطة التجارية.

يحتوي هذا الدليل على تعليمات للشركاء المطوّرين حول كيفية تقديم محتوى القراءة (الكتب الإلكترونية والكتب المسموعة والقصص المصوّرة/المانغا والمدوّنات والأخبار والمجلات) إلى مساحات عرض المحتوى في Engage.

الفئات ومساحات العرض المتوافقة

تعتمد أهلية مساحة العرض في حزمة Engage SDK على فئة محتوى تطبيقك. استخدِم الجدول التالي لتحديد أهليتك للظهور على مساحات عرض معيّنة:

الحالة فئة المحتوى أو حالة الاستخدام مساحات العرض المتوافقة
متاحة
(مؤهَّلة على جميع مساحات العرض)
  • الكتب الإلكترونية
  • رسوم هزلية ومانغا
  • كتب مسموعة
  • خدمات قراءة المحتوى الطويل الذي ينشئه المستخدمون
  • المدوّنات
  • المجموعات
  • مساحة الترفيه
  • علامة تبويب "التطبيقات" في "متجر Google Play"
  • علامة التبويب "أنت" في "متجر Google Play" (الاقتراحات المخصّصة والمتابعة فقط)
  • صفحة بطاقة بيانات المتجر على "متجر Google Play"
مسموح بها جزئيًا
(مؤهَّلة للعرض على بعض مساحات العرض)
  • الأخبار والمجلات*
  • المجموعات
  • مساحة الترفيه
غير متاح
  • قارئ كتب إلكترونية أو ملفات PDF
  • مراجعات الكتب
  • موسوعة / قاموس
  • مترجم
  • نص ديني

تطبيقات الأخبار

تقدّم تطبيقات الأخبار محتوًى متنوعًا، ويخضع كل منها لقواعد أهلية فريدة. بما أنّ محتوى حزمة Engage SDK على "متجر Google Play" يتوافق مع أدوات Play Premium Growth، فإنّ المقالات الإخبارية ومقاطع الفيديو من تطبيقات الأخبار غير مؤهَّلة للعرض على "متجر Google Play"، مع أنّها مؤهَّلة للعرض في "المجموعات" و"مساحة الترفيه". في المقابل، قد يكون المحتوى الإخباري غير التقليدي، مثل ملفات البودكاست والوصفات، مؤهلاً للنشر على "متجر Google Play":

نوع الكيان مؤهَّلة للظهور في "المجموعات" مؤهَّل لاستخدام "مساحة الترفيه" مؤهَّل لـ "متجر Google Play"
مقالة إخبارية نعم (علامة التبويب "قراءة") نعم (علامة التبويب "قراءة") لا
مقطع فيديو نعم (علامة التبويب "مشاهدة") نعم (علامة التبويب "مشاهدة") لا
بودكاست نعم (علامة التبويب "استماع") نعم (علامة التبويب "استماع") نعم
وصفة طعام نعم (علامة التبويب "طعام") لا نعم

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

يوضّح هذا القسم الخطوات ونماذج البيانات والمصطلحات المطلوبة للتكامل مع حزمة Engage SDK لمحتوى القراءة.

المصطلحات

يتضمّن هذا الدمج أنواع المجموعات الثلاثة التالية: اقتراح ومتابعة ومميّز.

  • تعرض مجموعات الاقتراحات اقتراحات مخصّصة للمحتوى الذي يمكن قراءته من شريك مطوّر فردي.

    تتّبع الاقتراحات البنية التالية:

    • مجموعة الاقتراحات: هي طريقة عرض في واجهة المستخدم تحتوي على مجموعة من الاقتراحات من شريك مطوّر واحد.

      الشكل 1: واجهة مستخدم "مساحة الترفيه" تعرض مجموعة اقتراحات من شريك واحد
    • الكيان: عنصر يمثّل عنصرًا واحدًا في مجموعة. يمكن أن يكون الكيان كتابًا إلكترونيًا أو كتابًا مسموعًا أو سلسلة كتب أو غير ذلك. اطّلِع على قسم تقديم بيانات الكيانات للحصول على قائمة بأنواع الكيانات المتوافقة.

      الشكل 2. واجهة مستخدم "مساحة الترفيه" تعرض كيانًا واحدًا ضمن مجموعة اقتراحات لشريك واحد
  • تعرض مجموعة المتابعة الكتب غير المكتملة من عدة شركاء مطوّرين في مجموعة واحدة ضمن واجهة المستخدم. سيُسمح لكل شريك مطوّر ببث 10 كيانات كحد أقصى في مجموعة "المتابعة".

    الشكل 3. واجهة مستخدم في "مساحة الترفيه" تعرض مجموعة "متابعة المشاهدة" مع اقتراحات غير مكتملة من شركاء متعددين (يظهر اقتراح واحد فقط حاليًا)
  • تعرض مجموعة المحتوى المميّز مجموعة مختارة من العناصر من عدة شركاء مطوّرين في مجموعة واحدة في واجهة المستخدم. ستكون هناك مجموعة واحدة مميّزة تظهر بالقرب من أعلى واجهة المستخدم مع موضع ذي أولوية فوق جميع مجموعات الاقتراحات. سيُسمح لكل شريك مطوّر ببث ما يصل إلى 10 عناصر في مجموعة "المحتوى المميّز".

    الشكل 4. واجهة مستخدم لمساحة الترفيه تعرض مجموعة مميّزة مع اقتراحات من شركاء متعددين (يظهر اقتراح واحد فقط حاليًا).

العمل التحضيري

الحدّ الأدنى لمستوى واجهة برمجة التطبيقات: 19

أضِف مكتبة com.google.android.engage:engage-core إلى تطبيقك:

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.6.0'
}

ملخّص

يستند التصميم إلى تنفيذ خدمة ربط.

تخضع البيانات التي يمكن للعميل نشرها للحدود التالية لأنواع المجموعات المختلفة:

نوع المجموعة حدود المجموعة العنقودية الحدود القصوى للكيانات في مجموعة عنقودية
مجموعات الاقتراحات 7 على الأكثر ‫50 على الأكثر
مجموعة المتابعة ‫1 كحدّ أقصى ‫20 على الأكثر
مجموعة "المحتوى المميّز" ‫1 كحدّ أقصى ‫20 على الأكثر

الخطوة 1: تقديم بيانات الكيان

حدّدت حزمة تطوير البرامج (SDK) كيانات مختلفة لتمثيل كل نوع عنصر. نوفّر الكيانات التالية لفئة "القراءة":

  1. EbookEntity
  2. AudiobookEntity
  3. BookSeriesEntity

توضّح الرسوم البيانية التالية السمات والمتطلبات المتاحة لكل نوع.

EbookEntity

يمثّل العنصر EbookEntity كتابًا إلكترونيًا (على سبيل المثال، الكتاب الإلكتروني Becoming لميشيل أوباما).

السمة المتطلبات ملاحظات
الاسم مطلوبة
صور الملصقات مطلوبة يجب تقديم صورة واحدة على الأقل. للحصول على إرشادات، يُرجى الاطّلاع على مواصفات الصور.
المؤلِّف مطلوبة يجب تقديم اسم مؤلف واحد على الأقل.
معرّف الموارد المنتظم (URI) للرابط لاتّخاذ إجراء مطلوبة

الرابط لصفحة معيّنة في تطبيق مقدّم الخدمة للكتاب الإلكتروني

ملاحظة: يمكنك استخدام الروابط العميقة لتحديد المصدر. يُرجى الرجوع إلى هذه الأسئلة الشائعة

تاريخ النشر اختياري بالملي ثانية منذ بدء الحقبة إذا تم توفيرها
الوصف اختياري يجب ألا يتجاوز طوله 200 حرف في حال تقديمه.
السعر اختياري حقل التعبئة النصّية الحرّة
عدد الصفحات اختياري يجب أن تكون القيمة عددًا صحيحًا موجبًا في حال تقديمها.
النوع اختياري قائمة بالأنواع المرتبطة بالكتاب
اسم السلسلة اختياري اسم السلسلة التي ينتمي إليها الكتاب الإلكتروني (على سبيل المثال، هاري بوتر)
فهرس وحدات السلسلة اختياري فهرس الكتاب الإلكتروني في السلسلة، حيث يمثّل الرقم 1 الكتاب الإلكتروني الأول في السلسلة. على سبيل المثال، إذا كان كتاب هاري بوتر وسجين أزكابان هو الكتاب الثالث في السلسلة، يجب ضبط هذه القيمة على 3.
مواصلة اختيار نوع الكتاب اختياري

‫TYPE_CONTINUE: استئناف قراءة كتاب غير مكتمل

‫TYPE_NEXT: المتابعة في سلسلة جديدة

‫TYPE_NEW: تم إصداره حديثًا.

وقت آخر تفاعل مطلوب بشروط

يجب تقديم هذه السمة عندما يكون المنتج في مجموعة "مواصلة".

يمكن أن تكون الكتب الإلكترونية التي تم الحصول عليها *مؤخرًا* جزءًا من مجموعة "مواصلة القراءة".

بالملي ثانية منذ بداية الحقبة

النسبة المئوية لمستوى التقدّم المكتمل مطلوب بشروط

يجب تقديم هذه السمة عندما يكون المنتج في مجموعة "مواصلة".

يجب أن تكون القيمة أكبر من 0 وأقل من 100.

‫DisplayTimeWindow: لضبط نافذة زمنية لعرض المحتوى على السطح
الطابع الزمني للبدء اختياري

الطابع الزمني الذي يمثّل الوقت الذي يجب بعده عرض المحتوى على مساحة العرض.

وفي حال عدم ضبطها، يكون المحتوى مؤهلاً للظهور على مساحة العرض.

بالملي ثانية منذ بداية الحقبة

الطابع الزمني للنهاية اختياري

الطابع الزمني الذي يشير إلى الوقت الذي لن يظهر فيه المحتوى على مساحة العرض.

وفي حال عدم ضبطها، يكون المحتوى مؤهلاً للظهور على مساحة العرض.

بالملي ثانية منذ بداية الحقبة

AudiobookEntity

يمثّل العنصر AudiobookEntity كتابًا مسموعًا (على سبيل المثال، الكتاب المسموع Becoming لميشيل أوباما).

السمة المتطلبات ملاحظات
الاسم مطلوبة
صور الملصقات مطلوبة يجب تقديم صورة واحدة على الأقل. للحصول على إرشادات، يُرجى الاطّلاع على مواصفات الصور.
المؤلِّف مطلوبة يجب تقديم اسم مؤلف واحد على الأقل.
معرّف الموارد المنتظم (URI) للرابط لاتّخاذ إجراء مطلوبة

الرابط لصفحة معيّنة في تطبيق مقدّم الخدمة للكتاب المسموع

ملاحظة: يمكنك استخدام الروابط العميقة لتحديد المصدر. يُرجى الرجوع إلى هذه الأسئلة الشائعة

راوٍ اختياري يجب تقديم اسم راوٍ واحد على الأقل.
تاريخ النشر اختياري بالملي ثانية منذ بدء الحقبة إذا تم توفيرها
الوصف اختياري يجب ألا يتجاوز طوله 200 حرف في حال تقديمه.
السعر اختياري حقل التعبئة النصّية الحرّة
المدة اختياري يجب أن تكون القيمة موجبة في حال تقديمها.
النوع اختياري قائمة بالأنواع المرتبطة بالكتاب
اسم السلسلة اختياري اسم السلسلة التي ينتمي إليها الكتاب المسموع (على سبيل المثال، هاري بوتر).
فهرس وحدات السلسلة اختياري فهرس الكتاب المسموع في السلسلة، حيث يشير الرقم 1 إلى الكتاب المسموع الأول في السلسلة على سبيل المثال، إذا كان كتاب هاري بوتر وسجين أزكابان هو الكتاب الثالث في السلسلة، يجب ضبط هذه القيمة على 3.
مواصلة اختيار نوع الكتاب اختياري

‫TYPE_CONTINUE: استئناف قراءة كتاب غير مكتمل

‫TYPE_NEXT: المتابعة في سلسلة جديدة

‫TYPE_NEW: تم إصداره حديثًا.

وقت آخر تفاعل مطلوب بشروط

يجب تقديم هذه السمة عندما يكون المنتج في مجموعة "مواصلة".

بالملي ثانية منذ بداية الحقبة

النسبة المئوية لمستوى التقدّم المكتمل مطلوب بشروط

يجب تقديم هذه السمة عندما يكون المنتج في مجموعة "مواصلة".

يمكن أن تكون الكتب المسموعة التي تم الحصول عليها *مؤخرًا* جزءًا من مجموعة "مواصلة القراءة".

يجب أن تكون القيمة أكبر من 0 وأقل من 100.

‫DisplayTimeWindow: لضبط نافذة زمنية لعرض المحتوى على السطح
الطابع الزمني للبدء اختياري

الطابع الزمني الذي يمثّل الوقت الذي يجب بعده عرض المحتوى على مساحة العرض.

وفي حال عدم ضبطها، يكون المحتوى مؤهلاً للظهور على مساحة العرض.

بالملي ثانية منذ بداية الحقبة

الطابع الزمني للنهاية اختياري

الطابع الزمني الذي يشير إلى الوقت الذي لن يظهر فيه المحتوى على مساحة العرض.

وفي حال عدم ضبطها، يكون المحتوى مؤهلاً للظهور على مساحة العرض.

بالملي ثانية منذ بداية الحقبة

BookSeriesEntity

يمثّل العنصر BookSeriesEntity سلسلة كتب (على سبيل المثال، سلسلة كتب هاري بوتر التي تتضمّن 7 كتب).

السمة المتطلبات ملاحظات
الاسم مطلوبة
صور الملصقات مطلوبة يجب تقديم صورة واحدة على الأقل. للحصول على إرشادات، يُرجى الاطّلاع على مواصفات الصور.
المؤلِّف مطلوبة يجب توفّر اسم مؤلف واحد على الأقل.
معرّف الموارد المنتظم (URI) للرابط لاتّخاذ إجراء مطلوبة

الرابط لصفحة معيّنة في تطبيق مقدّم الخدمة للكتاب المسموع أو الكتاب الإلكتروني

ملاحظة: يمكنك استخدام الروابط العميقة لتحديد المصدر. يُرجى الرجوع إلى هذه الأسئلة الشائعة

عدد الكتب مطلوبة عدد الكتب في السلسلة
الوصف اختياري يجب ألا يتجاوز طوله 200 حرف في حال تقديمه.
النوع اختياري قائمة بالأنواع المرتبطة بالكتاب
مواصلة اختيار نوع الكتاب اختياري

‫TYPE_CONTINUE: استئناف قراءة كتاب غير مكتمل

‫TYPE_NEXT: المتابعة في سلسلة جديدة

‫TYPE_NEW: تم إصداره حديثًا.

وقت آخر تفاعل مطلوب بشروط

يجب تقديم هذه السمة عندما يكون المنتج في مجموعة "مواصلة".

بالملي ثانية منذ بداية الحقبة

النسبة المئوية لمستوى التقدّم المكتمل مطلوب بشروط

يجب تقديم هذه السمة عندما يكون المنتج في مجموعة "مواصلة".

يمكن أن تكون سلسلة الكتب التي تم الحصول عليها *مؤخرًا* جزءًا من مجموعة "مواصلة القراءة".

يجب أن تكون القيمة أكبر من 0 وأقل من 100.

‫DisplayTimeWindow: لضبط نافذة زمنية لعرض المحتوى على السطح
الطابع الزمني للبدء اختياري

الطابع الزمني الذي يمثّل الوقت الذي يجب بعده عرض المحتوى على مساحة العرض.

وفي حال عدم ضبطها، يكون المحتوى مؤهلاً للظهور على مساحة العرض.

بالملي ثانية منذ بداية الحقبة

الطابع الزمني للنهاية اختياري

الطابع الزمني الذي يشير إلى الوقت الذي لن يظهر فيه المحتوى على مساحة العرض.

وفي حال عدم ضبطها، يكون المحتوى مؤهلاً للظهور على مساحة العرض.

بالملي ثانية منذ بداية الحقبة

مواصفات الصور

يعرض الجدول التالي المواصفات المطلوبة لمواد عرض الصور:

نسبة العرض إلى الارتفاع المجموعات المتوافقة الحدّ الأدنى لعدد وحدات البكسل وحدات البكسل المقترَحة
مربّعة (1 × 1) كل المجموعات ‫300 × 300 ‫1200 × 1200
أفقية (1.91x1) المحتوى المميّز والمتابعة 600 × 314 ‫1200 × 628
عمودية (4x5) الاقتراح ‫480×600 ‫960 × 1200

تنسيقات الملفات

‫PNG أو JPG أو GIF ثابت أو WebP

الحد الأقصى لحجم الملف

‫5,120 كيلوبايت

اقتراحات إضافية

  • المنطقة الآمنة للصور: ضَع المحتوى المهم في الوسط بحيث يشغل% 80 من الصورة.

مثال

AudiobookEntity audiobookEntity =
        new AudiobookEntity.Builder()
            .setName("Becoming")
            .addPosterImage(
                      new Image.Builder()
                          .setImageUri(Uri.parse("http://www.x.com/image.png"))
                          .setImageHeightInPixel(960)
                          .setImageWidthInPixel(408)
                          .build())
            .addAuthor("Michelle Obama")
            .addNarrator("Michelle Obama")
            .setActionLinkUri(Uri.parse("https://play.google/audiobooks/1"))
            .setDurationMillis(16335L)
            .setPublishDateEpochMillis(1633032895L)
            .setDescription("An intimate, powerful, and inspiring memoir")
            .setPrice("$16.95")
            .addGenre("biography")
            .build();

الخطوة 2: تقديم بيانات المجموعة

ننصح بتنفيذ مهمة نشر المحتوى في الخلفية (على سبيل المثال، باستخدام WorkManager) وجدولتها بشكل منتظم أو حسب الحدث (على سبيل المثال، في كل مرة يفتح فيها المستخدم التطبيق أو عندما يضيف المستخدم شيئًا إلى سلة التسوق).

‫AppEngagePublishClient مسؤول عن نشر المجموعات. تتوفّر واجهات برمجة التطبيقات التالية في العميل:

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishContinuationCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteContinuationCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

تُستخدَم واجهة برمجة التطبيقات هذه للتحقّق مما إذا كانت الخدمة متاحة للدمج وما إذا كان يمكن عرض المحتوى على الجهاز.

يمكنك التحقّق من توفّر الخدمة لكل نوع مجموعة تريد نشرها. تقبل واجهة برمجة التطبيقات isServiceAvailable عنصر طلب، ServiceAvailabilityRequest، يحتوي على أنواع المجموعات التي يجب التحقّق من توفّر الخدمة لها. يمكنك العثور على قيم التعداد ClusterType المطلوبة لـ ServiceAvailabilityRequest من الجدول التالي.

نوع المجموعة ثابت نوع المجموعة قيمة العدد الصحيح
غير معروف TYPE_UNKNOWN 0
مجموعة الاقتراحات TYPE_RECOMMENDATION 1
مجموعة "المحتوى المميّز" TYPE_FEATURED 2
مجموعة المتابعة TYPE_CONTINUATION 3
مجموعة إدارة المستخدمين TYPE_ENGAGEMENT 8
مجموعة الاشتراكات TYPE_SUBSCRIPTION 12

Kotlin

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

Java

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here such as retry.
    }
});
ميزة "توفّر الخدمة المشروط"

تطلب بعض التطبيقات المدمجة إعدادات خاصة تتيح تفعيل خدمة Engage وإيقافها بشكل متقطّع لتقليل تكاليف عرض الإعلانات. ومع ذلك، فإنّ استراتيجية تحليل المحتوى المتقطّعة هذه تؤثر سلبًا في تجربة المستخدم، إذ لن يتم عرض المحتوى القديم، ولن يتم عرض بعض مساحات العرض.

اعتبارًا من الإصدار 1.6.0، تتيح حزمة Engage SDK التحقّق من مدى توفّر أنواع معيّنة من المجموعات. إذا كان تطبيقك يستخدم ميزة "الاستيعاب المتقطّع":

  • تظل مجموعات المتابعة (مثل "مواصلة القراءة") مفعَّلة تلقائيًا على جميع الأجهزة المتوافقة.
  • يتم تفعيل أنواع المجموعات الأخرى (مثل الاقتراحات) وإيقافها بشكل متقطّع.

إذا لم تكن هذه الإعدادات التلقائية مناسبة لاحتياجاتك، يُرجى التواصل مع engage-developers@google.com.

بالنسبة إلى إصدارات حزمة تطوير البرامج (SDK) الأقدم من 1.6.0 (تم إيقافها نهائيًا)

Kotlin

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

Java

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

تُستخدَم واجهة برمجة التطبيقات هذه لنشر قائمة بعناصر RecommendationCluster.

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Reconnect with yourself")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Reconnect with yourself")
                        .build())
                .build());

عندما تتلقّى الخدمة الطلب، يتم تنفيذ الإجراءات التالية ضمن معاملة واحدة:

  • تتم إزالة بيانات RecommendationCluster الحالية من الشريك المطوّر.
  • يتم تحليل البيانات من الطلب وتخزينها في مجموعة الاقتراحات المعدَّلة.

في حال حدوث خطأ، يتم رفض الطلب بالكامل ويتم الاحتفاظ بالحالة الحالية.

publishFeaturedCluster

تُستخدَم واجهة برمجة التطبيقات هذه لنشر قائمة بعناصر FeaturedCluster.

Kotlin

client.publishFeaturedCluster(
            PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    FeaturedCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    new FeaturedCluster.Builder()
                        ...
                        .build())
                .build());

عندما تتلقّى الخدمة الطلب، يتم تنفيذ الإجراءات التالية ضمن معاملة واحدة:

  • تتم إزالة بيانات FeaturedCluster الحالية من الشريك المطوّر.
  • يتم تحليل البيانات من الطلب وتخزينها في "المجموعة المميّزة" المعدَّلة.

في حال حدوث خطأ، يتم رفض الطلب بالكامل ويتم الاحتفاظ بالحالة الحالية.

publishContinuationCluster

تُستخدَم واجهة برمجة التطبيقات هذه لنشر عنصر ContinuationCluster.

Kotlin

client.publishContinuationCluster(
            PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    ContinuationCluster.Builder()
                        .addEntity(book_entity1)
                        .addEntity(book_entity2)
                        .build())
                .build())

Java

client.publishContinuationCluster(
            PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    ContinuationCluster.Builder()
                        .addEntity(book_entity1)
                        .addEntity(book_entity2)
                        .build())
                .build())

عندما تتلقّى الخدمة الطلب، يتم تنفيذ الإجراءات التالية ضمن معاملة واحدة:

  • تتم إزالة بيانات ContinuationCluster الحالية من الشريك المطوّر.
  • يتم تحليل البيانات من الطلب وتخزينها في "مجموعة المتابعة" المعدَّلة.

في حال حدوث خطأ، يتم رفض الطلب بالكامل ويتم الاحتفاظ بالحالة الحالية.

publishUserAccountManagementRequest

تُستخدَم واجهة برمجة التطبيقات هذه لنشر بطاقة تسجيل دخول . يوجه إجراء تسجيل الدخول المستخدمين إلى صفحة تسجيل الدخول في التطبيق حتى يتمكن التطبيق من نشر المحتوى (أو تقديم محتوى أكثر تخصيصًا)

البيانات الوصفية التالية هي جزء من بطاقة تسجيل الدخول:

السمة المتطلبات الوصف
معرّف الموارد المنتظم (URI) للإجراء مطلوب رابط لصفحة معيّنة يؤدي إلى إجراء (أي ينقل المستخدم إلى صفحة تسجيل الدخول إلى التطبيق)
صورة اختيارية: إذا لم يتم تقديمها، يجب تقديم سمة "العنوان" (Title)

الصورة المعروضة على البطاقة

صور بنسبة عرض إلى ارتفاع 16:9 وبدرجة دقة 1264x712

العنوان اختياري: يجب تقديم صورة في حال عدم توفير هذا الحقل العنوان على البطاقة
نص الإجراء اختياري النص الذي يظهر في عبارة الحث على اتخاذ إجراء (مثل "تسجيل الدخول")
العنوان الفرعي اختياري عنوان فرعي اختياري على البطاقة

Kotlin

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

عندما تتلقّى الخدمة الطلب، يتم تنفيذ الإجراءات التالية ضمن معاملة واحدة:

  • تتم إزالة بيانات UserAccountManagementCluster الحالية من الشريك المطوّر.
  • يتم تحليل البيانات من الطلب وتخزينها في مجموعة UserAccountManagementCluster المعدَّلة.

في حال حدوث خطأ، يتم رفض الطلب بالكامل ويتم الاحتفاظ بالحالة الحالية.

updatePublishStatus

إذا لم يتم نشر أي من المجموعات لأي سبب تجاري داخلي، ننصح بشدة بتعديل حالة النشر باستخدام واجهة برمجة التطبيقات updatePublishStatus. هذا مهم لأنّ :

  • من المهم توفير الحالة في جميع السيناريوهات، حتى عندما يكون المحتوى منشورًا (STATUS == PUBLISHED)، وذلك لملء لوحات البيانات التي تستخدم هذه الحالة الصريحة لعرض حالة التكامل ومقاييس أخرى.
  • إذا لم يتم نشر أي محتوى ولكن حالة الدمج ليست معطّلة (STATUS == NOT_PUBLISHED)، يمكن لـ Google تجنُّب إرسال تنبيهات في لوحات بيانات سلامة التطبيق. وتؤكّد أنّ المحتوى لم يتم نشره بسبب حالة متوقّعة من وجهة نظر مقدّم الخدمة.
  • ويساعد المطوّرين في تقديم إحصاءات حول وقت نشر البيانات مقابل عدم نشرها.
  • قد تستخدم Google رموز الحالة لتشجيع المستخدم على تنفيذ إجراءات معيّنة في التطبيق ليتمكّن من الاطّلاع على محتوى التطبيق أو تجاوز المشكلة.

في ما يلي قائمة برموز حالة النشر المؤهَّلة :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

إذا لم يتم نشر المحتوى بسبب عدم تسجيل المستخدم الدخول، تنصح Google بنشر بطاقة تسجيل الدخول. إذا لم يتمكّن مقدّمو الخدمات لأي سبب من نشر "بطاقة تسجيل الدخول"، ننصح بطلب واجهة برمجة التطبيقات updatePublishStatus باستخدام رمز الحالة NOT_PUBLISHED_REQUIRES_SIGN_IN

Kotlin

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationsClusters

تُستخدَم واجهة برمجة التطبيقات هذه لحذف محتوى مجموعات الاقتراحات.

Kotlin

client.deleteRecommendationsClusters()

Java

client.deleteRecommendationsClusters();

عندما تتلقّى الخدمة الطلب، تزيل البيانات الحالية من مجموعات الاقتراحات. في حال حدوث خطأ، يتم رفض الطلب بالكامل ويتم الاحتفاظ بالحالة الحالية.

deleteFeaturedCluster

تُستخدَم واجهة برمجة التطبيقات هذه لحذف محتوى "المجموعة المميّزة".

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

عندما تتلقّى الخدمة الطلب، تزيل البيانات الحالية من "المجموعة المميّزة". في حال حدوث خطأ، يتم رفض الطلب بالكامل ويتم الاحتفاظ بالحالة الحالية.

deleteContinuationCluster

تُستخدَم واجهة برمجة التطبيقات هذه لحذف محتوى مجموعة المتابعة.

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

عندما تتلقّى الخدمة الطلب، تزيل البيانات الحالية من "مجموعة المتابعة". في حال حدوث خطأ، يتم رفض الطلب بالكامل ويتم الاحتفاظ بالحالة الحالية.

deleteUserManagementCluster

تُستخدَم واجهة برمجة التطبيقات هذه لحذف محتوى مجموعة UserAccountManagement.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

عندما تتلقّى الخدمة الطلب، تزيل البيانات الحالية من مجموعة UserAccountManagement. في حال حدوث خطأ، يتم رفض الطلب بالكامل ويتم الاحتفاظ بالحالة الحالية.

deleteClusters

تُستخدَم واجهة برمجة التطبيقات هذه لحذف محتوى نوع مجموعة معيّن.

Kotlin

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      ...
      .build())

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                ...
                .build());

عندما تتلقّى الخدمة الطلب، تزيل البيانات الحالية من جميع المجموعات التي تتطابق مع أنواع المجموعات المحدّدة. يمكن للعملاء اختيار تمرير نوع واحد أو العديد من أنواع المجموعات. في حال حدوث خطأ، يتم رفض الطلب بالكامل ويتم الاحتفاظ بالحالة الحالية.

معالجة الأخطاء

ننصح بشدة بالاستماع إلى نتيجة المهمة من واجهات برمجة التطبيقات للنشر، مثل التي يمكن من خلالها اتخاذ إجراء متابعة لاسترداد مهمة ناجحة وإعادة إرسالها.

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

يتم عرض الخطأ على شكل AppEngageException مع تضمين السبب كرمز خطأ.

رمز الخطأ اسم الخطأ ملاحظة
1 SERVICE_NOT_FOUND الخدمة غير متاحة على الجهاز المحدّد.
2 SERVICE_NOT_AVAILABLE تتوفّر الخدمة على الجهاز المحدّد، ولكنّها غير متاحة في وقت المكالمة (على سبيل المثال، تم إيقافها صراحةً).
3 SERVICE_CALL_EXECUTION_FAILURE تعذّر تنفيذ المهمة بسبب مشاكل في سلاسل المحادثات. وفي هذه الحالة، يمكن إعادة المحاولة.
4 SERVICE_CALL_PERMISSION_DENIED لا يُسمح للمتصل بإجراء مكالمة الخدمة.
5 SERVICE_CALL_INVALID_ARGUMENT يحتوي الطلب على بيانات غير صالحة (على سبيل المثال، أكثر من العدد المسموح به من المجموعات).
6 SERVICE_CALL_INTERNAL حدث خطأ في الخدمة.
7 SERVICE_CALL_RESOURCE_EXHAUSTED يتم إجراء طلب الخدمة بشكل متكرر جدًا.

الخطوة 3: التعامل مع الأهداف التي يتم بثها

بالإضافة إلى إجراء طلبات بيانات من واجهة برمجة التطبيقات لنشر المحتوى من خلال مهمة، يجب أيضًا إعداد BroadcastReceiver لتلقّي طلب نشر المحتوى.

الهدف من عمليات البث هو إعادة تفعيل التطبيق وفرض مزامنة البيانات. لم يتم تصميم أهداف البث ليتم إرسالها بشكل متكرر. ولا يتم تشغيلها إلا عندما تحدّد خدمة Engage أنّ المحتوى قد يكون قديمًا (على سبيل المثال، عمره أسبوع). بهذه الطريقة، يمكننا أن نضمن بشكل أكبر حصول المستخدم على تجربة محتوى جديدة، حتى إذا لم يتم تشغيل التطبيق لفترة طويلة.

يجب إعداد BroadcastReceiver بالطريقتَين التاليتَين:

  • يمكنك تسجيل مثيل لفئة BroadcastReceiver ديناميكيًا باستخدام Context.registerReceiver(). يتيح ذلك الاتصال من التطبيقات التي لا تزال نشطة في الذاكرة.

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
  // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
  // received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Continuation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)
}

Java

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
// received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

}
  • يجب الإعلان بشكل ثابت عن عملية التنفيذ باستخدام علامة <receiver> في ملف AndroidManifest.xml. يسمح هذا للتطبيق بتلقي أهداف البث عندما لا يكون قيد التشغيل، كما يسمح للتطبيق بنشر المحتوى.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
      </intent-filter>
   </receiver>
</application>

سترسل الخدمة الطلبات التالية:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION ننصحك ببدء مكالمة publishRecommendationClusters عند تلقّي هذا الطلب.
  • com.google.android.engage.action.PUBLISH_FEATURED ننصحك ببدء مكالمة publishFeaturedCluster عند تلقّي هذا الطلب.
  • ‫com.google.android.engage.action.PUBLISH_CONTINUATIONIt is recommended to start apublishContinuationCluster` عند تلقّي هذا الغرض.

سير عمل الدمج

للحصول على دليل مفصّل حول التحقّق من عملية الدمج بعد اكتمالها، يُرجى الاطّلاع على سير عمل دمج المطوّرين في Engage.

الأسئلة الشائعة

يمكنك الاطّلاع على الأسئلة الشائعة حول Engage SDK لمعرفة المزيد.

معلومات الاتصال

يُرجى التواصل مع engage-developers@google.com إذا كانت لديك أي أسئلة أثناء عملية الدمج. سيردّ فريقنا عليك في أقرب وقت ممكن.

الخطوات التالية

بعد إكمال عملية الدمج هذه، تكون خطواتك التالية كما يلي:

  • أرسِل رسالة إلكترونية إلى engage-developers@google.com وأرفِق حزمة APK المدمجة والجاهزة للاختبار من قِبل Google.
  • ستُجري Google عملية تحقّق ومراجعة داخلية للتأكّد من أنّ عملية الدمج تعمل على النحو المتوقّع. إذا كانت هناك حاجة إلى إجراء تغييرات، ستتواصل معك Google لإطلاعك على أي تفاصيل ضرورية.
  • عند اكتمال الاختبار وعدم الحاجة إلى إجراء أي تغييرات، ستتواصل معك Google لإعلامك بأنّه يمكنك البدء في نشر حزمة APK المحدَّثة والمتكاملة على "متجر Google Play".
  • بعد أن تؤكّد Google نشر حزمة APK المعدَّلة على &quot;متجر Google Play&quot;، سيتم نشر مجموعات الاقتراحات والمحتوى المميّز والمتابعة وستظهر للمستخدمين.