Engage SDK Other Verticals: دستورالعمل‌های یکپارچه‌سازی فنی شخص ثالث، سایر عمودی‌ها Engage SDK: دستورالعمل‌های یکپارچه‌سازی فنی شخص ثالث

با دسترسی به کاربران خود در هر کجا که هستند، تعامل با برنامه را افزایش دهید. Engage SDK را ادغام کنید تا توصیه‌های شخصی‌سازی‌شده و محتوای مداوم را مستقیماً به کاربران در سطوح مختلف روی دستگاه، مانند Collections ، Entertainment Space و Play Store ارائه دهید. این ادغام کمتر از ۵۰ کیلوبایت (فشرده‌شده) به میانگین APK اضافه می‌کند و برای اکثر برنامه‌ها حدود یک هفته از زمان توسعه‌دهنده را می‌گیرد. برای اطلاعات بیشتر به سایت تجاری ما مراجعه کنید.

این سند شامل دستورالعمل‌هایی برای شرکای توسعه‌دهنده است تا محتوای جدیدی مانند رزرو، رویدادها، اقامتگاه‌ها، مکان‌های دیدنی، افراد و سایر محتوایی که ممکن است به هیچ یک از این دسته‌ها تعلق نداشته باشند را ادغام کنند.

جزئیات ادغام

اصطلاحات

این ادغام شامل سه نوع خوشه زیر است: توصیه ، ویژه و ادامه .

• خوشه‌های توصیه، پیشنهادهای شخصی‌سازی‌شده از یک شریک توسعه‌دهنده را نشان می‌دهند. این یک نمای رابط کاربری است که شامل گروهی از توصیه‌ها از همان شریک توسعه‌دهنده است.

  • ArticleEntity : ArticleEntity که یک پیشنهاد مبتنی بر متن برای محتوایی ارائه می‌دهد که به بیش از یک دسته از محتوا مربوط می‌شود. آیتم ArticleEntity به توسعه‌دهندگان این امکان را می‌دهد که در مقایسه با GenericFeaturedEntity، انواع محتوای متنی و تصویری را با فراداده‌های بیشتر برای بیان اطلاعات به کاربران ارائه دهند. مثال: محتوای بازاریابی، قطعه اخبار

    

    شکل ۱: رابط کاربری که یک ArticleEntity واحد را در خوشه توصیه‌ها نشان می‌دهد.

  • EventEntity : EventEntity نشان دهنده رویدادی است که در آینده اتفاق می‌افتد. زمان شروع رویداد، بخش مهمی از اطلاعات است که باید به کاربران منتقل شود.

    

    شکل ۲: رابط کاربری که یک EventEntity واحد را در خوشه توصیه‌ها نشان می‌دهد.

  • LodgingEntity : LodgingEntity نشان دهنده یک اقامتگاه، مانند هتل، آپارتمان، خانه تعطیلات برای اجاره کوتاه مدت و بلند مدت است.

    

    شکل ۳: رابط کاربری که یک LodgingEntity واحد را در خوشه توصیه‌ها نشان می‌دهد.

  • StoreEntity : StoreEntity نشان‌دهنده یک فروشگاه، رستوران، کافه و غیره است. این عنصر، محتوایی را برجسته می‌کند که در آن یک محل غذاخوری یا فروشگاه، بخش مهمی از اطلاعات است که باید به کاربران منتقل شود.

    

    شکل ۴: رابط کاربری که یک StoreEntity واحد را در خوشه توصیه‌ها نشان می‌دهد.

  • PointOfInterestEntity : PointOfInterestEntity نشان‌دهنده یک مکان مورد علاقه مانند پمپ بنزین، محل برگزاری رویداد، پارک تفریحی، موزه، جاذبه گردشگری، مسیر پیاده‌روی و غیره است. این مکان، محتوایی را برجسته می‌کند که در آن مکان، اطلاعات مهمی است که باید به کاربران منتقل شود. نباید از آن برای اقامت، فروشگاه یا محل غذاخوری استفاده شود.

    

    شکل ۵: رابط کاربری که یک PointOfInterestEntity واحد را در خوشه توصیه‌ها نشان می‌دهد.

  • PersonEntity : PersonEntity نمایانگر یک شخص است. توصیه‌ها می‌تواند برجسته کردن یک شخص در دسته‌بندی‌هایی مانند سلامت و تناسب اندام، ورزش، قرار ملاقات و غیره باشد.

    

    شکل ۵: رابط کاربری که یک PersonEntity واحد را در خوشه توصیه‌ها نشان می‌دهد.

• خوشه Continuation محتوایی را نشان می‌دهد که اخیراً توسط کاربران چندین شریک توسعه‌دهنده در یک گروه‌بندی رابط کاربری واحد مورد استفاده قرار گرفته است. هر شریک توسعه‌دهنده مجاز به پخش حداکثر ۱۰ موجودیت در خوشه Continuation خواهد بود.

  محتوای ادامه شما می‌تواند ساختار زیر را داشته باشد:

  • موجودیت مقاله : موجودیت مقاله‌ای که یک پیشنهاد متنی برای محتوایی مرتبط با بیش از یک دسته محتوا ارائه می‌دهد. این موجودیت می‌تواند برای نمایش مقالات خبری ناتمام یا سایر محتوایی که کاربر مایل است از جایی که آن را رها کرده است، به خواندن آن ادامه دهد، استفاده شود. مثال: محتوای بازاریابی، قطعه خبر

    

    شکل ۶. رابط کاربری که یک ArticleEntity واحد را در یک خوشه Continuation نشان می‌دهد.

  • RestaurantReservationEntity : RestaurantReservationEntity نشان‌دهنده رزرو برای یک رستوران یا کافه است و به کاربران کمک می‌کند تا رزروهای آینده یا جاری رستوران را پیگیری کنند.

    

    شکل ۷. رابط کاربری که یک RestaurantReservationEntity واحد را در یک خوشه Continuation نشان می‌دهد.

  • EventReservationEntity : EventReservationEntity نشان‌دهنده رزرو برای یک رویداد است و به کاربران کمک می‌کند تا رزرو رویدادهای آینده یا در حال انجام را پیگیری کنند. رویدادها می‌توانند شامل موارد زیر باشند، اما محدود به آنها نیستند:

    • رویدادهای ورزشی مانند رزرو مسابقه فوتبال
    • رویدادهای بازی مانند رزرو برای eSports
    • رویدادهای سرگرمی مانند رزرو فیلم در سینما، کنسرت، تئاتر، امضای کتاب
    • رزرو سفر یا مکان‌های مورد علاقه مانند تورهای گردشگری، بلیط موزه
    • رزروهای اجتماعی / سمینار / کنفرانس
    • رزرو جلسات آموزشی/تربیتی

    

    شکل ۸. رابط کاربری که یک EventReservationEntity واحد را درون یک کلاستر Continuation نشان می‌دهد.

  • LodgingReservationEntity : LodgingEntityReservation نشان‌دهنده رزرو یک اقامتگاه مسافرتی است و به کاربران کمک می‌کند تا رزروهای آتی یا جاری هتل یا اجاره اقامتگاه برای تعطیلات را پیگیری کنند.

    

    شکل ۹. رابط کاربری که یک LodgingReservationEntity واحد را در یک خوشه Continuation نشان می‌دهد.

  • TransportationReservationEntity : TransportationReservationEntity نشان‌دهنده رزرو برای حمل و نقل با هر وسیله‌ای است و به کاربران کمک می‌کند تا رزروهای مربوط به پرواز، کشتی، قطار، اتوبوس، تاکسی اینترنتی یا سفر دریایی آینده یا در حال انجام را پیگیری کنند.

    

    شکل ۱۰. رابط کاربری که یک TransportationReservationEntity واحد را درون یک خوشه Continuation نشان می‌دهد.

  • VehicleRentalReservationEntity : VehicleRentalReservationEntity نشان‌دهنده رزرو اجاره خودرو است و به کاربران کمک می‌کند تا رزروهای اجاره خودرو در آینده یا در حال انجام را پیگیری کنند.

    

    شکل ۱۱. رابط کاربری که یک VehicleRentalReservationEntity واحد را در یک خوشه Continuation نشان می‌دهد.

• خوشه ویژه (Featured cluster) یک نمای رابط کاربری است که GenericFeaturedEntity قهرمان انتخاب شده را از بین بسیاری از شرکای توسعه‌دهنده در یک گروه‌بندی رابط کاربری نمایش می‌دهد. یک خوشه ویژه (Featured cluster) وجود دارد که در نزدیکی بالای رابط کاربری ظاهر می‌شود و اولویت آن بالاتر از همه خوشه‌های توصیه (Recommendation clusters) است. هر شریک توسعه‌دهنده مجاز است یک موجودیت واحد از یک نوع پشتیبانی شده را در ویژه (Featured) پخش کند، و بسیاری از موجودیت‌ها (به طور بالقوه از انواع مختلف) از چندین توسعه‌دهنده برنامه در خوشه ویژه (Featured cluster) قرار دارند.

  • موجودیت ویژه عمومی (GenericFeaturedEntity) : موجودیت ویژه عمومی با آیتم توصیه (Recommendation item) متفاوت است، زیرا آیتم ویژه باید برای یک محتوای برتر از توسعه‌دهندگان استفاده شود و باید مهم‌ترین محتوایی را که برای کاربران جالب و مرتبط خواهد بود، نشان دهد.

    

    شکل ۱۲: رابط کاربری که یک کارت GenericFeaturedEntity قهرمان واحد را در یک خوشه ویژه نشان می‌دهد

پیش کار

حداقل سطح API: ۱۹

کتابخانه com.google.android.engage:engage-core به برنامه خود اضافه کنید:

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

خلاصه

طراحی بر اساس پیاده‌سازی یک سرویس محدود (bound service) است.

داده‌هایی که یک کلاینت می‌تواند منتشر کند، برای انواع مختلف خوشه‌ها مشمول محدودیت‌های زیر است:

نوع خوشه	محدودیت‌های خوشه	حداقل محدودیت موجودیت در یک خوشه	حداکثر محدودیت‌های موجودیت در یک خوشه
خوشه(های) پیشنهادی	حداکثر ۷ عدد	حداقل ۱	حداکثر ۵۰ ( ArticleEntity ، EventEntity ، LodgingEntity ، StoreEntity ، PointOfInterestEntity یا PersonEntity )
خوشه ادامه	حداکثر ۱	حداقل ۱	حداکثر ۲۰ ( ArticleEntity ، EventReservationEntity ، LodgingReservationEntity ، TransportationReservationEntity ، یا VehicleRentalReservationEntity )
خوشه ویژه	حداکثر ۱	حداقل ۱	حداکثر 20 ( GenericFeaturedEntity )

مرحله ۱: ارائه داده‌های موجودیت

SDK برای نمایش هر نوع آیتم، موجودیت‌های مختلفی تعریف کرده است. ما از موجودیت‌های زیر برای دسته‌ی other پشتیبانی می‌کنیم:

1. GenericFeaturedEntity
2. ArticleEntity
3. EventEntity
4. LodgingEntity
5. StoreEntity
6. PointOfInterestEntity
7. PersonEntity
8. RestaurantReservationEntity
9. EventReservationEntity
10. LodgingReservationEntity
11. TransportationReservationEntity
12. VehicleRentalReservationEntity

نمودارهای زیر ویژگی‌ها و الزامات موجود برای هر نوع را شرح می‌دهند.

GenericFeaturedEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
تصاویر پوستر	مورد نیاز	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است. توجه: اگر نشان ارائه می‌شود، فضای امن ۲۴ dps را در بالا و پایین تصویر تضمین کنید.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
عنوان	اختیاری	عنوان نهاد.	متن رایگان اندازه متن پیشنهادی: ۵۰ کاراکتر
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
نشان‌ها	اختیاری	هر نشان یا متن آزاد (حداکثر ۱۵ کاراکتر) یا تصویر کوچک است. جلوه‌های ویژه UX روی تصویر/ویدئو، مثلاً به عنوان پوشش نشان روی تصویر «به‌روزرسانی زنده» مدت زمان مطالعه مقاله
نشان - متن	اختیاری	عنوان برای نشان توجه: برای نشان، متن یا تصویر الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ۱۵ کاراکتر
نشان - تصویر	اختیاری	تصویر کوچک جلوه‌های ویژه تجربه کاربری، برای مثال به صورت پوشش نشان روی تصویر کوچک تصویر/ویدئو. توجه: برای نشان، متن یا تصویر الزامی است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
دسته بندی محتوا	اختیاری	دسته بندی محتوای موجود در موجودیت را شرح دهید.	فهرست Enumها برای راهنمایی به بخش دسته‌بندی محتوا مراجعه کنید.

ArticleEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
عنوان	مورد نیاز	عنوان نهاد.	متن رایگان اندازه متن پیشنهادی: حداکثر ۵۰ کاراکتر
تصاویر پوستر	اختیاری	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است. توجه: تصویر اکیداً توصیه می‌شود. در صورت ارائه نشان، فضای امن ۲۴ dps را در بالا و پایین تصویر تضمین کنید.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
منبع - عنوان	اختیاری	نام نویسنده، سازمان یا گزارشگر	متن رایگان اندازه متن پیشنهادی: کمتر از ۲۵ کاراکتر
منبع - تصویر	اختیاری	تصویری از منبع مانند نویسنده، سازمان، خبرنگار	برای راهنمایی به مشخصات تصویر مراجعه کنید.
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
نشان‌ها	اختیاری	هر نشان یا متن آزاد (حداکثر ۱۵ کاراکتر) یا تصویر کوچک است. جلوه‌های ویژه UX روی تصویر/ویدئو، برای مثال به عنوان پوشش نشان روی تصویر «به‌روزرسانی زنده» مدت زمان مطالعه مقاله
نشان - متن	اختیاری	عنوان برای نشان توجه: برای نشان، متن یا تصویر الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ۱۵ کاراکتر
نشان - تصویر	اختیاری	تصویر کوچک جلوه‌های ویژه تجربه کاربری، برای مثال به صورت پوشش نشان روی تصویر کوچک تصویر/ویدئو. توجه: برای نشان، متن یا تصویر الزامی است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
زمان انتشار محتوا	اختیاری	این نشانگر زمانیِ epoch بر حسب میلی‌ثانیه است که نشان می‌دهد محتوا در چه زمانی در برنامه منتشر/به‌روزرسانی شده است.	مهر زمانی عصر بر حسب میلی ثانیه
آخرین زمان نامزدی	مشروط الزامی	مهر زمانیِ آخرین تعامل کاربر با این موجودیت بر حسب میلی‌ثانیه. توجه: اگر این موجودیت بخشی از خوشه تداوم باشد، این فیلد الزامی است.	مهر زمانی عصر بر حسب میلی ثانیه
درصد پیشرفت	مشروط الزامی	درصد کل محتوای مصرف‌شده توسط کاربر تا به امروز. توجه: اگر این موجودیت بخشی از خوشه تداوم باشد، این فیلد الزامی است.	یک مقدار صحیح بین ۰ تا ۱۰۰.
دسته بندی محتوا	اختیاری	دسته بندی محتوای موجود در موجودیت را شرح دهید.	فهرست Enumها برای راهنمایی به بخش دسته‌بندی محتوا مراجعه کنید.

EventEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
عنوان	مورد نیاز	عنوان نهاد.	رشته اندازه متن پیشنهادی: حداکثر ۵۰ کاراکتر
زمان شروع	مورد نیاز	مهر زمانیِ دوره‌ای که انتظار می‌رود رویداد در آن شروع شود. نکته: این مقدار بر حسب میلی‌ثانیه نمایش داده می‌شود.	مهر زمانی عصر بر حسب میلی ثانیه
حالت رویداد	مورد نیاز	فیلدی برای مشخص کردن اینکه آیا رویداد مجازی، حضوری یا هر دو خواهد بود.	Enum: مجازی، حضوری یا ترکیبی
تصاویر پوستر	مورد نیاز	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است. توجه: تصویر اکیداً توصیه می‌شود. در صورت ارائه نشان، فضای امن ۲۴ dps را در بالا و پایین تصویر تضمین کنید.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
مکان - کشور	مشروط الزامی	کشوری که رویداد در آن اتفاق می‌افتد. توجه: این مورد برای رویدادهایی که IN_PERSON یا HYBRID هستند، الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - شهر	مشروط الزامی	شهری که رویداد در آن اتفاق می‌افتد. توجه: این مورد برای رویدادهایی که IN_PERSON یا HYBRID هستند، الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - نمایش آدرس	مشروط الزامی	آدرس یا نام مکانی که رویداد در آن برگزار خواهد شد که باید به کاربر نمایش داده شود. توجه: این مورد برای رویدادهایی که IN_PERSON یا HYBRID هستند، الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) مکانی که رویداد در آن برگزار می‌شود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - ایالت	اختیاری	ایالت یا استانی (در صورت وجود) که رویداد در آن برگزار می‌شود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - کد پستی	اختیاری	کد پستی (در صورت وجود) محل برگزاری رویداد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
موقعیت مکانی - محله	اختیاری	محله (در صورت وجود) که رویداد در آن برگزار می‌شود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
زمان پایان	اختیاری	مهر زمانیِ دوره‌ای که انتظار می‌رود رویداد در آن پایان یابد. نکته: این مقدار بر حسب میلی‌ثانیه نمایش داده می‌شود.	مهر زمانی عصر بر حسب میلی ثانیه
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
نشان‌ها	اختیاری	هر نشان یا متن آزاد (حداکثر ۱۵ کاراکتر) یا تصویر کوچک است.
نشان - متن	اختیاری	عنوان برای نشان توجه: برای نشان، متن یا تصویر الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ۱۵ کاراکتر
نشان - تصویر	اختیاری	تصویر کوچک جلوه‌های ویژه تجربه کاربری، برای مثال به صورت پوشش نشان روی تصویر کوچک تصویر/ویدئو. توجه: برای نشان، متن یا تصویر الزامی است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
قیمت - قیمت فعلی	مشروط مورد نیاز	قیمت فعلی بلیط/کارت ورود به رویداد. در صورت ارائه قیمت خط خورده، باید ارائه شود.	متن رایگان
قیمت - قیمت ضربدری	اختیاری	قیمت اصلی بلیط/کارت ورود به رویداد.	متن رایگان
اطلاع از قیمت	اختیاری	اعلام قیمت برای ارائه تخفیف ویژه، رویداد، و تخفیف برای اعضا، در صورت وجود.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)
دسته بندی محتوا	اختیاری	دسته بندی محتوای موجود در موجودیت را شرح دهید.	فهرست Enumهای واجد شرایط نوع فیلم و سریال (مثال - سینما) TYPE_DIGITAL_GAMES (مثال - ورزش‌های الکترونیکی) نوع موسیقی (مثال - کنسرت) نوع سفر و محل (مثال - تور، جشنواره) نوع_سلامتی_و_تناسب_اندام (مثال - کلاس یوگا) نوع آموزش (مثال - کلاس) TYPE_SPORTS (مثال - بازی فوتبال) TYPE_DATING (مثال - ملاقات) برای راهنمایی به بخش دسته‌بندی محتوا مراجعه کنید.

LodgingEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
عنوان	مورد نیاز	عنوان نهاد.	رشته اندازه متن پیشنهادی: حداکثر ۵۰ کاراکتر
تصاویر پوستر	مورد نیاز	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است. توجه: اگر نشان ارائه می‌شود، فضای امن ۲۴ dps را در بالا و پایین تصویر تضمین کنید.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
مکان - کشور	مورد نیاز	کشوری که محل اقامت در آن اتفاق می‌افتد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - شهر	مورد نیاز	شهری که محل اقامت در آن واقع شده است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - نمایش آدرس	مورد نیاز	آدرس اقامتگاه به کاربر نمایش داده می‌شود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) محل اقامت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - ایالت	اختیاری	ایالت یا استانی (در صورت وجود) که محل اقامت در آن واقع شده است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - کد پستی	اختیاری	کد پستی (در صورت وجود) محل اقامت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
موقعیت مکانی - محله	اختیاری	محله (در صورت وجود) محل اقامت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
نشان‌ها	اختیاری	هر نشان یا متن آزاد (حداکثر ۱۵ کاراکتر) یا تصویر کوچک است.
نشان - متن	اختیاری	عنوان برای نشان توجه: برای نشان، متن یا تصویر الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ۱۵ کاراکتر
نشان - تصویر	اختیاری	تصویر کوچک جلوه‌های ویژه تجربه کاربری، برای مثال به صورت پوشش نشان روی تصویر کوچک تصویر/ویدئو. توجه: برای نشان، متن یا تصویر الزامی است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
پنجره زمان دسترسی - زمان شروع	اختیاری	مهر زمانی دوره زمانی (epoch) بر حسب میلی‌ثانیه که انتظار می‌رود اقامتگاه باز/در دسترس باشد.	مهر زمانی عصر بر حسب میلی ثانیه
پنجره زمان دسترسی - زمان پایان	اختیاری	مهر زمانی دوره زمانی به میلی‌ثانیه که انتظار می‌رود اقامتگاه تا آن زمان باز/در دسترس باشد.	مهر زمانی عصر بر حسب میلی ثانیه
رتبه‌بندی - حداکثر مقدار	اختیاری	حداکثر مقدار مقیاس رتبه‌بندی. اگر مقدار فعلی رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - ارزش فعلی	اختیاری	مقدار فعلی مقیاس رتبه‌بندی. اگر حداکثر مقدار رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - تعداد	اختیاری	تعداد امتیازهای مربوط به اقامتگاه. نکته: اگر برنامه شما نحوه نمایش تعداد به کاربران را کنترل می‌کند، این فیلد را ارائه دهید. از یک رشته مختصر استفاده کنید. برای مثال، اگر تعداد ۱,۰۰۰,۰۰۰ است، استفاده از مخففی مانند ۱M را در نظر بگیرید تا تعداد در اندازه‌های کوچک‌تر صفحه نمایش کوتاه نشود.	رشته
رتبه‌بندی - مقدار شمارش	اختیاری	تعداد امتیازهای مربوط به اقامتگاه. نکته: اگر خودتان منطق نمایش اختصارات را مدیریت نمی‌کنید، این فیلد را وارد کنید. اگر هم تعداد و هم مقدار تعداد وجود داشته باشند، تعداد به کاربران نمایش داده می‌شود.	طولانی
قیمت - قیمت فعلی	مشروط مورد نیاز	قیمت فعلی اقامتگاه. در صورت ارائه قیمت خط خورده، باید ارائه شود.	متن رایگان
قیمت - قیمت ضربدری	اختیاری	قیمت اصلی اقامتگاه، که در فاکتور خط خورده است.	متن رایگان
اطلاع از قیمت	اختیاری	اعلام قیمت برای ارائه تخفیف ویژه، رویداد، و تخفیف برای اعضا، در صورت وجود.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)

StoreEntity

شیء StoreEntity نشان دهنده یک فروشگاه شخصی است که شرکای توسعه دهنده می خواهند آن را منتشر کنند، مانند یک رستوران یا یک فروشگاه مواد غذایی.

ویژگی	مورد نیاز	توضیحات	قالب
تصاویر پوستر	مورد نیاز	حداقل یک تصویر باید ارائه شود.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
عنوان	اختیاری	نام فروشگاه.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)
مکان	اختیاری	موقعیت مکانی فروشگاه.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)
فراخوان	اختیاری	در صورت امکان، برای تبلیغ، رویداد یا به‌روزرسانی فروشگاه، فراخوان دهید.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)
چاپ خوب را بنویسید	اختیاری	متن چاپی زیبا برای توضیحات.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)
توضیحات	اختیاری	توضیحی در مورد فروشگاه.	متن رایگان اندازه متن پیشنهادی: کمتر از ۹۰ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)
رتبه‌بندی - حداکثر مقدار	اختیاری	حداکثر مقدار مقیاس رتبه‌بندی. اگر مقدار فعلی رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - ارزش فعلی	اختیاری	مقدار فعلی مقیاس رتبه‌بندی. اگر حداکثر مقدار رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - تعداد	اختیاری	تعداد امتیازهای مربوط به اقامتگاه. نکته: اگر برنامه شما می‌خواهد نحوه نمایش این عدد به کاربران را کنترل کند، این فیلد را ارائه دهید. رشته مختصری را که می‌تواند به کاربر نمایش داده شود، ارائه دهید. برای مثال، اگر تعداد ۱,۰۰۰,۰۰۰ است، استفاده از اختصاراتی مانند ۱M را در نظر بگیرید تا در اندازه‌های کوچک‌تر صفحه نمایش کوتاه نشود.	رشته
رتبه‌بندی - مقدار شمارش	اختیاری	تعداد امتیازهای مربوط به اقامتگاه. توجه: اگر نمی‌خواهید خودتان منطق نمایش اختصارات را مدیریت کنید، این فیلد را وارد کنید. اگر هم تعداد و هم مقدار تعداد وجود داشته باشد، از تعداد برای نمایش به کاربران استفاده خواهیم کرد.	طولانی

PointOfInterestEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
عنوان	مورد نیاز	عنوان نهاد.	رشته اندازه متن پیشنهادی: حداکثر ۵۰ کاراکتر
تصاویر پوستر	مورد نیاز	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است. توجه: تصویر اکیداً توصیه می‌شود. در صورت ارائه نشان، فضای امن ۲۴ dps را در بالا و پایین تصویر تضمین کنید.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
مکان - کشور	مورد نیاز	کشوری که نقطه مورد نظر در آن اتفاق می‌افتد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - شهر	مورد نیاز	شهری که نقطه مورد نظر در آن اتفاق می‌افتد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - نمایش آدرس	مورد نیاز	آدرس نقطه مورد نظر که به کاربر نمایش داده خواهد شد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) نقطه مورد نظر.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - ایالت	اختیاری	ایالت یا استانی (در صورت وجود) که نقطه مورد نظر در آن واقع شده است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - کد پستی	اختیاری	کد پستی (در صورت وجود) نقطه مورد نظر.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
موقعیت مکانی - محله	اختیاری	محله (در صورت وجود) نقطه مورد نظر.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
پنجره زمان دسترسی - زمان شروع	اختیاری	مهر زمانی دوره زمانی بر حسب میلی‌ثانیه که انتظار می‌رود نقطه مورد نظر باز/در دسترس باشد.	مهر زمانی عصر بر حسب میلی ثانیه
پنجره زمان دسترسی - زمان پایان	اختیاری	مهر زمانی دوره زمانی بر حسب میلی‌ثانیه که انتظار می‌رود نقطه مورد نظر تا آن زمان باز/در دسترس باشد.	مهر زمانی عصر بر حسب میلی ثانیه
نشان‌ها	اختیاری	هر نشان یا متن آزاد (حداکثر ۱۵ کاراکتر) یا تصویر کوچک است.
نشان - متن	اختیاری	عنوان برای نشان توجه: برای نشان، متن یا تصویر الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ۱۵ کاراکتر
نشان - تصویر	اختیاری	تصویر کوچک جلوه‌های ویژه تجربه کاربری، برای مثال به صورت پوشش نشان روی تصویر کوچک تصویر/ویدئو. توجه: برای نشان، متن یا تصویر الزامی است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
رتبه‌بندی - حداکثر مقدار	اختیاری	حداکثر مقدار مقیاس رتبه‌بندی. اگر مقدار فعلی رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - ارزش فعلی	اختیاری	مقدار فعلی مقیاس رتبه‌بندی. اگر حداکثر مقدار رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - تعداد	اختیاری	تعداد امتیازهای مربوط به نقطه مورد نظر. نکته: اگر برنامه شما نحوه نمایش تعداد به کاربران را کنترل می‌کند، این فیلد را ارائه دهید. از یک رشته مختصر استفاده کنید. برای مثال، اگر تعداد ۱,۰۰۰,۰۰۰ است، استفاده از مخففی مانند ۱M را در نظر بگیرید تا تعداد در اندازه‌های کوچک‌تر صفحه نمایش کوتاه نشود.	رشته
رتبه‌بندی - مقدار شمارش	اختیاری	تعداد امتیازهای مربوط به نقطه مورد نظر. توجه: اگر خودتان منطق نمایش اختصارات را مدیریت نمی‌کنید، این فیلد را وارد کنید. اگر هم تعداد و هم مقدار تعداد وجود داشته باشد، تعداد به کاربران نمایش داده می‌شود.	طولانی
قیمت - قیمت فعلی	مشروط مورد نیاز	قیمت فعلی بلیط/کارت ورود به نقطه مورد نظر. در صورت ارائه قیمت خط خورده، باید ارائه شود.	متن رایگان
قیمت - قیمت ضربدری	اختیاری	قیمت اصلی بلیط/کارت ورود به نقطه مورد نظر.	متن رایگان
اطلاع از قیمت	اختیاری	اعلام قیمت برای ارائه تخفیف ویژه، رویداد، و تخفیف برای اعضا، در صورت وجود.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)
دسته بندی محتوا	اختیاری	دسته بندی محتوای موجود در موجودیت را شرح دهید.	فهرست Enumهای واجد شرایط نوع سفر و محل نوع فیلم و سریال (مثال - سینما) نوع پزشکی (مثال - بیمارستان) نوع آموزش (مثال - مدرسه) نوع ورزش (مثال - ورزشگاه) برای راهنمایی به بخش دسته‌بندی محتوا مراجعه کنید.

PersonEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
مشخصات - نام	مورد نیاز	نام یا شناسه یا شناسه پروفایل، مثلاً "John Doe"، "@TeamPixel" و غیره.	رشته اندازه متن پیشنهادی: حداکثر ۵۰ کاراکتر
پروفایل - آواتار	مورد نیاز	تصویر پروفایل یا تصویر آواتار کاربر. توجه: تصویر باید مربعی شکل و با نسبت تصویر ۱:۱ باشد.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
مشخصات - متن اضافی	اختیاری	متن رایگان مانند دسته پروفایل.	متن رایگان اندازه متن پیشنهادی: حداکثر ۱۵ کاراکتر
مشخصات - تصویر اضافی	اختیاری	تصویر کوچکی مانند نشان تأیید.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
تصویر سربرگ	اختیاری	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است. توجه: تصویر اکیداً توصیه می‌شود. در صورت ارائه نشان، فضای امن ۲۴ dps را در بالا و پایین تصویر تضمین کنید.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
محبوبیت - تعداد	اختیاری	تعداد دنبال‌کنندگان یا مقدار محبوبیت را مشخص کنید، مثلاً - "3.7 میلیون". نکته: اگر هم تعداد و هم مقدار تعداد ارائه شوند، از تعداد استفاده خواهد شد.	رشته اندازه متن پیشنهادی: حداکثر ۲۰ کاراکتر برای تعداد + برچسب (ترکیبی از هر کاراکتر)
محبوبیت - تعداد ارزش	اختیاری	تعداد دنبال‌کنندگان یا ارزش محبوبیت. نکته: اگر برنامه شما نمی‌خواهد منطق بهینه‌سازی یک عدد بزرگ برای اندازه‌های مختلف نمایشگر را مدیریت کند، مقدار شمارش (Count Value) را ارائه دهید. اگر هم تعداد و هم مقدار شمارش ارائه شوند، از تعداد (Count Value) استفاده خواهد شد.	طولانی
محبوبیت - برچسب	اختیاری	مشخص کنید که برچسب محبوبیت چیست. به عنوان مثال - "لایک".	رشته اندازه متن پیشنهادی: حداکثر ۲۰ کاراکتر برای مجموع تعداد + برچسب
محبوبیت - بصری	اختیاری	مشخص کنید که این تعامل برای چیست. برای مثال - تصویری که آیکون لایک یا ایموجی را نشان می‌دهد. می‌تواند بیش از یک تصویر ارائه دهد، هرچند ممکن است همه آنها در همه فرم فاکتورها نمایش داده نشوند. توجه: تصویر باید مربعی شکل و با نسبت تصویر ۱:۱ باشد.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
رتبه‌بندی - حداکثر مقدار	مورد نیاز	حداکثر مقدار مقیاس رتبه‌بندی. اگر مقدار فعلی رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - ارزش فعلی	مورد نیاز	مقدار فعلی مقیاس رتبه‌بندی. اگر حداکثر مقدار رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - تعداد	اختیاری	تعداد رتبه‌بندی‌ها برای نهاد. نکته: اگر برنامه شما می‌خواهد نحوه نمایش این عدد به کاربران را کنترل کند، این فیلد را ارائه دهید. رشته مختصری را که می‌تواند به کاربر نمایش داده شود، ارائه دهید. برای مثال، اگر تعداد ۱,۰۰۰,۰۰۰ است، استفاده از اختصاراتی مانند ۱M را در نظر بگیرید تا در اندازه‌های کوچک‌تر صفحه نمایش کوتاه نشود.	رشته
رتبه‌بندی - مقدار شمارش	اختیاری	تعداد رتبه‌بندی‌ها برای نهاد. توجه: اگر نمی‌خواهید خودتان منطق نمایش اختصارات را مدیریت کنید، این فیلد را وارد کنید. اگر هم تعداد و هم مقدار تعداد وجود داشته باشد، از تعداد برای نمایش به کاربران استفاده خواهیم کرد.	طولانی
مکان - کشور	اختیاری	کشوری که شخص در آن مستقر است یا خدمت می‌کند.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - شهر	اختیاری	شهری که فرد در آن مستقر است یا خدمت می‌کند.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - نمایش آدرس	اختیاری	آدرسی که فرد در آن قرار دارد یا به آن خدمت رسانی می‌کند، به کاربر نمایش داده می‌شود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) که شخص در آن مستقر است یا خدمت می‌کند.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - ایالت	اختیاری	ایالتی (در صورت وجود) که شخص در آن مستقر است یا خدمت می‌کند.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - کد پستی	اختیاری	کد پستی (در صورت وجود) جایی که فرد در آن مستقر است یا خدمت می‌کند.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
موقعیت مکانی - محله	اختیاری	محله (در صورت وجود) که فرد در آن مستقر است یا خدمت می‌کند.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
نشان‌ها	اختیاری	هر نشان یا متن آزاد (حداکثر ۱۵ کاراکتر) یا تصویر کوچک است.
نشان - متن	اختیاری	عنوان برای نشان توجه: برای نشان، متن یا تصویر الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ۱۵ کاراکتر
نشان - تصویر	اختیاری	تصویر کوچک جلوه‌های ویژه تجربه کاربری، برای مثال به صورت پوشش نشان روی تصویر کوچک تصویر/ویدئو. توجه: برای نشان، متن یا تصویر الزامی است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
دسته بندی محتوا	اختیاری	دسته بندی محتوای موجود در موجودیت را شرح دهید.	فهرست Enumهای واجد شرایط نوع سلامت و تناسب اندام (مثال - مربی یوگا/تناسب اندام) TYPE_HOME_AND_AUTO (مثال - لوله‌کش) TYPE_SPORTS (مثال - بازیکن) نوع_تاریخ برای راهنمایی به بخش دسته‌بندی محتوا مراجعه کنید.

RestaurantReservationEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
عنوان	مورد نیاز	عنوان نهاد.	رشته اندازه متن پیشنهادی: حداکثر ۵۰ کاراکتر
زمان شروع رزرو	مورد نیاز	مهر زمانی دوره زمانی (epoch) بر حسب میلی‌ثانیه که انتظار می‌رود رزرو از آن شروع شود.	مهر زمانی عصر بر حسب میلی ثانیه
مکان - کشور	مورد نیاز	کشوری که رستوران در آن برگزار می‌شود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - شهر	مورد نیاز	شهری که رستوران در آن واقع شده است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - نمایش آدرس	مورد نیاز	آدرس رستوران که به کاربر نمایش داده خواهد شد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) رستوران.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - ایالت	اختیاری	ایالت یا استانی (در صورت وجود) که رستوران در آن واقع شده است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - کد پستی	اختیاری	کد پستی (در صورت وجود) رستوران.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
موقعیت مکانی - محله	اختیاری	محله رستوران (در صورت وجود).	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
تصاویر پوستر	اختیاری	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
اندازه میز	اختیاری	تعداد افراد در گروه رزرو	عدد صحیح > 0

EventReservationEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
عنوان	مورد نیاز	عنوان نهاد.	رشته اندازه متن پیشنهادی: حداکثر ۵۰ کاراکتر
زمان شروع	مورد نیاز	مهر زمانیِ دوره‌ای که انتظار می‌رود رویداد در آن شروع شود. نکته: این مقدار بر حسب میلی‌ثانیه نمایش داده می‌شود.	مهر زمانی عصر بر حسب میلی ثانیه
حالت رویداد	مورد نیاز	فیلدی برای مشخص کردن اینکه آیا رویداد مجازی، حضوری یا هر دو خواهد بود.	Enum: مجازی، حضوری یا ترکیبی
مکان - کشور	مشروط الزامی	کشوری که رویداد در آن اتفاق می‌افتد. توجه: این مورد برای رویدادهایی که IN_PERSON یا HYBRID هستند، الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - شهر	مشروط الزامی	شهری که رویداد در آن اتفاق می‌افتد. توجه: این مورد برای رویدادهایی که IN_PERSON یا HYBRID هستند، الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - نمایش آدرس	مشروط الزامی	آدرس یا نام مکانی که رویداد در آن برگزار خواهد شد که باید به کاربر نمایش داده شود. توجه: این مورد برای رویدادهایی که IN_PERSON یا HYBRID هستند، الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) مکانی که رویداد در آن برگزار می‌شود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - ایالت	اختیاری	ایالت یا استانی (در صورت وجود) که رویداد در آن برگزار می‌شود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - کد پستی	اختیاری	کد پستی (در صورت وجود) محل برگزاری رویداد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
موقعیت مکانی - محله	اختیاری	محله (در صورت وجود) که رویداد در آن برگزار می‌شود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
تصاویر پوستر	اختیاری	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است. توجه: تصویر اکیداً توصیه می‌شود. در صورت ارائه نشان، فضای امن ۲۴ dps را در بالا و پایین تصویر تضمین کنید.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
زمان پایان	اختیاری	مهر زمانیِ دوره‌ای که انتظار می‌رود رویداد در آن پایان یابد. نکته: این مقدار بر حسب میلی‌ثانیه نمایش داده می‌شود.	مهر زمانی عصر بر حسب میلی ثانیه
ارائه دهنده خدمات - نام	اختیاری	نام ارائه دهنده خدمات. توجه: متن یا تصویر برای ارائه دهنده خدمات الزامی است.	متن آزاد. به عنوان مثال، نام برگزارکننده رویداد/تور
ارائه دهنده خدمات - تصویر	اختیاری	لوگو/تصویر ارائه دهنده خدمات. توجه: متن یا تصویر برای ارائه دهنده خدمات الزامی است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
نشان‌ها	اختیاری	هر نشان یا متن آزاد (حداکثر ۱۵ کاراکتر) یا تصویر کوچک است.
نشان - متن	اختیاری	عنوان برای نشان توجه: برای نشان، متن یا تصویر الزامی است.	متن رایگان اندازه متن پیشنهادی: حداکثر ۱۵ کاراکتر
نشان - تصویر	اختیاری	تصویر کوچک جلوه‌های ویژه تجربه کاربری، برای مثال به صورت پوشش نشان روی تصویر کوچک تصویر/ویدئو. توجه: برای نشان، متن یا تصویر الزامی است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
شناسه رزرو	اختیاری	شناسه رزرو برای رزرو رویداد.	متن رایگان
قیمت - قیمت فعلی	مشروط مورد نیاز	قیمت فعلی بلیط/کارت ورود به رویداد. در صورت ارائه قیمت خط خورده، باید ارائه شود.	متن رایگان
قیمت - قیمت ضربدری	اختیاری	قیمت اصلی بلیط/کارت ورود به رویداد.	متن رایگان
اطلاع از قیمت	اختیاری	اعلام قیمت برای ارائه تخفیف ویژه، رویداد، و تخفیف برای اعضا، در صورت وجود.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)
رتبه‌بندی - حداکثر مقدار	اختیاری	حداکثر مقدار مقیاس رتبه‌بندی. اگر مقدار فعلی رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - ارزش فعلی	اختیاری	مقدار فعلی مقیاس رتبه‌بندی. اگر حداکثر مقدار رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - تعداد	اختیاری	تعداد رتبه‌بندی‌های این رویداد. نکته: اگر برنامه شما می‌خواهد نحوه نمایش این عدد به کاربران را کنترل کند، این فیلد را ارائه دهید. رشته مختصری را که می‌تواند به کاربر نمایش داده شود، ارائه دهید. برای مثال، اگر تعداد ۱,۰۰۰,۰۰۰ است، استفاده از اختصاراتی مانند ۱M را در نظر بگیرید تا در اندازه‌های کوچک‌تر صفحه نمایش کوتاه نشود.	رشته
رتبه‌بندی - مقدار شمارش	اختیاری	تعداد رتبه‌بندی‌های این رویداد. توجه: اگر نمی‌خواهید خودتان منطق نمایش اختصارات را مدیریت کنید، این فیلد را وارد کنید. اگر هم تعداد و هم مقدار تعداد وجود داشته باشد، از تعداد برای نمایش به کاربران استفاده خواهیم کرد.	طولانی
دسته بندی محتوا	اختیاری	دسته بندی محتوای موجود در موجودیت را شرح دهید.	فهرست Enumهای واجد شرایط نوع فیلم و سریال (مثال - سینما) TYPE_DIGITAL_GAMES (مثال - ورزش‌های الکترونیکی) نوع موسیقی (مثال - کنسرت) نوع سفر و محل (مثال - تور، جشنواره) نوع_سلامتی_و_تناسب_اندام (مثال - کلاس یوگا) نوع آموزش (مثال - کلاس) TYPE_SPORTS (مثال - بازی فوتبال) TYPE_DATING (مثال - ملاقات) برای راهنمایی به بخش دسته‌بندی محتوا مراجعه کنید.

LodgingReservationEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
عنوان	مورد نیاز	عنوان نهاد.	پیامک رایگان. برای مثال، «اقامت شما از ۱۲ دسامبر» اندازه متن پیشنهادی: حداکثر ۵۰ کاراکتر
زمان ورود	مورد نیاز	مهر زمانی دوره بر حسب میلی‌ثانیه که نشان دهنده زمان ورود برای رزرو است.	مهر زمانی عصر بر حسب میلی ثانیه
زمان خروج	مورد نیاز	مهر زمانی دوره (epoch) بر حسب میلی‌ثانیه که نشان دهنده زمان خروج برای رزرو است.	مهر زمانی عصر بر حسب میلی ثانیه
مکان - کشور	مورد نیاز	کشوری که اقامتگاه در آن واقع شده است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - شهر	مورد نیاز	شهری که اقامتگاه در آن واقع شده است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - نمایش آدرس	مورد نیاز	آدرس اقامتگاه به کاربر نمایش داده می‌شود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) محل اقامت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - ایالت	اختیاری	ایالت یا استانی (در صورت وجود) که محل اقامت در آن واقع شده است.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
مکان - کد پستی	اختیاری	کد پستی (در صورت وجود) محل اقامت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
موقعیت مکانی - محله	اختیاری	محله (در صورت وجود) محل اقامت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
تصاویر پوستر	اختیاری	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است. توجه: اگر نشان ارائه می‌شود، فضای امن ۲۴ dps را در بالا و پایین تصویر تضمین کنید.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
شناسه رزرو	اختیاری	شناسه رزرو برای رزرو اقامتگاه.	متن رایگان
رتبه‌بندی - حداکثر مقدار	اختیاری	حداکثر مقدار مقیاس رتبه‌بندی. اگر مقدار فعلی رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - ارزش فعلی	اختیاری	مقدار فعلی مقیاس رتبه‌بندی. اگر حداکثر مقدار رتبه‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= 0.0
رتبه‌بندی - تعداد	اختیاری	تعداد امتیازهای مربوط به اقامتگاه. نکته: اگر برنامه شما می‌خواهد نحوه نمایش این عدد به کاربران را کنترل کند، این فیلد را ارائه دهید. رشته مختصری را که می‌تواند به کاربر نمایش داده شود، ارائه دهید. برای مثال، اگر تعداد ۱,۰۰۰,۰۰۰ است، استفاده از اختصاراتی مانند ۱M را در نظر بگیرید تا در اندازه‌های کوچک‌تر صفحه نمایش کوتاه نشود.	رشته
رتبه‌بندی - مقدار شمارش	اختیاری	تعداد امتیازهای مربوط به اقامتگاه. توجه: اگر نمی‌خواهید خودتان منطق نمایش اختصارات را مدیریت کنید، این فیلد را وارد کنید. اگر هم تعداد و هم مقدار تعداد وجود داشته باشد، از تعداد برای نمایش به کاربران استفاده خواهیم کرد.	طولانی
قیمت - قیمت فعلی	مشروط مورد نیاز	قیمت فعلی اقامتگاه. در صورت ارائه قیمت خط خورده، باید ارائه شود.	متن رایگان
قیمت - قیمت ضربدری	اختیاری	قیمت اصلی اقامتگاه، که در فاکتور خط خورده است.	متن رایگان
اطلاع از قیمت	اختیاری	اعلام قیمت برای ارائه تخفیف ویژه، رویداد، و تخفیف برای اعضا، در صورت وجود.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)

TransportationReservationEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
عنوان	مورد نیاز	عنوان نهاد.	متن آزاد. به عنوان مثال، "SFO به SAN" اندازه متن پیشنهادی: حداکثر ۵۰ کاراکتر
نوع حمل و نقل	مورد نیاز	روش/نوع حمل و نقل برای رزرو.	Enum: پرواز، قطار، اتوبوس یا کشتی
زمان حرکت	مورد نیاز	مهر زمانی دوره بر حسب میلی‌ثانیه که زمان حرکت را نشان می‌دهد.	مهر زمانی عصر بر حسب میلی ثانیه
زمان رسیدن	مورد نیاز	مهر زمانی دوره بر حسب میلی‌ثانیه که زمان رسیدن را نشان می‌دهد.	مهر زمانی عصر بر حسب میلی ثانیه
محل عزیمت - کشور	اختیاری	کشور مبدا.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل حرکت - شهر	اختیاری	شهر مبدا.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل حرکت - نمایش آدرس	اختیاری	محل حرکت به کاربر نمایش داده خواهد شد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل حرکت - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) محل عزیمت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل عزیمت - ایالت	اختیاری	ایالت یا استان محل عزیمت (در صورت وجود).	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل حرکت - کد پستی	اختیاری	کد پستی (در صورت وجود) محل عزیمت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل حرکت - محله	اختیاری	محله (در صورت وجود) محل عزیمت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل ورود - کشور	اختیاری	کشور ورود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل ورود - شهر	اختیاری	شهر ورود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل ورود - نمایش آدرس	اختیاری	محل رسیدن که به کاربر نمایش داده خواهد شد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل ورود - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) محل ورود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل ورود - ایالت	اختیاری	ایالت یا استان (در صورت وجود) محل ورود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل ورود - کد پستی	اختیاری	کد پستی (در صورت وجود) محل ورود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
محل ورود - محله	اختیاری	محله (در صورت وجود) محل ورود.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
ارائه دهنده خدمات - نام	اختیاری	نام ارائه دهنده خدمات. توجه: متن یا تصویر برای ارائه دهنده خدمات الزامی است.	متن رایگان. به عنوان مثال، نام شرکت هواپیمایی
ارائه دهنده خدمات - تصویر	اختیاری	لوگو/تصویر ارائه دهنده خدمات. توجه: متن یا تصویر برای ارائه دهنده خدمات الزامی است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
تصاویر پوستر	اختیاری	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
شناسه رزرو	اختیاری	شناسه رزرو برای رزرو حمل و نقل.	متن رایگان
قیمت - قیمت فعلی	مشروط مورد نیاز	قیمت فعلی رزرو. در صورت ارائه قیمت خط خورده، باید ارائه شود.	متن رایگان
قیمت - قیمت ضربدری	اختیاری	قیمت اصلی رزرو، که در رابط کاربری خط خورده است.	متن رایگان
اطلاع از قیمت	اختیاری	اعلام قیمت برای ارائه تخفیف ویژه، رویداد، و تخفیف برای اعضا، در صورت وجود.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)
شماره حمل و نقل	مورد نیاز	شماره پرواز، شماره اتوبوس، شماره قطار یا شماره کشتی/سفر دریایی.	متن رایگان
زمان سوار شدن به هواپیما	مورد نیاز	مهر زمانی عصر که نشان دهنده زمان سوار شدن برای رزرو است (در صورت وجود)	مهر زمانی عصر بر حسب میلی ثانیه

VehicleRentalReservationEntity

ویژگی	مورد نیاز	توضیحات	قالب
اکشن اوری	مورد نیاز	پیوند عمیق به موجودیت در برنامه ارائه دهنده. توجه: می‌توانید از لینک‌های عمیق برای ارجاع استفاده کنید. به این سوالات متداول مراجعه کنید.	اوری
عنوان	مورد نیاز	عنوان نهاد.	متن آزاد. به عنوان مثال، "Avis Union Square SF" اندازه متن پیشنهادی: حداکثر ۵۰ کاراکتر
زمان تحویل	مورد نیاز	مهر زمانی عصر که نشان دهنده زمان تحویل گرفتن رزرو است.	مهر زمانی عصر بر حسب میلی ثانیه
زمان بازگشت	اختیاری	مهر زمانی عصر که نشان دهنده زمان خروج برای رزرو است.	مهر زمانی عصر بر حسب میلی ثانیه
آدرس تحویل - کشور	اختیاری	کشور محل تحویل.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس تحویل - شهر	اختیاری	شهر محل تحویل.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس تحویل - آدرس نمایش داده شده	اختیاری	محل تحویل کالا که به کاربر نمایش داده خواهد شد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس تحویل - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) محل تحویل.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس تحویل - ایالت	اختیاری	ایالت یا استان (در صورت وجود) محل تحویل.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس تحویل - کد پستی	اختیاری	کد پستی (در صورت وجود) محل تحویل.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس تحویل - محله	اختیاری	محله (در صورت وجود) محل تحویل گرفتن.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس برگشت - کشور	اختیاری	کشور محل بازگشت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس برگشت - شهر	اختیاری	شهر محل بازگشت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس برگشت - آدرس نمایش داده شده	اختیاری	مکان بازگشتی که به کاربر نمایش داده خواهد شد.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس برگشت - آدرس خیابان	اختیاری	آدرس خیابان (در صورت وجود) محل بازگشت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس برگشت - ایالت	اختیاری	ایالت یا استان (در صورت وجود) محل بازگشت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس برگشت - کد پستی	اختیاری	کد پستی (در صورت وجود) محل بازگشت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
آدرس برگشت - محله	اختیاری	محله (در صورت وجود) محل بازگشت.	متن رایگان اندازه متن پیشنهادی: حداکثر ~20 کاراکتر
ارائه دهنده خدمات - نام	اختیاری	نام ارائه دهنده خدمات. توجه: متن یا تصویر برای ارائه دهنده خدمات الزامی است.	متن رایگان. به عنوان مثال، "اجاره خودرو Avis"
ارائه دهنده خدمات - تصویر	اختیاری	لوگو/تصویر ارائه دهنده خدمات. توجه: متن یا تصویر برای ارائه دهنده خدمات الزامی است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
تصاویر پوستر	اختیاری	در صورت ارائه چندین تصویر، فقط ۱ تصویر نمایش داده می‌شود. نسبت تصویر توصیه شده ۱۶:۹ است.	برای راهنمایی به مشخصات تصویر مراجعه کنید.
توضیحات	اختیاری	یک پاراگراف متن برای توصیف موجودیت. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی: ۱۸۰ کاراکتر
فهرست زیرنویس‌ها	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس شامل یک خط متن است. توجه: یا توضیحات یا فهرست زیرنویس‌ها به کاربر نمایش داده می‌شود، نه هر دو.	متن رایگان اندازه متن پیشنهادی برای هر زیرنویس: حداکثر ۵۰ کاراکتر
شناسه تأیید	اختیاری	شناسه تأیید رزرو اجاره خودرو.	متن رایگان
قیمت - قیمت فعلی	مشروط مورد نیاز	قیمت فعلی رزرو. در صورت ارائه قیمت خط خورده، باید ارائه شود.	متن رایگان
قیمت - قیمت ضربدری	اختیاری	قیمت اصلی رزرو، که در رابط کاربری خط خورده است.	متن رایگان
اطلاع از قیمت	اختیاری	اعلام قیمت برای ارائه تخفیف ویژه، رویداد، و تخفیف برای اعضا، در صورت وجود.	متن رایگان اندازه متن پیشنهادی: کمتر از ۴۵ کاراکتر (متن خیلی طولانی ممکن است بیضی نشان دهد)

مشخصات تصویر

مشخصات مورد نیاز برای تصاویر در این جدول ذکر شده است:

نسبت ابعاد	حداقل پیکسل‌ها	پیکسل‌های توصیه‌شده
مربع (۱x۱) ترجیحی	۳۰۰x۳۰۰	۱۲۰۰x۱۲۰۰
منظره (۱.۹۱x۱)	۶۰۰x۳۱۴	۱۲۰۰x۶۲۸
پرتره (۴x۵)	۴۸۰x۶۰۰	۹۶۰x۱۲۰۰

تصاویر باید روی CDN های عمومی میزبانی شوند تا گوگل بتواند به آنها دسترسی داشته باشد.

فرمت‌های فایل

PNG، JPG، GIF ثابت، WebP

حداکثر اندازه فایل

۵۱۲۰ کیلوبایت

توصیه‌های اضافی

• ناحیه امن تصویر: محتوای مهم خود را در مرکز ۸۰٪ تصویر قرار دهید.
• از یک پس‌زمینه شفاف استفاده کنید تا تصویر در تنظیمات تم تیره و روشن به درستی نمایش داده شود.

دسته بندی محتوا

دسته‌بندی محتوا به برنامه‌ها اجازه می‌دهد تا محتوای متعلق به چندین دسته‌بندی را منتشر کنند. این دسته‌بندی، محتوا را با برخی از دسته‌بندی‌های از پیش تعریف‌شده، مانند موارد زیر، مرتبط می‌کند:

• TYPE_EDUCATION
• TYPE_SPORTS
• TYPE_MOVIES_AND_TV_SHOWS
• TYPE_BOOKS
• TYPE_AUDIOBOOKS
• TYPE_MUSIC
• TYPE_DIGITAL_GAMES
• TYPE_TRAVEL_AND_LOCAL
• TYPE_HOME_AND_AUTO
• TYPE_BUSINESS
• TYPE_NEWS
• TYPE_FOOD_AND_DRINK
• TYPE_SHOPPING
• TYPE_HEALTH_AND_FITENESS
• TYPE_MEDICAL
• TYPE_PARENTING
• TYPE_DATING

تصاویر باید روی CDN های عمومی میزبانی شوند تا گوگل بتواند به آنها دسترسی داشته باشد.

دستورالعمل‌های استفاده از دسته‌بندی‌های محتوا

1. برخی از موجودیت‌ها مانند ArticleEntity و GenericFeaturedEntity واجد شرایط استفاده از هر یک از دسته‌بندی‌های محتوا هستند. برای موجودیت‌های دیگر مانند EventEntity ، EventReservationEntity ، PointOfInterestEntity ، فقط زیرمجموعه‌ای از این دسته‌بندی‌ها واجد شرایط هستند. قبل از پر کردن لیست، لیست دسته‌بندی‌های واجد شرایط برای یک نوع موجودیت را بررسی کنید.

2. برای برخی از دسته‌های محتوا، به جای ترکیبی از موجودیت‌های عمومی و دسته محتوا، از نوع موجودیت خاص استفاده کنید:

   • نوع_فیلم‌ها_و_نمایش‌های_تلویزیون - قبل از استفاده از موجودیت‌های عمومی، موجودیت‌های موجود در راهنمای ادغام Watch را بررسی کنید.
   • TYPE_BOOKS - قبل از استفاده از موجودیت‌های عمومی ، EbookEntity را بررسی کنید.
   • TYPE_AUDIOBOOKS - قبل از استفاده از موجودیت‌های عمومی، AudiobookEntity را بررسی کنید.
   • TYPE_SHOPPING - قبل از استفاده از موجودیت‌های عمومی ، ShoppingEntity را بررسی کنید.
   • نوع غذا و نوشیدنی - قبل از استفاده از موجودیت‌های عمومی، موجودیت‌ها را از راهنمای ادغام غذا بررسی کنید.

3. فیلد ContentCategory اختیاری است و اگر محتوا به هیچ یک از دسته‌های ذکر شده قبلی تعلق ندارد، باید خالی گذاشته شود.

4. در صورتی که چندین دسته محتوا ارائه شده باشد، آنها را به ترتیب ارتباط با محتوا ارائه دهید و مرتبط‌ترین دسته محتوا در ابتدا قرار گیرد.

مرحله ۲: ارائه داده‌های خوشه‌ای

توصیه می‌شود که کار انتشار محتوا در پس‌زمینه اجرا شود (برای مثال، با استفاده از WorkManager ) و به صورت منظم یا بر اساس یک رویداد (مثلاً هر بار که کاربر برنامه را باز می‌کند یا وقتی کاربر چیزی را به سبد خرید خود اضافه می‌کند) برنامه‌ریزی شود.

AppEngagePublishClient مسئول انتشار کلاسترها است.

API های زیر برای انتشار خوشه ها در کلاینت وجود دارد:

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

isServiceAvailable

این API برای بررسی اینکه آیا سرویس برای ادغام در دسترس است و آیا محتوا می‌تواند روی دستگاه ارائه شود، استفاده می‌شود.

برای Engage SDK نسخه ۱.۶.۰ و بالاتر (توصیه شده)

شما می‌توانید در دسترس بودن سرویس را برای هر نوع کلاستری که قصد انتشار آن را دارید، بررسی کنید. isServiceAvailable API یک شیء درخواست به نام ServiceAvailabilityRequest را می‌پذیرد که شامل انواع کلاستری است که در دسترس بودن سرویس برای آنها باید بررسی شود. می‌توانید مقادیر شمارشی ClusterType مورد نیاز برای ServiceAvailabilityRequest را از جدول زیر پیدا کنید.

نوع خوشه	ثابت نوع خوشه	مقدار عدد صحیح
ناشناخته	TYPE_UNKNOWN	0
خوشه توصیه	TYPE_RECOMMENDATION	۱
خوشه ویژه	TYPE_FEATURED	۲
خوشه ادامه	TYPE_CONTINUATION	۳
خوشه سبد خرید	TYPE_SHOPPING_CART	۴
خوشه سفارش مجدد غذا	TYPE_FOOD_REORDER	۵
خوشه سبد خرید مواد غذایی	TYPE_FOOD_SHOPPING_CART	۶
خوشه فهرست خرید مواد غذایی	TYPE_FOOD_SHOPPING_LIST	۷
خوشه مدیریت کاربر	TYPE_ENGAGEMENT	۸
خوشه لیست خرید	TYPE_SHOPPING_LIST	۹
خوشه سفارش مجدد خرید	TYPE_SHOPPING_REORDER	۱۰
خوشه پیگیری سفارش خرید	TYPE_SHOPPING_ORDER_TRACKING	۱۱
خوشه اشتراک	TYPE_SUBSCRIPTION	۱۲
ادامه جستجو در خوشه	TYPE_CONTINUE_SEARCH	۱۳
خوشه رزرو	TYPE_RESERVATION	۱۴

کاتلین

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

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

جاوا

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

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
});

ویژگی دسترسی مشروط به سرویس

برخی از برنامه‌های یکپارچه، پیکربندی خاصی را درخواست می‌کنند که سرویس Engage را به طور متناوب فعال و غیرفعال کند تا هزینه سرویس‌دهی خود را کاهش دهند. این استراتژی مصرف محتوای متناوب، اگرچه ممکن است، اما بر کاربر و محصول تأثیر منفی می‌گذارد - محتوای قدیمی ارائه نمی‌شود و برخی از سطوح اصلاً سرویس‌دهی نمی‌شوند.

از نسخه ۱.۶.۰ به بعد، Engage SDK امکان بررسی در دسترس بودن انواع خاصی از کلاسترها را فراهم می‌کند. این امر انعطاف‌پذیری بیشتری را فراهم می‌کند، به طوری که اگر استراتژی محتوای متناوب توسط یک برنامه خاص اتخاذ شده باشد، برخی از انواع کلاسترها می‌توانند از آن استراتژی متناوب پیروی کنند در حالی که سایر انواع کلاسترها همیشه فعال هستند (یعنی کلاسترهای مداوم).

اگر سرویس Engage به هر دلیلی نباید به صورت «مداوم» در تمام دستگاه‌های پشتیبانی‌شده فعال باشد و برای هر مجموعه‌ای از دستگاه‌ها به صورت مصرف متناوب پیکربندی شده باشد، تمام انتشارات خوشه‌های تداوم (مثلاً ادامه مطلب و رزرو) همچنان با پیکربندی پیش‌فرض فعال خواهند بود و بقیه انواع خوشه‌ها به صورت متناوب فعال و غیرفعال می‌شوند. اگر مصرف متناوب برای شما صدق می‌کند اما این پیکربندی پیش‌فرض برای نیازهای شما مناسب نیست، لطفاً با [e-mail] تماس بگیرید.

برای نسخه‌های SDK قبل از v1.6.0 (منسوخ شده)

کاتلین

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 استفاده می‌شود.

مهم: APIهای انتشار، APIهای درج‌شده هستند؛ این APIها محتوای موجود را جایگزین می‌کنند. APIهای حذف و انتشار را متعاقباً برای جایگزینی محتوا فراخوانی نکنید ، زیرا APIهای انتشار ذاتاً این کار را انجام می‌دهند.

کاتلین

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

جاوا

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

وقتی سرویس درخواست را دریافت می‌کند، اقدامات زیر در یک تراکنش انجام می‌شود:

• داده‌های RecommendationCluster موجود از شریک توسعه‌دهنده حذف شده است.
• داده‌های درخواست تجزیه و تحلیل شده و در خوشه توصیه به‌روزرسانی‌شده ذخیره می‌شوند.

در صورت بروز خطا، کل درخواست رد می‌شود و وضعیت موجود حفظ می‌شود.

publishFeaturedCluster

این API برای انتشار فهرستی از اشیاء FeaturedCluster استفاده می‌شود.

مهم: APIهای انتشار، APIهای درج‌شده هستند؛ این APIها محتوای موجود را جایگزین می‌کنند. APIهای حذف و انتشار را متعاقباً برای جایگزینی محتوا فراخوانی نکنید ، زیرا APIهای انتشار ذاتاً این کار را انجام می‌دهند.

کاتلین

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

جاوا

client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

وقتی سرویس درخواست را دریافت می‌کند، اقدامات زیر در یک تراکنش انجام می‌شود:

• داده‌های FeaturedCluster موجود از شریک توسعه‌دهنده حذف می‌شوند.
• داده‌های حاصل از درخواست، تجزیه و تحلیل شده و در Featured Cluster به‌روزرسانی‌شده ذخیره می‌شوند.

در صورت بروز خطا، کل درخواست رد می‌شود و وضعیت موجود حفظ می‌شود.

publishContinuationCluster

این API برای انتشار یک شیء ContinuationCluster استفاده می‌شود.

مهم: APIهای انتشار، APIهای درج‌شده هستند؛ این APIها محتوای موجود را جایگزین می‌کنند. APIهای حذف و انتشار را متعاقباً برای جایگزینی محتوا فراخوانی نکنید ، زیرا APIهای انتشار ذاتاً این کار را انجام می‌دهند.

کاتلین

client.publishContinuationCluster(
    PublishContinuationClusterRequest.Builder()
      .setContinuationCluster(
        ContinuationCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

جاوا

client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

وقتی سرویس درخواست را دریافت می‌کند، اقدامات زیر در یک تراکنش انجام می‌شود:

• داده‌های ContinuationCluster موجود از شریک توسعه‌دهنده حذف می‌شوند.
• داده‌های حاصل از درخواست، تجزیه و تحلیل شده و در خوشه‌ی ادامه‌ی به‌روزرسانی‌شده ذخیره می‌شوند.

در صورت بروز خطا، کل درخواست رد می‌شود و وضعیت موجود حفظ می‌شود.

publishUserAccountManagementRequest

این API برای انتشار کارت ورود به سیستم استفاده می‌شود. عمل ورود به سیستم، کاربران را به صفحه ورود به سیستم برنامه هدایت می‌کند تا برنامه بتواند محتوا را منتشر کند (یا محتوای شخصی‌سازی‌شده‌تری ارائه دهد).

فراداده‌های زیر بخشی از کارت ورود به سیستم هستند -

ویژگی	مورد نیاز	توضیحات
اکشن اوری	مورد نیاز	پیوند عمیق به اقدام (یعنی به صفحه ورود به برنامه هدایت می‌شود)
تصویر	اختیاری - در صورت عدم ارائه، عنوان باید ارائه شود	تصویر نشان داده شده روی کارت تصاویر با نسبت تصویر ۱۶x۹ و وضوح تصویر ۱۲۶۴x۷۱۲
عنوان	اختیاری - در صورت عدم ارائه، تصویر باید ارائه شود	عنوان روی کارت
متن اکشن	اختیاری	متن نمایش داده شده در فراخوان عمل (مثلاً ورود)
زیرنویس	اختیاری	زیرنویس اختیاری روی کارت

مهم: APIهای انتشار، APIهای درج‌شده هستند؛ این APIها محتوای موجود را جایگزین می‌کنند. APIهای حذف و انتشار را متعاقباً برای جایگزینی محتوا فراخوانی نکنید ، زیرا APIهای انتشار ذاتاً این کار را انجام می‌دهند.

کاتلین

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

اگر به هر دلیل داخلی تجاری، هیچ یک از کلاسترها منتشر نشده‌اند، اکیداً توصیه می‌کنیم وضعیت انتشار را با استفاده از API مربوط به updatePublishStatus به‌روزرسانی کنید. این مهم است زیرا:

• ارائه وضعیت در همه سناریوها، حتی زمانی که محتوا منتشر شده است (وضعیت == منتشر شده)، برای پر کردن داشبوردهایی که از این وضعیت صریح برای انتقال سلامت و سایر معیارهای ادغام شما استفاده می‌کنند، بسیار مهم است.
• اگر هیچ محتوایی منتشر نشده باشد اما وضعیت ادغام خراب نباشد (STATUS == NOT_PUBLISHED)، گوگل می‌تواند از نمایش هشدارها در داشبوردهای سلامت برنامه جلوگیری کند. این تأیید می‌کند که محتوا به دلیل وضعیت مورد انتظار از دیدگاه ارائه‌دهنده منتشر نشده است.
• این به توسعه‌دهندگان کمک می‌کند تا بینشی در مورد زمان انتشار داده‌ها در مقابل عدم انتشار آنها ارائه دهند.
• گوگل ممکن است از کدهای وضعیت برای ترغیب کاربر به انجام اقدامات خاص در برنامه استفاده کند تا بتواند محتوای برنامه را ببیند یا از آن عبور کند.

لیست کدهای وضعیت انتشار واجد شرایط عبارتند از:

// 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

اگر محتوا به دلیل عدم ورود کاربر منتشر نشود، گوگل انتشار کارت ورود به سیستم را توصیه می‌کند. اگر به هر دلیلی ارائه دهندگان خدمات قادر به انتشار کارت ورود به سیستم نیستند، توصیه می‌کنیم API مربوط به updatePublishStatus را با کد وضعیت NOT_PUBLISHED_REQUIRES_SIGN_IN فراخوانی کنید.

کاتلین

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 برای حذف محتوای خوشه‌های توصیه استفاده می‌شود.

مهم: APIهای Delete فقط باید زمانی فراخوانی شوند که محتوایی برای انتشار وجود ندارد. APIهای delete و publish را متعاقباً برای جایگزینی محتوا فراخوانی نکنید ، زیرا APIهای publish ذاتاً این کار را انجام می‌دهند. قبل از استفاده از APIهای delete با آدرس [e-mail] تماس بگیرید.

کاتلین

client.deleteRecommendationClusters()

جاوا

client.deleteRecommendationClusters();

وقتی سرویس درخواست را دریافت می‌کند، داده‌های موجود را از خوشه‌های توصیه حذف می‌کند. در صورت بروز خطا، کل درخواست رد می‌شود و وضعیت موجود حفظ می‌شود.

نکته: این api از نسخه ۱.۱.۰ به بعد در دسترس است.

deleteFeaturedCluster

این API برای حذف محتوای Featured Cluster استفاده می‌شود.

مهم: APIهای Delete فقط باید زمانی فراخوانی شوند که محتوایی برای انتشار وجود ندارد. APIهای delete و publish را متعاقباً برای جایگزینی محتوا فراخوانی نکنید ، زیرا APIهای publish ذاتاً این کار را انجام می‌دهند. قبل از استفاده از APIهای delete با آدرس [e-mail] تماس بگیرید.

کاتلین

client.deleteFeaturedCluster()

جاوا

client.deleteFeaturedCluster();

وقتی سرویس درخواست را دریافت می‌کند، داده‌های موجود را از Featured Cluster حذف می‌کند. در صورت بروز خطا، کل درخواست رد شده و وضعیت موجود حفظ می‌شود.

نکته: این api از نسخه ۱.۱.۰ به بعد در دسترس است.

deleteContinuationCluster

این API برای حذف محتوای Continuation Cluster استفاده می‌شود.

مهم: APIهای Delete فقط باید زمانی فراخوانی شوند که محتوایی برای انتشار وجود ندارد. APIهای delete و publish را متعاقباً برای جایگزینی محتوا فراخوانی نکنید ، زیرا APIهای publish ذاتاً این کار را انجام می‌دهند. قبل از استفاده از APIهای delete با آدرس [e-mail] تماس بگیرید.

کاتلین

client.deleteContinuationCluster()

جاوا

client.deleteContinuationCluster();

وقتی سرویس درخواست را دریافت می‌کند، داده‌های موجود را از خوشه ادامه حذف می‌کند. در صورت بروز خطا، کل درخواست رد می‌شود و وضعیت موجود حفظ می‌شود.

نکته: این api از نسخه ۱.۱.۰ به بعد در دسترس است.

deleteUserManagementCluster

این API برای حذف محتوای کلاستر UserAccountManagement استفاده می‌شود.

مهم: APIهای Delete فقط باید زمانی فراخوانی شوند که محتوایی برای انتشار وجود ندارد. APIهای delete و publish را متعاقباً برای جایگزینی محتوا فراخوانی نکنید ، زیرا APIهای publish ذاتاً این کار را انجام می‌دهند. قبل از استفاده از APIهای delete با آدرس [e-mail] تماس بگیرید.

کاتلین

client.deleteUserManagementCluster()

جاوا

client.deleteUserManagementCluster();

وقتی سرویس درخواست را دریافت می‌کند، داده‌های موجود را از کلاستر UserAccountManagement حذف می‌کند. در صورت بروز خطا، کل درخواست رد شده و وضعیت موجود حفظ می‌شود.

نکته: این api از نسخه ۱.۱.۰ به بعد در دسترس است.

deleteClusters

این API برای حذف محتوای یک نوع خوشه داده شده استفاده می‌شود.

مهم: APIهای Delete فقط باید زمانی فراخوانی شوند که محتوایی برای انتشار وجود ندارد. APIهای delete و publish را متعاقباً برای جایگزینی محتوا فراخوانی نکنید ، زیرا APIهای publish ذاتاً این کار را انجام می‌دهند. قبل از استفاده از APIهای delete با آدرس [e-mail] تماس بگیرید.

کاتلین

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

جاوا

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

وقتی سرویس درخواست را دریافت می‌کند، داده‌های موجود را از تمام خوشه‌هایی که با انواع خوشه‌های مشخص‌شده مطابقت دارند، حذف می‌کند. کلاینت‌ها می‌توانند یک یا چند نوع خوشه را ارسال کنند. در صورت بروز خطا، کل درخواست رد می‌شود و وضعیت موجود حفظ می‌شود.

مدیریت خطا

اکیداً توصیه می‌شود که به نتیجه‌ی وظیفه از APIهای انتشار گوش دهید تا بتوان اقدامات بعدی را برای بازیابی و ارسال مجدد یک وظیفه‌ی موفق انجام داد.

کاتلین

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

جاوا

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	اجرای وظیفه به دلیل مشکلات نخ‌بندی (threading) با شکست مواجه شد. در این صورت، می‌توان آن را دوباره امتحان کرد.
4	SERVICE_CALL_PERMISSION_DENIED	تماس گیرنده مجاز به برقراری تماس خدماتی نیست.
5	SERVICE_CALL_INVALID_ARGUMENT	درخواست شامل داده‌های نامعتبر است (برای مثال، بیش از تعداد مجاز خوشه‌ها).
6	SERVICE_CALL_INTERNAL	در سمت سرویس خطایی رخ داده است.
7	SERVICE_CALL_RESOURCE_EXHAUSTED	تماس با سرویس خیلی زیاد انجام می‌شود.

مرحله ۳: مدیریت اهداف پخش

علاوه بر فراخوانی‌های API مربوط به انتشار محتوا از طریق یک job، لازم است یک BroadcastReceiver نیز راه‌اندازی شود تا درخواست انتشار محتوا را دریافت کند.

هدف از اعلان‌های هدف عمدتاً فعال‌سازی مجدد برنامه و همگام‌سازی اجباری داده‌ها است. اعلان‌های هدف برای ارسال مکرر طراحی نشده‌اند. این اعلان‌ها فقط زمانی فعال می‌شوند که سرویس Engage تشخیص دهد محتوا ممکن است قدیمی باشد (مثلاً یک هفته قدیمی). به این ترتیب، حتی اگر برنامه برای مدت طولانی اجرا نشده باشد، اطمینان بیشتری وجود دارد که کاربر می‌تواند تجربه محتوای جدیدی داشته باشد.

BroadcastReceiver باید به دو روش زیر تنظیم شود:

• با استفاده از Context.registerReceiver() یک نمونه از کلاس BroadcastReceiver را به صورت پویا ثبت کنید. این کار امکان ارتباط از برنامه‌هایی را که هنوز در حافظه فعال هستند، فراهم می‌کند.

کاتلین

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

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

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

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

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

جاوا

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

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

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

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

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

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

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

• یک پیاده‌سازی را به صورت ایستا با تگ <receiver> در فایل AndroidManifest.xml خود تعریف کنید. این به برنامه اجازه می‌دهد تا در زمانی که در حال اجرا نیست، اهداف پخش (broadcast intents) را دریافت کند و همچنین به برنامه اجازه می‌دهد تا محتوا را منتشر کند.

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

اینتنت‌های زیر توسط سرویس ارسال می‌شوند:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION توصیه می‌شود هنگام دریافت این intent، یک فراخوانی publishRecommendationClusters آغاز شود.
• com.google.android.engage.action.PUBLISH_FEATURED توصیه می‌شود هنگام دریافت این intent، یک فراخوانی publishFeaturedCluster آغاز شود.
• com.google.android.engage.action.PUBLISH_CONTINUATION توصیه می‌شود هنگام دریافت این intent، یک فراخوانی publishContinuationCluster آغاز شود.

گردش کار یکپارچه‌سازی

برای راهنمای گام به گام تأیید ادغام پس از تکمیل، به گردش کار ادغام توسعه‌دهنده مراجعه کنید.

سوالات متداول

برای سوالات متداول به بخش سوالات متداول Engage SDK مراجعه کنید.

تماس

در صورت وجود هرگونه سوال در طول فرآیند ادغام، [e-mail] تماس بگیرید.

مراحل بعدی

پس از تکمیل این ادغام، مراحل بعدی به شرح زیر است:

• یک ایمیل به [e-mail] ارسال کنید و APK یکپارچه خود را که آماده آزمایش توسط گوگل است، پیوست کنید.
• گوگل یک بررسی داخلی انجام می‌دهد تا مطمئن شود که ادغام طبق انتظار کار می‌کند. در صورت نیاز به تغییرات، گوگل با شما تماس می‌گیرد و جزئیات لازم را ارائه می‌دهد.
• وقتی آزمایش کامل شد و نیازی به تغییر نبود، گوگل با شما تماس می‌گیرد تا به شما اطلاع دهد که می‌توانید APK به‌روزرسانی‌شده و یکپارچه‌شده را در فروشگاه Play منتشر کنید.
• پس از اینکه گوگل تأیید کرد که APK به‌روزرسانی‌شده شما در فروشگاه Play منتشر شده است، خوشه‌های توصیه ، ویژه و ادامه شما ممکن است منتشر شده و برای کاربران قابل مشاهده باشند.