تصمم Google مساحة على الجهاز لتنظيم تطبيقات المستخدمين حسب الفئات وتقديم تجربة غامرة وجديدة تتيح لهم الاطّلاع على محتوى التطبيقات واستكشافه بطريقة مخصصة. وتوفّر تجربة ملء الشاشة هذه للشركاء المطوّرين فرصة لعرض أفضل محتوى وافٍ في قناة مخصّصة خارج التطبيق.
يتضمّن هذا الدليل تعليمات لشركائنا من المطوّرين حول دمج المحتوى الغذائي الخاص بهم باستخدام حزمة تطوير البرامج Engage SDK لتعبئة مساحة العرض الجديدة هذه ومساحات عرض Google الحالية.
تفاصيل عملية الدمج
المصطلحات
ويشمل هذا الدمج أنواع المجموعات الخمسة التالية: اقتراحات ومميزة وسلة تسوّق الطعام وقائمة تسوّق الطعام وإعادة الطلب.
تعرض مجموعات الاقتراحات اقتراحات مخصّصة تتعلّق بالطعام من شريك مطوّر فردي. يمكن تخصيص هذه الاقتراحات للمستخدم أو تعميمها (على سبيل المثال، عروض جديدة بأسعار مخفَّضة). استخدمها لعرض الوصفات والمتاجر والأطباق ومنتجات البقالة وما إلى ذلك على النحو الذي تراه مناسبًا.
- يمكن أن تتألف مجموعة الاقتراحات من بيانات
ProductEntity
أوStoreEntity
أوRecipeEntity
، ولكن لا يمكن أن تتألف من مزيج من أنواع مختلفة من الكيانات.
- يمكن أن تتألف مجموعة الاقتراحات من بيانات
تعرض مجموعة المميّزة الصورة الرئيسية
ProductEntity
، أوStoreEntity
، أوRecipeEntity
التي تم اختيارها من بين العديد من شركاء المطوّرين في مجموعة واحدة لواجهة المستخدم. هناك مجموعة ميزات واحدة تظهر بالقرب من أعلى واجهة المستخدم، مع وضع أولوية أعلى من كل مجموعات الاقتراحات. يُسمح لكل شريك من شركاء المطوّرين ببث كيان واحد من نوع متوافق ضمن "المحتوى المميّز"، مع العديد من الكيانات (من المحتمل أن تكون من أنواع مختلفة) من مطوّري تطبيقات متعددين في المجموعة "المميزة".تعرض مجموعة سلات تسوّق الطعام لمحة سريعة على سلات تسوّق البقالة من عدة شركاء من المطوّرين في مجموعة واحدة من واجهات المستخدم، ما يدفع المستخدمين إلى إكمال سلات التسوّق البارزة. هناك مجموعة واحدة لعربة تسوق الطعام.
- يجب أن تعرض مجموعة سلات تسوّق الطعام العدد الإجمالي للسلع في سلّة التسوّق وقد تتضمّن أيضًا صورًا لـ X سلعة في سلّة تسوّق المستخدم.
تعرض مجموعة Food Shopping List (قائمة التسوّق) لمحة سريعة على قوائم تسوّق البقالة من عدة شركاء من المطوّرين في مجموعة واحدة من واجهة المستخدم، ما يدفع المستخدمين إلى العودة إلى التطبيق المعني لتحديث قوائمهم وإكمالها. هناك مجموعة قائمة واحدة لتسوق الطعام.
تعرض مجموعة إعادة الترتيب لمحة سريعة على الطلبات السابقة من عدة شركاء من المطوّرين في مجموعة واحدة من واجهة المستخدم، ما يدفع المستخدمين إلى إعادة الطلب. هناك مجموعة واحدة لإعادة الترتيب.
يجب أن تُظهر إعادة ترتيب التجميع العدد الإجمالي للعناصر في الطلب السابق للمستخدم، كما يجب أن تتضمن أيضًا أحد ما يلي:
- صور لـ X عنصر بالترتيب السابق للمستخدم.
- تصنيفات X عنصر بالترتيب السابق للمستخدم.
ما قبل العمل
الحد الأدنى لمستوى واجهة برمجة التطبيقات: 19
إضافة مكتبة com.google.android.play:engage
إلى تطبيقك:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.4.0'
}
ملخّص
ويعتمد التصميم على تنفيذ خدمة مرتبطة.
تخضع البيانات التي يمكن للعميل نشرها للحدود التالية لأنواع المجموعات المختلفة:
نوع المجموعة | حدود المجموعة | الحدود القصوى لعدد العناصر في المجموعة الواحدة |
---|---|---|
مجموعة أو مجموعات الاقتراحات | 5 على الأكثر | 25 كحد أقصى (ProductEntity أو RecipeEntity أو
StoreEntity ) |
مجموعة مميّزة | 1 كحد أقصى | منتج واحد كحدّ أقصى (ProductEntity أو RecipeEntity أو
StoreEntity ) |
مجموعة عربات تسوق الطعام | 1 كحد أقصى | ShoppingCartEntity واحد كحدّ أقصى |
مجموعة قوائم تسوق المأكولات | 1 كحد أقصى | ShoppingListEntity واحد كحدّ أقصى |
مجموعة إعادة طلب الطعام | 1 كحد أقصى | ReorderEntity واحد كحدّ أقصى |
الخطوة 1: تقديم بيانات الكيان
حدّدت حزمة SDK عناصر مختلفة لتمثيل كل نوع عنصر. ندعم الكيانات التالية لفئة "الطعام":
ProductEntity
StoreEntity
RecipeEntity
FoodShoppingCart
FoodShoppingList
FoodReorderCluster
توضّح الرسوم البيانية أدناه السمات والمتطلبات المتاحة لكل نوع.
ProductEntity
يمثّل الكائن ProductEntity
عنصرًا فرديًا (مثل سلعة بقالة أو طبق من مطعم أو عرض ترويجي) يريد شركاء المطوّرين نشره.
السمة | المتطلب | الوصف | التنسيق |
---|---|---|---|
صور الملصق | مطلوبة | يجب تقديم صورة واحدة على الأقل. | يمكنك الاطّلاع على مواصفات الصور للحصول على إرشادات. |
يوري أدنيش | مطلوبة |
الرابط لموضع معيّن يؤدي إلى صفحة في التطبيق تعرض تفاصيل عن المنتج. ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق من أجل تحديد المصدر. يمكنك الرجوع إلى هذه الأسئلة الشائعة. |
معرّف موارد منتظم (URI) |
العنوان | اختياري | اسم المنتج | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 90 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
السعر - الحالي | مطلوب بشكل مشروط | السعر الحالي للمنتج. يجب توفير هذه السمة في حال تقديم سعر يتوسطه خط. |
حقل التعبئة النصّية الحرّة |
السعر - يتوسطه خط | اختياري | السعر الأصلي للكيان، الذي تم عرضه في واجهة المستخدم. | حقل التعبئة النصّية الحرّة |
وسيلة الشرح | اختياري | وسيلة شرح لإدراج عرض ترويجي أو فعالية أو تعديل للمنتج، في حال توفّره. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
النص المكتوب كوسائل شرح | اختياري | النص المطبوع الدقيق لوسيلة الشرح. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
التقييم (اختياري): ملاحظة: يتم عرض جميع التقييمات باستخدام نظام التقييم بالنجوم العادي لدينا. | |||
التقييم - الحد الأقصى للقيمة | عنصر مطلوب | تمثّل هذه السمة القيمة القصوى لمقياس التقييم. يجب تقديمها في حال تقديم القيمة الحالية للتقييم أيضًا. |
الرقم >= 0.0 |
التقييم - القيمة الحالية | عنصر مطلوب | القيمة الحالية لتقييم الكيان. يجب تقديمها في حال تقديم الحد الأقصى لقيمة التقييم أيضًا. |
الرقم >= 0.0 |
التقييم - العدد | اختياري | تمثّل هذه السمة عدد التقييمات للكيان. | سلسلة |
DisplayTimeWindow (اختيارية): ضبط فترة زمنية لعرض المحتوى على مساحة العرض | |||
الطابع الزمني للبدء | اختياري |
الطابع الزمني للفترة التي يجب بعدها عرض المحتوى على مساحة العرض. وفي حال تركها بدون ضبط، يكون المحتوى مؤهّلاً للظهور على سطح الفيديو. |
الطابع الزمني للفترة بالمللي ثانية |
الطابع الزمني للانتهاء | اختياري |
الطابع الزمني للفترة التي لن يظهر بعدها المحتوى على السطح. وفي حال تركها بدون ضبط، يكون المحتوى مؤهّلاً للظهور على سطح الفيديو. |
الطابع الزمني للفترة بالمللي ثانية |
StoreEntity
يمثّل العنصر StoreEntity
متجرًا فرديًا يريد الشركاء
المطوّرون نشره، مثل مطعم أو متجر بقالة.
السمة | المتطلب | الوصف | التنسيق |
---|---|---|---|
صور الملصق | مطلوبة | يجب تقديم صورة واحدة على الأقل. | يمكنك الاطّلاع على مواصفات الصور للحصول على إرشادات. |
يوري أدنيش | مطلوبة | الرابط لموضع معيّن يؤدي إلى صفحة في التطبيق تعرض تفاصيل عن المتجر. ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق من أجل تحديد المصدر. يمكنك الرجوع إلى هذه الأسئلة الشائعة. |
معرّف موارد منتظم (URI) |
العنوان | اختياري | اسم المتجر | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
الموقع الجغرافي | اختياري | الموقع الجغرافي للمتجر. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
وسيلة الشرح | اختياري | وسيلة شرح لعرض عرض ترويجي أو حدث أو تحديث للمتجر، في حال توفّرها. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
النص المكتوب كوسائل شرح | اختياري | النص المطبوع الدقيق لوسيلة الشرح. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
الوصف | اختياري | وصف للمتجر. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 90 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
ملاحظة: يتم عرض جميع التقييمات باستخدام نظام التقييم بالنجوم العادي. | |||
التقييم - الحد الأقصى للقيمة | مطلوب بشكل مشروط | تمثّل هذه السمة القيمة القصوى لمقياس التقييم. يجب تقديمها في حال تقديم القيمة الحالية للتقييم أيضًا. |
الرقم >= 0.0 |
التقييم - القيمة الحالية | مطلوب بشكل مشروط | القيمة الحالية لتقييم الكيان. يجب تقديمها في حال تقديم الحد الأقصى لقيمة التقييم أيضًا. |
الرقم >= 0.0 |
التقييم - العدد | اختياري | تمثّل هذه السمة عدد التقييمات للكيان. | سلسلة |
RecipeEntity
يمثّل الكائن RecipeEntity
صنفًا من الوصفة يريد الشركاء
المطوّرون نشره.
السمة | المتطلب | الوصف | التنسيق |
---|---|---|---|
صور الملصق | مطلوبة | يجب تقديم صورة واحدة على الأقل. | يمكنك الاطّلاع على مواصفات الصور للحصول على إرشادات. |
يوري أدنيش | مطلوبة | رابط الصفحة في التطبيق الذي يعرض تفاصيل حول الوصفة. ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق من أجل تحديد المصدر. يمكنك الرجوع إلى هذه الأسئلة الشائعة. |
معرّف موارد منتظم (URI) |
العنوان | اختياري | تمثّل هذه السمة اسم الوصفة. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
المؤلّف | اختياري | تمثّل هذه السمة مؤلف الوصفة. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
وقت الطهي/التحضير | اختياري | تمثّل هذه السمة وقت طهي الوصفة. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
وسيلة الشرح | اختياري | وسيلة شرح لإدراج عرض ترويجي أو فعالية أو تعديل لوصفة الطعام، إذا كان ذلك متاحًا. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
الفئة | اختياري | تمثّل هذه السمة فئة الوصفة. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 45 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
الوصف | اختياري | تمثّل هذه السمة وصفًا للوصفة. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 90 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
ملاحظة: يتم عرض جميع التقييمات باستخدام نظام التقييم بالنجوم العادي. | |||
التقييم - الحد الأقصى للقيمة | مطلوب بشكل مشروط | تمثّل هذه السمة القيمة القصوى لمقياس التقييم. يجب تقديمها في حال تقديم القيمة الحالية للتقييم أيضًا. |
الرقم >= 0.0 |
التقييم - القيمة الحالية | مطلوب بشكل مشروط | القيمة الحالية لتقييم الكيان. يجب تقديمها في حال تقديم الحد الأقصى لقيمة التقييم أيضًا. |
الرقم >= 0.0 |
التقييم - العدد | اختياري | تمثّل هذه السمة عدد التقييمات للكيان. | سلسلة |
FoodShoppingCart
السمة | المتطلب | الوصف | التنسيق |
---|---|---|---|
يوري أدنيش | مطلوبة |
الرابط لموضع معيّن يؤدي إلى سلة التسوّق في تطبيق الشريك. ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق من أجل تحديد المصدر. يمكنك الرجوع إلى هذه الأسئلة الشائعة. |
معرّف موارد منتظم (URI) |
عدد العناصر | مطلوبة | عدد السلع (وليس فقط عدد المنتجات) في سلّة التسوّق على سبيل المثال: إذا كان هناك 3 برتقال وتفاحة واحدة في سلة التسوق، يجب أن يكون هذا الرقم 4. |
عدد صحيح >= 1 |
العنوان | اختياري | عنوان سلة التسوّق (على سبيل المثال، سلّة التسوّق). إذا لم يقدّم المطوّر أي عنوان، ستكون سلّة التسوّق هي الإعداد التلقائي. |
حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 25 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
نص الإجراء | اختياري |
نص عبارة الحث على اتخاذ إجراء للزرّ في سلّة التسوّق (مثل حقيبة التسوّق). إذا لم يقدم المطوّر نص إجراء، سيكون خيار عرض سلّة التسوّق هو الخيار التلقائي. تتوفّر هذه السمة في الإصدار 1.1.0 والإصدارات الأحدث. |
سلسلة |
صور سلة التسوّق | اختياري | صور لكل منتج في سلة التسوق يمكن تقديم ما يصل إلى 10 صور بترتيب الأولوية، ويعتمد العدد الفعلي للصور المعروضة على شكل الجهاز. |
يمكنك الاطّلاع على مواصفات الصور للحصول على إرشادات. |
تصنيفات العناصر | اختياري | قائمة تصنيفات السلع في قائمة التسوّق يعتمد العدد الفعلي للتصنيفات المعروضة على شكل الجهاز المستخدَم. |
قائمة التصنيفات النصية المجانية حجم النص المقترَح: أقل من 20 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
DisplayTimeWindow (اختيارية): ضبط فترة زمنية لعرض المحتوى على مساحة العرض | |||
الطابع الزمني للبدء | اختياري |
الطابع الزمني للفترة التي يجب بعدها عرض المحتوى على مساحة العرض. وفي حال تركها بدون ضبط، يكون المحتوى مؤهّلاً للظهور على سطح الفيديو. |
الطابع الزمني للفترة بالمللي ثانية |
الطابع الزمني للانتهاء | اختياري |
الطابع الزمني للفترة التي لن يظهر بعدها المحتوى على السطح. وفي حال تركها بدون ضبط، يكون المحتوى مؤهّلاً للظهور على سطح الفيديو. |
الطابع الزمني للفترة بالمللي ثانية |
FoodShoppingList
السمة | المتطلب | الوصف | التنسيق |
---|---|---|---|
يوري أدنيش | مطلوبة |
الرابط لصفحة معيّنة في قائمة التسوّق في تطبيق الشريك ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق من أجل تحديد المصدر. يمكنك الرجوع إلى هذه الأسئلة الشائعة. |
معرّف موارد منتظم (URI) |
عدد العناصر | مطلوبة | عدد السلع في قائمة التسوّق | عدد صحيح >= 1 |
العنوان | اختياري |
عنوان القائمة (على سبيل المثال، قائمة البقالة). إذا لم يقدّم المطوّر أي عنوان، ستكون قائمة التسوّق هي الخيار التلقائي. |
حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 25 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
تصنيفات العناصر | مطلوبة | قائمة تصنيفات السلع في قائمة التسوّق يجب تقديم تصنيف واحد على الأقل، ويمكن تقديم ما يصل إلى 10 تصنيفات بترتيب الأولوية، ويعتمد العدد الفعلي للتصنيفات المعروضة على شكل الجهاز المستخدَم. |
قائمة التصنيفات النصية المجانية حجم النص المقترَح: أقل من 20 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
FoodReorderCluster
السمة | المتطلب | الوصف | التنسيق |
---|---|---|---|
يوري أدنيش | مطلوبة |
رابط الصفحة في التطبيق المطلوب إعادة ترتيبه في تطبيق الشريك. ملاحظة: يمكنك استخدام الروابط لصفحات في التطبيق من أجل تحديد المصدر. يمكنك الرجوع إلى هذه الأسئلة الشائعة. |
معرّف موارد منتظم (URI) |
نص الإجراء | اختياري |
نص عبارة الحث على اتّخاذ إجراء للزرّ في "إعادة الطلب" (على سبيل المثال، الطلب مرة أخرى). إذا لم يقدِّم المطوِّر نص الإجراء، سيكون خيار إعادة الترتيب هو الخيار التلقائي. تتوفّر هذه السمة في الإصدار 1.1.0 والإصدارات الأحدث. |
سلسلة |
عدد العناصر | مطلوبة | عدد السلع (وليس فقط عدد المنتجات) في الطلب السابق على سبيل المثال: إذا كان هناك 3 أنواع قهوة صغيرة وكرواسون واحد في الطلب السابق، يجب أن يكون هذا الرقم 4. |
عدد صحيح >= 1 |
العنوان | مطلوبة | تمثّل هذه السمة عنوان طلب إعادة الطلب. | حقل التعبئة النصّية الحرّة حجم النص المقترَح: أقل من 40 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
تصنيفات العناصر | اختياري (يجب توفير صور الملصق في حال عدم توفيرها) |
قائمة تصنيفات السلع للطلب السابق. يمكن تقديم ما يصل إلى 10 تصنيفات بترتيب الأولوية، ويعتمد العدد الفعلي للتصنيفات المعروضة على شكل الجهاز المستخدَم. |
قائمة النصوص المجانية حجم النص المقترَح لكل تصنيف: أقل من 20 حرفًا (قد يعرض النص الطويل جدًا علامات حذف) |
صور الملصق | اختياري (يجب تقديم تصنيفات السلع في حال عدم توفيرها) |
صور السلع بالترتيب السابق يمكن تقديم ما يصل إلى 10 صور بترتيب الأولوية، ويعتمد العدد الفعلي للصور المعروضة على شكل الجهاز. |
يمكنك الاطّلاع على مواصفات الصور للحصول على إرشادات. |
مواصفات الصور
في ما يلي المواصفات المطلوبة لمواد عرض الصور:
نسبة العرض إلى الارتفاع | الحدّ الأدنى لوحدات البكسل | وحدات البكسل التي ننصح بها |
---|---|---|
مربّع (1x1) الخيار المفضّل |
300×300 | 1200 × 1200 |
أفقي (1.91x1) | 600×314 | 1200 × 628 |
العمودية (4×5) | 480×600 | 960×1200 |
تنسيقات الملفات
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
تُستخدم واجهة برمجة التطبيقات هذه لنشر بطاقة تسجيل الدخول . عند إجراء تسجيل الدخول، يتم توجيه المستخدمين إلى صفحة تسجيل الدخول إلى التطبيق ليتمكن التطبيق من نشر المحتوى (أو تقديم محتوى أكثر تخصيصًا)
تشكّل البيانات الوصفية التالية جزءًا من بطاقة تسجيل الدخول -
السمة | المتطلب | الوصف |
---|---|---|
يوري أدنيش | عنصر مطلوب | رابط لموضع معيّن يؤدي إلى إجراء (أي الانتقال إلى صفحة تسجيل الدخول إلى التطبيق) |
صورة | اختياري: يجب تقديم العنوان في حال عدم تقديمه. |
الصورة التي تظهر على البطاقة صور بنسبة عرض إلى ارتفاع تبلغ 16x9 بدقة 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 == 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
مع تضمين السبب كرمز خطأ.
رمز الخطأ | ملاحظة |
---|---|
SERVICE_NOT_FOUND |
لا تتوفر الخدمة على الجهاز المحدد. |
SERVICE_NOT_AVAILABLE |
الخدمة متاحة على الجهاز المحدّد، ولكنّها غير متاحة في وقت المكالمة (على سبيل المثال، تكون غير مفعّلة بشكل صريح). |
SERVICE_CALL_EXECUTION_FAILURE |
تعذّر تنفيذ المهمة بسبب مشاكل في سلاسل المحادثات. وفي هذه الحالة، يمكن إعادة المحاولة. |
SERVICE_CALL_PERMISSION_DENIED |
غير مسموح للمتصل بإجراء مكالمة الخدمة. |
SERVICE_CALL_INVALID_ARGUMENT |
يحتوي الطلب على بيانات غير صالحة (على سبيل المثال، أكثر من عدد المجموعات المسموح به). |
SERVICE_CALL_INTERNAL |
هناك خطأ في جانب الخدمة. |
SERVICE_CALL_RESOURCE_EXHAUSTED |
يتم الاتصال بالخدمة بشكل متكرر جدًا. |
الخطوة 3: التعامل مع أهداف البث
بالإضافة إلى إجراء طلبات خاصة بواجهة النشر للمحتوى من خلال المهمة، يجب أيضًا إعداد BroadcastReceiver
لتلقّي طلب نشر المحتوى.
إن الهدف من أغراض البث بشكل أساسي هو إعادة تفعيل التطبيق وفرض مزامنة البيانات. لم يتم تصميم أغراض البث كي يتم إرسالها بشكل متكرر. ولا يتمّ بدء المراجعة إلّا عندما تحدّد خدمة التفاعل أنّ المحتوى قد يكون قديمًا (على سبيل المثال، منذ أسبوع). بهذه الطريقة، يكون هناك المزيد من الثقة في أن المستخدم يمكن أن يحصل على تجربة محتوى جديدة، حتى إذا لم يتم تنفيذ التطبيق لفترة زمنية طويلة.
يجب إعداد BroadcastReceiver
بالطريقتَين التاليتَين:
- تسجيل مثيل لفئة
BroadcastReceiver
ديناميكيًا باستخدام السمةContext.registerReceiver()
. يتيح ذلك الاتصال من التطبيقات التي لا تزال موجودة في الذاكرة.
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 shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART
// broadcast is received
// Trigger 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));
// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));
// Register Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART));
// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_LIST));
// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER));
}
- أعلِن بشكل ثابت عن عملية تنفيذ باستخدام علامة
<receiver>
في ملفAndroidManifest.xml
الخاص بك. يتيح ذلك للتطبيق تلقّي أغراض البث عندما لا يكون قيد التشغيل، كما يسمح للتطبيق بنشر المحتوى.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
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
عند تلقّي هذا الهدف.
سير عمل عملية الدمج
للحصول على دليل مفصّل حول التحقّق من عملية الدمج بعد اكتمالها، يُرجى الاطّلاع على خطوات دمج المطوّرين المرتبطة بالتفاعل.
الأسئلة الشائعة
اطّلِع على الأسئلة الشائعة حول التفاعل مع حزمة تطوير البرامج (SDK) للحصول على الأسئلة الشائعة.
Contact
يُرجى التواصل معنا على engagement-developers@google.com إذا كانت لديك أي أسئلة خلال عملية الدمج. سيرد فريقنا في أقرب وقت ممكن.
الخطوات التالية
بعد إتمام عملية الدمج هذه، ستكون خطواتك التالية على النحو التالي:
- أرسل رسالة إلكترونية إلى engagement-developers@google.com وإرفاق حزمة APK المدمجة والجاهزة للاختبار من Google.
- ستجري Google عملية تحقق وتراجع داخليًا للتأكّد من أنّ عملية الدمج تعمل على النحو المتوقّع. وفي حال الحاجة إلى إجراء أي تغييرات، ستتواصل معك Google لإطلاعك على أي تفاصيل ضرورية.
- عند اكتمال الاختبار وعدم الحاجة إلى إجراء أي تغييرات، ستتواصل معك Google لتخبرك بأنه يمكنك بدء نشر حِزمة APK المعدّلة والمدمجة على متجر Play.
- بعد أن تتأكّد Google من نشر حزمة APK المعدّلة على "متجر Play"، سيتم نشر مجموعات الاقتراحات والمميزة وسلّة التسوّق وقائمة التسوّق وإعادة الترتيب وستظهر للمستخدمين.