আপনার ব্যবহারকারীরা যেখানেই থাকুক না কেন, তাদের কাছে পৌঁছে অ্যাপের সম্পৃক্ততা বাড়ান। কালেকশন , এন্টারটেইনমেন্ট স্পেস এবং প্লে স্টোরের মতো ডিভাইসের বিভিন্ন প্ল্যাটফর্মে ব্যবহারকারীদের কাছে সরাসরি ব্যক্তিগতকৃত সুপারিশ এবং ধারাবাহিক কন্টেন্ট পৌঁছে দিতে Engage SDK ইন্টিগ্রেট করুন। এই ইন্টিগ্রেশনটি গড় APK-তে ৫০ কেবি-রও কম (কম্প্রেসড) সাইজ যোগ করে এবং বেশিরভাগ অ্যাপের জন্য ডেভেলপারদের প্রায় এক সপ্তাহ সময় লাগে। আমাদের বিজনেস সাইটে আরও জানুন।
এই নির্দেশিকায় ডেভেলপার পার্টনারদের জন্য Engage কন্টেন্ট সারফেসে ভ্রমণ ও ইভেন্ট সংক্রান্ত কন্টেন্ট সরবরাহ করার নির্দেশনা রয়েছে।
একীকরণের বিবরণ
পরিভাষা
এই ইন্টিগ্রেশনে নিম্নলিখিত ক্লাস্টার প্রকারগুলি অন্তর্ভুক্ত রয়েছে: সুপারিশ , বৈশিষ্ট্যযুক্ত , সংরক্ষণ এবং অনুসন্ধান চালিয়ে যান ।
সুপারিশ ক্লাস্টারগুলো একজন নির্দিষ্ট ডেভেলপার পার্টনারের কাছ থেকে ব্যক্তিগতকৃত ভ্রমণ ও ইভেন্টের পরামর্শ দেখায়। এই সুপারিশগুলো ব্যবহারকারীর জন্য ব্যক্তিগতকৃত বা সাধারণীকৃত (যেমন, ট্রেন্ডিং আইটেম) হতে পারে। আর্টিকেল, ইভেন্ট, বাসস্থান বা দর্শনীয় স্থানের সুপারিশ খুঁজে পেতে এগুলো ব্যবহার করুন।
- একটি সুপারিশ ক্লাস্টার
ArticleEntity,EventEntity,LodgingEntity,PointOfInterestEntity, বাStoreEntityতালিকা দিয়ে তৈরি হতে পারে, কিন্তু বিভিন্ন এনটিটি টাইপের মিশ্রণ দিয়ে নয়।
আপনার সুপারিশগুলোর কাঠামোটি নিম্নরূপ:
সুপারিশ ক্লাস্টার: একটি UI ভিউ যেখানে একই ডেভেলপার পার্টনারের দেওয়া একাধিক সুপারিশ থাকে।
সত্তা: একটি ক্লাস্টারের মধ্যে থাকা একটি একক আইটেমকে প্রতিনিধিত্বকারী একটি অবজেক্ট। এই ইন্টিগ্রেশনটি এমন কিছু সত্তা প্রদান করে যা রিকমেন্ডেশন ক্লাস্টার ব্যবহার করে প্রদর্শিত হবে:
ArticleEntity : ArticleEntity হলো ভ্রমণ ও অনুষ্ঠান সম্পর্কিত পাঠ্য-ভিত্তিক বিষয়বস্তুর জন্য একটি সুপারিশ। এটি প্রবন্ধ, ব্লগপোস্ট, বিপণন বিষয়বস্তু, সংবাদের সংক্ষিপ্ত অংশ ইত্যাদির জন্য ব্যবহার করা যেতে পারে।

চিত্র ১: রিকমেন্ডেশনস ক্লাস্টারের মধ্যে একটিমাত্র আর্টিকেলএন্টিটি দেখানো ইউআই। ইভেন্টএন্টিটি : ইভেন্টএন্টিটি ভবিষ্যতে ঘটতে যাওয়া একটি ঘটনাকে বোঝায়। ঘটনা শুরুর সময় একটি অত্যন্ত গুরুত্বপূর্ণ তথ্য যা ব্যবহারকারীদের জানানো প্রয়োজন।

চিত্র ২: রিকমেন্ডেশনস ক্লাস্টারের মধ্যে একটিমাত্র ইভেন্টএন্টিটি দেখানো ইউআই। আবাসন সত্তা : আবাসন সত্তা বলতে স্বল্প ও দীর্ঘমেয়াদী ভাড়ার জন্য হোটেল, অ্যাপার্টমেন্ট, বা অবকাশকালীন বাড়ির মতো কোনো বাসস্থানকে বোঝায়।

চিত্র ৩: ইউআই (UI) যেখানে রিকমেন্ডেশনস (Recommendations) ক্লাস্টারের মধ্যে একটিমাত্র লজিংএন্টিটি (LodgingEntity) দেখানো হচ্ছে। স্টোরএন্টিটি : স্টোরএন্টিটি একটি দোকান, রেস্তোরাঁ, ক্যাফে ইত্যাদির প্রতিনিধিত্ব করে। এটি এমন বিষয়বস্তুকে তুলে ধরে যেখানে কোনো খাবারের স্থান বা দোকান সম্পর্কিত গুরুত্বপূর্ণ তথ্য ব্যবহারকারীদের কাছে পৌঁছে দেওয়া প্রয়োজন।

চিত্র ৪: রিকমেন্ডেশন ক্লাস্টারের মধ্যে একটিমাত্র স্টোরএন্টিটি দেখানো ইউআই। PointOfInterestEntity : PointOfInterestEntity একটি আকর্ষণীয় স্থানকে বোঝায়, যেমন—গ্যাস স্টেশন, অনুষ্ঠানস্থল, থিম পার্ক, জাদুঘর, পর্যটন কেন্দ্র, হাইকিং ট্রেইল ইত্যাদি। এটি এমন বিষয়বস্তুকে হাইলাইট করে যেখানে অবস্থান একটি অত্যন্ত গুরুত্বপূর্ণ তথ্য যা ব্যবহারকারীদের কাছে পৌঁছে দেওয়া প্রয়োজন। এটি বাসস্থান, দোকান বা খাবারের জায়গার জন্য ব্যবহার করা উচিত নয়।

চিত্র ৫: রিকমেন্ডেশন ক্লাস্টারের মধ্যে একটিমাত্র পয়েন্ট অফ ইন্টারেস্ট এনটিটি (PointOfInterestEntity) প্রদর্শনকারী ইউআই (UI)।
- একটি সুপারিশ ক্লাস্টার
রিজার্ভেশন ক্লাস্টার একাধিক ডেভেলপার পার্টনারের ব্যবহারকারীদের দ্বারা সম্প্রতি ব্যবহৃত কন্টেন্ট একটি একক UI গ্রুপে প্রদর্শন করে। প্রতিটি ডেভেলপার পার্টনারকে রিজার্ভেশন ক্লাস্টারে সর্বোচ্চ ১০টি এনটিটি ব্রডকাস্ট করার অনুমতি দেওয়া হবে।
আপনার রিজার্ভেশনের বিষয়বস্তু নিম্নলিখিত কাঠামোতে হতে পারে:
RestaurantReservationEntity : RestaurantReservationEntity একটি রেস্তোরাঁ বা ক্যাফের রিজার্ভেশনকে প্রতিনিধিত্ব করে এবং ব্যবহারকারীদের আসন্ন বা চলমান রেস্তোরাঁর রিজার্ভেশন ট্র্যাক করতে সাহায্য করে।

চিত্র ৬। একটি রিজার্ভেশন ক্লাস্টারের মধ্যে একটিমাত্র RestaurantReservationEntity প্রদর্শনকারী UI। EventReservationEntity : EventReservationEntity একটি ইভেন্টের রিজার্ভেশনকে প্রতিনিধিত্ব করে এবং ব্যবহারকারীদের আসন্ন বা চলমান ইভেন্টের রিজার্ভেশন ট্র্যাক করতে সাহায্য করে। ইভেন্টগুলোর মধ্যে নিম্নলিখিতগুলো অন্তর্ভুক্ত থাকতে পারে, তবে এগুলোতেই সীমাবদ্ধ নয়:
- ফুটবল ম্যাচের রিজার্ভেশনের মতো ক্রীড়া ইভেন্ট
- ই-স্পোর্টসের জন্য রিজার্ভেশনের মতো গেমিং ইভেন্ট
- সিনেমা হলে সিনেমার টিকিট সংরক্ষণ, কনসার্ট, থিয়েটার, বই স্বাক্ষর অনুষ্ঠানের মতো বিনোদনমূলক অনুষ্ঠান।
- ভ্রমণ বা দর্শনীয় স্থানের রিজার্ভেশন, যেমন গাইডেড ট্যুর, জাদুঘরের টিকিট
- সামাজিক অনুষ্ঠান / সেমিনার / সম্মেলনের রিজার্ভেশন
- শিক্ষা / প্রশিক্ষণ সেশনের জন্য রিজার্ভেশন

চিত্র ৭. একটি রিজার্ভেশন ক্লাস্টারের মধ্যে একটিমাত্র EventReservationEntity প্রদর্শনকারী UI। LodgingReservationEntity : LodgingEntityReservation ভ্রমণকালীন আবাসনের জন্য করা একটি রিজার্ভেশনকে বোঝায় এবং ব্যবহারকারীদের আসন্ন বা চলমান হোটেল অথবা অবকাশকালীন ভাড়ার রিজার্ভেশন ট্র্যাক করতে সাহায্য করে।

চিত্র ৮. একটি রিজার্ভেশন ক্লাস্টারের মধ্যে একটিমাত্র LodgingReservationEntity প্রদর্শনকারী UI। TransportationReservationEntity : TransportationReservationEntity যেকোনো ধরনের পরিবহনের জন্য করা রিজার্ভেশনকে বোঝায় এবং ব্যবহারকারীদের আসন্ন বা চলমান ফ্লাইট, ফেরি, ট্রেন, বাস, রাইড-হেইলিং বা ক্রুজের রিজার্ভেশন ট্র্যাক করতে সাহায্য করে।

চিত্র ৯। একটি রিজার্ভেশন ক্লাস্টারের মধ্যে একটিমাত্র TransportationReservationEntity প্রদর্শনকারী UI। VehicleRentalReservationEntity : VehicleRentalReservationEntity যানবাহন ভাড়ার রিজার্ভেশনকে প্রতিনিধিত্ব করে এবং ব্যবহারকারীদের আসন্ন বা চলমান রিজার্ভেশন ট্র্যাক করতে সাহায্য করে।

চিত্র ১০। একটি রিজার্ভেশন ক্লাস্টারের মধ্যে একটিমাত্র VehicleRentalReservationEntity প্রদর্শনকারী UI।
ফিচার্ড ক্লাস্টার একাধিক ডেভেলপার পার্টনারের নির্বাচিত কিছু এনটিটি একটি UI গ্রুপে প্রদর্শন করে। একটিমাত্র ফিচার্ড ক্লাস্টার থাকবে, যা UI-এর উপরের দিকে প্রদর্শিত হবে এবং সমস্ত রিকমেন্ডেশন ক্লাস্টারের উপরে অগ্রাধিকার পাবে। প্রতিটি ডেভেলপার পার্টনার ফিচার্ড ক্লাস্টারে সর্বোচ্চ ১০টি এনটিটি ব্রডকাস্ট করতে পারবে।
GenericFeaturedEntity : GenericFeaturedEntity, Recommendation আইটেম থেকে এই কারণে ভিন্ন যে, Featured আইটেমটি ডেভেলপারদের তৈরি একটি সেরা কন্টেন্টের জন্য ব্যবহৃত হওয়া উচিত এবং এটি এমন একটি সবচেয়ে গুরুত্বপূর্ণ কন্টেন্টকে উপস্থাপন করবে যা ব্যবহারকারীদের কাছে আকর্ষণীয় এবং প্রাসঙ্গিক হবে।

চিত্র ১১: একটি FeaturedCluster এবং GenericFeaturedEntity-এর তালিকা সম্বলিত UI।
‘ কন্টিনিউ সার্চ’ ক্লাস্টারটি ব্যবহারকারীদের তাদের সমস্ত ট্র্যাভেল অ্যাপ জুড়ে সম্প্রতি অনুসন্ধান করা সার্চ কোয়েরিগুলির একটি তালিকা প্রদর্শন করে তাদের পূর্ববর্তী ভ্রমণ অনুসন্ধান যাত্রা পুনরায় শুরু করতে সহায়তা করে। এই ক্লাস্টারটি রিজার্ভেশনের পরে এবং ফিচার্ড ও রিকমেন্ডেশন ক্লাস্টারের আগে, দ্বিতীয় অবস্থানে পিন করা থাকবে। প্রতিটি ডেভেলপার পার্টনারকে ‘কন্টিনিউ সার্চ’ ক্লাস্টারে সর্বোচ্চ ৩টি এনটিটি ব্রডকাস্ট করার অনুমতি দেওয়া হবে।
- PointOfInterestEntity: PointOfInterestEntity একটি আকর্ষণীয় স্থানকে বোঝায়, যেমন—গ্যাস স্টেশন, অনুষ্ঠানস্থল, থিম পার্ক, জাদুঘর, পর্যটন কেন্দ্র, হাইকিং ট্রেইল ইত্যাদি। এটি ব্যবহারকারীর পূর্বে অনুসন্ধান করা বিষয়বস্তুকে হাইলাইট করে।
প্রাক-কাজ
সর্বনিম্ন এপিআই স্তর: ১৯
আপনার অ্যাপে com.google.android.engage:engage-core লাইব্রেরিটি যোগ করুন:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.5.12'
}
সারসংক্ষেপ
ডিজাইনটি একটি বাউন্ড সার্ভিসের বাস্তবায়নের উপর ভিত্তি করে তৈরি।
বিভিন্ন ক্লাস্টার প্রকারের জন্য একজন ক্লায়েন্ট যে ডেটা প্রকাশ করতে পারে তা নিম্নলিখিত সীমাবদ্ধতার অধীন:
| ক্লাস্টার টাইপ | ক্লাস্টার সীমা | একটি ক্লাস্টারে সর্বনিম্ন সত্তার সীমা | একটি ক্লাস্টারে সত্তার সর্বোচ্চ সীমা |
|---|---|---|---|
| সুপারিশ ক্লাস্টার(গুলি) | সর্বাধিক ৭ | অন্তত ১ | সর্বাধিক ৫০টি ( ArticleEntity , EventEntity , LodgingEntity , StoreEntity , অথবা PointOfInterestEntity ) |
| রিজার্ভেশন ক্লাস্টার | সর্বাধিক ১ | অন্তত ১ | সর্বাধিক ২০টি ( RestaurantReservationEntity , EventReservationEntity , LodgingReservationEntity , TransportationReservationEntity , অথবা VehicleRentalReservationEntity রিজার্ভেশন এনটিটি) |
| বৈশিষ্ট্যযুক্ত ক্লাস্টার | সর্বাধিক ১ | অন্তত ১ | সর্বাধিক ২০ ( GenericFeaturedEntity ) |
| অনুসন্ধান ক্লাস্টার চালিয়ে যান | সর্বাধিক ১ | অন্তত ১ | সর্বাধিক ৩টি ( PointOfInterestEntity ) |
ধাপ ১: সত্তার তথ্য প্রদান করুন
এসডিকে প্রতিটি আইটেমের ধরনকে উপস্থাপন করার জন্য বিভিন্ন এনটিটি সংজ্ঞায়িত করেছে। আমরা ভ্রমণ ও ইভেন্ট বিভাগের জন্য নিম্নলিখিত এনটিটিগুলো সমর্থন করি:
-
GenericFeaturedEntity -
ArticleEntity -
EventEntity -
LodgingEntity -
StoreEntity -
PointOfInterestEntity -
RestaurantReservationEntity -
EventReservationEntity -
LodgingReservationEntity -
TransportationReservationEntity -
VehicleRentalReservationEntity
নিচের চার্টগুলোতে প্রতিটি প্রকারের জন্য উপলব্ধ বৈশিষ্ট্য এবং প্রয়োজনীয়তাগুলো তুলে ধরা হয়েছে।
GenericFeaturedEntity
| বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| অ্যাকশন উরি | প্রয়োজনীয় | প্রোভাইডার অ্যাপে থাকা এনটিটির ডিপ লিঙ্ক। দ্রষ্টব্য: অ্যাট্রিবিউশনের জন্য আপনি ডিপ লিঙ্ক ব্যবহার করতে পারেন। এই প্রায়শই জিজ্ঞাসিত প্রশ্নাবলী (FAQ) দেখুন। | উরি |
| পোস্টারের ছবি | প্রয়োজনীয় | একাধিক ছবি দেওয়া হলে আমরা কেবল ১টি ছবিই দেখাব। প্রস্তাবিত অ্যাসপেক্ট রেশিও হলো ১৬:৯। দ্রষ্টব্য: যদি কোনো ব্যাজ প্রদান করা হয়, তবে ছবির উপরে এবং নীচে উভয় দিকে ২৪ ডিপিএস-এর নিরাপদ স্থান নিশ্চিত করুন। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| শিরোনাম | ঐচ্ছিক | সত্তার শিরোনাম। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ৫০ অক্ষর |
| বর্ণনা | ঐচ্ছিক | সত্তাটির বর্ণনা দেওয়ার জন্য একটিমাত্র অনুচ্ছেদ। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ১৮০ অক্ষর |
| সাবটাইটেল তালিকা | ঐচ্ছিক | সর্বোচ্চ ৩টি সাবটাইটেল, এবং প্রতিটি সাবটাইটেল এক লাইনের লেখা হবে। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রতিটি উপশিরোনামের জন্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ৫০ অক্ষর |
| ব্যাজ | ঐচ্ছিক | প্রতিটি ব্যাজ হয় মুক্ত লেখা (সর্বোচ্চ ১৫ অক্ষর) অথবা একটি ছোট ছবি। ছবি/ভিডিওর উপরে বিশেষ ইউএক্স ট্রিটমেন্ট, যেমন—ছবির উপরে ব্যাজ ওভারলে হিসেবে।
| |
| ব্যাজ - টেক্সট | ঐচ্ছিক | ব্যাজের জন্য শিরোনাম দ্রষ্টব্য: ব্যাজের জন্য লেখা অথবা ছবি যেকোনো একটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ১৫ অক্ষর |
| ব্যাজ - ছবি | ঐচ্ছিক | ছোট ছবি বিশেষ ইউএক্স ট্রিটমেন্ট, যেমন ছবি/ভিডিও থাম্বনেইলের উপর ব্যাজ ওভারলে হিসেবে। দ্রষ্টব্য: ব্যাজের জন্য লেখা অথবা ছবি যেকোনো একটি আবশ্যক। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| বিষয়বস্তুর বিভাগ | ঐচ্ছিক | সত্তাটির বিষয়বস্তুর শ্রেণি বর্ণনা করুন। | এনামের তালিকা নির্দেশনার জন্য বিষয়বস্তুর শ্রেণীবিভাগ দেখুন। |
| DisplayTimeWindow (ঐচ্ছিক) - সারফেসে কোনো কন্টেন্ট প্রদর্শনের জন্য একটি সময়সীমা নির্ধারণ করুন। | |||
| শুরুর সময় | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হবে। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
| শেষ টাইমস্ট্যাম্প | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি আর পৃষ্ঠে প্রদর্শিত হয় না। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
ArticleEntity
| বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| অ্যাকশন উরি | প্রয়োজনীয় | প্রোভাইডার অ্যাপে থাকা এনটিটির ডিপ লিঙ্ক। দ্রষ্টব্য: অ্যাট্রিবিউশনের জন্য আপনি ডিপ লিঙ্ক ব্যবহার করতে পারেন। এই প্রায়শই জিজ্ঞাসিত প্রশ্নাবলী (FAQ) দেখুন। | উরি |
| শিরোনাম | প্রয়োজনীয় | সত্তার শিরোনাম। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ৫০ অক্ষর |
| পোস্টারের ছবি | ঐচ্ছিক | একাধিক ছবি দেওয়া হলে আমরা কেবল ১টি ছবিই দেখাব। প্রস্তাবিত অ্যাসপেক্ট রেশিও হলো ১৬:৯। দ্রষ্টব্য: ছবি ব্যবহার করা বিশেষভাবে বাঞ্ছনীয়। যদি ব্যাজ দেওয়া হয়, তবে ছবির উপরে এবং নীচে ২৪ ডিপিএস-এর নিরাপদ দূরত্ব নিশ্চিত করুন। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| উৎস - শিরোনাম | ঐচ্ছিক | লেখক, সংস্থা বা প্রতিবেদকের নাম | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ২৫ অক্ষরের কম |
| উৎস - ছবি | ঐচ্ছিক | লেখক, সংস্থা, প্রতিবেদকের মতো উৎসের একটি ছবি। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| বর্ণনা | ঐচ্ছিক | সত্তাটির বর্ণনা দেওয়ার জন্য একটিমাত্র অনুচ্ছেদ। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ১৮০ অক্ষর |
| সাবটাইটেল তালিকা | ঐচ্ছিক | সর্বোচ্চ ৩টি সাবটাইটেল, এবং প্রতিটি সাবটাইটেল এক লাইনের লেখা হবে। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রতিটি উপশিরোনামের জন্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ৫০ অক্ষর |
| ব্যাজ | ঐচ্ছিক | প্রতিটি ব্যাজ হয় মুক্ত লেখা (সর্বোচ্চ ১৫ অক্ষর) অথবা একটি ছোট ছবি। ছবি/ভিডিওর উপরে বিশেষ ইউএক্স ট্রিটমেন্ট, যেমন—ছবির উপরে ব্যাজ ওভারলে হিসেবে।
| |
| ব্যাজ - টেক্সট | ঐচ্ছিক | ব্যাজের জন্য শিরোনাম দ্রষ্টব্য: ব্যাজের জন্য লেখা অথবা ছবি যেকোনো একটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ১৫ অক্ষর |
| ব্যাজ - ছবি | ঐচ্ছিক | ছোট ছবি বিশেষ ইউএক্স ট্রিটমেন্ট, যেমন ছবি/ভিডিও থাম্বনেইলের উপর ব্যাজ ওভারলে হিসেবে। দ্রষ্টব্য: ব্যাজের জন্য লেখা অথবা ছবি যেকোনো একটি আবশ্যক। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| বিষয়বস্তু প্রকাশের সময় | ঐচ্ছিক | অ্যাপে কন্টেন্টটি কখন প্রকাশিত বা আপডেট করা হয়েছিল, এটি সেই ইপক টাইমস্ট্যাম্প যা মিলিসেকেন্ডে পরিমাপ করা হয়। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
| শেষ বাগদানের সময় | ঐচ্ছিক | ব্যবহারকারী শেষবার এই সত্তাটির সাথে যখন ইন্টারঅ্যাক্ট করেছিলেন, সেই ইপক টাইমস্ট্যাম্প (মিলিসেকেন্ডে)। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
| অগ্রগতির শতাংশ | ঐচ্ছিক | ব্যবহারকারী কর্তৃক এ পর্যন্ত সম্পূর্ণ কন্টেন্টের যে শতাংশ গ্রহণ করা হয়েছে। | ০ থেকে ১০০ পর্যন্ত একটি পূর্ণসংখ্যা। |
| বিষয়বস্তুর বিভাগ | ঐচ্ছিক | সত্তাটির বিষয়বস্তুর শ্রেণি বর্ণনা করুন। | এনামের তালিকা নির্দেশনার জন্য বিষয়বস্তুর শ্রেণীবিভাগ দেখুন। |
| DisplayTimeWindow (ঐচ্ছিক) - সারফেসে কোনো কন্টেন্ট প্রদর্শনের জন্য একটি সময়সীমা নির্ধারণ করুন। | |||
| শুরুর সময় | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হবে। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
| শেষ টাইমস্ট্যাম্প | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি আর পৃষ্ঠে প্রদর্শিত হয় না। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
EventEntity
| বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| অ্যাকশন উরি | প্রয়োজনীয় | প্রোভাইডার অ্যাপে থাকা এনটিটির ডিপ লিঙ্ক। দ্রষ্টব্য: অ্যাট্রিবিউশনের জন্য আপনি ডিপ লিঙ্ক ব্যবহার করতে পারেন। এই প্রায়শই জিজ্ঞাসিত প্রশ্নাবলী (FAQ) দেখুন। | উরি |
| শিরোনাম | প্রয়োজনীয় | সত্তার শিরোনাম। | স্ট্রিং প্রস্তাবিত লেখার আকার: সর্বোচ্চ ৫০ অক্ষর |
| স্থানীয় শুরুর সময় - টাইমস্ট্যাম্প | প্রয়োজনীয় | যে ইপক টাইমস্ট্যাম্পে ইভেন্টটি শুরু হওয়ার কথা। | জোডা-টাইম ইনস্ট্যান্ট |
| স্থানীয় শুরুর সময় - সময় অঞ্চল | প্রয়োজনীয় | যে সময় অঞ্চলে অনুষ্ঠানটি শুরু হবে বলে আশা করা হচ্ছে। | জোডা-টাইম ডেটটাইমজোন নির্দেশনার জন্য টাইমজোন স্পেসিফিকেশন দেখুন। |
| ইভেন্ট মোড | প্রয়োজনীয় | অনুষ্ঠানটি ভার্চুয়াল, সশরীরে নাকি উভয়ই হবে, তা নির্দেশ করার জন্য একটি ক্ষেত্র। | Enum: ভার্চুয়াল, সশরীরে, অথবা হাইব্রিড |
| পোস্টারের ছবি | প্রয়োজনীয় | একাধিক ছবি দেওয়া হলে আমরা কেবল ১টি ছবিই দেখাব। প্রস্তাবিত অ্যাসপেক্ট রেশিও হলো ১৬:৯। দ্রষ্টব্য: ছবি ব্যবহার করা বিশেষভাবে বাঞ্ছনীয়। যদি ব্যাজ দেওয়া হয়, তবে ছবির উপরে এবং নীচে ২৪ ডিপিএস-এর নিরাপদ দূরত্ব নিশ্চিত করুন। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| অবস্থান - দেশ | শর্তসাপেক্ষে আবশ্যক | যে দেশে অনুষ্ঠানটি অনুষ্ঠিত হচ্ছে। দ্রষ্টব্য: যেসব অনুষ্ঠান সরাসরি উপস্থিতিতে (IN_PERSON) অথবা হাইব্রিড (HYBRID) পদ্ধতিতে অনুষ্ঠিত হয়, সেগুলোর জন্য এটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - শহর | শর্তসাপেক্ষে আবশ্যক | যে শহরে অনুষ্ঠানটি অনুষ্ঠিত হচ্ছে। দ্রষ্টব্য: যেসব অনুষ্ঠান সরাসরি উপস্থিতিতে (IN_PERSON) অথবা হাইব্রিড (HYBRID) পদ্ধতিতে অনুষ্ঠিত হয়, সেগুলোর জন্য এটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - ঠিকানা প্রদর্শন করুন | শর্তসাপেক্ষে আবশ্যক | অনুষ্ঠানটি যে ঠিকানায় বা স্থানে অনুষ্ঠিত হবে, তা ব্যবহারকারীকে দেখানো উচিত। দ্রষ্টব্য: যেসব অনুষ্ঠান সরাসরি উপস্থিতিতে (IN_PERSON) অথবা হাইব্রিড (HYBRID) পদ্ধতিতে অনুষ্ঠিত হয়, সেগুলোর জন্য এটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - রাস্তার ঠিকানা | ঐচ্ছিক | যে স্থানে অনুষ্ঠানটি আয়োজন করা হচ্ছে, সেই স্থানের রাস্তার ঠিকানা (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - রাজ্য | ঐচ্ছিক | যে রাজ্য বা প্রদেশে (প্রযোজ্য ক্ষেত্রে) অনুষ্ঠানটি আয়োজিত হচ্ছে। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - জিপ কোড | ঐচ্ছিক | যে স্থানে অনুষ্ঠানটি আয়োজন করা হচ্ছে, সেই স্থানের জিপ কোড (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - এলাকা | ঐচ্ছিক | যে এলাকায় (প্রযোজ্য ক্ষেত্রে) অনুষ্ঠানটি আয়োজন করা হচ্ছে। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| শেষ সময় | ঐচ্ছিক | যে ইপক টাইমস্ট্যাম্পে ইভেন্টটি শেষ হওয়ার কথা। দ্রষ্টব্য: এটি মিলিসেকেন্ডে প্রকাশ করা হবে। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
| বর্ণনা | ঐচ্ছিক | সত্তাটির বর্ণনা দেওয়ার জন্য একটিমাত্র অনুচ্ছেদ। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ১৮০ অক্ষর |
| সাবটাইটেল তালিকা | ঐচ্ছিক | সর্বোচ্চ ৩টি সাবটাইটেল, এবং প্রতিটি সাবটাইটেল এক লাইনের লেখা হবে। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রতিটি উপশিরোনামের জন্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ৫০ অক্ষর |
| ব্যাজ | ঐচ্ছিক | প্রতিটি ব্যাজ হয় মুক্ত লেখা (সর্বোচ্চ ১৫ অক্ষর) অথবা একটি ছোট ছবি। | |
| ব্যাজ - টেক্সট | ঐচ্ছিক | ব্যাজের জন্য শিরোনাম দ্রষ্টব্য: ব্যাজের জন্য লেখা অথবা ছবি যেকোনো একটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ১৫ অক্ষর |
| ব্যাজ - ছবি | ঐচ্ছিক | ছোট ছবি বিশেষ ইউএক্স ট্রিটমেন্ট, যেমন ছবি/ভিডিও থাম্বনেইলের উপর ব্যাজ ওভারলে হিসেবে। দ্রষ্টব্য: ব্যাজের জন্য লেখা অথবা ছবি যেকোনো একটি আবশ্যক। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| মূল্য - বর্তমান মূল্য | শর্তসাপেক্ষে আবশ্যক | অনুষ্ঠানটির টিকিট/পাসের বর্তমান মূল্য। যদি কেটে দেওয়া মূল্য প্রদান করা হয়, তবে এটি অবশ্যই প্রদান করতে হবে। | মুক্ত পাঠ্য |
| মূল্য - কাটা-চিহ্নিত মূল্য | ঐচ্ছিক | অনুষ্ঠানটির টিকিট/পাসের মূল মূল্য। | মুক্ত পাঠ্য |
| মূল্য ঘোষণা | ঐচ্ছিক | কোনো প্রোমো, ইভেন্ট বা সদস্য ছাড় (যদি থাকে) তুলে ধরতে মূল্য উল্লেখ করা হবে। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ৪৫ অক্ষরের কম (অতিরিক্ত দীর্ঘ লেখার শেষে ডট ডট চিহ্ন দেখা যেতে পারে) |
| বিষয়বস্তুর বিভাগ | ঐচ্ছিক | সত্তাটির বিষয়বস্তুর শ্রেণি বর্ণনা করুন। | যোগ্য এনামের তালিকা
নির্দেশনার জন্য বিষয়বস্তুর শ্রেণীবিভাগ দেখুন। |
| DisplayTimeWindow (ঐচ্ছিক) - সারফেসে কোনো কন্টেন্ট প্রদর্শনের জন্য একটি সময়সীমা নির্ধারণ করুন। | |||
| শুরুর সময় | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হবে। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
| শেষ টাইমস্ট্যাম্প | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি আর পৃষ্ঠে প্রদর্শিত হয় না। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
LodgingEntity
| বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| অ্যাকশন উরি | প্রয়োজনীয় | প্রোভাইডার অ্যাপে থাকা এনটিটির ডিপ লিঙ্ক। দ্রষ্টব্য: অ্যাট্রিবিউশনের জন্য আপনি ডিপ লিঙ্ক ব্যবহার করতে পারেন। এই প্রায়শই জিজ্ঞাসিত প্রশ্নাবলী (FAQ) দেখুন। | উরি |
| শিরোনাম | প্রয়োজনীয় | সত্তার শিরোনাম। | স্ট্রিং প্রস্তাবিত লেখার আকার: সর্বোচ্চ ৫০ অক্ষর |
| পোস্টারের ছবি | প্রয়োজনীয় | একাধিক ছবি দেওয়া হলে আমরা কেবল ১টি ছবিই দেখাব। প্রস্তাবিত অ্যাসপেক্ট রেশিও হলো ১৬:৯। দ্রষ্টব্য: যদি কোনো ব্যাজ প্রদান করা হয়, তবে ছবির উপরে এবং নীচে উভয় দিকে ২৪ ডিপিএস-এর নিরাপদ স্থান নিশ্চিত করুন। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| অবস্থান - দেশ | প্রয়োজনীয় | যে দেশে থাকার ব্যবস্থাটি করা হচ্ছে। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - শহর | প্রয়োজনীয় | যে শহরে থাকার ব্যবস্থা করা হচ্ছে। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - ঠিকানা প্রদর্শন করুন | প্রয়োজনীয় | যে ঠিকানাটি ব্যবহারকারীকে দেখানো হবে। বেশিরভাগ ক্ষেত্রে আমরা শহরের নাম এবং সম্ভব হলে রাজ্য বা দেশের নাম অন্তর্ভুক্ত করার পরামর্শ দিই। শুধুমাত্র তখনই রাস্তার ঠিকানা বা এলাকার নাম অন্তর্ভুক্ত করুন, যখন ব্যবহারকারী সেই স্থানের কাছাকাছি থাকেন, স্থানটির সাথে পরিচিত হন, অথবা ক্লাস্টার শিরোনামে শহরটির নাম অন্তর্ভুক্ত থাকে। যদি আপনি রাস্তার ঠিকানা অন্তর্ভুক্ত করেন, তবে একটি সংক্ষিপ্ত ঠিকানা দিন এবং যেখানে সম্ভব সংক্ষিপ্ত রূপ ব্যবহার করুন (উদাহরণস্বরূপ, "রাস্তা"-র জন্য "St", "অ্যাভিনিউ"-এর জন্য "Ave")। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - রাস্তার ঠিকানা | ঐচ্ছিক | বাসস্থানের রাস্তার ঠিকানা (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - রাজ্য | ঐচ্ছিক | যে রাজ্য বা প্রদেশে (প্রযোজ্য ক্ষেত্রে) বাসস্থানটি অবস্থিত। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - জিপ কোড | ঐচ্ছিক | বাসস্থানের জিপ কোড (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - এলাকা | ঐচ্ছিক | আবাসস্থলের এলাকা (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| ব্যাজ | ঐচ্ছিক | প্রতিটি ব্যাজ হয় মুক্ত লেখা (সর্বোচ্চ ১৫ অক্ষর) অথবা একটি ছোট ছবি। | |
| ব্যাজ - টেক্সট | ঐচ্ছিক | ব্যাজের জন্য শিরোনাম দ্রষ্টব্য: ব্যাজের জন্য লেখা অথবা ছবি যেকোনো একটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ১৫ অক্ষর |
| ব্যাজ - ছবি | ঐচ্ছিক | ছোট ছবি বিশেষ ইউএক্স ট্রিটমেন্ট, যেমন ছবি/ভিডিও থাম্বনেইলের উপর ব্যাজ ওভারলে হিসেবে। দ্রষ্টব্য: ব্যাজের জন্য লেখা অথবা ছবি যেকোনো একটি আবশ্যক। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| বর্ণনা | ঐচ্ছিক | সত্তাটির বর্ণনা দেওয়ার জন্য একটিমাত্র অনুচ্ছেদ। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ১৮০ অক্ষর |
| সাবটাইটেল তালিকা | ঐচ্ছিক | সর্বোচ্চ ৩টি সাবটাইটেল, এবং প্রতিটি সাবটাইটেল এক লাইনের লেখা হবে। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রতিটি উপশিরোনামের জন্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ৫০ অক্ষর |
| AvailabilityTimeWindow - স্থানীয় শুরুর সময় - টাইমস্ট্যাম্প | ঐচ্ছিক | যে সময়ে বাসস্থানটি খোলা বা উপলব্ধ থাকবে বলে আশা করা হচ্ছে, সেই ইপক টাইমস্ট্যাম্প। | জোডা-টাইম ইনস্ট্যান্ট |
| AvailabilityTimeWindow - স্থানীয় শুরুর সময় - সময় অঞ্চল | ঐচ্ছিক | যে টাইমজোনে বাসস্থানটি খোলা/উপলব্ধ থাকার সম্ভাবনা রয়েছে। | জোডা-টাইম ডেটটাইমজোন নির্দেশনার জন্য টাইমজোন স্পেসিফিকেশন দেখুন। |
| AvailabilityTimeWindow - স্থানীয় শেষ সময় - টাইমস্ট্যাম্প | ঐচ্ছিক | যে ইপক টাইমস্ট্যাম্প পর্যন্ত বাসস্থানটি খোলা/উপলব্ধ থাকবে বলে আশা করা হচ্ছে। | জোডা-টাইম ইনস্ট্যান্ট |
| AvailabilityTimeWindow - স্থানীয় শেষ সময় - সময় অঞ্চল | ঐচ্ছিক | যে টাইমজোনে বাসস্থানটি খোলা/উপলব্ধ থাকার সম্ভাবনা রয়েছে। | জোডা-টাইম ডেটটাইমজোন নির্দেশনার জন্য টাইমজোন স্পেসিফিকেশন দেখুন। |
| রেটিং - সর্বোচ্চ মান | ঐচ্ছিক | রেটিং স্কেলের সর্বোচ্চ মান। রেটিং-এর বর্তমান মান প্রদান করা হলে এটিও অবশ্যই প্রদান করতে হবে। | সংখ্যা >= ০.০ |
| রেটিং - বর্তমান মান | ঐচ্ছিক | রেটিং স্কেলের বর্তমান মান। রেটিং-এর সর্বোচ্চ মান প্রদান করা হলে এটিও অবশ্যই প্রদান করতে হবে। | সংখ্যা >= ০.০ |
| রেটিং - গণনা | ঐচ্ছিক | আবাসনটির রেটিং সংখ্যা। দ্রষ্টব্য: আপনার অ্যাপ যদি ব্যবহারকারীদের কাছে এটি কীভাবে প্রদর্শিত হবে তা নিয়ন্ত্রণ করতে চায়, তবে এই ফিল্ডটি প্রদান করুন। ব্যবহারকারীকে দেখানোর জন্য সংক্ষিপ্ত স্ট্রিংটি প্রদান করুন। উদাহরণস্বরূপ, যদি সংখ্যাটি 1,000,000 হয়, তাহলে 1M-এর মতো সংক্ষিপ্ত রূপ ব্যবহার করার কথা বিবেচনা করুন, যাতে এটি ছোট ডিসপ্লে আকারে কেটে না যায়। | স্ট্রিং |
| রেটিং - গণনার মান | ঐচ্ছিক | আবাসনটির রেটিং সংখ্যা। দ্রষ্টব্য: আপনি যদি প্রদর্শনের সংক্ষিপ্ত রূপের লজিক নিজে পরিচালনা করতে না চান, তবে এই ফিল্ডটি প্রদান করুন। যদি Count এবং Count Value উভয়ই উপস্থিত থাকে, তবে আমরা ব্যবহারকারীদের দেখানোর জন্য Count ব্যবহার করব। | দীর্ঘ |
| মূল্য - বর্তমান মূল্য | শর্তসাপেক্ষে আবশ্যক | আবাসনটির বর্তমান মূল্য। যদি কেটে দেওয়া মূল্য প্রদান করা হয়, তবে এটি অবশ্যই প্রদান করতে হবে। | মুক্ত পাঠ্য |
| মূল্য - কাটা-চিহ্নিত মূল্য | ঐচ্ছিক | আবাসনের আসল মূল্য, যা UI-তে কেটে দেওয়া থাকবে। | মুক্ত পাঠ্য |
| মূল্য ঘোষণা | ঐচ্ছিক | কোনো প্রোমো, ইভেন্ট বা সদস্য ছাড় (যদি থাকে) তুলে ধরতে মূল্য উল্লেখ করা হবে। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ৪৫ অক্ষরের কম (অতিরিক্ত দীর্ঘ লেখার শেষে ডট ডট চিহ্ন দেখা যেতে পারে) |
| DisplayTimeWindow (ঐচ্ছিক) - সারফেসে কোনো কন্টেন্ট প্রদর্শনের জন্য একটি সময়সীমা নির্ধারণ করুন। | |||
| শুরুর সময় | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হবে। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
| শেষ টাইমস্ট্যাম্প | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি আর পৃষ্ঠে প্রদর্শিত হয় না। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
StoreEntity
StoreEntity অবজেক্টটি একটি স্বতন্ত্র স্টোরকে প্রতিনিধিত্ব করে, যা ডেভেলপার পার্টনাররা প্রকাশ করতে চান; যেমন কোনো জনপ্রিয় খাবারের জায়গা বা রেস্তোরাঁ যা ভ্রমণ অভিজ্ঞতার সাথে প্রাসঙ্গিক।
| বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| পোস্টারের ছবি | প্রয়োজনীয় | কমপক্ষে একটি ছবি অবশ্যই প্রদান করতে হবে। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| অ্যাকশন উরি | প্রয়োজনীয় | প্রোভাইডার অ্যাপে থাকা এনটিটির ডিপ লিঙ্ক। দ্রষ্টব্য: অ্যাট্রিবিউশনের জন্য আপনি ডিপ লিঙ্ক ব্যবহার করতে পারেন। এই প্রায়শই জিজ্ঞাসিত প্রশ্নাবলী (FAQ) দেখুন। | উরি |
| শিরোনাম | ঐচ্ছিক | দোকানের নাম। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ৪৫ অক্ষরের কম (অতিরিক্ত দীর্ঘ লেখার শেষে ডট ডট চিহ্ন দেখা যেতে পারে) |
| অবস্থান | ঐচ্ছিক | দোকানটির অবস্থান। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ৪৫ অক্ষরের কম (অতিরিক্ত দীর্ঘ লেখার শেষে ডট ডট চিহ্ন দেখা যেতে পারে) |
| কলআউট | ঐচ্ছিক | স্টোরের কোনো প্রোমো, ইভেন্ট বা আপডেট থাকলে, তা তুলে ধরতে কলআউট করুন। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ৪৫ অক্ষরের কম (অতিরিক্ত দীর্ঘ লেখার শেষে ডট ডট চিহ্ন দেখা যেতে পারে) |
| কলআউট সূক্ষ্ম মুদ্রণ | ঐচ্ছিক | কলআউটের জন্য সূক্ষ্ম হরফের লেখা। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ৪৫ অক্ষরের কম (অতিরিক্ত দীর্ঘ লেখার শেষে ডট ডট চিহ্ন দেখা যেতে পারে) |
| বর্ণনা | ঐচ্ছিক | দোকানটির একটি বিবরণ। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ৯০ অক্ষরের কম (অতিরিক্ত দীর্ঘ লেখার শেষে ডট ডট চিহ্ন দেখা যেতে পারে) |
| বিভাগ | ঐচ্ছিক | খাবারের জায়গার প্রেক্ষাপটে, একটি দোকানের খাবারের ধরন হতে পারে "ফরাসি", "নিউ আমেরিকান", "রামেন", "ফাইন ডাইনিং"-এর মতো রন্ধনশৈলী। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ৪৫ অক্ষরের কম (অতিরিক্ত দীর্ঘ লেখার শেষে ডট ডট চিহ্ন দেখা যেতে পারে) |
| রেটিং - সর্বোচ্চ মান | ঐচ্ছিক | রেটিং স্কেলের সর্বোচ্চ মান। রেটিং-এর বর্তমান মান প্রদান করা হলে এটিও অবশ্যই প্রদান করতে হবে। | সংখ্যা >= ০.০ |
| রেটিং - বর্তমান মান | ঐচ্ছিক | রেটিং স্কেলের বর্তমান মান। রেটিং-এর সর্বোচ্চ মান প্রদান করা হলে এটিও অবশ্যই প্রদান করতে হবে। | সংখ্যা >= ০.০ |
| রেটিং - গণনা | ঐচ্ছিক | আবাসনটির রেটিং সংখ্যা। দ্রষ্টব্য: আপনার অ্যাপ যদি ব্যবহারকারীদের কাছে এটি কীভাবে প্রদর্শিত হবে তা নিয়ন্ত্রণ করতে চায়, তবে এই ফিল্ডটি প্রদান করুন। ব্যবহারকারীকে দেখানোর জন্য সংক্ষিপ্ত স্ট্রিংটি প্রদান করুন। উদাহরণস্বরূপ, যদি সংখ্যাটি 1,000,000 হয়, তাহলে 1M-এর মতো সংক্ষিপ্ত রূপ ব্যবহার করার কথা বিবেচনা করুন, যাতে এটি ছোট ডিসপ্লে আকারে কেটে না যায়। | স্ট্রিং |
| রেটিং - গণনার মান | ঐচ্ছিক | আবাসনটির রেটিং সংখ্যা। দ্রষ্টব্য: আপনি যদি প্রদর্শনের সংক্ষিপ্ত রূপের লজিক নিজে পরিচালনা করতে না চান, তবে এই ফিল্ডটি প্রদান করুন। যদি Count এবং Count Value উভয়ই উপস্থিত থাকে, তবে আমরা ব্যবহারকারীদের দেখানোর জন্য Count ব্যবহার করব। | দীর্ঘ |
| DisplayTimeWindow (ঐচ্ছিক) - সারফেসে কোনো কন্টেন্ট প্রদর্শনের জন্য একটি সময়সীমা নির্ধারণ করুন। | |||
| শুরুর সময় | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হবে। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
| শেষ টাইমস্ট্যাম্প | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি আর পৃষ্ঠে প্রদর্শিত হয় না। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
PointOfInterestEntity
| বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| অ্যাকশন উরি | প্রয়োজনীয় | প্রোভাইডার অ্যাপে থাকা এনটিটির ডিপ লিঙ্ক। দ্রষ্টব্য: অ্যাট্রিবিউশনের জন্য আপনি ডিপ লিঙ্ক ব্যবহার করতে পারেন। এই প্রায়শই জিজ্ঞাসিত প্রশ্নাবলী (FAQ) দেখুন। | উরি |
| শিরোনাম | প্রয়োজনীয় | সত্তার শিরোনাম। | স্ট্রিং প্রস্তাবিত লেখার আকার: সর্বোচ্চ ৫০ অক্ষর |
| পোস্টারের ছবি | শর্তসাপেক্ষে আবশ্যক | একাধিক ছবি দেওয়া হলে আমরা কেবল ১টি ছবিই দেখাব। প্রস্তাবিত অ্যাসপেক্ট রেশিও হলো ১৬:৯। দ্রষ্টব্য: সত্তাটি সুপারিশ ক্লাস্টারের অংশ হলে ছবি আবশ্যক। যদি ব্যাজ প্রদান করা হয়, তবে ছবির উপরে এবং নীচে ২৪ ডিপিএস-এর নিরাপদ স্থান নিশ্চিত করুন। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| শেষ বাগদানের সময় | শর্তসাপেক্ষে আবশ্যক | ব্যবহারকারী সর্বশেষ যখন এই সত্তাটির সাথে ইন্টারঅ্যাক্ট করেছিলেন, সেই ইপক টাইমস্ট্যাম্প। দ্রষ্টব্য: সত্তাটি যদি 'কন্টিনিউ সার্চ' ক্লাস্টারের অংশ হয়, তবে এই ফিল্ডটি আবশ্যক। | জোডা-টাইম ইনস্ট্যান্ট |
| অবস্থান - দেশ | শর্তসাপেক্ষে আবশ্যক | যে দেশে আলোচ্য ঘটনাটি ঘটছে। দ্রষ্টব্য: সত্তাটি যদি সুপারিশ ক্লাস্টারের অংশ হয়, তবে এই ক্ষেত্রটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - শহর | শর্তসাপেক্ষে আবশ্যক | যে শহরে আকর্ষণীয় ঘটনাটি ঘটছে। দ্রষ্টব্য: সত্তাটি যদি সুপারিশ ক্লাস্টারের অংশ হয়, তবে এই ক্ষেত্রটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - ঠিকানা প্রদর্শন করুন | শর্তসাপেক্ষে আবশ্যক | যে ঠিকানাটি ব্যবহারকারীকে দেখানো হবে। একটি সংক্ষিপ্ত ঠিকানা দিন এবং যেখানে সম্ভব সংক্ষিপ্ত রূপ ব্যবহার করুন (উদাহরণস্বরূপ, "রাস্তা"-র জন্য "St", "অ্যাভিনিউ"-এর জন্য "Ave")। ব্যবহারকারীর ডিভাইস এবং সেটিংসের উপর নির্ভর করে এই স্ট্রিংটি সংক্ষিপ্ত হতে পারে। স্পষ্ট শনাক্তকরণের জন্য শহরের নাম অন্তর্ভুক্ত করুন। দ্রষ্টব্য: সত্তাটি যদি সুপারিশ ক্লাস্টারের অংশ হয়, তবে এই ক্ষেত্রটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ৩৫ অক্ষর |
| অবস্থান - রাস্তার ঠিকানা | ঐচ্ছিক | দর্শনীয় স্থানটির রাস্তার ঠিকানা (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - রাজ্য | ঐচ্ছিক | যে রাজ্য বা প্রদেশে (প্রযোজ্য ক্ষেত্রে) আগ্রহের স্থানটি অবস্থিত। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - জিপ কোড | ঐচ্ছিক | আগ্রহের স্থানটির জিপ কোড (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - এলাকা | ঐচ্ছিক | আগ্রহের স্থানটির পার্শ্ববর্তী এলাকা (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| AvailabilityTimeWindow - স্থানীয় শুরুর সময় - টাইমস্ট্যাম্প | ঐচ্ছিক | যে ইপক টাইমস্ট্যাম্প অনুযায়ী কাঙ্ক্ষিত পয়েন্ট অফ ইন্টারেস্টটি খোলা বা উপলব্ধ থাকার কথা। | জোডা-টাইম ইনস্ট্যান্ট |
| AvailabilityTimeWindow - স্থানীয় শুরুর সময় - সময় অঞ্চল | ঐচ্ছিক | যে টাইমজোনে আগ্রহের স্থানটি খোলা বা উপলব্ধ থাকবে বলে আশা করা হচ্ছে। | জোডা-টাইম ডেটটাইমজোন নির্দেশনার জন্য টাইমজোন স্পেসিফিকেশন দেখুন। |
| AvailabilityTimeWindow - স্থানীয় শেষ সময় - টাইমস্ট্যাম্প | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যে পর্যন্ত আগ্রহের বিষয়টি খোলা/উপলব্ধ থাকবে বলে আশা করা যায়। | জোডা-টাইম ইনস্ট্যান্ট |
| AvailabilityTimeWindow - স্থানীয় শেষ সময় - সময় অঞ্চল | ঐচ্ছিক | যে টাইমজোনে আগ্রহের স্থানটি খোলা বা উপলব্ধ থাকবে বলে আশা করা হচ্ছে। | জোডা-টাইম ডেটটাইমজোন নির্দেশনার জন্য টাইমজোন স্পেসিফিকেশন দেখুন। |
| ব্যাজ | ঐচ্ছিক | প্রতিটি ব্যাজ হয় মুক্ত লেখা (সর্বোচ্চ ১৫ অক্ষর) অথবা একটি ছোট ছবি। | |
| ব্যাজ - টেক্সট | ঐচ্ছিক | ব্যাজের জন্য শিরোনাম দ্রষ্টব্য: ব্যাজের জন্য লেখা অথবা ছবি যেকোনো একটি আবশ্যক। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ১৫ অক্ষর |
| ব্যাজ - ছবি | ঐচ্ছিক | ছোট ছবি বিশেষ ইউএক্স ট্রিটমেন্ট, যেমন ছবি/ভিডিও থাম্বনেইলের উপর ব্যাজ ওভারলে হিসেবে। দ্রষ্টব্য: ব্যাজের জন্য লেখা অথবা ছবি যেকোনো একটি আবশ্যক। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| বর্ণনা | ঐচ্ছিক | সত্তাটির বর্ণনা দেওয়ার জন্য একটিমাত্র অনুচ্ছেদ। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ১৮০ অক্ষর |
| সাবটাইটেল তালিকা | ঐচ্ছিক | সর্বোচ্চ ৩টি সাবটাইটেল, এবং প্রতিটি সাবটাইটেল এক লাইনের লেখা হবে। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রতিটি উপশিরোনামের জন্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ ৫০ অক্ষর |
| রেটিং - সর্বোচ্চ মান | ঐচ্ছিক | রেটিং স্কেলের সর্বোচ্চ মান। রেটিং-এর বর্তমান মান প্রদান করা হলে এটিও অবশ্যই প্রদান করতে হবে। | সংখ্যা >= ০.০ |
| রেটিং - বর্তমান মান | ঐচ্ছিক | রেটিং স্কেলের বর্তমান মান। রেটিং-এর সর্বোচ্চ মান প্রদান করা হলে এটিও অবশ্যই প্রদান করতে হবে। | সংখ্যা >= ০.০ |
| রেটিং - গণনা | ঐচ্ছিক | আগ্রহের স্থানটির রেটিং সংখ্যা। দ্রষ্টব্য: আপনার অ্যাপ যদি ব্যবহারকারীদের কাছে এটি কীভাবে প্রদর্শিত হবে তা নিয়ন্ত্রণ করতে চায়, তবে এই ফিল্ডটি প্রদান করুন। ব্যবহারকারীকে দেখানোর জন্য সংক্ষিপ্ত স্ট্রিংটি প্রদান করুন। উদাহরণস্বরূপ, যদি সংখ্যাটি 1,000,000 হয়, তাহলে 1M-এর মতো সংক্ষিপ্ত রূপ ব্যবহার করার কথা বিবেচনা করুন, যাতে এটি ছোট ডিসপ্লে আকারে কেটে না যায়। | স্ট্রিং |
| রেটিং - গণনার মান | ঐচ্ছিক | আগ্রহের স্থানটির রেটিং সংখ্যা। দ্রষ্টব্য: আপনি যদি প্রদর্শনের সংক্ষিপ্ত রূপের লজিক নিজে পরিচালনা করতে না চান, তবে এই ফিল্ডটি প্রদান করুন। যদি Count এবং Count Value উভয়ই উপস্থিত থাকে, তবে আমরা ব্যবহারকারীদের দেখানোর জন্য Count ব্যবহার করব। | দীর্ঘ |
| মূল্য - বর্তমান মূল্য | শর্তসাপেক্ষে আবশ্যক | দর্শনীয় স্থানটির টিকিট/প্রবেশ পাসের বর্তমান মূল্য। যদি কেটে দেওয়া মূল্য প্রদান করা হয়, তবে এটি অবশ্যই প্রদান করতে হবে। | মুক্ত পাঠ্য |
| মূল্য - কাটা-চিহ্নিত মূল্য | ঐচ্ছিক | দর্শনীয় স্থানটির টিকিট/প্রবেশ পাসের মূল মূল্য। | মুক্ত পাঠ্য |
| মূল্য ঘোষণা | ঐচ্ছিক | কোনো প্রোমো, ইভেন্ট বা সদস্য ছাড় (যদি থাকে) তুলে ধরতে মূল্য উল্লেখ করা হবে। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ৪৫ অক্ষরের কম (অতিরিক্ত দীর্ঘ লেখার শেষে ডট ডট চিহ্ন দেখা যেতে পারে) |
| বিষয়বস্তুর বিভাগ | ঐচ্ছিক | সত্তাটির বিষয়বস্তুর শ্রেণি বর্ণনা করুন। | যোগ্য এনামের তালিকা
নির্দেশনার জন্য বিষয়বস্তুর শ্রেণীবিভাগ দেখুন। |
| DisplayTimeWindow (ঐচ্ছিক) - সারফেসে কোনো কন্টেন্ট প্রদর্শনের জন্য একটি সময়সীমা নির্ধারণ করুন। | |||
| শুরুর সময় | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হবে। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
| শেষ টাইমস্ট্যাম্প | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প, যার পরে বিষয়বস্তুটি আর পৃষ্ঠে প্রদর্শিত হয় না। সেট করা না থাকলে, বিষয়বস্তুটি পৃষ্ঠে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে ইপক টাইমস্ট্যাম্প |
RestaurantReservationEntity
| বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| অ্যাকশন উরি | প্রয়োজনীয় | প্রোভাইডার অ্যাপে থাকা এনটিটির ডিপ লিঙ্ক। দ্রষ্টব্য: অ্যাট্রিবিউশনের জন্য আপনি ডিপ লিঙ্ক ব্যবহার করতে পারেন। এই প্রায়শই জিজ্ঞাসিত প্রশ্নাবলী (FAQ) দেখুন। | উরি |
| শিরোনাম | প্রয়োজনীয় | সত্তার শিরোনাম। | স্ট্রিং প্রস্তাবিত লেখার আকার: সর্বোচ্চ ৫০ অক্ষর |
| স্থানীয় রিজার্ভেশন শুরুর সময় - টাইমস্ট্যাম্প | প্রয়োজনীয় | যে ইপক টাইমস্ট্যাম্পে রিজার্ভেশনটি শুরু হওয়ার কথা। | জোডা-টাইম ইনস্ট্যান্ট |
| স্থানীয় রিজার্ভেশন শুরুর সময় - সময় অঞ্চল | প্রয়োজনীয় | যে টাইমজোনে রিজার্ভেশনটি শুরু হবে বলে আশা করা হচ্ছে। | জোডা-টাইম ডেটটাইমজোন নির্দেশনার জন্য টাইমজোন স্পেসিফিকেশন দেখুন। |
| অবস্থান - দেশ | প্রয়োজনীয় | যে দেশে রেস্তোরাঁটি অবস্থিত। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - শহর | প্রয়োজনীয় | যে শহরে রেস্তোরাঁটি অবস্থিত। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - ঠিকানা প্রদর্শন করুন | প্রয়োজনীয় | প্রি-রেস্টুরেন্টটির ঠিকানা যা ব্যবহারকারীকে দেখানো হবে। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - রাস্তার ঠিকানা | ঐচ্ছিক | রেস্তোরাঁটির রাস্তার ঠিকানা (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - রাজ্য | ঐচ্ছিক | যে রাজ্য বা প্রদেশে (প্রযোজ্য ক্ষেত্রে) রেস্তোরাঁটি অবস্থিত। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - জিপ কোড | ঐচ্ছিক | রেস্তোরাঁর জিপ কোড (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| অবস্থান - এলাকা | ঐচ্ছিক | রেস্তোরাঁটির এলাকা (যদি প্রযোজ্য হয়)। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: সর্বোচ্চ প্রায় ২০ অক্ষর |
| পোস্টারের ছবি | ঐচ্ছিক | একাধিক ছবি দেওয়া হলে আমরা কেবল ১টি ছবিই দেখাব। প্রস্তাবিত অ্যাসপেক্ট রেশিও হলো ১৬:৯। | নির্দেশনার জন্য ছবির বিবরণ দেখুন। |
| বর্ণনা | ঐচ্ছিক | সত্তাটির বর্ণনা দেওয়ার জন্য একটিমাত্র অনুচ্ছেদ। দ্রষ্টব্য: ব্যবহারকারীকে হয় বিবরণ অথবা উপশিরোনাম তালিকা দেখানো হবে, উভয়ই নয়। | মুক্ত পাঠ্য প্রস্তাবিত লেখার আকার: ১৮০ অক্ষর |
| সাবটাইটেল তালিকা | ঐচ্ছিক | Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both. | Free text Recommended text size for each subtitle: max 50 chars |
| Table Size | ঐচ্ছিক | The number of people in the reservation group | Integer > 0 |
| DisplayTimeWindow (Optional) - Set a time window for a content to be shown on the surface | |||
| Start Timestamp | ঐচ্ছিক | The epoch timestamp after which the content should be shown on the surface. If not set, content is eligible to be shown on the surface. | Epoch timestamp in milliseconds |
| End Timestamp | ঐচ্ছিক | The epoch timestamp after which the content is no longer shown on the surface. If not set, content is eligible to be shown on the surface. | Epoch timestamp in milliseconds |
EventReservationEntity
| বৈশিষ্ট্য | Requirement | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| Action Uri | প্রয়োজনীয় | Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ | Uri |
| শিরোনাম | প্রয়োজনীয় | Title of the entity. | String Recommended text size: Max 50 chars |
| Localized Start time - Timestamp | প্রয়োজনীয় | The epoch timestamp when the event is expected to start. | Joda-Time Instant |
| Localized Start time - Timezone | প্রয়োজনীয় | The timezone in which the event is expected to start. | Joda-Time DateTimeZone See Timezone Specifications for guidance. |
| Event mode | প্রয়োজনীয় | A field to indicate whether the event will be virtual, in-person or both. | Enum: VIRTUAL, IN_PERSON, or HYBRID |
| Location - Country | Conditionally required | The country in which the event is happening. Note: This is required for events which are IN_PERSON or HYBRID | Free text Recommended text size: max ~20 chars |
| Location - City | Conditionally required | The city in which the event is happening. Note: This is required for events which are IN_PERSON or HYBRID | Free text Recommended text size: max ~20 chars |
| Location - Display Address | Conditionally required | The address or venue name where the event will take place that should be displayed to the user. Note: This is required for events which are IN_PERSON or HYBRID | Free text Recommended text size: max ~20 chars |
| Location - Street Address | ঐচ্ছিক | The street address (if applicable) of the location at which event is being hosted. | Free text Recommended text size: max ~20 chars |
| Location - State | ঐচ্ছিক | The state or province (if applicable) in which the event is being hosted. | Free text Recommended text size: max ~20 chars |
| Location - Zip code | ঐচ্ছিক | The zip code (if applicable) of the location in which the event is being hosted. | Free text Recommended text size: max ~20 chars |
| Location - Neighborhood | ঐচ্ছিক | The neighborhood (if applicable) in which the event is being hosted. | Free text Recommended text size: max ~20 chars |
| Poster images | ঐচ্ছিক | We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: Image is highly recommended. If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image | See Image Specifications for guidance. |
| Localized End time - Timestamp | ঐচ্ছিক | The epoch timestamp when the event is expected to end. | Joda-Time Instant |
| Localized End time - Timezone | ঐচ্ছিক | The timezone in which the event is expected to end. | Joda-Time DateTimeZone See Timezone Specifications for guidance. |
| Service Provider - Name | ঐচ্ছিক | The name of the service provider. Note: Either text or image is required for the service provider. | Free text. For example, name of the event organizer/tour |
| Service Provider - Image | ঐচ্ছিক | The logo/image of the service provider. Note: Either text or image is required for the service provider. | See Image Specifications for guidance. |
| বর্ণনা | ঐচ্ছিক | A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both. | Free text Recommended text size: 180 chars |
| Subtitle list | ঐচ্ছিক | Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both. | Free text Recommended text size for each subtitle: max 50 chars |
| ব্যাজ | ঐচ্ছিক | Each badge is either free text (max 15 chars) or small image. | |
| Badge - Text | ঐচ্ছিক | Title for the badge Note: Either text or image is required for the badge | Free text Recommended text size: max 15 chars |
| Badge - Image | ঐচ্ছিক | Small image Special UX treatment, for example as badge overlay on the image/video thumbnail. Note: Either text or image is required for the badge | See Image Specifications for guidance. |
| Reservation ID | ঐচ্ছিক | The reservation ID for the event reservation. | Free text |
| Price - CurrentPrice | Conditionally required | The current price of the ticket/pass for the event. Must be provided if strikethrough price is provided. | Free text |
| Price - StrikethroughPrice | ঐচ্ছিক | The original price of the ticket/pass for the event. | Free text |
| Price Callout | ঐচ্ছিক | Price callout to feature a promo, event, member discount, if available. | Free text Recommended text size: under 45 chars (Text that is too long may show ellipses) |
| Rating - Max value | ঐচ্ছিক | The maximum value of the rating scale. Must be provided if current value of rating is also provided. | Number >= 0.0 |
| Rating - Current value | ঐচ্ছিক | The current value of the rating scale. Must be provided if maximum value of rating is also provided. | Number >= 0.0 |
| Rating - Count | ঐচ্ছিক | The count of the ratings for the event. Note: Provide this field if your app wants to control how this is displayed to the users. Provide the concise string that can be displayed to the user. For example, if the count is 1,000,000, consider using abbreviations like 1M, so that it won't be truncated on smaller display sizes. | String |
| Rating - Count Value | ঐচ্ছিক | The count of the ratings for the event. Note: Provide this field if you don't want to handle the display abbreviation logic yourself. If both Count and Count Value are present, we will use the Count to display to users | Long |
| Content Categories | ঐচ্ছিক | Describe the category of the content in the entity. | List of Eligible Enums
See the Content Category section for guidance. |
| DisplayTimeWindow (Optional) - Set a time window for a content to be shown on the surface | |||
| Start Timestamp | ঐচ্ছিক | The epoch timestamp after which the content should be shown on the surface. If not set, content is eligible to be shown on the surface. | Epoch timestamp in milliseconds |
| End Timestamp | ঐচ্ছিক | The epoch timestamp after which the content is no longer shown on the surface. If not set, content is eligible to be shown on the surface. | Epoch timestamp in milliseconds |
LodgingReservationEntity
| বৈশিষ্ট্য | Requirement | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| Action Uri | প্রয়োজনীয় | Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ | Uri |
| শিরোনাম | প্রয়োজনীয় | Title of the entity. | Free text. For example, "Your Stay from Dec 12th" Recommended text size: Max 50 chars |
| Localized Check-in Time - Timestamp | প্রয়োজনীয় | The epoch timestamp that represents the check in time for the reservation. | Joda-Time Instant |
| Localized Check-in Time - Timezone | প্রয়োজনীয় | The timezone in which the check in time exists for the reservation. | Joda-Time DateTimeZone See Timezone Specifications for guidance. |
| Localized Check-out Time - Timestamp | প্রয়োজনীয় | The epoch timestamp that represents the check out time for the reservation. | Joda-Time Instant |
| Localized Check-out Time - Timezone | প্রয়োজনীয় | The timezone in which the check out time exists for the reservation. | Joda-Time DateTimeZone See Timezone Specifications for guidance. |
| Location - Country | প্রয়োজনীয় | The country in which the lodging is located. | Free text Recommended text size: max ~20 chars |
| Location - City | প্রয়োজনীয় | The city in which the lodging is located. | Free text Recommended text size: max ~20 chars |
| Location - Display Address | প্রয়োজনীয় | The address that will be displayed to the user. Provide a succinct address, using abbreviations where possible (for example, "St" for "Street", "Ave" for "Avenue"). This string may be truncated depending on the user's device and settings. Include the city name for clear identification. | Free text Recommended text size: max ~35 chars |
| Location - Street Address | Optional | The street address (if applicable) of the lodging. | Free text Recommended text size: max ~20 chars |
| Location - State | Optional | The state or province (if applicable) in which the lodging is located. | Free text Recommended text size: max ~20 chars |
| Location - Zip code | Optional | The zip code (if applicable) of the lodging. | Free text Recommended text size: max ~20 chars |
| Location - Neighborhood | Optional | The neighborhood (if applicable) of the lodging. | Free text Recommended text size: max ~20 chars |
| Poster images | Optional | We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image | See Image Specifications for guidance. |
| বর্ণনা | Optional | A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both. | Free text Recommended text size: 180 chars |
| Subtitle list | Optional | Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both. | Free text Recommended text size for each subtitle: max 50 chars |
| Reservation ID | Optional | The reservation ID for the lodging reservation. | Free text |
| Rating - Max value | Optional | The maximum value of the rating scale. Must be provided if current value of rating is also provided. | Number >= 0.0 |
| Rating - Current value | Optional | The current value of the rating scale. Must be provided if maximum value of rating is also provided. | Number >= 0.0 |
| Rating - Count | Optional | The count of the ratings for the lodging. Note: Provide this field if your app wants to control how this is displayed to the users. Provide the concise string that can be displayed to the user. For example, if the count is 1,000,000, consider using abbreviations like 1M, so that it won't be truncated on smaller display sizes. | String |
| Rating - Count Value | Optional | The count of the ratings for the lodging. Note: Provide this field if you don't want to handle the display abbreviation logic yourself. If both Count and Count Value are present, we will use the Count to display to users | Long |
| Price - CurrentPrice | Conditionally required | The current price of the lodging. Must be provided if strikethrough price is provided. | Free text |
| Price - StrikethroughPrice | Optional | The original price of the lodging, which is be struck-through in the UI. | Free text |
| Price Callout | Optional | Price callout to feature a promo, event, member discount, if available. | Free text Recommended text size: under 45 chars (Text that is too long may show ellipses) |
| DisplayTimeWindow (Optional) - Set a time window for a content to be shown on the surface | |||
| Start Timestamp | Optional | The epoch timestamp after which the content should be shown on the surface. If not set, content is eligible to be shown on the surface. | Epoch timestamp in milliseconds |
| End Timestamp | Optional | The epoch timestamp after which the content is no longer shown on the surface. If not set, content is eligible to be shown on the surface. | Epoch timestamp in milliseconds |
TransportationReservationEntity
| বৈশিষ্ট্য | Requirement | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| Action Uri | প্রয়োজনীয় | Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ | Uri |
| শিরোনাম | প্রয়োজনীয় | Title of the entity. | Free text. For example, "SFO to SAN" Recommended text size: Max 50 chars |
| Transportation Type | প্রয়োজনীয় | The mode/type of transportation for the reservation. | Enum: FLIGHT, TRAIN, BUS, or FERRY |
| Localized Departure Time - Timestamp | প্রয়োজনীয় | The epoch timestamp that represents the departure time. | Joda-Time Instant |
| Localized Departure Time - Timezone | প্রয়োজনীয় | The timezone of the departure time. | Joda-Time DateTimeZone See Timezone Specifications for guidance. |
| Localized Arrival Time - Timestamp | প্রয়োজনীয় | The epoch timestamp that represents the arrival time. | Joda-Time Instant |
| Localized Arrival Time - Timezone | প্রয়োজনীয় | The timezone of the arrival time. | Joda-Time DateTimeZone See Timezone Specifications for guidance. |
| Transportation Number | প্রয়োজনীয় | The flight number, bus number, train number, or ferry/cruise number. | Free text |
| Localized Boarding Time - Timestamp | প্রয়োজনীয় | The epoch timestamp that represents the boarding time for the reservation (if applicable) | Joda-Time Instant |
| Localized Boarding Time - Timezone | প্রয়োজনীয় | The timezone of the boarding time for the reservation (if applicable) | Joda-Time DateTimeZone See Timezone Specifications for guidance. |
| Departure Location - Country | Optional | The country of departure. | Free text Recommended text size: max ~20 chars |
| Departure Location - City | Optional | The city of departure. | Free text Recommended text size: max ~20 chars |
| Departure Location - Display Address | Optional | The location of departure that will be displayed to the user. | Free text Recommended text size: max ~20 chars |
| Departure Location - Street Address | Optional | The street address (if applicable) of the departure location. | Free text Recommended text size: max ~20 chars |
| Departure Location - State | Optional | The state or province (if applicable) of the departure location. | Free text Recommended text size: max ~20 chars |
| Departure Location - Zip code | Optional | The zip code (if applicable) of the departure location. | Free text Recommended text size: max ~20 chars |
| Departure Location - Neighborhood | Optional | The neighborhood (if applicable) of the departure location. | Free text Recommended text size: max ~20 chars |
| Arrival Location - Country | Optional | The country of arrival. | Free text Recommended text size: max ~20 chars |
| Arrival Location - City | Optional | The city of arrival. | Free text Recommended text size: max ~20 chars |
| Arrival Location - Display Address | Optional | The location of arrival that will be displayed to the user. | Free text Recommended text size: max ~20 chars |
| Arrival Location - Street Address | Optional | The street address (if applicable) of the arrival location. | Free text Recommended text size: max ~20 chars |
| Arrival Location - State | Optional | The state or province (if applicable) of the arrival location. | Free text Recommended text size: max ~20 chars |
| Arrival Location - Zip code | Optional | The zip code (if applicable) of the arrival location. | Free text Recommended text size: max ~20 chars |
| Arrival Location - Neighborhood | Optional | The neighborhood (if applicable) of the arrival location. | Free text Recommended text size: max ~20 chars |
| Service Provider - Name | Optional | The name of the service provider. Note: Either text or image is required for the service provider. | Free text. For example, Airline name |
| Service Provider - Image | Optional | The logo/image of the service provider. Note: Either text or image is required for the service provider. | See Image Specifications for guidance. |
| Poster images | Optional | We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 | See Image Specifications for guidance. |
| বর্ণনা | Optional | A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both. | Free text Recommended text size: 180 chars |
| Subtitle list | Optional | Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both. | Free text Recommended text size for each subtitle: max 50 chars |
| Reservation ID | Optional | The reservation ID for the transportation reservation. | Free text |
| Price - CurrentPrice | Conditionally required | The current price of the reservation. Must be provided if strikethrough price is provided. | Free text |
| Price - StrikethroughPrice | Optional | The original price of the reservation, which is be struck-through in the UI. | Free text |
| Price Callout | Optional | Price callout to feature a promo, event, member discount, if available. | Free text Recommended text size: under 45 chars (Text that is too long may show ellipses) |
| DisplayTimeWindow (Optional) - Set a time window for a content to be shown on the surface | |||
| Start Timestamp | Optional | The epoch timestamp after which the content should be shown on the surface. If not set, content is eligible to be shown on the surface. | Epoch timestamp in milliseconds |
| End Timestamp | Optional | The epoch timestamp after which the content is no longer shown on the surface. If not set, content is eligible to be shown on the surface. | Epoch timestamp in milliseconds |
VehicleRentalReservationEntity
| বৈশিষ্ট্য | Requirement | বর্ণনা | ফর্ম্যাট |
|---|---|---|---|
| Action Uri | প্রয়োজনীয় | Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ | Uri |
| শিরোনাম | প্রয়োজনীয় | Title of the entity. | Free text. For example, "Avis Union Square SF" Recommended text size: Max 50 chars |
| Localized Pickup Time - Timestamp | প্রয়োজনীয় | The epoch timestamp that represents the pick up time for the reservation. | Joda-Time Instant |
| Localized Pickup Time - Timezone | প্রয়োজনীয় | The timezone of the pick up time for the reservation. | Joda-Time DateTimeZone See Timezone Specifications for guidance. |
| Localized Return Time - Timestamp | Optional | The epoch timestamp that represents the check out time for the reservation. | Joda-Time Instant |
| Localized Return Time - Timezone | Optional | The timezone of the check out time for the reservation. | Joda-Time DateTimeZone See Timezone Specifications for guidance. |
| Pickup Address - Country | Optional | The country of the pickup location. | Free text Recommended text size: max ~20 chars |
| Pickup Address - City | Optional | The city of the pickup location. | Free text Recommended text size: max ~20 chars |
| Pickup Address - Display Address | Optional | The pickup location that will be displayed to the user. | Free text Recommended text size: max ~20 chars |
| Pickup Address - Street Address | Optional | The street address (if applicable) of the pickup location. | Free text Recommended text size: max ~20 chars |
| Pickup Address - State | Optional | The state or province (if applicable) of the pickup location. | Free text Recommended text size: max ~20 chars |
| Pickup Address - Zip code | Optional | The zip code (if applicable) of the pickup location. | Free text Recommended text size: max ~20 chars |
| Pickup Address - Neighborhood | Optional | The neighborhood (if applicable) of the pickup location. | Free text Recommended text size: max ~20 chars |
| Return Address - Country | Optional | The country of return location. | Free text Recommended text size: max ~20 chars |
| Return Address - City | Optional | The city of return location. | Free text Recommended text size: max ~20 chars |
| Return Address - Display Address | Optional | The return location that will be displayed to the user. | Free text Recommended text size: max ~20 chars |
| Return Address - Street Address | Optional | The street address (if applicable) of the return location. | Free text Recommended text size: max ~20 chars |
| Return Address - State | Optional | The state or province (if applicable) of the return location. | Free text Recommended text size: max ~20 chars |
| Return Address - Zip code | Optional | The zip code (if applicable) of the return location. | Free text Recommended text size: max ~20 chars |
| Return Address - Neighborhood | Optional | The neighborhood (if applicable) of the return location. | Free text Recommended text size: max ~20 chars |
| Service Provider - Name | Optional | The name of the service provider. Note: Either text or image is required for the service provider. | Free text. For example, "Avis Car Rental" |
| Service Provider - Image | Optional | The logo/image of the service provider. Note: Either text or image is required for the service provider. | See Image Specifications for guidance. |
| Poster images | Optional | We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 | See Image Specifications for guidance. |
| বর্ণনা | Optional | A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both. | Free text Recommended text size: 180 chars |
| Subtitle list | Optional | Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both. | Free text Recommended text size for each subtitle: max 50 chars |
| Confirmation ID | Optional | The confirmation ID for the vehicle rental reservation. | Free text |
| Price - CurrentPrice | Conditionally required | The current price of the reservation. Must be provided if strikethrough price is provided. | Free text |
| Price - StrikethroughPrice | Optional | The original price of the reservation, which is be struck-through in the UI. | Free text |
| Price Callout | Optional | Price callout to feature a promo, event, member discount, if available. | Free text Recommended text size: under 45 chars (Text that is too long may show ellipses) |
| DisplayTimeWindow (Optional) - Set a time window for a content to be shown on the surface | |||
| Start Timestamp | Optional | The epoch timestamp after which the content should be shown on the surface. If not set, content is eligible to be shown on the surface. | Epoch timestamp in milliseconds |
| End Timestamp | Optional | The epoch timestamp after which the content is no longer shown on the surface. If not set, content is eligible to be shown on the surface. | Epoch timestamp in milliseconds |
Image specifications
Required specifications for image assets are listed in this table:
| আকৃতির অনুপাত | Minimum pixels | Recommended pixels |
|---|---|---|
Square (1x1) Preferred | 300x300 | 1200x1200 |
| Landscape (1.91x1) | 600x314 | 1200x628 |
| Portrait (4x5) | 480x600 | 960x1200 |
The images are required to be hosted on public CDNs so that Google can access them.
ফাইল ফরম্যাট
PNG, JPG, static GIF, WebP
Maximum file size
5120 KB
Additional recommendations
- Image safe area: Put your important content in the center 80% of the image.
- Use a transparent background so that the image can be properly displayed in Dark and Light theme settings.
Timezone specifications
Prefer ID (for example, "America/Los_Angeles") over offset (for example, "-07:00").
Sample usage: DateTimeZone.forID("America/Los_Angeles")
Content Category
The content category allows apps to publish content belonging to multiple categories. This maps the content with some of the predefined categories namely:
-
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
The images are required to be hosted on public CDNs so that Google can access them.
Guidelines to use the content categories
- Some entities like ArticleEntity and GenericFeaturedEntity are eligible to use any of the content categories. For other entities like EventEntity , EventReservationEntity , PointOfInterestEntity , only a subset of these categories are eligible. Check the list of categories eligible for an entity type before populating the list.
Use the specific entity type for some content categories over a combination of the Generic entities and the ContentCategory:
- TYPE_MOVIES_AND_TV_SHOWS - Check out the entities from Watch integration guide before using the generic entities.
- 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 - Check out entities from Food Integration guide before using the generic entities.
The ContentCategory field is optional and should be left blank if the content doesn't belong to any of the categories mentioned earlier.
In case multiple content categories are provided, provide them in the order of relevance to the content with the most relevant content category placed first in the list.
Step 2: Provide Cluster data
It is recommended to have the content publish job executed in the background (for example, using WorkManager ) and scheduled on a regular basis or on an event basis (for example, every time the user opens the app or when the user just added something to their cart).
AppEngageTravelClient is responsible for publishing clusters.
There are following APIs to publish clusters in the client:
-
isServiceAvailable -
publishRecommendationClusters -
publishFeaturedCluster -
publishReservationCluster -
publishContinueSearchCluster -
publishUserAccountManagementRequest -
updatePublishStatus -
deleteRecommendationsClusters -
deleteFeaturedCluster -
deleteReservationCluster -
deleteContinueSearchCluster -
deleteUserManagementCluster -
deleteClusters
isServiceAvailable
This API is used to check if the service is available for integration and whether the content can be presented on the device.
কোটলিন
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
This API is used to publish a list of RecommendationCluster objects.
কোটলিন
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());
When the service receives the request, the following actions take place within one transaction:
- Existing
RecommendationClusterdata from the developer partner is removed. - Data from the request is parsed and stored in the updated Recommendation Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishFeaturedCluster
This API is used to publish a list of FeaturedCluster objects.
কোটলিন
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());
When the service receives the request, the following actions take place within one transaction:
- Existing
FeaturedClusterdata from the developer partner is removed. - Data from the request is parsed and stored in the updated Featured Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishReservationCluster
This API is used to publish a ReservationCluster object.
কোটলিন
client.publishReservationCluster(
PublishReservationClusterRequest.Builder()
.setReservationCluster(
ReservationCluster.Builder()
.addLodgingReservationEntity(lodgingReservationEntity)
.addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
.addTransportationReservationEntity(transportationReservationEntity)
.addEventReservationEntity(eventReservationEntity)
.addRestaurantReservationEntity(restaurantReservationEntity)
.build())
.build())
জাভা
client.publishReservationCluster(
new PublishReservationClusterRequest.Builder()
.setReservationCluster(
new ReservationCluster.Builder()
.addLodgingReservationEntity(lodgingReservationEntity)
.addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
.addTransportationReservationEntity(transportationReservationEntity)
.addEventReservationEntity(eventReservationEntity)
.addRestaurantReservationEntity(restaurantReservationEntity)
.build())
.build());
When the service receives the request, the following actions take place within one transaction:
- Existing
ReservationClusterdata from the developer partner is removed. - Data from the request is parsed and stored in the updated Reservation Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishContinueSearchCluster
This API is used to publish a list of ContinueSearchCluster objects.
কোটলিন
client.publishContinueSearchCluster(
PublishContinueSearchClusterRequest.Builder()
.setContinueSearchCluster(
ContinueSearchCluster.Builder()
.addPointOfInterestEntity(entity1)
.addPointOfInterestEntity(entity2)
.build())
.build())
জাভা
client.publishContinueSearchCluster(
new PublishContinueSearchClusterRequest.Builder()
.setContinueSearchCluster(
new ContinueSearchCluster.Builder()
.addPointOfInterestEntity(entity1)
.addPointOfInterestEntity(entity2)
.build())
.build());
When the service receives the request, the following actions take place within one transaction:
- Existing
ContinueSearchClusterdata from the developer partner is removed. - Data from the request is parsed and stored in the updated Continue Search Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishUserAccountManagementRequest
This API is used to publish a Sign In card . The signin action directs users to the app's sign in page so that the app can publish content (or provide more personalized content)
The following metadata is part of the Sign In Card -
| বৈশিষ্ট্য | Requirement | বর্ণনা |
|---|---|---|
| Action Uri | প্রয়োজনীয় | Deeplink to Action (ie navigates to app sign in page) |
| ছবি | Optional - If not provided, Title must be provided | Image Shown on the Card 16x9 aspect ratio images with a resolution of 1264x712 |
| শিরোনাম | Optional - If not provided, Image must be provided | Title on the Card |
| Action Text | Optional | Text Shown on the CTA (ie Sign in) |
| Subtitle | Optional | Optional Subtitle on the Card |
কোটলিন
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());
When the service receives the request, the following actions take place within one transaction:
- Existing
UserAccountManagementClusterdata from the developer partner is removed. - Data from the request is parsed and stored in the updated UserAccountManagementCluster Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
updatePublishStatus
If for any internal business reason, none of the clusters is published, we strongly recommend updating the publish status using the updatePublishStatus API. This is important because :
- Providing the status in all scenarios, even when the content is published (STATUS == PUBLISHED), is critical to populate dashboards that use this explicit status to convey the health and other metrics of your integration.
- If no content is published but the integration status isn't broken (STATUS == NOT_PUBLISHED), Google can avoid triggering alerts in the app health dashboards. It confirms that content is not published due to an expected situation from the provider's standpoint.
- It helps developers provide insights into when the data is published versus not.
- Google may use the status codes to nudge the user to do certain actions in the app so they can see the app content or overcome it.
The list of eligible publish status codes are :
// 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
If the content is not published due to a user not logged in, Google would recommend publishing the Sign In Card. If for any reason providers are not able to publish the Sign In Card then we recommend calling the updatePublishStatus API with the status code 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
This API is used to delete the content of Recommendation Clusters.
কোটলিন
client.deleteRecommendationClusters()
জাভা
client.deleteRecommendationClusters();
When the service receives the request, it removes the existing data from the Recommendation Clusters. In case of an error, the entire request is rejected and the existing state is maintained.
deleteFeaturedCluster
This API is used to delete the content of Featured Cluster.
কোটলিন
client.deleteFeaturedCluster()
জাভা
client.deleteFeaturedCluster();
When the service receives the request, it removes the existing data from the Featured Cluster. In case of an error, the entire request is rejected and the existing state is maintained.
deleteReservationCluster
This API is used to delete the content of Reservation Cluster.
কোটলিন
client.deleteReservationCluster()
জাভা
client.deleteReservationCluster();
When the service receives the request, it removes the existing data from the Reservation Cluster. In case of an error, the entire request is rejected and the existing state is maintained.
deleteUserManagementCluster
This API is used to delete the content of UserAccountManagement Cluster.
কোটলিন
client.deleteUserManagementCluster()
জাভা
client.deleteUserManagementCluster();
When the service receives the request, it removes the existing data from the UserAccountManagement Cluster. In case of an error, the entire request is rejected and the existing state is maintained.
deleteContinueSearchCluster
This API is used to delete the content of Continue Search Cluster.
কোটলিন
client.deleteContinueSearchCluster()
জাভা
client.deleteContinueSearchCluster();
When the service receives the request, it removes the existing data from the Continue Search Cluster. In case of an error, the entire request is rejected, and the existing state is maintained.
deleteClusters
This API is used to delete the content of a given cluster type.
কোটলিন
client.deleteClusters(
DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_RESERVATION)
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
.addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
.build())
জাভা
client.deleteClusters(
new DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_RESERVATION)
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
.addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
.build());
When the service receives the request, it removes the existing data from all clusters matching the specified cluster types. Clients can choose to pass one or many cluster types. In case of an error, the entire request is rejected and the existing state is maintained.
ত্রুটি পরিচালনা
It is highly recommended to listen to the task result from the publish APIs such that a follow-up action can be taken to recover and resubmit an successful task.
কোটলিন
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
}
}
}
});
The error is returned as an AppEngageException with the cause included as an error code.
| ত্রুটি কোড | Error name | Note |
|---|---|---|
1 | SERVICE_NOT_FOUND | The service is not available on the given device. |
2 | SERVICE_NOT_AVAILABLE | The service is available on the given device, but it is not available at the time of the call (for example, it is explicitly disabled). |
3 | SERVICE_CALL_EXECUTION_FAILURE | The task execution failed due to threading issues. In this case, it can be retried. |
4 | SERVICE_CALL_PERMISSION_DENIED | The caller is not allowed to make the service call. |
5 | SERVICE_CALL_INVALID_ARGUMENT | The request contains invalid data (for example, more than the allowed number of clusters). |
6 | SERVICE_CALL_INTERNAL | There is an error on the service side. |
7 | SERVICE_CALL_RESOURCE_EXHAUSTED | The service call is made too frequently. |
Step 3: Handle broadcast intents
In addition to making publish content API calls through a job, it is also required to set up a BroadcastReceiver to receive the request for a content publish.
The goal of broadcast intents is mainly for app reactivation and forcing data sync. Broadcast intents are not designed to be sent very frequently. It is only triggered when the Engage Service determines the content might be stale (for example, a week old). That way, there is more confidence that the user can have a fresh content experience, even if the application has not been executed for a long period of time.
The BroadcastReceiver must be set up in the following two ways:
Dynamically register an instance of the
BroadcastReceiverclass usingContext.registerReceiver(). This enables communication from applications that are still live in memory.
কোটলিন
class AppEngageBroadcastReceiver : BroadcastReceiver(){
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger continue search cluster publish when PUBLISH_CONTINUE_SEARCH
// broadcast is received
// Trigger reservation cluster publish when PUBLISH_RESERVATION broadcast is
// received
}
fun registerBroadcastReceivers(context: Context){
var context = context
context = context.applicationContext
// Register Recommendation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
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(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Continue Search Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_CONTINUE_SEARCH),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Reservation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_RESERVATION),
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 continue search cluster publish when PUBLISH_CONTINUE_SEARCH
// broadcast is received
// Trigger reservation cluster publish when PUBLISH_RESERVATION 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 Continue Search Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_CONTINUE_SEARCH),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Reservation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_RESERVATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
}
Statically declare an implementation with the
<receiver>tag in yourAndroidManifest.xmlfile. This allows the application to receive broadcast intents when it is not running, and also allows the application to publish the content.
<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.travel.PUBLISH_CONTINUE_SEARCH" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.travel.PUBLISH_RESERVATION" />
</intent-filter>
</receiver>
</application>
The following intents is sent by the service:
-
com.google.android.engage.action.PUBLISH_RECOMMENDATIONIt is recommended to start apublishRecommendationClusterscall when receiving this intent. -
com.google.android.engage.action.PUBLISH_FEATUREDIt is recommended to start apublishFeaturedClustercall when receiving this intent. -
com.google.android.engage.action.travel.PUBLISH_CONTINUE_SEARCHIt is recommended to start apublishContinueSearchClustercall when receiving this intent. -
com.google.android.engage.action.travel.PUBLISH_RESERVATIONIt is recommended to start apublishReservationClustercall when receiving this intent.
Integration workflow
For a step-by-step guide on verifying your integration after it is complete, see Engage developer integration workflow .
প্রায়শই জিজ্ঞাসিত প্রশ্নাবলী
See Engage SDK Frequently Asked Questions for FAQs.
যোগাযোগ করুন
Contact engage-developers@google.com if there are any questions during the integration process.
পরবর্তী পদক্ষেপ
After completing this integration, your next steps are as follows:
- Send an email to
engage-developers@google.comand attach your integrated APK that is ready for testing by Google. - Google performs a verification and reviews internally to make sure the integration works as expected. If changes are needed, Google contacts you with any necessary details.
- When testing is complete and no changes are needed, Google contacts you to notify you that you can start publishing the updated and integrated APK to the Play Store.
- After Google has confirmed that your updated APK has been published to the Play Store, your Recommendation , Featured , Reservation , and Continue Search clusters may be published and visible to users.