تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Grow SDK Food: تعليمات الدمج الفني التابعة لجهات خارجية

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

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

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

المصطلحات

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

تعرض مجموعات الاقتراحات اقتراحات مخصّصة متعلقة بالطعام من أحد شركاء المطوّرين. ويمكن تخصيص هذه الاقتراحات للمستخدم أو تعميمها (على سبيل المثال، المنتجات الجديدة المخفَّضة). يمكنك استخدامها لعرض وصفات ومتاجر وأطباق ومواد غذائية وما إلى ذلك حسب ما تراه مناسبًا.
- يمكن أن تتألف مجموعة الاقتراحات من ProductEntity أو StoreEntity أو RecipeEntity من البطاقات، ولكن ليس من مزيج من أنواع مختلفة من العناصر.
الشكل :`ProductEntity` و`StoreEntity` و `RecipeEntity`. (*واجهة المستخدِم لأغراض توضيحية فقط)
تعرض المجموعة المميّزة مجموعة من العناصر من عدة شركاء مطوّرين في مجموعة واحدة ضمن واجهة المستخدم. سيكون هناك مجموعة واحدة من "الميزات"، تظهر بالقرب من أعلى واجهة المستخدم في موضع ذي أولوية أعلى من جميع مجموعات "الاقتراحات". سيُسمح لكل شريك مطوّر ببث ما يصل إلى 10 كيانات في المجموعة المميزة.

الشكل : مجموعة مميّزة تتضمّن `RecipeEntity`. (*واجهة المستخدم لأغراض توضيحية فقط)
تعرض مجموعة سلة تسوّق الطعام معاينة لسلال تسوّق البقالة من عدة شركاء مطوّرين في مجموعة واحدة من واجهة المستخدم، ما يشجّع المستخدمين على إكمال سلال التسوّق غير المكتملة. هناك مجموعة واحدة من "عربات تسوّق الطعام".
- يجب أن تعرض مجموعة "سلة تسوّق الطعام" العدد الإجمالي للعناصر في السلة، ويمكن أن تتضمّن أيضًا صورًا لعدد X من العناصر في سلة المستخدم.
  
  الشكل: مجموعة سلة تسوّق الطعام من شريك واحد. (*واجهة المستخدم لأغراض توضيحية فقط)
تعرض حزمة قائمة تسوّق الطعام معاينة لقوائم تسوّق البقالة من عدة شركاء مطوّرين في مجموعة واحدة من واجهة المستخدم، ما يدفع المستخدمين إلى الرجوع إلى التطبيق المعنيّ لتعديل قوائمهم وإكمالها. هناك مجموعة واحدة من "قوائم تسوّق الطعام".

الشكل: مجموعة "قائمة تسوّق المواد الغذائية" من شريك واحد. (*واجهة المستخدم لأغراض توضيحية فقط)
تعرض المجموعة إعادة ترتيب معاينة للطلبات السابقة من عدة شركاء مطوّرين في مجموعة واحدة ضمن واجهة المستخدم، ما يشجّع المستخدمين على إعادة ترتيب الطلبات. تتوفّر مجموعة واحدة فقط من "إعادة الترتيب".
- يجب أن تعرض مجموعة إعادة الطلب العدد الإجمالي للعناصر في طلب المستخدم السابق، ويجب أن تتضمّن أيضًا أحد الخيارَين التاليَين:
  - صور لـ X منتجات في طلب المستخدم السابق
  - تصنيفات لـ X منتجات في طلب المستخدم السابق
الشكل: مجموعة طلبات إعادة شراء الطعام من شريك واحد. (*واجهة المستخدم لأغراض توضيحية فقط)

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

الحد الأدنى لمستوى واجهة برمجة التطبيقات: 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.5.2'
}

ملخّص

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

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

نوع المجموعة	حدود المجموعات	الحدّ الأقصى لعدد العناصر في مجموعة
مجموعات الاقتراحات	7 على الأكثر	50 على الأكثر (`ProductEntity` أو `RecipeEntity` أو `StoreEntity`)
المجموعة المميزة	عملية واحدة بحد أقصى	20 على الأكثر (`ProductEntity` أو `RecipeEntity` أو `StoreEntity`)
مجموعة عربات تسوّق الطعام	عملية واحدة بحد أقصى	`ShoppingCartEntity` واحد كحدّ أقصى
مجموعة قائمة التسوّق من البقالة	عملية واحدة بحد أقصى	`ShoppingListEntity` واحد كحدّ أقصى
مجموعة إعادة طلب الطعام	عملية واحدة بحد أقصى	`ReorderEntity` واحد كحدّ أقصى

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

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

ProductEntity
StoreEntity
RecipeEntity
FoodShoppingCart
FoodShoppingList
FoodReorderCluster

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

`ProductEntity`

يمثّل العنصر ProductEntity منتجًا فرديًا (مثل منتج بقالة أو طبق من مطعم أو عرض ترويجي) يريد شركاء المطوّرين نشره.

السمة	المتطلب	الوصف	التنسيق
صور الملصقات	مطلوبة	يجب تقديم صورة واحدة على الأقل.	راجِع مواصفات الصور للحصول على إرشادات.
Action Uri	مطلوبة	تمثّل هذه السمة الرابط لصفحة في التطبيق تعرض تفاصيل حول المنتج. ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق لتحديد مصدر الإحالة. يُرجى الرجوع إلى الأسئلة الشائعة	معرّف موارد منتظم (URI)
العنوان	اختياري	اسم المنتج	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 90 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
السعر - الحالي	مطلوب بشكل مشروط	تمثّل هذه السمة السعر الحالي للمنتج. يجب توفيرها إذا تم توفير السعر المشطوب.	حقل التعبئة النصّية الحرّة
السعر - مشطوب	اختياري	تمثّل هذه السمة السعر الأصلي للعنصر، ويظهر مشطوبًا في واجهة المستخدم.	حقل التعبئة النصّية الحرّة
وسيلة الشرح	اختياري	عبارة توضيحية لعرض عرض ترويجي أو فعالية أو إشعار بشأن المنتج، إذا كان ذلك متاحًا	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
أحكام وسيلة الشرح	اختياري	نص الأحكام والشروط الدقيقة لوسيلة الشرح.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
التقييم (اختياري) - ملاحظة: يتم عرض جميع التقييمات باستخدام نظام التقييم بالنجوم العادي.
التقييم - الحد الأقصى للقيمة	اختياري	الحد الأقصى لمقياس التقييم. يجب توفيرها إذا تم توفير القيمة الحالية للتقييم أيضًا.	عدد >= 0.0
التقييم - القيمة الحالية	اختياري	القيمة الحالية لمقياس التقييم يجب توفيرها إذا تم توفير الحد الأقصى للتصنيف أيضًا.	عدد >= 0.0
التقييم - العدد	اختياري	تمثّل هذه السمة عدد التقييمات التي حصل عليها المنتج. ملاحظة: يجب توفير هذا الحقل إذا كان تطبيقك يتحكّم في طريقة عرض العدد للمستخدمين. استخدِم سلسلة موجزة. على سبيل المثال، إذا كان العدد 1,000,000، ننصحك باستخدام اختصار مثل 1M كي لا يتم اقتطاع العدد على أحجام العرض الأصغر.	سلسلة
التقييم - قيمة العدد	اختياري	تمثّل هذه السمة عدد التقييمات التي حصل عليها المنتج. ملاحظة: يجب توفير هذا الحقل إذا كنت لا تتعامل مع منطق الاختصار المعروض بنفسك. إذا كان كل من "العدد" و"قيمة العدد" متوفّرَين، سيظهر "العدد" للمستخدمين.	طويل
DisplayTimeWindow (اختياري): ضبط فترة زمنية لعرض المحتوى على المساحة
الطابع الزمني للبدء	اختياري	الطابع الزمني الخاص بالحقبة الذي يجب أن يظهر بعده المحتوى على مساحة العرض. في حال عدم ضبط هذه السياسة، يكون المحتوى مؤهَّلاً للعرض على المساحة.	الطابع الزمني لحقبة Unix بالملي ثانية
الطابع الزمني للنهاية	اختياري	الطابع الزمني لوقت بدء العصر الذي يتوقف بعده عرض المحتوى على مساحة العرض. في حال عدم ضبط هذه السياسة، يكون المحتوى مؤهَّلاً للعرض على المساحة.	الطابع الزمني لحقبة Unix بالملي ثانية

`StoreEntity`

يمثّل العنصر StoreEntity متجرًا فرديًا يريد شركاء المطوّرين نشره، مثل مطعم أو متجر بقالة.

السمة	المتطلب	الوصف	التنسيق
صور الملصقات	مطلوبة	يجب تقديم صورة واحدة على الأقل.	راجِع مواصفات الصور للحصول على إرشادات.
Action Uri	مطلوبة	الرابط لصفحة في التطبيق تعرض تفاصيل حول المتجر. ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق لتحديد مصدر الإحالة. يُرجى الرجوع إلى الأسئلة الشائعة	معرّف موارد منتظم (URI)
العنوان	اختياري	تمثّل هذه السمة اسم المتجر.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
الموقع الجغرافي	اختياري	تمثّل هذه السمة الموقع الجغرافي للمتجر.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
وسيلة الشرح	اختياري	عبارة توضيحية لعرض عرض ترويجي أو حدث أو آخر الأخبار عن المتجر، إذا كانت متاحة	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
أحكام وسيلة الشرح	اختياري	نص الأحكام والشروط الدقيقة لوسيلة الشرح.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
الوصف	اختياري	تمثّل هذه السمة وصفًا للمتجر.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 90 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
الفئة	اختياري	فئة المتجر، وفي سياق أماكن تناول الطعام، يمكن أن تكون مطبخًا مثل "فرنسي" أو "أمريكي جديد" أو "رامن" أو "مأكولات راقية".	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
ملاحظة: يتم عرض جميع التقييمات باستخدام نظام التقييم العادي بالنجوم.
التقييم - الحد الأقصى للقيمة	اختياري	الحد الأقصى لمقياس التقييم. يجب توفيرها إذا تم توفير القيمة الحالية للتقييم أيضًا.	عدد >= 0.0
التقييم - القيمة الحالية	اختياري	القيمة الحالية لمقياس التقييم يجب توفيرها إذا تم توفير الحد الأقصى للتصنيف أيضًا.	عدد >= 0.0
التقييم - العدد	اختياري	عدد التقييمات للمتجر ملاحظة: يجب توفير هذا الحقل إذا كان تطبيقك يريد التحكّم في طريقة عرض هذه المعلومات للمستخدمين. قدِّم السلسلة الموجزة التي يمكن عرضها للمستخدم. على سبيل المثال، إذا كان العدد 1,000,000، ننصحك باستخدام اختصارات مثل 1 مليون، كي لا يتم اقتطاعه على أحجام الشاشات الأصغر.	سلسلة
التقييم - قيمة العدد	اختياري	عدد التقييمات للمتجر ملاحظة: يجب توفير هذا الحقل إذا كنت لا تريد التعامل مع منطق الاختصار المعروض بنفسك. إذا توفّرت كل من "العدد" و"قيمة العدد"، سنستخدم "العدد" لعرضه للمستخدمين.	طويل

`RecipeEntity`

يمثّل عنصر RecipeEntity وصفة يريد شركاء المطوّرين نشرها.

السمة	المتطلب	الوصف	التنسيق
صور الملصقات	مطلوبة	يجب تقديم صورة واحدة على الأقل.	راجِع مواصفات الصور للحصول على إرشادات.
معرّف الموارد المنتظم للإجراء	مطلوبة	تمثّل هذه السمة الرابط لصفحة في التطبيق تعرض تفاصيل حول وصفة الطعام. ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق لتحديد مصدر الإحالة. يُرجى الرجوع إلى الأسئلة الشائعة	معرّف موارد منتظم (URI)
العنوان	اختياري	تمثّل هذه السمة اسم وصفة الطعام.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
مؤلِّف	اختياري	تمثّل هذه السمة مؤلف الوصفة.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
مدة الطهي/التحضير	اختياري	تمثّل هذه السمة مدة طهي الوصفة.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
وسيلة الشرح	اختياري	تمثّل هذه السمة وسيلة شرح لعرض عرض ترويجي أو حدث أو معلومات جديدة حول الوصفة، إذا كان ذلك متاحًا.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
الفئة	اختياري	تمثّل هذه السمة فئة الوصفة.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
الوصف	اختياري	تمثّل هذه السمة وصفًا للوصفة.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 90 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
ملاحظة: يتم عرض جميع التقييمات باستخدام نظام التقييم بالنجوم العادي.
التقييم - الحد الأقصى للقيمة	اختياري	الحد الأقصى لمقياس التقييم. يجب توفيرها إذا تم توفير القيمة الحالية للتقييم أيضًا.	عدد >= 0.0
التقييم - القيمة الحالية	اختياري	القيمة الحالية لمقياس التقييم يجب توفيرها إذا تم توفير الحد الأقصى للتصنيف أيضًا.	عدد >= 0.0
التقييم - العدد	اختياري	تمثّل هذه السمة عدد التقييمات التي حصلت عليها الوصفة. ملاحظة: يجب توفير هذا الحقل إذا كان تطبيقك يريد التحكّم في طريقة عرض هذه المعلومات للمستخدمين. قدِّم السلسلة الموجزة التي يمكن عرضها للمستخدم. على سبيل المثال، إذا كان العدد 1,000,000، ننصحك باستخدام اختصارات مثل 1 مليون، كي لا يتم اقتطاعه على أحجام الشاشات الأصغر.	سلسلة
التقييم - قيمة العدد	اختياري	تمثّل هذه السمة عدد التقييمات التي حصلت عليها الوصفة. ملاحظة: يجب توفير هذا الحقل إذا كنت لا تريد التعامل مع منطق الاختصار المعروض بنفسك. إذا توفّرت كل من "العدد" و"قيمة العدد"، سنستخدم "العدد" لعرضه للمستخدمين.	طويل

`FoodShoppingCart`

**الشكل:** سمات مجموعة "سلة تسوّق الطعام".

السمة	المتطلب	الوصف	التنسيق
معرّف الموارد المنتظم للإجراء	مطلوبة	الرابط لصفحة سلة التسوق في تطبيق الشريك ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق لتحديد مصدر الإحالة. الرجوع إلى الأسئلة الشائعة	معرّف موارد منتظم (URI)
عدد العناصر	مطلوبة	عدد السلع (وليس عدد المنتجات فقط) في سلة التسوّق. مثال: إذا كان هناك 3 برتقالات وتفاحة واحدة في سلة التسوق، يجب أن يكون هذا الرقم 4.	عدد صحيح >= 1
العنوان	اختياري	عنوان سلة التسوّق (مثلاً، سلة التسوّق) *في حال عدم توفير المطوّر للعنوان، يكون العنوان التلقائي هو سلّة التسوّق.*	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 25 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
نص الإجراء	اختياري	تمثّل هذه السمة نص عبارة الحث على اتخاذ إجراء في الزرّ الموجود في "حقيبة التسوّق" (على سبيل المثال، حقيبة التسوّق). *إذا لم يقدّم المطوّر نصًا للإجراء، سيكون الإجراء التلقائي هو عرض سلة التسوّق.* تتوفّر هذه السمة في الإصدار 1.1.0 والإصدارات الأحدث.	سلسلة
صور سلة التسوّق	اختياري	صور لكل منتج في سلة التسوّق يمكن تقديم ما يصل إلى 10 صور حسب ترتيب الأولوية، ويعتمد عدد الصور المعروضة على شكل الجهاز.	راجِع مواصفات الصور للحصول على إرشادات.
تصنيفات العناصر	اختياري	قائمة بتصنيفات السلع في قائمة التسوّق. يعتمد العدد الفعلي للتصنيفات المعروضة على شكل الجهاز.	قائمة التصنيفات النصية الحرة حجم النص المقترَح: أقل من 20 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
DisplayTimeWindow (اختياري): ضبط فترة زمنية لعرض المحتوى على المساحة
الطابع الزمني للبدء	اختياري	الطابع الزمني الخاص بالحقبة الذي يجب أن يظهر بعده المحتوى على مساحة العرض. في حال عدم ضبط هذه السياسة، يكون المحتوى مؤهَّلاً للعرض على المساحة.	الطابع الزمني لحقبة Unix بالملي ثانية
الطابع الزمني للنهاية	اختياري	الطابع الزمني لوقت بدء العصر الذي يتوقف بعده عرض المحتوى على مساحة العرض. في حال عدم ضبط هذه السياسة، يكون المحتوى مؤهَّلاً للعرض على المساحة.	الطابع الزمني لحقبة Unix بالملي ثانية

`FoodShoppingList`

**الشكل:** مجموعة "قائمة تسوّق المواد الغذائية".

السمة	المتطلب	الوصف	التنسيق
معرّف الموارد المنتظم للإجراء	مطلوبة	الرابط لصفحة معيّنة في تطبيق الشريك تؤدي إلى قائمة التسوّق ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق لتحديد مصدر الإحالة. يُرجى الرجوع إلى الأسئلة الشائعة	معرّف موارد منتظم (URI)
عدد العناصر	مطلوبة	عدد السلع في قائمة التسوّق	عدد صحيح >= 1
العنوان	اختياري	عنوان القائمة (مثلاً، قائمة مشترياتك) *إذا لم يقدّم المطوّر عنوانًا، سيكون العنوان التلقائي هو قائمة التسوّق.*	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 25 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
تصنيفات العناصر	مطلوبة	قائمة بتصنيفات السلع في قائمة التسوّق. يجب توفير تصنيف واحد على الأقل، ويمكن توفير ما يصل إلى 10 تصنيفات حسب ترتيب الأولوية، ويعتمد العدد الفعلي للتصنيفات المعروضة على شكل الجهاز.	قائمة التصنيفات النصية الحرة حجم النص المقترَح: أقل من 20 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)

`FoodReorderCluster`

السمة	المتطلب	الوصف	التنسيق
معرّف الموارد المنتظم للإجراء	مطلوبة	الرابط لصفحة في تطبيق الشريك لإعادة ترتيب المنتجات ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق لتحديد مصدر الإحالة. يُرجى الرجوع إلى الأسئلة الشائعة	معرّف موارد منتظم (URI)
نص الإجراء	اختياري	نص عبارة الحث على اتخاذ إجراء في زر "إعادة الطلب" (على سبيل المثال، إعادة الطلب). *في حال عدم توفير المطوّر لنص الإجراء، تكون القيمة التلقائية هي إعادة الترتيب.* تتوفّر هذه السمة في الإصدار 1.1.0 والإصدارات الأحدث.	سلسلة
عدد العناصر	مطلوبة	تمثّل هذه السمة عدد السلع (وليس عدد المنتجات فقط) في الطلب السابق. على سبيل المثال: إذا كان الطلب السابق يتضمّن 3 قهوات صغيرة وقطعة كرواسون واحدة، يجب أن يكون هذا الرقم 4.	عدد صحيح >= 1
العنوان	مطلوبة	تمثّل هذه السمة عنوان المنتج الذي يمكن إعادة طلبه.	حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 40 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
تصنيفات العناصر	اختياري (في حال عدم توفيرها، يجب توفير صور الملصقات)	قائمة بتصنيفات المنتجات للطلب السابق يمكن تقديم ما يصل إلى 10 تصنيفات حسب ترتيب الأولوية، ويعتمد العدد الفعلي للتصنيفات المعروضة على شكل الجهاز.	قائمة النصوص الحرة حجم النص المقترَح لكل تصنيف: أقل من 20 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
صور الملصقات	اختياري (في حال عدم توفيرها، يجب توفير تصنيفات العناصر)	صور السلع في الطلب السابق يمكن تقديم ما يصل إلى 10 صور حسب ترتيب الأولوية، ويعتمد عدد الصور المعروضة على شكل الجهاز.	راجِع مواصفات الصور للحصول على إرشادات.

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

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

نسبة العرض إلى الارتفاع	الحدّ الأدنى لعدد وحدات البكسل	وحدات البكسل المقترَحة
مربّعة (1x1) الشبكة المفضّلة	300x300	1200x1200
أفقية (1.91x1)	600x314	1200x628
عمودية (4x5)	‫480x600	960x1200

نسبة العرض إلى الارتفاع

الحدّ الأدنى لعدد وحدات البكسل

وحدات البكسل المقترَحة

مربّعة (1x1)

الشبكة المفضّلة

300x300

1200x1200

أفقية (1.91x1)

600x314

1200x628

عمودية (4x5)

‫480x600

960x1200

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

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

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

5120 كيلوبايت

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

مساحة القسم المهم في الصور: ضَع المحتوى المهم في الوسط ليشغل ‎80% من الصورة.
استخدِم خلفية شفافة حتى يمكن عرض الصورة بشكل صحيح في إعدادات المظهرَين الداكن والفاتح.

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

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

تتحمّل AppEngageFoodClient مسؤولية نشر مجموعات المأكولات.

تتوفّر واجهات برمجة التطبيقات التالية لنشر المجموعات في العميل:

isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishFoodShoppingCart
publishFoodShoppingList
publishReorderCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteFoodShoppingCartCluster
deleteFoodShoppingListCluster
deleteReorderCluster
deleteUserManagementCluster
deleteClusters

`isServiceAvailable`

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

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.

يمكن أن يتضمّن عنصر RecommendationCluster السمات التالية:

السمة	المتطلب	الوصف
قائمة ProductEntity أو StoreEntity أو RecipeEntity	مطلوبة	قائمة بالكيانات التي تشكّل الاقتراحات الخاصة بمجموعة الاقتراحات هذه. يجب أن تكون الكيانات في المجموعة العنقودية الواحدة من النوع نفسه.
العنوان	مطلوبة	تمثّل هذه السمة عنوان مجموعة الاقتراحات (على سبيل المثال، خصومات كبيرة على قائمة عشاء عيد الشكر). حجم النص المقترَح: أقل من 25 حرفًا (قد تظهر علامات حذف إذا كان النص طويلاً جدًا)
العنوان الفرعي	اختياري	العنوان الفرعي لمجموعة الاقتراحات
معرّف الموارد المنتظم للإجراء	اختياري	الرابط لصفحة في تطبيق الشريك حيث يمكن للمستخدمين الاطّلاع على القائمة الكاملة للاقتراحات ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق لتحديد مصدر الإحالة. الرجوع إلى الأسئلة الشائعة

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .build())
                .build());

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

تتم إزالة جميع بيانات "مجموعة الاقتراحات" الحالية.
يتم تحليل البيانات من الطلب وتخزينها في "مجموعات الاقتراحات" الجديدة.

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

`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 الحالية من حساب المطوّر الشريك.
يتم تحليل البيانات من الطلب وتخزينها في "المجموعة المميّزة" المعدَّلة.

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

`publishFoodShoppingCart`

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

Kotlin

client.publishFoodShoppingCart(
            PublishFoodShoppingCartClusterRequest.Builder()
                .setShoppingCart(
                    FoodShoppingCart.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFoodShoppingCart(
            new PublishFoodShoppingCartClusterRequest.Builder()
                .setShoppingCart(
                    new FoodShoppingCart.Builder()
                        ...
                        .build())
                .build());

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

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

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

`publishFoodShoppingList`

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

Kotlin

client.publishFoodShoppingList(
            PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFoodShoppingList(
            new PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    new FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build());

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

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

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

`publishReorderCluster`

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

Kotlin

client.publishReorderCluster(
            PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    FoodReorderCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishReorderCluster(
            new PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    new FoodReorderCluster.Builder()
                        ...
                        .build())
                .build());

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

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

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

`publishUserAccountManagementRequest`

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

تشكّل البيانات الوصفية التالية جزءًا من "بطاقة تسجيل الدخول":

السمة	المتطلب	الوصف
معرّف الموارد المنتظم للإجراء	مطلوب	رابط لصفحة الإجراء (أي ينتقل إلى صفحة تسجيل الدخول إلى التطبيق)
صورة	اختياري - إذا لم يتم توفيرها، يجب توفير العنوان	الصورة المعروضة على البطاقة صور بنسبة عرض إلى ارتفاع 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());

`deleteRecommendationClusters`

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

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

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

`deleteFeaturedCluster`

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

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

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

`deleteFoodShoppingCartCluster`

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

Kotlin

client.deleteFoodShoppingCartCluster()

Java

client.deleteFoodShoppingCartCluster();

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

`deleteFoodShoppingListCluster`

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

Kotlin

client.deleteFoodShoppingListCluster()

Java

client.deleteFoodShoppingListCluster();

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

`deleteReorderCluster`

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

Kotlin

client.deleteReorderCluster()

Java

client.deleteReorderCluster();

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

`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 لتلقّي طلب نشر المحتوى.

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

يجب إعداد 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 food shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART broadcast
  // is received
  // Trigger food shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST broadcast
  // is received
  // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER 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 food Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

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

// Register Reorder Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                           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 food shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART broadcast is
// received

// Trigger food shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER 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 food Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register food Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_LIST),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                         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.food.PUBLISH_FOOD_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER" />
      </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.food.PUBLISH_FOOD_SHOPPING_CART يُنصح ببدء مكالمة publishFoodShoppingCart عند تلقّي هذا الغرض.
com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST يُنصح ببدء مكالمة publishFoodShoppingList عند تلقّي هذا الغرض.
com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER يُنصح ببدء مكالمة publishReorderCluster عند تلقّي هذا الغرض.

سير عمل الدمج

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

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

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

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

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

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

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

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

Grow SDK Food: تعليمات الدمج الفني التابعة لجهات خارجية تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

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

المصطلحات

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

ملخّص

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

ProductEntity

StoreEntity

RecipeEntity

FoodShoppingCart

FoodShoppingList

FoodReorderCluster

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

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

isServiceAvailable

Kotlin

Java

publishRecommendationClusters

Kotlin

Java

publishFeaturedCluster

Kotlin

Java

publishFoodShoppingCart

Kotlin

Java

publishFoodShoppingList

Kotlin

Java

publishReorderCluster

Kotlin

Java

publishUserAccountManagementRequest

Kotlin

Java

updatePublishStatus

Kotlin

Java

deleteRecommendationClusters

Kotlin

Java

deleteFeaturedCluster

Kotlin

Java

deleteFoodShoppingCartCluster

Kotlin

Java

deleteFoodShoppingListCluster

Kotlin

Java

deleteReorderCluster

Kotlin

Java

deleteUserManagementCluster

Kotlin

Java

deleteClusters

Kotlin

Java

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

الخطوة 3: معالجة أغراض البث

Kotlin

Java

سير عمل الدمج

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

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

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

Grow SDK Food: تعليمات الدمج الفني التابعة لجهات خارجية

`ProductEntity`

`StoreEntity`

`RecipeEntity`

`FoodShoppingCart`

`FoodShoppingList`

`FoodReorderCluster`

`isServiceAvailable`

`publishRecommendationClusters`

`publishFeaturedCluster`

`publishFoodShoppingCart`

`publishFoodShoppingList`

`publishReorderCluster`

`publishUserAccountManagementRequest`

`updatePublishStatus`

`deleteRecommendationClusters`

`deleteFeaturedCluster`

`deleteFoodShoppingCartCluster`

`deleteFoodShoppingListCluster`

`deleteReorderCluster`

`deleteUserManagementCluster`

`deleteClusters`