Engage SDK Other Verticals: Third-party technical integration instructions

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

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

مهارت‌های Android

مشاهده در GitHub

ادغام Engage SDK

از مهارت Android در Engage SDK برای ادغام، اشکال‌زدایی، و حل مشکلات پیاده‌سازی استفاده کنید.

برای نصب مهارت از Android CLI، این دستور را اجرا کنید:

android skills add engage-sdk-integration

جزئیات یکپارچه‌سازی

این بخش مراحل، مدل‌های داده، و اصطلاحات لازم برای ادغام با «کیت توسعه نرم‌افزار Engage» را برای سایر دسته‌های محتوا شرح می‌دهد.

اصطلاحات

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

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

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

    

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

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

    

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

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

    

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

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

    

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

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

    

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

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

    

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

• خوشه ادامه محتوایی را نشان می‌دهد که اخیراً کاربران از چندین شریک توسعه‌دهنده در یک گروه‌بندی واسط کاربر با آن تعامل داشته‌اند. هر شریک توسعه‌دهنده می‌تواند حداکثر ۱۰ نهاد را در خوشه «ادامه» همه‌فرستی کند.

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

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

    

    شکل ۶.‏ واسط کاربری که یک ArticleEntity را در خوشه «ادامه» نشان می‌دهد.

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

    

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

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

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

    

    شکل ۸. واسط کاربر که یک EventReservationEntity را در خوشه «ادامه» نشان می‌دهد.

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

    

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

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

    

    شکل ۱۰. میانای کاربری که یک TransportationReservationEntity را در خوشه «ادامه» نشان می‌دهد.

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

    

    شکل ۱۱. میانای کاربری که یک VehicleRentalReservationEntity را در خوشه «ادامه» نشان می‌دهد.

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

  • GenericFeaturedEntity: GenericFeaturedEntity با مورد «توصیه» تفاوت دارد زیرا مورد «ویژه» باید برای یک محتوای برتر از توسعه‌دهندگان استفاده شود و باید نشان‌دهنده مهم‌ترین محتوایی باشد که برای کاربران جالب و مرتبط است.

    

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

پیش‌کار

حداقل سطح میانای برنامه‌سازی کاربردی: ۱۹

کتابخانه 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'
}

خلاصه

طراحی براساس پیاده‌سازی خدمات محدودکننده است.

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

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

مرحله ۱: ارائه داده‌های نهاد

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

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

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

ArticleEntity

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

EventEntity

مشخصه	الزام	شرح	قالب
شناسه منبع یکسان کنش	الزامی	پیوند عمیق به نهاد در برنامه ارائه‌دهنده. توجه: می‌توانید از پیوندهای عمیق برای اِسناد استفاده کنید. به این پرسشگان مراجعه کنید	Uri
عنوان	الزامی	عنوان نهاد.	رشته اندازه نوشتار توصیه‌شده: حداکثر ۵۰ نویسه
زمان شروع	الزامی	مُهر زمان مبدأ که انتظار می‌رود رویداد در آن زمان شروع شود. توجه:این مقدار برحسب میلی‌ثانیه نشان داده می‌شود.	مُهر زمان تاریخ برحسب میلی‌ثانیه
حالت رویداد	الزامی	فیلدی برای نشان دادن اینکه رویداد مجازی، حضوری، یا هر دو خواهد بود.	Enum: VIRTUAL،‏ IN_PERSON، یا HYBRID
تصاویر پوستر	الزامی	وقتی چند تصویر ارائه شده باشد، فقط ۱ تصویر را نشان می‌دهیم. نسبت ابعادی توصیه‌شده ۱۶:۹ است توجه: تصویر به‌شدت توصیه می‌شود. اگر نشان ارائه شده است، مطمئن شوید که فضای ایمن ۲۴ پیکسل مستقل از تراکم در بالا و پایین تصویر وجود داشته باشد	برای راهنمایی، مشخصات تصویر را ببینید.
مکان - کشور	الزامی مشروط	کشوری که رویداد در آن اتفاق می‌افتد. توجه: این مورد برای رویدادهای IN_PERSON یا HYBRID الزامی است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - شهر	الزامی مشروط	شهری که رویداد در آن اتفاق می‌افتد. توجه: این مورد برای رویدادهای IN_PERSON یا HYBRID الزامی است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - نشانی نمایشی	الزامی مشروط	نشانی یا نام محل برگزاری رویداد که باید به کاربر نشان داده شود. توجه: این مورد برای رویدادهای IN_PERSON یا HYBRID الزامی است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Location - Street Address	اختیاری	نشانی خیابان (درصورت وجود) مکانی که رویداد در آن برگزار می‌شود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - ایالت	اختیاری	ایالت یا استان (درصورت وجود) که رویداد در آن میزبانی می‌شود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - کد پستی	اختیاری	کد پستی (درصورت وجود) مکانی که رویداد در آن میزبانی می‌شود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - محله	اختیاری	محله‌ای (درصورت وجود) که رویداد در آنجا میزبانی می‌شود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
زمان پایان	اختیاری	مُهر زمان مبدأ که انتظار می‌رود رویداد در آن زمان پایان یابد. توجه:این مقدار برحسب میلی‌ثانیه نشان داده می‌شود.	مُهر زمان تاریخ برحسب میلی‌ثانیه
شرح	اختیاری	یک پاراگراف نوشتار برای توصیف نهاد. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه توصیه‌شده نوشتار: ۱۸۰ نویسه
فهرست زیرنویس	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس یک خط نوشتار است. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه نوشتار توصیه‌شده برای هر زیرنویس: حداکثر ۵۰ نویسه
نشان‌ها	اختیاری	هر نشان یا نوشتار آزاد (حداکثر ۱۵ نویسه) یا تصویر کوچک است.
نشان - نوشتار	اختیاری	عنوان نشان توجه: برای نشان، نوشتار یا تصویر لازم است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ۱۵ نویسه
نشان - تصویر	اختیاری	تصویر کوچک پردازش ویژه UX، برای مثال به‌عنوان نشان روی ریزعکس تصویر/ویدیو. توجه: برای نشان، نوشتار یا تصویر لازم است	برای راهنمایی، مشخصات تصویر را ببینید.
Price - CurrentPrice	الزامی مشروط	قیمت فعلی بلیت/مجوز رویداد. اگر قیمت خط‌خورده ارائه شده باشد، باید ارائه شود.	نوشتار آزاد
Price - StrikethroughPrice	اختیاری	قیمت اصلی بلیت/مجوز رویداد.	نوشتار آزاد
نوشته راهنمای قیمت	اختیاری	توضیح قیمت برای نمایش تبلیغ، رویداد، تخفیف عضو، درصورت وجود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)
دسته‌های محتوا	اختیاری	دسته محتوا را در نهاد شرح دهید.	فهرست انواع شمارشی واجدشرایط TYPE_MOVIES_AND_TV_SHOWS (مثال - سینما) TYPE_DIGITAL_GAMES (Example - eSports) TYPE_MUSIC (مثال - کنسرت) TYPE_TRAVEL_AND_LOCAL (مثال - تور، جشنواره) TYPE_HEALTH_AND_FITENESS (مثال - کلاس یوگا) TYPE_EDUCATION (مثال - کلاس) TYPE_SPORTS (مثال - بازی فوتبال) TYPE_DATING (مثال - meetup) برای راهنمایی، به بخش «دسته محتوا» مراجعه کنید.

LodgingEntity

مشخصه	الزام	شرح	قالب
شناسه منبع یکسان کنش	الزامی	پیوند عمیق به نهاد در برنامه ارائه‌دهنده. توجه: می‌توانید از پیوندهای عمیق برای اِسناد استفاده کنید. به این پرسشگان مراجعه کنید	Uri
عنوان	الزامی	عنوان نهاد.	رشته اندازه نوشتار توصیه‌شده: حداکثر ۵۰ نویسه
تصاویر پوستر	الزامی	وقتی چند تصویر ارائه شده باشد، فقط ۱ تصویر را نشان می‌دهیم. نسبت ابعادی توصیه‌شده ۱۶:۹ است توجه: اگر نشان ارائه شده است، مطمئن شوید فضای امن ۲۴ پیکسل مستقل از تراکم در بالا و پایین تصویر وجود داشته باشد	برای راهنمایی، مشخصات تصویر را ببینید.
مکان - کشور	الزامی	کشوری که اقامت در آن انجام می‌شود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - شهر	الزامی	شهری که اقامتگاه در آن واقع شده است.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - نشانی نمایشی	الزامی	نشانی اقامتگاهی که به کاربر نمایش داده خواهد شد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Location - Street Address	اختیاری	نشانی خیابان (درصورت وجود) اقامتگاه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - ایالت	اختیاری	ایالت یا استان (درصورت وجود) که اقامتگاه در آن واقع شده است.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - کد پستی	اختیاری	کد پستی (درصورت وجود) اقامتگاه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - محله	اختیاری	محله (درصورت وجود) اقامتگاه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
نشان‌ها	اختیاری	هر نشان یا نوشتار آزاد (حداکثر ۱۵ نویسه) یا تصویر کوچک است.
نشان - نوشتار	اختیاری	عنوان نشان توجه: برای نشان، نوشتار یا تصویر لازم است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ۱۵ نویسه
نشان - تصویر	اختیاری	تصویر کوچک پردازش ویژه UX، برای مثال به‌عنوان نشان روی ریزعکس تصویر/ویدیو. توجه: برای نشان، نوشتار یا تصویر لازم است	برای راهنمایی، مشخصات تصویر را ببینید.
شرح	اختیاری	یک پاراگراف نوشتار برای توصیف نهاد. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه توصیه‌شده نوشتار: ۱۸۰ نویسه
فهرست زیرنویس	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس یک خط نوشتار است. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه نوشتار توصیه‌شده برای هر زیرنویس: حداکثر ۵۰ نویسه
AvailabilityTimeWindow - Start Time	اختیاری	مُهر زمان تاریخ یونیکس برحسب میلی‌ثانیه که انتظار می‌رود اقامتگاه باز/دردسترس باشد.	مُهر زمان تاریخ برحسب میلی‌ثانیه
AvailabilityTimeWindow - End Time	اختیاری	مُهر زمان تاریخ برحسب میلی‌ثانیه که تا آن زمان انتظار می‌رود اقامتگاه باز/دردسترس باشد.	مُهر زمان تاریخ برحسب میلی‌ثانیه
رده‌بندی - مقدار حداکثر	اختیاری	حداکثر مقدار مقیاس رده‌بندی. اگر مقدار فعلی رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - مقدار فعلی	اختیاری	مقدار فعلی مقیاس رده‌بندی. اگر حداکثر مقدار رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - تعداد	اختیاری	تعداد رده‌بندی‌های اقامتگاه. توجه: اگر برنامه‌تان نحوه نمایش تعداد به کاربران را کنترل می‌کند، این فیلد را ارائه دهید. از رشته‌ای مختصر استفاده کنید. برای مثال، اگر تعداد ۱٬۰۰۰٬۰۰۰ است، از مخفف‌هایی مثل 1M استفاده کنید تا تعداد در اندازه‌های نمایشگر کوچک‌تر کوتاه نشود.	رشته
رده‌بندی - مقدار شمارش	اختیاری	تعداد رده‌بندی‌های اقامتگاه. توجه: اگر منطق اختصار نمایش را خودتان مدیریت نمی‌کنید، این فیلد را ارائه دهید. اگر هم «تعداد» و هم «مقدار تعداد» وجود داشته باشد، «تعداد» به کاربران نشان داده می‌شود.	بلند
Price - CurrentPrice	الزامی مشروط	قیمت فعلی اقامتگاه. اگر قیمت خط‌خورده ارائه شده باشد، باید ارائه شود.	نوشتار آزاد
Price - StrikethroughPrice	اختیاری	قیمت اصلی اقامتگاه که در واسط کاربر خط‌خورده است.	نوشتار آزاد
نوشته راهنمای قیمت	اختیاری	توضیح قیمت برای نمایش تبلیغ، رویداد، تخفیف عضو، درصورت وجود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)

StoreEntity

شیء StoreEntity نشان‌دهنده فروشگاه تکی است که شرکای توسعه‌دهنده می‌خواهند منتشر کنند، مثل رستوران یا خواربارفروشی.

مشخصه	الزام	شرح	قالب
تصاویر پوستر	الزامی	حداقل یک تصویر باید ارائه شود.	برای راهنمایی، مشخصات تصویر را ببینید.
شناسه منبع یکسان کنش	الزامی	پیوند عمیق به نهاد در برنامه ارائه‌دهنده. توجه: می‌توانید از پیوندهای عمیق برای اِسناد استفاده کنید. به این پرسشگان مراجعه کنید	Uri
عنوان	اختیاری	نام فروشگاه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)
مکان	اختیاری	مکان فروشگاه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)
نوشته راهنما	اختیاری	توضیح برای نمایش تبلیغ، رویداد، یا به‌روزرسانی برای فروشگاه، درصورت وجود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)
ریزجزئیات نوشته راهنما	اختیاری	نوشتار ریزنویس برای نوشته راهنما.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)
شرح	اختیاری	شرح فروشگاه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۹۰ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)
رده‌بندی - مقدار حداکثر	اختیاری	حداکثر مقدار مقیاس رده‌بندی. اگر مقدار فعلی رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - مقدار فعلی	اختیاری	مقدار فعلی مقیاس رده‌بندی. اگر حداکثر مقدار رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - تعداد	اختیاری	تعداد رده‌بندی‌های اقامتگاه. توجه: اگر برنامه‌تان می‌خواهد نحوه نمایش این مورد به کاربران را کنترل کند، این فیلد را ارائه دهید. رشته مختصری ارائه دهید که بتواند به کاربر نمایش داده شود. برای مثال، اگر تعداد ۱٬۰۰۰٬۰۰۰ است، از کوته‌نوشت‌هایی مثل 1M استفاده کنید تا در اندازه‌های نمایشگر کوچک‌تر کوتاه نشود.	رشته
رده‌بندی - مقدار شمارش	اختیاری	تعداد رده‌بندی‌های اقامتگاه. توجه: اگر نمی‌خواهید منطق اختصار نمایش را خودتان مدیریت کنید، این فیلد را ارائه دهید. اگر هم «تعداد» و هم «مقدار تعداد» وجود داشته باشد، از «تعداد» برای نمایش به کاربران استفاده می‌کنیم	بلند

PointOfInterestEntity

مشخصه	الزام	شرح	قالب
شناسه منبع یکسان کنش	الزامی	پیوند عمیق به نهاد در برنامه ارائه‌دهنده. توجه: می‌توانید از پیوندهای عمیق برای اِسناد استفاده کنید. به این پرسشگان مراجعه کنید	Uri
عنوان	الزامی	عنوان نهاد.	رشته اندازه نوشتار توصیه‌شده: حداکثر ۵۰ نویسه
تصاویر پوستر	الزامی	وقتی چند تصویر ارائه شده باشد، فقط ۱ تصویر را نشان می‌دهیم. نسبت ابعادی توصیه‌شده ۱۶:۹ است توجه: تصویر به‌شدت توصیه می‌شود. اگر نشان ارائه شده است، مطمئن شوید که فضای ایمن ۲۴ پیکسل مستقل از تراکم در بالا و پایین تصویر وجود داشته باشد	برای راهنمایی، مشخصات تصویر را ببینید.
مکان - کشور	الزامی	کشوری که نقطه موردعلاقه در آن اتفاق می‌افتد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - شهر	الزامی	شهری که نقطه موردعلاقه در آن واقع شده است.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - نشانی نمایشی	الزامی	نشانی مکان جالب که به کاربر نشان داده خواهد شد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Location - Street Address	اختیاری	نشانی خیابان (درصورت وجود) نقطه موردعلاقه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - ایالت	اختیاری	ایالت یا استان (درصورت وجود) که نقطه موردعلاقه در آن واقع شده است.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - کد پستی	اختیاری	کد پستی (درصورت وجود) نقطه موردعلاقه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - محله	اختیاری	محله (درصورت وجود) نقطه موردعلاقه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
AvailabilityTimeWindow - Start Time	اختیاری	مُهر زمان تاریخ یونیکس در میلی‌ثانیه زمانی که انتظار می‌رود نقطه جالب باز/دردسترس باشد.	مُهر زمان تاریخ برحسب میلی‌ثانیه
AvailabilityTimeWindow - End Time	اختیاری	مُهر زمان تاریخ یونیکس برحسب میلی‌ثانیه که انتظار می‌رود مکان جالب تا آن زمان باز/دردسترس باشد.	مُهر زمان تاریخ برحسب میلی‌ثانیه
نشان‌ها	اختیاری	هر نشان یا نوشتار آزاد (حداکثر ۱۵ نویسه) یا تصویر کوچک است.
نشان - نوشتار	اختیاری	عنوان نشان توجه: برای نشان، نوشتار یا تصویر لازم است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ۱۵ نویسه
نشان - تصویر	اختیاری	تصویر کوچک پردازش ویژه UX، برای مثال به‌عنوان نشان روی ریزعکس تصویر/ویدیو. توجه: برای نشان، نوشتار یا تصویر لازم است	برای راهنمایی، مشخصات تصویر را ببینید.
شرح	اختیاری	یک پاراگراف نوشتار برای توصیف نهاد. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه توصیه‌شده نوشتار: ۱۸۰ نویسه
فهرست زیرنویس	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس یک خط نوشتار است. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه نوشتار توصیه‌شده برای هر زیرنویس: حداکثر ۵۰ نویسه
رده‌بندی - مقدار حداکثر	اختیاری	حداکثر مقدار مقیاس رده‌بندی. اگر مقدار فعلی رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - مقدار فعلی	اختیاری	مقدار فعلی مقیاس رده‌بندی. اگر حداکثر مقدار رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - تعداد	اختیاری	تعداد رده‌بندی‌های مکان نشان‌دار. توجه: اگر برنامه‌تان نحوه نمایش تعداد به کاربران را کنترل می‌کند، این فیلد را ارائه دهید. از رشته‌ای مختصر استفاده کنید. برای مثال، اگر تعداد ۱٬۰۰۰٬۰۰۰ است، از مخفف‌هایی مثل 1M استفاده کنید تا تعداد در اندازه‌های نمایشگر کوچک‌تر کوتاه نشود.	رشته
رده‌بندی - مقدار شمارش	اختیاری	تعداد رده‌بندی‌های مکان نشان‌دار. توجه: اگر منطق اختصار نمایش را خودتان مدیریت نمی‌کنید، این فیلد را ارائه دهید. اگر هم «تعداد» و هم «مقدار تعداد» وجود داشته باشد، «تعداد» به کاربران نشان داده می‌شود	بلند
Price - CurrentPrice	الزامی مشروط	قیمت فعلی بلیت/مجوز ورود برای نقطه موردعلاقه. اگر قیمت خط‌خورده ارائه شده باشد، باید ارائه شود.	نوشتار آزاد
Price - StrikethroughPrice	اختیاری	قیمت اصلی بلیت/مجوز ورود برای نقطه موردعلاقه.	نوشتار آزاد
نوشته راهنمای قیمت	اختیاری	توضیح قیمت برای نمایش تبلیغ، رویداد، تخفیف عضو، درصورت وجود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتار خیلی طولانی ممکن است با سه‌نقطه نشان داده شود)
دسته‌های محتوا	اختیاری	دسته محتوا را در نهاد شرح دهید.	فهرست انواع شمارشی واجدشرایط TYPE_TRAVEL_AND_LOCAL TYPE_MOVIES_AND_TV_SHOWS (Example - theater) TYPE_MEDICAL (مثال - بیمارستان) TYPE_EDUCATION (مثال - مدرسه) TYPE_SPORTS (مثال - استادیوم) برای راهنمایی، به بخش «دسته محتوا» مراجعه کنید.

PersonEntity

مشخصه	الزام	شرح	قالب
شناسه منبع یکسان کنش	الزامی	پیوند عمیق به نهاد در برنامه ارائه‌دهنده. توجه: می‌توانید از پیوندهای عمیق برای اِسناد استفاده کنید. به این پرسشگان مراجعه کنید	Uri
نمایه - نام	الزامی	نام نمایه یا شناسه یا نام کاربری، مثلاً «John Doe»،‏ «‎@TeamPixel»، و غیره.	رشته اندازه نوشتار توصیه‌شده: حداکثر ۵۰ نویسه
نمایه - چهرک	الزامی	عکس نمایه یا تصویر چهرک کاربر. توجه:باید تصویر مربعی ۱:۱ باشد.	برای راهنمایی، مشخصات تصویر را ببینید.
پروفایل - نوشتار اضافی	اختیاری	نوشتار آزاد مثل نام کاربری نمایه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ۱۵ نویسه
نمایه - تصویر اضافی	اختیاری	تصویر کوچکی مانند نشان درستی‌سنجی‌شده.	برای راهنمایی، مشخصات تصویر را ببینید.
تصویر عنوان	اختیاری	وقتی چند تصویر ارائه شده باشد، فقط ۱ تصویر را نشان می‌دهیم. نسبت ابعادی توصیه‌شده ۱۶:۹ است توجه: تصویر به‌شدت توصیه می‌شود. اگر نشان ارائه شده است، مطمئن شوید که فضای ایمن ۲۴ پیکسل مستقل از تراکم در بالا و پایین تصویر وجود داشته باشد	برای راهنمایی، مشخصات تصویر را ببینید.
محبوبیت - تعداد	اختیاری	تعداد دنبال‌کنندگان یا مقدار محبوبیت را نشان می‌دهد، برای مثال - «۳٫۷ میلیون». توجه: اگر هم «تعداد» و هم «مقدار تعداد» ارائه شده باشد، از «تعداد» استفاده خواهد شد	رشته اندازه نوشتار توصیه‌شده: حداکثر ۲۰ نویسه برای ترکیب تعداد + برچسب
محبوبیت - مقدار شمارش	اختیاری	تعداد دنبال‌کنندگان یا مقدار محبوبیت. توجه: اگر برنامه‌تان نمی‌خواهد منطق نحوه بهینه‌سازی عدد بزرگ برای اندازه‌های مختلف نمایش را مدیریت کند، Count Value را ارائه دهید. اگر هم «تعداد» و هم «مقدار تعداد» ارائه شده باشد، از «تعداد» استفاده خواهد شد.	بلند
محبوبیت - برچسب	اختیاری	مشخص کنید برچسب محبوبیت چیست. برای مثال - «پسندیدن‌ها».	رشته اندازه نوشتار توصیه‌شده: حداکثر ۲۰ نویسه برای ترکیب تعداد + برچسب
محبوبیت - بصری	اختیاری	مشخص کنید تعامل برای چیست. برای مثال - تصویری که نماد «پسندیدن»، اموجی را نشان می‌دهد. می‌توانید بیش‌از ۱ تصویر ارائه دهید، هرچند ممکن است همه آن‌ها در همه ضرایب شکل نشان داده نشوند. توجه: باید تصویر مربعی ۱:۱ باشد	برای راهنمایی، مشخصات تصویر را ببینید.
رده‌بندی - مقدار حداکثر	الزامی	حداکثر مقدار مقیاس رده‌بندی. اگر مقدار فعلی رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - مقدار فعلی	الزامی	مقدار فعلی مقیاس رده‌بندی. اگر حداکثر مقدار رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - تعداد	اختیاری	تعداد رده‌بندی‌های نهاد. توجه: اگر برنامه‌تان می‌خواهد نحوه نمایش این مورد به کاربران را کنترل کند، این فیلد را ارائه دهید. رشته مختصری ارائه دهید که بتواند به کاربر نمایش داده شود. برای مثال، اگر تعداد ۱٬۰۰۰٬۰۰۰ است، از کوته‌نوشت‌هایی مثل 1M استفاده کنید تا در اندازه‌های نمایشگر کوچک‌تر کوتاه نشود.	رشته
رده‌بندی - مقدار شمارش	اختیاری	تعداد رده‌بندی‌های نهاد. توجه: اگر نمی‌خواهید منطق اختصار نمایش را خودتان مدیریت کنید، این فیلد را ارائه دهید. اگر هم «تعداد» و هم «مقدار تعداد» وجود داشته باشد، از «تعداد» برای نمایش به کاربران استفاده می‌کنیم	بلند
مکان - کشور	اختیاری	کشوری که فرد در آنجا قرار دارد یا خدمت می‌کند.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - شهر	اختیاری	شهری که فرد در آنجا قرار دارد یا خدمت می‌کند.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - نشانی نمایشی	اختیاری	نشانی‌ای که فرد در آنجا قرار دارد یا خدمت ارائه می‌دهد به کاربر نشان داده خواهد شد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Location - Street Address	اختیاری	نشانی خیابان (درصورت وجود) جایی که فرد در آنجا قرار دارد یا خدمت می‌کند.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - ایالت	اختیاری	ایالتی (درصورت وجود) که فرد در آنجا قرار دارد یا خدمت می‌کند.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - کد پستی	اختیاری	کد پستی (درصورت وجود) جایی که فرد در آنجا قرار دارد یا خدمت می‌کند.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - محله	اختیاری	محله‌ای (درصورت وجود) که فرد در آنجا قرار دارد یا خدمات ارائه می‌دهد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
نشان‌ها	اختیاری	هر نشان یا نوشتار آزاد (حداکثر ۱۵ نویسه) یا تصویر کوچک است.
نشان - نوشتار	اختیاری	عنوان نشان توجه: برای نشان، نوشتار یا تصویر لازم است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ۱۵ نویسه
نشان - تصویر	اختیاری	تصویر کوچک پردازش ویژه UX، برای مثال به‌عنوان نشان روی ریزعکس تصویر/ویدیو. توجه: برای نشان، نوشتار یا تصویر لازم است	برای راهنمایی، مشخصات تصویر را ببینید.
شرح	اختیاری	یک پاراگراف نوشتار برای توصیف نهاد. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه توصیه‌شده نوشتار: ۱۸۰ نویسه
فهرست زیرنویس	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس یک خط نوشتار است. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه نوشتار توصیه‌شده برای هر زیرنویس: حداکثر ۵۰ نویسه
دسته‌های محتوا	اختیاری	دسته محتوا را در نهاد شرح دهید.	فهرست انواع شمارشی واجدشرایط TYPE_HEALTH_AND_FITENESS (مثال - مربی یوگا/تناسب اندام) TYPE_HOME_AND_AUTO (مثال - لوله‌کش) TYPE_SPORTS (مثال - بازیکن) TYPE_DATING برای راهنمایی، به بخش «دسته محتوا» مراجعه کنید.

RestaurantReservationEntity

مشخصه	الزام	شرح	قالب
شناسه منبع یکسان کنش	الزامی	پیوند عمیق به نهاد در برنامه ارائه‌دهنده. توجه: می‌توانید از پیوندهای عمیق برای اِسناد استفاده کنید. به این پرسشگان مراجعه کنید	Uri
عنوان	الزامی	عنوان نهاد.	رشته اندازه نوشتار توصیه‌شده: حداکثر ۵۰ نویسه
زمان شروع رزرو	الزامی	مُهر زمان تاریخ یونیکس برحسب میلی‌ثانیه که انتظار می‌رود رزرو در آن زمان شروع شود.	مُهر زمان تاریخ برحسب میلی‌ثانیه
مکان - کشور	الزامی	کشوری که رستوران در آن واقع شده است.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - شهر	الزامی	شهری که رستوران در آن واقع شده است.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - نشانی نمایشی	الزامی	نشانی رستوران که به کاربر نشان داده خواهد شد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Location - Street Address	اختیاری	نشانی خیابان (درصورت وجود) رستوران.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - ایالت	اختیاری	ایالت یا استان (درصورت وجود) که رستوران در آن واقع شده است.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - کد پستی	اختیاری	کد پستی (درصورت وجود) رستوران.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - محله	اختیاری	محله (درصورت وجود) رستوران.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
تصاویر پوستر	اختیاری	وقتی چند تصویر ارائه شده باشد، فقط ۱ تصویر را نشان می‌دهیم. نسبت ابعادی توصیه‌شده ۱۶:۹ است	برای راهنمایی، مشخصات تصویر را ببینید.
شرح	اختیاری	یک پاراگراف نوشتار برای توصیف نهاد. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه توصیه‌شده نوشتار: ۱۸۰ نویسه
فهرست زیرنویس	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس یک خط نوشتار است. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه نوشتار توصیه‌شده برای هر زیرنویس: حداکثر ۵۰ نویسه
اندازه جدول	اختیاری	تعداد افراد در گروه رزرو	عدد صحیح > ۰

EventReservationEntity

مشخصه	الزام	شرح	قالب
شناسه منبع یکسان کنش	الزامی	پیوند عمیق به نهاد در برنامه ارائه‌دهنده. توجه: می‌توانید از پیوندهای عمیق برای اِسناد استفاده کنید. به این پرسشگان مراجعه کنید	Uri
عنوان	الزامی	عنوان نهاد.	رشته اندازه نوشتار توصیه‌شده: حداکثر ۵۰ نویسه
زمان شروع	الزامی	مُهر زمان مبدأ که انتظار می‌رود رویداد در آن زمان شروع شود. توجه:این مقدار برحسب میلی‌ثانیه نشان داده می‌شود.	مُهر زمان تاریخ برحسب میلی‌ثانیه
حالت رویداد	الزامی	فیلدی برای نشان دادن اینکه رویداد مجازی، حضوری، یا هر دو خواهد بود.	Enum: VIRTUAL،‏ IN_PERSON، یا HYBRID
مکان - کشور	الزامی مشروط	کشوری که رویداد در آن اتفاق می‌افتد. توجه: این مورد برای رویدادهای IN_PERSON یا HYBRID الزامی است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - شهر	الزامی مشروط	شهری که رویداد در آن اتفاق می‌افتد. توجه: این مورد برای رویدادهای IN_PERSON یا HYBRID الزامی است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - نشانی نمایشی	الزامی مشروط	نشانی یا نام محل برگزاری رویداد که باید به کاربر نشان داده شود. توجه: این مورد برای رویدادهای IN_PERSON یا HYBRID الزامی است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Location - Street Address	اختیاری	نشانی خیابان (درصورت وجود) مکانی که رویداد در آن برگزار می‌شود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - ایالت	اختیاری	ایالت یا استان (درصورت وجود) که رویداد در آن میزبانی می‌شود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - کد پستی	اختیاری	کد پستی (درصورت وجود) مکانی که رویداد در آن میزبانی می‌شود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - محله	اختیاری	محله‌ای (درصورت وجود) که رویداد در آنجا میزبانی می‌شود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
تصاویر پوستر	اختیاری	وقتی چند تصویر ارائه شده باشد، فقط ۱ تصویر را نشان می‌دهیم. نسبت ابعادی توصیه‌شده ۱۶:۹ است توجه: تصویر به‌شدت توصیه می‌شود. اگر نشان ارائه شده است، مطمئن شوید که فضای ایمن ۲۴ پیکسل مستقل از تراکم در بالا و پایین تصویر وجود داشته باشد	برای راهنمایی، مشخصات تصویر را ببینید.
زمان پایان	اختیاری	مُهر زمان مبدأ که انتظار می‌رود رویداد در آن زمان پایان یابد. توجه:این مقدار برحسب میلی‌ثانیه نشان داده می‌شود.	مُهر زمان تاریخ برحسب میلی‌ثانیه
فراهم‌ساز خدمات - نام	اختیاری	نام ارائه‌دهنده خدمات. توجه:برای ارائه‌دهنده خدمات، نوشتار یا تصویر الزامی است.	نوشتار آزاد. برای مثال، نام سازمان‌دهنده رویداد/تور
فراهم‌ساز خدمات - تصویر	اختیاری	نشان‌واره/تصویر ارائه‌دهنده خدمات. توجه:برای ارائه‌دهنده خدمات، نوشتار یا تصویر الزامی است.	برای راهنمایی، مشخصات تصویر را ببینید.
شرح	اختیاری	یک پاراگراف نوشتار برای توصیف نهاد. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه توصیه‌شده نوشتار: ۱۸۰ نویسه
فهرست زیرنویس	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس یک خط نوشتار است. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه نوشتار توصیه‌شده برای هر زیرنویس: حداکثر ۵۰ نویسه
نشان‌ها	اختیاری	هر نشان یا نوشتار آزاد (حداکثر ۱۵ نویسه) یا تصویر کوچک است.
نشان - نوشتار	اختیاری	عنوان نشان توجه: برای نشان، نوشتار یا تصویر لازم است	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ۱۵ نویسه
نشان - تصویر	اختیاری	تصویر کوچک پردازش ویژه UX، برای مثال به‌عنوان نشان روی ریزعکس تصویر/ویدیو. توجه: برای نشان، نوشتار یا تصویر لازم است	برای راهنمایی، مشخصات تصویر را ببینید.
شناسه رزرو	اختیاری	شناسه رزرو برای رزرو رویداد.	نوشتار آزاد
Price - CurrentPrice	الزامی مشروط	قیمت فعلی بلیت/مجوز رویداد. اگر قیمت خط‌خورده ارائه شده باشد، باید ارائه شود.	نوشتار آزاد
Price - StrikethroughPrice	اختیاری	قیمت اصلی بلیت/مجوز رویداد.	نوشتار آزاد
نوشته راهنمای قیمت	اختیاری	توضیح قیمت برای نمایش تبلیغ، رویداد، تخفیف عضو، درصورت وجود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)
رده‌بندی - مقدار حداکثر	اختیاری	حداکثر مقدار مقیاس رده‌بندی. اگر مقدار فعلی رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - مقدار فعلی	اختیاری	مقدار فعلی مقیاس رده‌بندی. اگر حداکثر مقدار رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - تعداد	اختیاری	تعداد رده‌بندی‌های رویداد. توجه: اگر برنامه‌تان می‌خواهد نحوه نمایش این مورد به کاربران را کنترل کند، این فیلد را ارائه دهید. رشته مختصری ارائه دهید که بتواند به کاربر نمایش داده شود. برای مثال، اگر تعداد ۱٬۰۰۰٬۰۰۰ است، از کوته‌نوشت‌هایی مثل 1M استفاده کنید تا در اندازه‌های نمایشگر کوچک‌تر کوتاه نشود.	رشته
رده‌بندی - مقدار شمارش	اختیاری	تعداد رده‌بندی‌های رویداد. توجه: اگر نمی‌خواهید منطق اختصار نمایش را خودتان مدیریت کنید، این فیلد را ارائه دهید. اگر هم «تعداد» و هم «مقدار تعداد» وجود داشته باشد، از «تعداد» برای نمایش به کاربران استفاده می‌کنیم	بلند
دسته‌های محتوا	اختیاری	دسته محتوا را در نهاد شرح دهید.	فهرست انواع شمارشی واجدشرایط TYPE_MOVIES_AND_TV_SHOWS (مثال - سینما) TYPE_DIGITAL_GAMES (Example - eSports) TYPE_MUSIC (مثال - کنسرت) TYPE_TRAVEL_AND_LOCAL (مثال - تور، جشنواره) TYPE_HEALTH_AND_FITENESS (مثال - کلاس یوگا) TYPE_EDUCATION (مثال - کلاس) TYPE_SPORTS (مثال - بازی فوتبال) TYPE_DATING (مثال - meetup) برای راهنمایی، به بخش «دسته محتوا» مراجعه کنید.

LodgingReservationEntity

مشخصه	الزام	شرح	قالب
شناسه منبع یکسان کنش	الزامی	پیوند عمیق به نهاد در برنامه ارائه‌دهنده. توجه: می‌توانید از پیوندهای عمیق برای اِسناد استفاده کنید. به این پرسشگان مراجعه کنید	Uri
عنوان	الزامی	عنوان نهاد.	نوشتار آزاد. برای مثال، «اقامت شما از ۱۲ دسامبر» اندازه نوشتار توصیه‌شده: حداکثر ۵۰ نویسه
زمان اعلام حضور کردن	الزامی	مُهر زمان تاریخ یونیکس برحسب میلی‌ثانیه که نشان‌دهنده زمان ورود برای رزرو است.	مُهر زمان تاریخ برحسب میلی‌ثانیه
زمان اعلام خروج	الزامی	مُهر زمان تاریخ یونیکس برحسب میلی‌ثانیه که نشان‌دهنده زمان تسویه‌حساب برای رزرو است.	مُهر زمان تاریخ برحسب میلی‌ثانیه
مکان - کشور	الزامی	کشوری که اقامتگاه در آن واقع شده است.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - شهر	الزامی	شهری که اقامتگاه در آن واقع شده است.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - نشانی نمایشی	الزامی	نشانی اقامتگاهی که به کاربر نمایش داده خواهد شد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Location - Street Address	اختیاری	نشانی خیابان (درصورت وجود) اقامتگاه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - ایالت	اختیاری	ایالت یا استان (درصورت وجود) که اقامتگاه در آن واقع شده است.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - کد پستی	اختیاری	کد پستی (درصورت وجود) اقامتگاه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان - محله	اختیاری	محله (درصورت وجود) اقامتگاه.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
تصاویر پوستر	اختیاری	وقتی چند تصویر ارائه شده باشد، فقط ۱ تصویر را نشان می‌دهیم. نسبت ابعادی توصیه‌شده ۱۶:۹ است توجه: اگر نشان ارائه شده است، مطمئن شوید فضای امن ۲۴ پیکسل مستقل از تراکم در بالا و پایین تصویر وجود داشته باشد	برای راهنمایی، مشخصات تصویر را ببینید.
شرح	اختیاری	یک پاراگراف نوشتار برای توصیف نهاد. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه توصیه‌شده نوشتار: ۱۸۰ نویسه
فهرست زیرنویس	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس یک خط نوشتار است. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه نوشتار توصیه‌شده برای هر زیرنویس: حداکثر ۵۰ نویسه
شناسه رزرو	اختیاری	شناسه رزرو برای رزرو اقامتگاه.	نوشتار آزاد
رده‌بندی - مقدار حداکثر	اختیاری	حداکثر مقدار مقیاس رده‌بندی. اگر مقدار فعلی رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - مقدار فعلی	اختیاری	مقدار فعلی مقیاس رده‌بندی. اگر حداکثر مقدار رده‌بندی نیز ارائه شده باشد، باید ارائه شود.	عدد >= ۰٫۰
رده‌بندی - تعداد	اختیاری	تعداد رده‌بندی‌های اقامتگاه. توجه: اگر برنامه‌تان می‌خواهد نحوه نمایش این مورد به کاربران را کنترل کند، این فیلد را ارائه دهید. رشته مختصری ارائه دهید که بتواند به کاربر نمایش داده شود. برای مثال، اگر تعداد ۱٬۰۰۰٬۰۰۰ است، از کوته‌نوشت‌هایی مثل 1M استفاده کنید تا در اندازه‌های نمایشگر کوچک‌تر کوتاه نشود.	رشته
رده‌بندی - مقدار شمارش	اختیاری	تعداد رده‌بندی‌های اقامتگاه. توجه: اگر نمی‌خواهید منطق اختصار نمایش را خودتان مدیریت کنید، این فیلد را ارائه دهید. اگر هم «تعداد» و هم «مقدار تعداد» وجود داشته باشد، از «تعداد» برای نمایش به کاربران استفاده می‌کنیم	بلند
Price - CurrentPrice	الزامی مشروط	قیمت فعلی اقامتگاه. اگر قیمت خط‌خورده ارائه شده باشد، باید ارائه شود.	نوشتار آزاد
Price - StrikethroughPrice	اختیاری	قیمت اصلی اقامتگاه که در واسط کاربر خط‌خورده است.	نوشتار آزاد
نوشته راهنمای قیمت	اختیاری	توضیح قیمت برای نمایش تبلیغ، رویداد، تخفیف عضو، درصورت وجود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)

TransportationReservationEntity

مشخصه	الزام	شرح	قالب
شناسه منبع یکسان کنش	الزامی	پیوند عمیق به نهاد در برنامه ارائه‌دهنده. توجه: می‌توانید از پیوندهای عمیق برای اِسناد استفاده کنید. به این پرسشگان مراجعه کنید	Uri
عنوان	الزامی	عنوان نهاد.	نوشتار آزاد. برای مثال، «SFO to SAN» (سان‌فرانسیسکو به سن‌دیگو) اندازه نوشتار توصیه‌شده: حداکثر ۵۰ نویسه
نوع حمل‌ونقل	الزامی	حالت/نوع حمل‌ونقل برای رزرو.	Enum: FLIGHT, TRAIN, BUS, or FERRY
زمان حرکت	الزامی	مُهر زمان تاریخ به میلی‌ثانیه که زمان حرکت را نشان می‌دهد.	مُهر زمان تاریخ برحسب میلی‌ثانیه
زمان ورود	الزامی	مُهر زمان تاریخ یونیکس برحسب میلی‌ثانیه که نشان‌دهنده زمان ورود است.	مُهر زمان تاریخ برحسب میلی‌ثانیه
مکان حرکت - کشور	اختیاری	کشور مبدأ.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان حرکت - شهر	اختیاری	شهر مبدأ.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Departure Location - Display Address	اختیاری	مکان عزیمت که به کاربر نمایش داده خواهد شد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان حرکت - نشانی خیابان	اختیاری	نشانی خیابان (درصورت وجود) مکان خروج.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان عزیمت - ایالت	اختیاری	ایالت یا استان (درصورت وجود) مکان عزیمت.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان حرکت - کد پستی	اختیاری	کد پستی (درصورت وجود) مکان عزیمت.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان حرکت - محله	اختیاری	محله (درصورت وجود) مکان عزیمت.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان ورود - کشور	اختیاری	کشور مقصد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان ورود - شهر	اختیاری	شهر ورود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان ورود - نشانی نمایشی	اختیاری	مکان ورود که به کاربر نمایش داده خواهد شد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Arrival Location - Street Address	اختیاری	نشانی خیابان (درصورت وجود) مکان ورود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان ورود - ایالت	اختیاری	ایالت یا استان (درصورت وجود) مکان ورود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان ورود - کد پستی	اختیاری	کد پستی (درصورت وجود) مکان ورود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
مکان ورود - محله	اختیاری	محله (درصورت وجود) مکان ورود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
فراهم‌ساز خدمات - نام	اختیاری	نام ارائه‌دهنده خدمات. توجه:برای ارائه‌دهنده خدمات، نوشتار یا تصویر الزامی است.	نوشتار آزاد. برای مثال، نام شرکت هواپیمایی
فراهم‌ساز خدمات - تصویر	اختیاری	نشان‌واره/تصویر ارائه‌دهنده خدمات. توجه:برای ارائه‌دهنده خدمات، نوشتار یا تصویر الزامی است.	برای راهنمایی، مشخصات تصویر را ببینید.
تصاویر پوستر	اختیاری	وقتی چند تصویر ارائه شده باشد، فقط ۱ تصویر را نشان می‌دهیم. نسبت ابعادی توصیه‌شده ۱۶:۹ است	برای راهنمایی، مشخصات تصویر را ببینید.
شرح	اختیاری	یک پاراگراف نوشتار برای توصیف نهاد. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه توصیه‌شده نوشتار: ۱۸۰ نویسه
فهرست زیرنویس	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس یک خط نوشتار است. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه نوشتار توصیه‌شده برای هر زیرنویس: حداکثر ۵۰ نویسه
شناسه رزرو	اختیاری	شناسه رزرو برای رزرو حمل‌ونقل.	نوشتار آزاد
Price - CurrentPrice	الزامی مشروط	قیمت فعلی رزرو. اگر قیمت خط‌خورده ارائه شده باشد، باید ارائه شود.	نوشتار آزاد
Price - StrikethroughPrice	اختیاری	قیمت اصلی رزرو که در واسط کاربر روی آن خط کشیده شده است.	نوشتار آزاد
نوشته راهنمای قیمت	اختیاری	توضیح قیمت برای نمایش تبلیغ، رویداد، تخفیف عضو، درصورت وجود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)
شماره حمل‌ونقل	الزامی	شماره پرواز، شماره اتوبوس، شماره قطار، یا شماره کشتی/کشتی تفریحی.	نوشتار آزاد
زمان سوار شدن	الزامی	مُهر زمان مبدأ که نشان‌دهنده زمان سوار شدن برای رزرو است (درصورت وجود)	مُهر زمان تاریخ برحسب میلی‌ثانیه

VehicleRentalReservationEntity

مشخصه	الزام	شرح	قالب
شناسه منبع یکسان کنش	الزامی	پیوند عمیق به نهاد در برنامه ارائه‌دهنده. توجه: می‌توانید از پیوندهای عمیق برای اِسناد استفاده کنید. به این پرسشگان مراجعه کنید	Uri
عنوان	الزامی	عنوان نهاد.	نوشتار آزاد. برای مثال، «Avis Union Square SF» اندازه نوشتار توصیه‌شده: حداکثر ۵۰ نویسه
زمان تحویل گرفتن	الزامی	مُهر زمان مبدأ که نشان‌دهنده زمان تحویل گرفتن برای رزرو است.	مُهر زمان تاریخ برحسب میلی‌ثانیه
زمانِ برگرداندن	اختیاری	مُهر زمان مبدأ که نشان‌دهنده زمان خروج برای رزرو است.	مُهر زمان تاریخ برحسب میلی‌ثانیه
نشانی تحویل گرفتن - کشور	اختیاری	کشور مکان سوار شدن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Pickup Address - City	اختیاری	شهر مکان سوار شدن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
نشانی تحویل گرفتن - نشانی نمایشی	اختیاری	محل تحویل که به کاربر نمایش داده خواهد شد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
نشانی تحویل گرفتن - نشانی خیابان	اختیاری	نشانی خیابان (درصورت وجود) مکان سوار شدن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
نشانی تحویل گرفتن - ایالت	اختیاری	ایالت یا استان (درصورت وجود) مکان سوار شدن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Pickup Address - Zip code	اختیاری	کد پستی (درصورت وجود) مکان سوار شدن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
نشانی تحویل گرفتن - محله	اختیاری	محله (درصورت وجود) مکان سوار شدن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Return Address - Country	اختیاری	کشور مکان مرجوع کردن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
نشانی برگشت - شهر	اختیاری	شهر مکان مرجوع کردن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
نشانی فرستنده - نشانی نمایشی	اختیاری	مکان مرجوع کردن که به کاربر نشان داده خواهد شد.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Return Address - Street Address	اختیاری	نشانی خیابان (درصورت وجود) مکان مرجوع کردن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Return Address - State	اختیاری	ایالت یا استان (درصورت وجود) مکان مرجوع کردن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
Return Address - Zip code	اختیاری	کد پستی (درصورت وجود) مکان مرجوع کردن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
نشانی فرستنده - محله	اختیاری	محله (درصورت وجود) مکان مرجوع کردن.	نوشتار آزاد اندازه نوشتار توصیه‌شده: حداکثر ~۲۰ نویسه
فراهم‌ساز خدمات - نام	اختیاری	نام ارائه‌دهنده خدمات. توجه:برای ارائه‌دهنده خدمات، نوشتار یا تصویر الزامی است.	نوشتار آزاد. برای مثال، «Avis Car Rental»
فراهم‌ساز خدمات - تصویر	اختیاری	نشان‌واره/تصویر ارائه‌دهنده خدمات. توجه:برای ارائه‌دهنده خدمات، نوشتار یا تصویر الزامی است.	برای راهنمایی، مشخصات تصویر را ببینید.
تصاویر پوستر	اختیاری	وقتی چند تصویر ارائه شده باشد، فقط ۱ تصویر را نشان می‌دهیم. نسبت ابعادی توصیه‌شده ۱۶:۹ است	برای راهنمایی، مشخصات تصویر را ببینید.
شرح	اختیاری	یک پاراگراف نوشتار برای توصیف نهاد. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه توصیه‌شده نوشتار: ۱۸۰ نویسه
فهرست زیرنویس	اختیاری	حداکثر ۳ زیرنویس، که هر زیرنویس یک خط نوشتار است. توجه: یا شرح یا فهرست زیرنویس به کاربر نمایش داده می‌شود، نه هر دو.	نوشتار آزاد اندازه نوشتار توصیه‌شده برای هر زیرنویس: حداکثر ۵۰ نویسه
شناسه تأیید	اختیاری	شناسه تأیید برای رزرو کرایه خودرو.	نوشتار آزاد
Price - CurrentPrice	الزامی مشروط	قیمت فعلی رزرو. اگر قیمت خط‌خورده ارائه شده باشد، باید ارائه شود.	نوشتار آزاد
Price - StrikethroughPrice	اختیاری	قیمت اصلی رزرو که در واسط کاربر روی آن خط کشیده شده است.	نوشتار آزاد
نوشته راهنمای قیمت	اختیاری	توضیح قیمت برای نمایش تبلیغ، رویداد، تخفیف عضو، درصورت وجود.	نوشتار آزاد اندازه نوشتار توصیه‌شده: کمتر از ۴۵ نویسه (نوشتاری که خیلی طولانی باشد ممکن است با سه‌نقطه نشان داده شود)

مشخصات تصویر

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

نسبت ابعادی	حداقل پیکسل	پیکسل‌های توصیه‌شده
مربع (۱×۱) ترجیحی	۳۰۰×۳۰۰	1200x1200
افقی (۱٫۹۱x۱)	‫۶۰۰×۳۱۴	1200x628
عمودی (۴×۵)	‫۴۸۰×۶۰۰	960x1200

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

قالب‌های فایل

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های عمومی میزبانی شوند تا Google بتواند به آن‌ها دسترسی داشته باشد.

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

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

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

   • TYPE_MOVIES_AND_TV_SHOWS - قبل‌از استفاده از نهادهای عمومی، نهادهای راهنمای ادغام تماشا را بررسی کنید.
   • TYPE_BOOKS - Check out the EbookEntity before using the generic entities.
   • TYPE_AUDIOBOOKS - Check out AudiobookEntity before using the generic entities.
   • TYPE_SHOPPING - Check out ShoppingEntity before using the generic entities.
   • TYPE_FOOD_AND_DRINK - قبل‌از استفاده از نهادهای عمومی، نهادهای موجود در راهنمای ادغام غذا را بررسی کنید.

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

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

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

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

‫AppEngagePublishClient مسئول انتشار خوشه‌ها است.

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

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

isServiceAvailable

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

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

مهارت‌های Android

مشاهده در GitHub

ادغام Engage SDK

برای نصب مهارت از Android CLI، این دستور را اجرا کنید:

android skills add engage-sdk-integration

اگر تیم شما از ابزارهای کدنویسی هوش مصنوعی (مانند Gemini در Android Studio) استفاده می‌کند، می‌توانید این انتقال را با درخواست از دستیار هوش مصنوعی خود به‌طور خودکار انجام دهید:

Use the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.

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

نوع خوشه	ثابت نوع خوشه	مقدار عدد صحیح
نامعلوم	TYPE_UNKNOWN	0
خوشه توصیه	TYPE_RECOMMENDATION	1
خوشه ویژه	TYPE_FEATURED	2
خوشه ادامه	TYPE_CONTINUATION	3
خوشه سبد خرید	TYPE_SHOPPING_CART	4
خوشه سفارش مجدد غذا	TYPE_FOOD_REORDER	5
خوشه سبد خرید غذا	TYPE_FOOD_SHOPPING_CART	6
خوشه فهرست خرید غذا	TYPE_FOOD_SHOPPING_LIST	7
خوشه مدیریت کاربر	TYPE_ENGAGEMENT	8
خوشه فهرست خرید	TYPE_SHOPPING_LIST	9
Shopping Reorder Cluster	TYPE_SHOPPING_REORDER	10
Shopping Order Tracking Cluster	TYPE_SHOPPING_ORDER_TRACKING	11
خوشه اشتراک	TYPE_SUBSCRIPTION	12
ادامه دادن خوشه جستجو	TYPE_CONTINUE_SEARCH	13
خوشه رزرو	TYPE_RESERVATION	14

کاتلین

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 امکان بررسی دردسترس بودن برای انواع خوشه‌های خاص را فراهم می‌کند. اگر برنامه‌تان از انتقال متناوب استفاده می‌کند:

• خوشه‌های ادامه (مثل «ادامه خواندن» و «رزروها») به‌طور پیش‌فرض در همه دستگاه‌های پشتیبانی‌شده فعال می‌مانند.
• انواع دیگر خوشه‌ها (مانند «توصیه‌ها») به‌طور متناوب فعال و غیرفعال می‌شوند.

اگر این پیکربندی پیش‌فرض برای نیازهای شما مناسب نیست، با [e-mail] تماس بگیرید.

برای نسخه‌های کیت توسعه نرم‌افزار قبل‌از نسخه ۱.۶.۰ (منسوخ‌شده)

کاتلین

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.
    }
});

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

publishRecommendationClusters

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

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

کاتلین

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

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

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

کاتلین

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

جاوا

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

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

• داده‌های FeaturedCluster موجود از شریک توسعه‌دهنده برداشته می‌شود.
• داده‌های درخواست تجزیه می‌شود و در «خوشه ویژه» به‌روزشده ذخیره می‌شود.

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

publishContinuationCluster

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

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

کاتلین

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 برای انتشار کارت «ورود به سیستم» استفاده می‌شود . کنش ورود به سیستم کاربران را به صفحه ورود به سیستم برنامه هدایت می‌کند تا برنامه بتواند محتوا منتشر کند (یا محتوای شخصی‌سازی‌شده‌تری ارائه دهد)

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

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

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

کاتلین

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 به‌روز کنید. این موضوع مهم است زیرا :

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

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

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

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

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

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

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

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

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

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

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

اگر محتوا به‌دلیل وارد نشدن کاربر به سیستم منتشر نشود، Google توصیه می‌کند «کارت ورود به سیستم» را منتشر کنید. اگر ارائه‌دهندگان به هر دلیلی نتوانند «کارت ورود به سیستم» را منتشر کنند، توصیه می‌کنیم میانای برنامه‌سازی کاربردی updatePublishStatus را با کد وضعیت NOT_PUBLISHED_REQUIRES_SIGN_IN فراخوانی کنید

کاتلین

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());

deleteRecommendationsClusters

این میانای برنامه‌سازی کاربردی برای حذف محتوای «خوشه‌های توصیه‌شده» استفاده می‌شود.

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

کاتلین

client.deleteRecommendationsClusters()

جاوا

client.deleteRecommendationsClusters();

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

توجه: این میانای برنامه‌سازی کاربردی از نسخه ۱.۱.۰ به بعد دردسترس است.

deleteFeaturedCluster

این میانای برنامه‌سازی کاربردی برای حذف محتوای «دسته ویژه» استفاده می‌شود.

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

کاتلین

client.deleteFeaturedCluster()

جاوا

client.deleteFeaturedCluster();

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

توجه: این میانای برنامه‌سازی کاربردی از نسخه ۱.۱.۰ به بعد دردسترس است.

deleteContinuationCluster

این میانای برنامه‌سازی کاربردی برای حذف محتوای «خوشه ادامه» استفاده می‌شود.

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

کاتلین

client.deleteContinuationCluster()

جاوا

client.deleteContinuationCluster();

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

توجه: این میانای برنامه‌سازی کاربردی از نسخه ۱.۱.۰ به بعد دردسترس است.

deleteUserManagementCluster

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

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

کاتلین

client.deleteUserManagementCluster()

جاوا

client.deleteUserManagementCluster();

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

توجه: این میانای برنامه‌سازی کاربردی از نسخه ۱.۱.۰ به بعد دردسترس است.

deleteClusters

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

مهم: Delete APIs فقط زمانی باید فراخوانی شود که محتوایی برای منتشر کردن وجود نداشته باشد. برای جایگزین کردن محتوا، APIهای حذف و انتشار را متعاقباً فراخوانی نکنید، زیرا APIهای انتشار این کار را به‌طور ذاتی انجام می‌دهند. پیش‌از استفاده از میاناهای برنامه‌سازی کاربردی حذف، با [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());

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

مدیریت کردن خطا

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

کاتلین

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

مرحله ۳: مدیریت هدف‌های همه‌فرستی

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

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

BroadcastReceiver باید به دو روش زیر راه‌اندازی شود:

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

کاتلین

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 به‌صورت ایستا اعلام کنید. این به برنامه اجازه می‌دهد تا زمانی که درحال اجرا نیست، اهداف پخش را دریافت کند و همچنین به برنامه اجازه می‌دهد تا محتوا را منتشر کند.

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

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

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

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

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

پرسشگان

برای پرسشگان، به پرسشگان Engage SDK مراجعه کنید.

تماس

اگر درطول فرایند ادغام سؤالی داشتید، با [e-mail] تماس بگیرید.

مراحل بعدی

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

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