Google در حال ساخت یک سطح روی دستگاه است که برنامه های کاربران را بر اساس عمودی سازماندهی می کند و یک تجربه همهجانبه جدید را برای مصرف شخصی و کشف محتوای برنامه امکان پذیر می کند. این تجربه تمام صفحه به شرکای توسعهدهنده فرصتی میدهد تا بهترین محتوای غنی خود را در یک کانال اختصاصی خارج از برنامه خود به نمایش بگذارند.
این راهنما حاوی دستورالعملهایی برای شرکای توسعهدهنده است تا محتوای غذایی خود را با استفاده از Engage SDK برای پر کردن این سطح جدید و سطوح موجود Google یکپارچه کنند.
جزئیات یکپارچه سازی
اصطلاحات
این ادغام شامل پنج نوع خوشه زیر است: توصیه ، ویژه ، سبد خرید غذا ، فهرست خرید غذا ، و سفارش مجدد .
خوشههای توصیه ، پیشنهادهای شخصیشده مرتبط با غذا را از یک شریک توسعهدهنده نشان میدهند. این توصیه ها را می توان برای کاربر شخصی سازی کرد یا تعمیم داد (به عنوان مثال، جدید در فروش). از آنها برای تهیه دستور العملها، فروشگاهها، ظروف، خواربارفروشیها و غیره استفاده کنید.
- یک خوشه توصیه می تواند از لیست های
ProductEntity
،StoreEntity
یاRecipeEntity
ساخته شود، اما ترکیبی از انواع موجودیت های مختلف نباشد.
- یک خوشه توصیه می تواند از لیست های
خوشه ویژه مجموعهای از موجودیتها را از چندین شریک توسعهدهنده در یک گروهبندی UI به نمایش میگذارد. یک خوشه ویژه وجود خواهد داشت که در نزدیکی بالای رابط کاربری با اولویت بالاتر از همه خوشههای توصیه ظاهر میشود. هر شریک توسعه دهنده مجاز به پخش حداکثر 10 موجودیت در خوشه ویژه خواهد بود.
خوشه سبد خرید غذا نگاهی اجمالی به سبد خرید خواربارفروشی از چندین شریک توسعه دهنده در یک گروه UI را نشان می دهد که کاربران را ترغیب می کند تا سبدهای خرید برجسته خود را تکمیل کنند. یک دسته سبد خرید غذا وجود دارد.
Cluster سبد خرید غذا باید تعداد کل اقلام موجود در سبد را نشان دهد و همچنین ممکن است تصاویر X مورد در سبد خرید کاربر را نیز شامل شود.
خوشه فهرست خرید غذا نگاهی اجمالی به لیست های خرید مواد غذایی از چندین شریک توسعه دهنده در یک گروه UI را نشان می دهد که از کاربران می خواهد برای به روز رسانی و تکمیل لیست خود به برنامه مربوطه بازگردند. یک گروه فهرست خرید غذا وجود دارد.
خوشه Reorder نگاهی اجمالی از سفارشات قبلی از چندین شریک توسعه دهنده در یک گروه UI را نشان می دهد که کاربران را وادار به سفارش مجدد می کند. یک خوشه Reorder واحد وجود دارد.
خوشه سفارش مجدد باید تعداد کل موارد در سفارش قبلی کاربر را نشان دهد و همچنین باید یکی از موارد زیر را شامل شود:
- تصاویر برای X مورد در سفارش قبلی کاربر.
- برچسبهایی برای X مورد در سفارش قبلی کاربر.
قبل از کار
حداقل سطح API: 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'
}
خلاصه
طراحی بر اساس اجرای یک سرویس محدود است.
دادههایی که مشتری میتواند منتشر کند مشمول محدودیتهای زیر برای انواع مختلف خوشه است:
نوع خوشه | محدودیت های خوشه ای | حداکثر محدودیت موجودیت در یک خوشه |
---|---|---|
خوشه(های) توصیه | حداکثر 5 | حداکثر 25 ( ProductEntity , RecipeEntity , یا StoreEntity ) |
خوشه ویژه | حداکثر 1 | حداکثر 10 ( ProductEntity , RecipeEntity , یا StoreEntity ) |
خوشه سبد خرید غذا | حداکثر 1 | حداکثر 1 ShoppingCartEntity |
خوشه لیست خرید مواد غذایی | حداکثر 1 | حداکثر 1 ShoppingListEntity |
خوشه سفارش مجدد غذا | حداکثر 1 | حداکثر 1 ReorderEntity |
مرحله 1: داده های موجودیت را ارائه دهید
SDK موجودیت های مختلفی را برای نشان دادن هر نوع مورد تعریف کرده است. ما از نهادهای زیر برای دسته غذا پشتیبانی می کنیم:
-
ProductEntity
-
StoreEntity
-
RecipeEntity
-
FoodShoppingCart
-
FoodShoppingList
-
FoodReorderCluster
نمودارهای زیر ویژگی ها و الزامات موجود برای هر نوع را مشخص می کند.
ProductEntity
شی ProductEntity
نشان دهنده یک مورد منفرد است (مانند یک کالای خواربارفروشی، غذای یک رستوران یا یک تبلیغ) که شرکای توسعه دهنده می خواهند منتشر کنند.
صفت | مورد نیاز | توضیحات | قالب |
---|---|---|---|
تصاویر پوستر | مورد نیاز | حداقل یک تصویر باید ارائه شود. | برای راهنمایی به مشخصات تصویر مراجعه کنید. |
اکشن اوری | مورد نیاز | پیوند عمیق به صفحه در برنامه که جزئیات مربوط به محصول را نشان می دهد. توجه: می توانید از پیوندهای عمیق برای ذکر منبع استفاده کنید. به این سؤالات متداول مراجعه کنید | اوری |
عنوان | اختیاری | نام محصول. | متن رایگان اندازه متن توصیه شده: کمتر از 90 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
قیمت - فعلی | مشروط مورد نیاز است | قیمت فعلی محصول. در صورت ارائه قیمت خطی باید ارائه شود. | متن رایگان |
قیمت - خط خطی | اختیاری | قیمت اصلی موجودیت، که در رابط کاربری مشخص شده است. | متن رایگان |
فراخوانی | اختیاری | فراخوانی برای ارائه یک تبلیغ، رویداد، یا بهروزرسانی برای محصول، در صورت وجود. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
چاپ ریز چاپ | اختیاری | متن چاپ دقیق برای فراخوانی. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
رتبه بندی (اختیاری) - توجه: همه رتبه بندی ها با استفاده از سیستم رتبه بندی ستاره استاندارد ما نمایش داده می شوند. | |||
رتبه - حداکثر مقدار | اختیاری | حداکثر مقدار مقیاس رتبه بندی. اگر ارزش فعلی رتبهبندی نیز ارائه شده باشد، باید ارائه شود. | عدد >= 0.0 |
رتبه - ارزش فعلی | اختیاری | ارزش فعلی مقیاس رتبه بندی. اگر حداکثر مقدار رتبه بندی نیز ارائه شده باشد، باید ارائه شود. | عدد >= 0.0 |
رتبه بندی - شمارش | اختیاری | تعداد امتیازات برای محصول توجه: اگر برنامه شما نحوه نمایش تعداد به کاربران را کنترل میکند، این قسمت را وارد کنید. از یک رشته مختصر استفاده کنید. به عنوان مثال، اگر تعداد 1,000,000 باشد، از مخففهایی مانند 1M استفاده کنید تا این تعداد در اندازههای نمایشگر کوچکتر کوتاه نشود. | رشته |
رتبه بندی - مقدار شمارش | اختیاری | تعداد امتیازات برای محصول توجه: اگر خودتان منطق مخفف نمایشگر را مدیریت نمیکنید، این فیلد را وارد کنید. اگر تعداد و مقدار تعداد هر دو موجود باشد، تعداد به کاربران نمایش داده می شود. | طولانی |
DisplayTimeWindow (اختیاری) - یک پنجره زمانی برای نمایش محتوا روی سطح تنظیم کنید | |||
مهر زمانی را شروع کنید | اختیاری | مهر زمانی دوره که پس از آن محتوا باید روی سطح نشان داده شود. اگر تنظیم نشود، محتوا واجد شرایط نمایش در سطح است. | مهر زمانی دوره در میلی ثانیه |
پایان مهر زمان | اختیاری | مهر زمانی دوره ای که پس از آن محتوا دیگر روی سطح نشان داده نمی شود. اگر تنظیم نشود، محتوا واجد شرایط نمایش در سطح است. | مهر زمانی دوره در میلی ثانیه |
StoreEntity
شی StoreEntity
نشان دهنده یک فروشگاه فردی است که شرکای توسعه دهنده می خواهند منتشر کنند، مانند یک رستوران یا یک فروشگاه مواد غذایی.
صفت | مورد نیاز | توضیحات | قالب |
---|---|---|---|
تصاویر پوستر | مورد نیاز | حداقل یک تصویر باید ارائه شود. | برای راهنمایی به مشخصات تصویر مراجعه کنید. |
اکشن اوری | مورد نیاز | پیوند عمیق به صفحه در برنامه که جزئیات مربوط به فروشگاه را نشان می دهد. توجه: می توانید از پیوندهای عمیق برای ذکر منبع استفاده کنید. به این سؤالات متداول مراجعه کنید | اوری |
عنوان | اختیاری | نام فروشگاه. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
مکان | اختیاری | موقعیت فروشگاه. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
فراخوانی | اختیاری | فراخوانی برای ارائه تبلیغات، رویداد یا بهروزرسانی برای فروشگاه، در صورت وجود. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
چاپ ریز چاپ | اختیاری | متن چاپ دقیق برای فراخوانی. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
توضیحات | اختیاری | توضیحات فروشگاه | متن رایگان اندازه متن توصیه شده: کمتر از 90 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
توجه: همه رتبهبندیها با استفاده از سیستم رتبهبندی ستاره استاندارد ما نمایش داده میشوند. | |||
رتبه - حداکثر مقدار | اختیاری | حداکثر مقدار مقیاس رتبه بندی. اگر ارزش فعلی رتبهبندی نیز ارائه شده باشد، باید ارائه شود. | عدد >= 0.0 |
رتبه - ارزش فعلی | اختیاری | ارزش فعلی مقیاس رتبه بندی. اگر حداکثر مقدار رتبه بندی نیز ارائه شده باشد، باید ارائه شود. | عدد >= 0.0 |
رتبه بندی - شمارش | اختیاری | تعداد امتیازات فروشگاه توجه: اگر برنامه شما میخواهد نحوه نمایش آن را برای کاربران کنترل کند، این قسمت را وارد کنید. رشته مختصری را ارائه دهید که می تواند به کاربر نمایش داده شود. برای مثال، اگر تعداد 1,000,000 باشد، از اختصاراتی مانند 1M استفاده کنید تا در اندازههای نمایشگر کوچکتر کوتاه نشود. | رشته |
رتبه بندی - مقدار شمارش | اختیاری | تعداد امتیازات فروشگاه توجه: اگر نمیخواهید منطق مخفف نمایش را خودتان مدیریت کنید، این فیلد را وارد کنید. اگر تعداد و مقدار تعداد هر دو موجود باشد، از تعداد برای نمایش به کاربران استفاده خواهیم کرد | طولانی |
RecipeEntity
شی RecipeEntity
یک آیتم دستوری را نشان می دهد که شرکای توسعه دهنده می خواهند منتشر کنند.
صفت | مورد نیاز | توضیحات | قالب |
---|---|---|---|
تصاویر پوستر | مورد نیاز | حداقل یک تصویر باید ارائه شود. | برای راهنمایی به مشخصات تصویر مراجعه کنید. |
اکشن اوری | مورد نیاز | پیوند عمیق به صفحه در برنامه که جزئیات مربوط به دستور غذا را نشان می دهد. توجه: می توانید از پیوندهای عمیق برای ذکر منبع استفاده کنید. به این سؤالات متداول مراجعه کنید | اوری |
عنوان | اختیاری | نام دستور غذا. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
نویسنده | اختیاری | نویسنده دستور غذا. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
زمان پخت / آماده سازی | اختیاری | زمان پخت دستور غذا. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
فراخوانی | اختیاری | فراخوانی برای ارائه یک تبلیغ، رویداد، یا بهروزرسانی برای دستور غذا، در صورت وجود. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
دسته بندی | اختیاری | دسته دستور غذا. | متن رایگان اندازه متن توصیه شده: کمتر از 45 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
توضیحات | اختیاری | شرح دستور غذا. | متن رایگان اندازه متن توصیه شده: کمتر از 90 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
توجه: همه رتبه بندی ها با استفاده از سیستم استاندارد رتبه بندی ستاره ما نمایش داده می شوند. | |||
رتبه - حداکثر مقدار | اختیاری | حداکثر مقدار مقیاس رتبه بندی. اگر ارزش فعلی رتبهبندی نیز ارائه شده باشد، باید ارائه شود. | عدد >= 0.0 |
رتبه - ارزش فعلی | اختیاری | ارزش فعلی مقیاس رتبه بندی. اگر حداکثر مقدار رتبه بندی نیز ارائه شده باشد، باید ارائه شود. | عدد >= 0.0 |
رتبه بندی - شمارش | اختیاری | تعداد امتیازات برای دستور غذا. توجه: اگر برنامه شما میخواهد نحوه نمایش آن را برای کاربران کنترل کند، این قسمت را وارد کنید. رشته مختصری را ارائه دهید که می تواند به کاربر نمایش داده شود. برای مثال، اگر تعداد 1,000,000 باشد، از اختصاراتی مانند 1M استفاده کنید تا در اندازههای نمایشگر کوچکتر کوتاه نشود. | رشته |
رتبه بندی - مقدار شمارش | اختیاری | تعداد امتیازات برای دستور غذا. توجه: اگر نمیخواهید منطق مخفف نمایش را خودتان مدیریت کنید، این فیلد را وارد کنید. اگر تعداد و مقدار تعداد هر دو موجود باشد، از تعداد برای نمایش به کاربران استفاده خواهیم کرد | طولانی |
FoodShoppingCart
صفت | مورد نیاز | توضیحات | قالب |
---|---|---|---|
اکشن اوری | مورد نیاز | پیوند عمیق به سبد خرید در برنامه شریک. توجه: می توانید از پیوندهای عمیق برای ذکر منبع استفاده کنید. به این سؤالات متداول مراجعه کنید | اوری |
تعداد اقلام | مورد نیاز | تعداد اقلام (نه فقط تعداد محصولات) در سبد خرید. به عنوان مثال: اگر 3 پرتقال و 1 سیب در سبد خرید وجود دارد، این عدد باید 4 باشد. | عدد صحیح >= 1 |
عنوان | اختیاری | عنوان سبد خرید (به عنوان مثال، سبد خرید شما ). اگر هیچ عنوانی توسط توسعه دهنده ارائه نشده باشد، سبد خرید شما پیش فرض است. | متن رایگان اندازه متن توصیه شده: کمتر از 25 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
متن اقدام | اختیاری | متن فراخوان دکمه روی سبد خرید (به عنوان مثال، کیف خرید شما ). اگر هیچ متن اقدامی توسط برنامهنویس ارائه نشد، View Cart پیشفرض است. این ویژگی در نسخه 1.1.0 به بعد پشتیبانی می شود. | رشته |
تصاویر سبد خرید | اختیاری | تصاویر هر محصول در سبد خرید. حداکثر 10 تصویر به ترتیب اولویت ارائه می شود. تعداد واقعی تصاویر نمایش داده شده به فاکتور فرم دستگاه بستگی دارد. | برای راهنمایی به مشخصات تصویر مراجعه کنید. |
برچسب های اقلام | اختیاری | لیست برچسب ها برای اقلام موجود در لیست خرید. تعداد واقعی برچسب های نمایش داده شده به فاکتور فرم دستگاه بستگی دارد. | لیست برچسب های متن آزاد اندازه متن توصیه شده: کمتر از 20 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
DisplayTimeWindow (اختیاری) - یک پنجره زمانی برای نمایش محتوا روی سطح تنظیم کنید | |||
مهر زمانی را شروع کنید | اختیاری | مهر زمانی دوره که پس از آن محتوا باید روی سطح نشان داده شود. اگر تنظیم نشود، محتوا واجد شرایط نمایش در سطح است. | مهر زمانی دوره در میلی ثانیه |
پایان مهر زمان | اختیاری | مهر زمانی دوره ای که پس از آن محتوا دیگر روی سطح نشان داده نمی شود. اگر تنظیم نشود، محتوا واجد شرایط نمایش در سطح است. | مهر زمانی دوره در میلی ثانیه |
FoodShoppingList
صفت | مورد نیاز | توضیحات | قالب |
---|---|---|---|
اکشن اوری | مورد نیاز | پیوند عمیق به لیست خرید در برنامه شریک. توجه: می توانید از پیوندهای عمیق برای ذکر منبع استفاده کنید. به این سؤالات متداول مراجعه کنید | اوری |
تعداد اقلام | مورد نیاز | تعداد کالاهای موجود در لیست خرید. | عدد صحیح >= 1 |
عنوان | اختیاری | عنوان لیست (به عنوان مثال، فهرست مواد غذایی شما ). اگر هیچ عنوانی توسط توسعه دهنده ارائه نشده باشد، لیست خرید پیش فرض است. | متن رایگان اندازه متن توصیه شده: کمتر از 25 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
برچسب های اقلام | مورد نیاز | لیست برچسب ها برای اقلام موجود در لیست خرید. حداقل 1 برچسب باید ارائه شود و حداکثر 10 برچسب می تواند به ترتیب اولویت ارائه شود. تعداد واقعی برچسب های نمایش داده شده به فاکتور فرم دستگاه بستگی دارد. | لیست برچسب های متن آزاد اندازه متن توصیه شده: کمتر از 20 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
FoodReorderCluster
صفت | مورد نیاز | توضیحات | قالب |
---|---|---|---|
اکشن اوری | مورد نیاز | پیوند عمیق برای سفارش مجدد در برنامه شریک. توجه: می توانید از پیوندهای عمیق برای ذکر منبع استفاده کنید. به این سؤالات متداول مراجعه کنید | اوری |
متن اقدام | اختیاری | متن فراخوانی دکمه روی ترتیب مجدد (به عنوان مثال، دوباره سفارش دهید ). اگر هیچ متن اقدامی توسط توسعهدهنده ارائه نشد، Reorder پیشفرض است. این ویژگی در نسخه 1.1.0 به بعد پشتیبانی می شود. | رشته |
تعداد اقلام | مورد نیاز | تعداد اقلام (نه فقط تعداد محصولات) در سفارش قبلی. به عنوان مثال: اگر به ترتیب قبلی 3 قهوه کوچک و 1 کروسان وجود داشت، این عدد باید 4 باشد. | عدد صحیح >= 1 |
عنوان | مورد نیاز | عنوان مورد سفارش مجدد. | متن رایگان اندازه متن توصیه شده: کمتر از 40 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
برچسب های اقلام | اختیاری (در صورت عدم ارائه، تصاویر پوستر ارائه شود) | لیست برچسب های اقلام برای سفارش قبلی. حداکثر 10 برچسب می تواند به ترتیب اولویت ارائه شود. تعداد واقعی برچسب های نمایش داده شده به فاکتور فرم دستگاه بستگی دارد. | لیست متن آزاد اندازه متن توصیه شده برای هر برچسب: کمتر از 20 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
تصاویر پوستر | اختیاری (در صورت عدم ارائه، برچسب های کالا باید ارائه شود) | تصاویری از اقلام به ترتیب قبلی. حداکثر 10 تصویر به ترتیب اولویت ارائه می شود. تعداد واقعی تصاویر نمایش داده شده به فاکتور فرم دستگاه بستگی دارد. | برای راهنمایی به مشخصات تصویر مراجعه کنید. |
مشخصات تصویر
مشخصات مورد نیاز برای دارایی های تصویر در زیر ذکر شده است:
نسبت ابعاد | حداقل پیکسل | پیکسل های توصیه شده |
---|---|---|
مربع (1x1) ترجیح داده شده است | 300x300 | 1200x1200 |
منظره (1.91x1) | 600x314 | 1200x628 |
پرتره (4x5) | 480x600 | 960x1200 |
فرمت های فایل
PNG، JPG، GIF استاتیک، WebP
حداکثر اندازه فایل
5120 کیلوبایت
توصیه های اضافی
- ناحیه امن تصویر: محتوای مهم خود را 80 درصد در مرکز تصویر قرار دهید.
- از پس زمینه شفاف استفاده کنید تا تصویر به درستی در تنظیمات تم تیره و روشن نمایش داده شود.
مرحله 2: داده های Cluster را ارائه دهید
توصیه میشود کار انتشار محتوا در پسزمینه اجرا شود (مثلاً با استفاده از WorkManager ) و به طور منظم یا بر اساس رویداد برنامهریزی شود (به عنوان مثال، هر بار که کاربر برنامه را باز میکند یا زمانی که کاربر به تازگی چیزی به آن اضافه کرده است. سبد خرید آنها).
AppEngageFoodClient
مسئول انتشار خوشه های غذایی است.
API های زیر برای انتشار خوشه ها در مشتری وجود دارد:
-
isServiceAvailable
-
publishRecommendationClusters
-
publishFeaturedCluster
-
publishFoodShoppingCart
-
publishFoodShoppingList
-
publishReorderCluster
-
publishUserAccountManagementRequest
-
updatePublishStatus
-
deleteRecommendationsClusters
-
deleteFeaturedCluster
-
deleteFoodShoppingCartCluster
-
deleteFoodShoppingListCluster
-
deleteReorderCluster
-
deleteUserManagementCluster
-
deleteClusters
isServiceAvailable
این API برای بررسی اینکه آیا سرویس برای یکپارچه سازی در دسترس است و اینکه آیا محتوا می تواند در دستگاه ارائه شود یا خیر استفاده می شود.
کاتلین
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. } }
جاوا
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
این API برای انتشار فهرست اشیاء RecommendationCluster
استفاده می شود.
یک شی RecommendationCluster
می تواند دارای ویژگی های زیر باشد:
صفت | مورد نیاز | توضیحات |
---|---|---|
فهرست ProductEntity، StoreEntity یا RecipeEntity | مورد نیاز | فهرستی از نهادهایی که توصیه های این خوشه توصیه را تشکیل می دهند. موجودیت های یک خوشه باید از یک نوع باشند. |
عنوان | مورد نیاز | عنوان برای خوشه توصیه (به عنوان مثال، پس انداز بزرگ در منوی شکرگزاری ). اندازه متن توصیه شده: کمتر از 25 کاراکتر (متنی که خیلی طولانی است ممکن است بیضی نشان دهد) |
زیرنویس | اختیاری | زیرنویس خوشه توصیه. |
اکشن اوری | اختیاری | پیوند عمیق به صفحه در برنامه شریک که در آن کاربران میتوانند فهرست کامل توصیهها را ببینند. توجه: می توانید از پیوندهای عمیق برای ذکر منبع استفاده کنید. به این سؤالات متداول مراجعه کنید |
کاتلین
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Big savings on Thanksgiving menu") .build()) .build())
جاوا
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Big savings on Thanksgiving menu") .build()) .build());
هنگامی که سرویس درخواست را دریافت می کند، اقدامات زیر در یک تراکنش انجام می شود:
- تمام داده های موجود در خوشه توصیه حذف شده است.
- دادههای درخواست در خوشههای پیشنهادی جدید تجزیه و ذخیره میشوند.
در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
publishFeaturedCluster
این API برای انتشار یک شی FeaturedCluster
استفاده می شود.
کاتلین
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() ... .build()) .build())
جاوا
client.publishFeaturedCluster( new PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( new FeaturedCluster.Builder() ... .build()) .build());
هنگامی که سرویس درخواست را دریافت می کند، اقدامات زیر در یک تراکنش انجام می شود:
- داده های
FeaturedCluster
موجود از شریک توسعه حذف شده است. - داده های درخواست تجزیه و تحلیل می شود و در خوشه ویژه به روز شده ذخیره می شود.
در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
publishFoodShoppingCart
این API برای انتشار یک شی FoodShoppingCart
استفاده می شود.
کاتلین
client.publishFoodShoppingCart( PublishFoodShoppingCartClusterRequest.Builder() .setShoppingCart( FoodShoppingCart.Builder() ... .build()) .build())
جاوا
client.publishFoodShoppingCart( new PublishFoodShoppingCartClusterRequest.Builder() .setShoppingCart( new FoodShoppingCart.Builder() ... .build()) .build());
هنگامی که سرویس درخواست را دریافت می کند، اقدامات زیر در یک تراکنش انجام می شود:
- داده های
FoodShoppingCart
موجود از شریک توسعه دهنده حذف شده است. - داده های درخواست تجزیه و تحلیل می شود و در خوشه سبد خرید به روز شده ذخیره می شود.
در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
publishFoodShoppingList
این API برای انتشار یک شی FoodShoppingList
استفاده می شود.
کاتلین
client.publishFoodShoppingList( PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( FoodShoppingListEntity.Builder() ... .build()) .build())
جاوا
client.publishFoodShoppingList( new PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( new FoodShoppingListEntity.Builder() ... .build()) .build());
هنگامی که سرویس درخواست را دریافت می کند، اقدامات زیر در یک تراکنش انجام می شود:
- داده های
FoodShoppingList
موجود از شریک سازنده حذف شده است. - داده های درخواست تجزیه و تحلیل می شود و در خوشه لیست خرید به روز شده ذخیره می شود.
در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
publishReorderCluster
این API برای انتشار یک شی FoodReorderCluster
استفاده می شود.
کاتلین
client.publishReorderCluster( PublishReorderClusterRequest.Builder() .setReorderCluster( FoodReorderCluster.Builder() ... .build()) .build())
جاوا
client.publishReorderCluster( new PublishReorderClusterRequest.Builder() .setReorderCluster( new FoodReorderCluster.Builder() ... .build()) .build());
هنگامی که سرویس درخواست را دریافت می کند، اقدامات زیر در یک تراکنش انجام می شود:
- داده های
FoodReorderCluster
موجود از شریک توسعه حذف شده است. - دادههای درخواست تجزیه و تحلیل میشوند و در خوشه ترتیب مجدد بهروز شده ذخیره میشوند.
در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
publishUserAccountManagementRequest
این API برای انتشار کارت ورود به سیستم استفاده می شود. عمل ورود به سیستم، کاربران را به صفحه ورود به برنامه هدایت میکند تا برنامه بتواند محتوا را منتشر کند (یا محتوای شخصیسازیشدهتری ارائه کند)
فراداده زیر بخشی از کارت ورود به سیستم است -
صفت | مورد نیاز | توضیحات |
---|---|---|
اکشن اوری | مورد نیاز | پیوند عمیق به Action (یعنی به صفحه ورود به برنامه پیمایش میکند) |
تصویر | اختیاری - در صورت عدم ارائه، عنوان باید ارائه شود | تصویر روی کارت نشان داده شده است تصاویر با نسبت ابعاد 16x9 با وضوح 1264x712 |
عنوان | اختیاری - اگر ارائه نشد، تصویر باید ارائه شود | عنوان روی کارت |
متن اقدام | اختیاری | متن نمایش داده شده در CTA (یعنی ورود به سیستم) |
زیرنویس | اختیاری | زیرنویس اختیاری روی کارت |
کاتلین
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());
جاوا
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 API بهروزرسانی کنید. این مهم است زیرا:
- ارائه وضعیت در همه سناریوها، حتی زمانی که محتوا منتشر می شود (وضعیت == منتشر شده)، برای پر کردن داشبوردهایی که از این وضعیت صریح برای انتقال سلامت و سایر معیارهای ادغام شما استفاده می کنند، بسیار مهم است.
- اگر محتوایی منتشر نشود اما وضعیت ادغام خراب نباشد (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 انتشار کارت ورود به سیستم را توصیه می کند. اگر به هر دلیلی ارائه دهندگان قادر به انتشار کارت ورود به سیستم نیستند، توصیه می کنیم با کد وضعیت NOT_PUBLISHED_REQUIRES_SIGN_IN با updatePublishStatus API تماس بگیرید.
کاتلین
client.updatePublishStatus( PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build())
جاوا
client.updatePublishStatus( new PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build());
deleteRecommendationClusters
این API برای حذف محتوای خوشه های توصیه استفاده می شود.
کاتلین
client.deleteRecommendationClusters()
جاوا
client.deleteRecommendationClusters();
هنگامی که سرویس درخواست را دریافت می کند، داده های موجود را از خوشه های توصیه حذف می کند. در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
deleteFeaturedCluster
این API برای حذف محتوای Featured Cluster استفاده می شود.
کاتلین
client.deleteFeaturedCluster()
جاوا
client.deleteFeaturedCluster();
هنگامی که سرویس درخواست را دریافت می کند، داده های موجود را از خوشه ویژه حذف می کند. در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
deleteFoodShoppingCartCluster
این API برای حذف محتوای خوشه سبد خرید غذا استفاده می شود.
کاتلین
client.deleteFoodShoppingCartCluster()
جاوا
client.deleteFoodShoppingCartCluster();
هنگامی که سرویس درخواست را دریافت می کند، داده های موجود را از خوشه سبد خرید غذا حذف می کند. در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
deleteFoodShoppingListCluster
این API برای حذف محتوای خوشه لیست خرید غذا استفاده می شود.
کاتلین
client.deleteFoodShoppingListCluster()
جاوا
client.deleteFoodShoppingListCluster();
هنگامی که سرویس درخواست را دریافت می کند، داده های موجود را از خوشه لیست خرید غذا حذف می کند. در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
deleteReorderCluster
این API برای حذف محتوای FoodReorderCluster استفاده می شود.
کاتلین
client.deleteReorderCluster()
جاوا
client.deleteReorderCluster();
هنگامی که سرویس درخواست را دریافت می کند، داده های موجود را از Reorder Cluster حذف می کند. در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
deleteUserManagementCluster
این API برای حذف محتوای UserAccountManagement Cluster استفاده می شود.
کاتلین
client.deleteUserManagementCluster()
جاوا
client.deleteUserManagementCluster();
هنگامی که سرویس درخواست را دریافت می کند، داده های موجود را از UserAccountManagement Cluster حذف می کند. در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
deleteClusters
این API برای حذف محتوای یک نوع خوشه مشخص استفاده می شود.
کاتلین
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build())
جاوا
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build());
هنگامی که سرویس درخواست را دریافت می کند، داده های موجود را از همه خوشه های مطابق با انواع خوشه های مشخص شده حذف می کند. مشتریان می توانند انتخاب کنند که یک یا چند نوع خوشه را پاس کنند. در صورت بروز خطا، کل درخواست رد می شود و وضعیت موجود حفظ می شود.
رسیدگی به خطا
به شدت توصیه می شود که به نتیجه کار از API های منتشر شده گوش دهید تا بتوان یک اقدام بعدی را برای بازیابی و ارسال مجدد یک کار موفق انجام داد.
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: اهداف پخش را مدیریت کنید
علاوه بر برقراری تماسهای API محتوای انتشار از طریق یک کار، برای دریافت درخواست انتشار محتوا نیز باید یک BroadcastReceiver
راهاندازی کرد.
هدف از اهداف پخش عمدتاً فعال سازی مجدد برنامه و همگام سازی اجباری داده ها است. اهداف پخش برای ارسال خیلی مکرر طراحی نشده اند. تنها زمانی فعال میشود که سرویس Engage تشخیص دهد که ممکن است محتوا قدیمی باشد (مثلاً یک هفتهای است). به این ترتیب، اطمینان بیشتری وجود دارد که کاربر می تواند یک تجربه محتوای تازه داشته باشد، حتی اگر برنامه برای مدت طولانی اجرا نشده باشد.
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
شروع کنید.
گردش کار یکپارچه سازی
برای راهنمایی گام به گام در مورد تأیید ادغام خود پس از تکمیل، به گردش کار ادغام برنامهنویس Engage مراجعه کنید.
سوالات متداول
برای پرسشهای متداول به پرسشهای متداول SDK مراجعه کنید.
تماس بگیرید
در صورت وجود هرگونه سوال در طول فرآیند ادغام، با engage-developers@google.com تماس بگیرید. تیم ما در اسرع وقت پاسخ خواهد داد.
مراحل بعدی
پس از تکمیل این ادغام، مراحل بعدی شما به شرح زیر است:
- یک ایمیل به engage-developers@google.com ارسال کنید و APK یکپارچه خود را که برای آزمایش توسط Google آماده است، پیوست کنید.
- Google یک راستیآزمایی و بازبینی داخلی انجام میدهد تا مطمئن شود که ادغام مطابق انتظار عمل میکند. در صورت نیاز به تغییرات، Google با هر جزئیات لازم با شما تماس خواهد گرفت.
- وقتی آزمایش کامل شد و نیازی به تغییر نیست، Google با شما تماس می گیرد تا به شما اطلاع دهد که می توانید انتشار APK به روز شده و یکپارچه را در فروشگاه Play شروع کنید.
- پس از اینکه Google تأیید کرد که APK به روز شده شما در فروشگاه Play منتشر شده است، مجموعه های توصیه ، ویژه ، سبد خرید ، فهرست خرید و سفارش مجدد شما منتشر شده و برای کاربران قابل مشاهده خواهد بود.