Google একটি অন-ডিভাইস পৃষ্ঠ তৈরি করছে যা ব্যবহারকারীদের অ্যাপগুলিকে উল্লম্বভাবে সংগঠিত করে এবং ব্যক্তিগতকৃত অ্যাপ সামগ্রী ব্যবহার এবং আবিষ্কারের জন্য একটি নতুন নিমজ্জিত অভিজ্ঞতা সক্ষম করে৷ এই ফুলস্ক্রিন অভিজ্ঞতা ডেভেলপার অংশীদারদের তাদের অ্যাপের বাইরে একটি ডেডিকেটেড চ্যানেলে তাদের সেরা সমৃদ্ধ সামগ্রী প্রদর্শন করার সুযোগ দেয়।
এই নির্দেশিকাটিতে বিকাশকারী অংশীদারদের জন্য তাদের কেনাকাটার বিষয়বস্তু সংহত করার জন্য নির্দেশাবলী রয়েছে, এই নতুন পৃষ্ঠের এলাকা এবং বিনোদন স্থানের মতো বিদ্যমান Google সারফেস উভয়ই পূরণ করতে Engage SDK ব্যবহার করে৷
ইন্টিগ্রেশন বিস্তারিত
পরিভাষা
এই ইন্টিগ্রেশনে নিম্নলিখিত পাঁচটি ক্লাস্টার প্রকার রয়েছে: সুপারিশ , বৈশিষ্ট্যযুক্ত , শপিং কার্ট , শপিং তালিকা , পুনরায় সাজানো এবং শপিং অর্ডার ট্র্যাকিং ৷
প্রস্তাবনা ক্লাস্টারগুলি একজন স্বতন্ত্র বিকাশকারী অংশীদার থেকে ব্যক্তিগতকৃত কেনাকাটার পরামর্শগুলি দেখায়৷ এই সুপারিশগুলি ব্যবহারকারীর জন্য ব্যক্তিগতকৃত বা সাধারণীকরণ করা যেতে পারে (উদাহরণস্বরূপ, ট্রেন্ডিং আইটেম)। পণ্য, ইভেন্ট, বিক্রয়, প্রচার, সাবস্ক্রিপশনের জন্য এগুলো ব্যবহার করুন যেমন আপনি উপযুক্ত মনে করেন।
আপনার সুপারিশগুলি নিম্নলিখিত কাঠামো গ্রহণ করে:
সুপারিশ ক্লাস্টার: একটি UI ভিউ যাতে একই বিকাশকারী অংশীদারের কাছ থেকে সুপারিশের একটি গোষ্ঠী রয়েছে৷
ShoppingEntity: একটি বস্তু একটি ক্লাস্টারে একটি একক আইটেমের প্রতিনিধিত্ব করে।
বৈশিষ্ট্যযুক্ত ক্লাস্টারটি একটি UI গ্রুপিংয়ে একাধিক বিকাশকারী অংশীদারদের থেকে সত্তার একটি নির্বাচন প্রদর্শন করে৷ একটি একক বৈশিষ্ট্যযুক্ত ক্লাস্টার থাকবে, যা সমস্ত সুপারিশ ক্লাস্টারের উপরে একটি অগ্রাধিকার প্লেসমেন্ট সহ UI এর শীর্ষের কাছে প্রদর্শিত হবে৷ প্রতিটি বিকাশকারী অংশীদারকে বৈশিষ্ট্যযুক্ত ক্লাস্টারে 10টি পর্যন্ত সম্প্রচার করার অনুমতি দেওয়া হবে।
শপিং কার্ট ক্লাস্টার একটি UI গ্রুপিং-এ অনেক ডেভেলপার অংশীদারের কাছ থেকে শপিং কার্টগুলির এক ঝলক দেখায়, ব্যবহারকারীদের তাদের অসামান্য কার্টগুলি সম্পূর্ণ করতে ধাক্কা দেয়৷ একটি একক শপিং কার্ট ক্লাস্টার রয়েছে, যা UI-এর শীর্ষের কাছে প্রদর্শিত হয়েছে, সমস্ত সুপারিশ ক্লাস্টারের উপরে একটি অগ্রাধিকার স্থান নির্ধারণ করা হয়েছে৷ প্রতিটি বিকাশকারী অংশীদারকে শপিং কার্ট ক্লাস্টারে 3টি পর্যন্ত
ShoppingCart
দৃষ্টান্ত সম্প্রচার করার অনুমতি দেওয়া হয়।আপনার শপিং কার্ট নিম্নলিখিত কাঠামো নেয়:
শপিং কার্ট ক্লাস্টার: একটি UI ভিউ যাতে অনেক ডেভেলপার অংশীদারদের কাছ থেকে শপিং কার্টের প্রিভিউ রয়েছে।
শপিংকার্ট: শপিং কার্ট ক্লাস্টারে প্রদর্শন করা একটি একক বিকাশকারী অংশীদারের জন্য শপিং কার্টের পূর্বরূপ প্রতিনিধিত্ব করে এমন একটি বস্তু৷
ShoppingCart
অবশ্যই কার্টে থাকা আইটেমের মোট সংখ্যা দেখাতে হবে এবং ব্যবহারকারীর কার্টে থাকা কিছু আইটেমের ছবিও অন্তর্ভুক্ত থাকতে পারে।
শপিং লিস্ট ক্লাস্টারটি একটি UI গ্রুপিং-এ একাধিক বিকাশকারী অংশীদারদের কাছ থেকে কেনাকাটার তালিকার এক ঝলক দেখায়, ব্যবহারকারীদের তাদের তালিকা আপডেট করতে এবং সম্পূর্ণ করতে সংশ্লিষ্ট অ্যাপে ফিরে যেতে অনুরোধ করে। একটি একক শপিং তালিকা ক্লাস্টার আছে।
পুনঃক্রম ক্লাস্টারটি একটি UI গ্রুপিং-এ একাধিক বিকাশকারী অংশীদারদের থেকে পূর্ববর্তী অর্ডারগুলির একটি ঝলক দেখায়, ব্যবহারকারীদের পুনরায় অর্ডার করতে প্ররোচিত করে৷ একটি একক পুনর্বিন্যাস ক্লাস্টার আছে।
পুনঃক্রম ক্লাস্টারে অবশ্যই ব্যবহারকারীর আগের অর্ডারে আইটেমের মোট সংখ্যা দেখাতে হবে এবং নিম্নলিখিতগুলির মধ্যে একটি অবশ্যই অন্তর্ভুক্ত করতে হবে:
- ব্যবহারকারীর পূর্ববর্তী ক্রমে X আইটেমের জন্য ছবি।
- ব্যবহারকারীর আগের ক্রমে X আইটেমগুলির জন্য লেবেল৷
শপিং অর্ডার ট্র্যাকিং ক্লাস্টারটি একটি UI গ্রুপিংয়ে অনেক ডেভেলপার অংশীদারের কাছ থেকে মুলতুবি থাকা বা সম্প্রতি সম্পন্ন হওয়া শপিং অর্ডারগুলির একটি ঝলক দেখায়, যা ব্যবহারকারীদের তাদের অর্ডারগুলি ট্র্যাক করতে দেয়৷
একটি একক ShoppingOrderTracking ক্লাস্টার রয়েছে যা UI-এর শীর্ষের কাছে প্রদর্শিত হয়েছে, সমস্ত সুপারিশ ক্লাস্টারের উপরে একটি অগ্রাধিকার স্থান নির্ধারণ করা হয়েছে৷ প্রতিটি বিকাশকারী অংশীদারকে শপিং অর্ডার ট্র্যাকিং ক্লাস্টারে একাধিক ShoppingOrderTrackingEntity আইটেম সম্প্রচার করার অনুমতি দেওয়া হয়।
আপনার ShoppingOrderTrackingCluster নিম্নলিখিত কাঠামো নেয়:
- শপিংঅর্ডারট্র্যাকিং ক্লাস্টার : একটি UI ভিউ যাতে অনেক ডেভেলপার অংশীদারের অর্ডার ট্র্যাকিং প্রিভিউগুলির একটি গ্রুপ থাকে
- ShoppingOrderTrackingEntity : শপিং অর্ডার ট্র্যাকিং ক্লাস্টারে প্রদর্শন করা একক বিকাশকারী অংশীদারের জন্য একটি শপিং অর্ডার ট্র্যাকিং প্রিভিউ প্রতিনিধিত্ব করে এমন একটি বস্তু৷ ShoppingOrderTrackingEntity অবশ্যই অর্ডারের অবস্থা এবং অর্ডারের সময় দেখাতে হবে। ShoppingOrderTrackingEntity-এর জন্য প্রত্যাশিত ডেলিভারি সময় পূরণ করার জন্য আমরা দৃঢ়ভাবে সুপারিশ করি, কারণ এটি প্রদান করা হলে ব্যবহারকারীদের কাছে প্রদর্শিত হয়।
প্রাক কাজ
ন্যূনতম API স্তর: 19
আপনার অ্যাপে com.google.android.engage:engage-core
লাইব্রেরি যোগ করুন:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.5.2'
}
আরও তথ্যের জন্য, Android 11-এ প্যাকেজ দৃশ্যমানতা দেখুন।
সারাংশ
নকশা একটি আবদ্ধ সেবা বাস্তবায়ন উপর ভিত্তি করে.
একটি ক্লায়েন্ট যে ডেটা প্রকাশ করতে পারে তা বিভিন্ন ক্লাস্টার প্রকারের জন্য নিম্নলিখিত সীমার সাপেক্ষে:
ক্লাস্টার টাইপ | ক্লাস্টার সীমা | একটি ক্লাস্টারে সত্তার সর্বোচ্চ সীমা |
---|---|---|
সুপারিশ ক্লাস্টার(গুলি) | সর্বাধিক 7 | সর্বাধিক 50টি ShoppingEntity |
বৈশিষ্ট্যযুক্ত ক্লাস্টার | সর্বোচ্চ 1 | সর্বাধিক 20টি ShoppingEntity |
শপিং কার্ট ক্লাস্টার | সর্বোচ্চ 1 | সর্বোচ্চ ৩টি ShoppingCart একাধিক কার্ট শুধুমাত্র প্রতি বণিক পৃথক কার্ট সহ অ্যাপের জন্য প্রত্যাশিত৷ |
শপিং লিস্ট ক্লাস্টার | সর্বোচ্চ 1 | সর্বাধিক 1টি ShoppingListEntity |
কেনাকাটা পুনর্বিন্যাস ক্লাস্টার | সর্বোচ্চ 1 | সর্বোচ্চ ১টি ReorderEntity |
শপিং অর্ডার ট্র্যাকিং ক্লাস্টার | সর্বাধিক 3 | সর্বাধিক 3টি ShoppingOrderTrackingEntity |
ধাপ 1: সত্তা তথ্য প্রদান
প্রতিটি আইটেমের প্রকারের প্রতিনিধিত্ব করার জন্য SDK বিভিন্ন সত্তাকে সংজ্ঞায়িত করেছে। নিম্নলিখিত সংস্থাগুলি কেনাকাটা বিভাগের জন্য সমর্থিত:
-
ShoppingEntity
-
ShoppingCart
-
ShoppingList
-
Reorder
-
ShoppingOrderTracking
নীচের চার্টগুলি প্রতিটি ধরণের জন্য উপলব্ধ বৈশিষ্ট্য এবং প্রয়োজনীয়তার রূপরেখা দেয়।
ShoppingEntity
ShoppingEntity
অবজেক্ট এমন একটি পণ্য, প্রচার, চুক্তি, সদস্যতা বা ইভেন্টের প্রতিনিধিত্ব করে যা বিকাশকারী অংশীদাররা প্রকাশ করতে চায়।
ShoppingEntity
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
পোস্টার ছবি | প্রয়োজন | অন্তত একটি ছবি প্রদান করা আবশ্যক. | নির্দেশিকা জন্য ইমেজ স্পেসিফিকেশন দেখুন. |
অ্যাকশন উরি | প্রয়োজন | অ্যাপের পৃষ্ঠার গভীর লিঙ্কটি সত্তা সম্পর্কে বিশদ বিবরণ প্রদর্শন করে। দ্রষ্টব্য: আপনি অ্যাট্রিবিউশনের জন্য গভীর লিঙ্ক ব্যবহার করতে পারেন। এই FAQ পড়ুন | উরি |
শিরোনাম | ঐচ্ছিক | সত্তার নাম। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 90 অক্ষরের নিচে (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাতে পারে) |
মূল্য - বর্তমান | শর্তসাপেক্ষে প্রয়োজন | সত্তার বর্তমান মূল্য। স্ট্রাইকথ্রু মূল্য প্রদান করা হলে অবশ্যই প্রদান করতে হবে। | বিনামূল্যে পাঠ্য |
মূল্য - স্ট্রাইকথ্রু | ঐচ্ছিক | সত্তার আসল মূল্য, যা UI-তে স্ট্রাক-থ্রু করা হয়। | বিনামূল্যে পাঠ্য |
কলআউট | ঐচ্ছিক | যদি উপলব্ধ থাকে তবে সত্তার জন্য একটি প্রচার, ইভেন্ট বা আপডেটের জন্য কলআউট করুন। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 45 অক্ষরের নিচে (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাতে পারে) |
কলআউট সূক্ষ্ম মুদ্রণ | ঐচ্ছিক | কলআউটের জন্য সূক্ষ্ম মুদ্রণ পাঠ্য। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 45 অক্ষরের নিচে (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাতে পারে) |
রেটিং (ঐচ্ছিক) - দ্রষ্টব্য: সমস্ত রেটিং আমাদের স্ট্যান্ডার্ড স্টার রেটিং সিস্টেম ব্যবহার করে প্রদর্শিত হয়। | |||
রেটিং - সর্বোচ্চ মান | ঐচ্ছিক | রেটিং স্কেলের সর্বোচ্চ মান। প্রদান করা আবশ্যক যদি রেটিং বর্তমান মান প্রদান করা হয়. | সংখ্যা >= 0.0 |
রেটিং - বর্তমান মান | ঐচ্ছিক | রেটিং স্কেলের বর্তমান মান। প্রদান করা আবশ্যক যদি রেটিং সর্বোচ্চ মান প্রদান করা হয়. | সংখ্যা >= 0.0 |
রেটিং - গণনা | ঐচ্ছিক | সত্তার জন্য রেটিং গণনা. দ্রষ্টব্য: এই ক্ষেত্রটি প্রদান করুন যদি আপনার অ্যাপ ব্যবহারকারীদের কাছে গণনা কীভাবে প্রদর্শিত হয় তা নিয়ন্ত্রণ করে। একটি সংক্ষিপ্ত স্ট্রিং ব্যবহার করুন. উদাহরণস্বরূপ, যদি গণনা 1,000,000 হয়, তাহলে 1M-এর মতো একটি সংক্ষিপ্ত রূপ ব্যবহার করার কথা বিবেচনা করুন যাতে ছোট ডিসপ্লে আকারে গণনাটি কাটা না যায়। | স্ট্রিং |
রেটিং - গণনা মান | ঐচ্ছিক | সত্তার জন্য রেটিং গণনা. দ্রষ্টব্য: আপনি যদি প্রদর্শনের সংক্ষিপ্তকরণের যুক্তি নিজে না পরিচালনা করেন তবে এই ক্ষেত্রটি প্রদান করুন। গণনা এবং গণনা মান উভয়ই উপস্থিত থাকলে, ব্যবহারকারীদের কাছে গণনা প্রদর্শিত হয়। | লম্বা |
DisplayTimeWindow (ঐচ্ছিক) - একটি বিষয়বস্তুর পৃষ্ঠে দেখানোর জন্য একটি সময় উইন্ডো সেট করুন | |||
টাইমস্ট্যাম্প শুরু করুন | ঐচ্ছিক | যুগের টাইমস্ট্যাম্প যার পরে বিষয়বস্তু পৃষ্ঠে দেখানো উচিত। যদি সেট না করা হয়, তাহলে বিষয়বস্তু পৃষ্ঠে দেখানোর যোগ্য। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
শেষ টাইমস্ট্যাম্প | ঐচ্ছিক | যুগের টাইমস্ট্যাম্প যার পরে বিষয়বস্তু পৃষ্ঠে আর দেখানো হয় না। যদি সেট না করা হয়, তাহলে বিষয়বস্তু পৃষ্ঠে দেখানোর যোগ্য। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
ShoppingCart
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
অ্যাকশন উরি | প্রয়োজন | অংশীদারের অ্যাপে শপিং কার্টের গভীর লিঙ্ক। দ্রষ্টব্য: আপনি অ্যাট্রিবিউশনের জন্য গভীর লিঙ্ক ব্যবহার করতে পারেন। এই FAQ পড়ুন | উরি |
আইটেম সংখ্যা | প্রয়োজন | শপিং কার্টে আইটেমের সংখ্যা (শুধু পণ্যের সংখ্যা নয়)। উদাহরণস্বরূপ: যদি কার্টে 3টি অভিন্ন শার্ট এবং 1টি টুপি থাকে তবে এই সংখ্যাটি 4 হতে হবে৷ | পূর্ণসংখ্যা >= 1 |
অ্যাকশন টেক্সট | ঐচ্ছিক | শপিং কার্টে বোতামের কল টু অ্যাকশন পাঠ্য (উদাহরণস্বরূপ, আপনার শপিং ব্যাগ )। ডেভেলপারের দ্বারা কোন অ্যাকশন টেক্সট প্রদান করা না হলে, ভিউ কার্ট ডিফল্ট। এই বৈশিষ্ট্যটি 1.1.0 এর পরের সংস্করণে সমর্থিত। | স্ট্রিং |
শিরোনাম | ঐচ্ছিক | কার্টের শিরোনাম (উদাহরণস্বরূপ, আপনার শপিং ব্যাগ )। ডেভেলপার দ্বারা কোন শিরোনাম প্রদান করা না হলে, আপনার কার্টটি ডিফল্ট। যদি বিকাশকারী অংশীদার প্রতি বণিকের জন্য একটি পৃথক কার্ট প্রকাশ করে, অনুগ্রহ করে শিরোনামে বণিকের নাম অন্তর্ভুক্ত করুন৷ | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 25 অক্ষরের নিচে (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাতে পারে) |
কার্ট ইমেজ | ঐচ্ছিক | কার্টে প্রতিটি পণ্যের ছবি। অগ্রাধিকার অনুযায়ী 10টি পর্যন্ত ছবি দেওয়া যেতে পারে; প্রদর্শিত চিত্রের প্রকৃত সংখ্যা ডিভাইস ফর্ম ফ্যাক্টরের উপর নির্ভর করে। | নির্দেশিকা জন্য ইমেজ স্পেসিফিকেশন দেখুন. |
আইটেম লেবেল | ঐচ্ছিক | কেনাকাটার তালিকায় থাকা আইটেমগুলির জন্য লেবেলের তালিকা৷ প্রদর্শিত লেবেলের প্রকৃত সংখ্যা ডিভাইস ফর্ম ফ্যাক্টরের উপর নির্ভর করে। | বিনামূল্যে পাঠ্য লেবেল তালিকা প্রস্তাবিত পাঠ্যের আকার: 20 অক্ষরের নিচে (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাতে পারে) |
শেষ ব্যবহারকারী ইন্টারঅ্যাকশন টাইমস্ট্যাম্প | ঐচ্ছিক | যুগ থেকে অতিবাহিত মিলিসেকেন্ডের সংখ্যা, ব্যবহারকারী কার্টের সাথে ইন্টারঅ্যাক্ট করার শেষ সময় চিহ্নিত করে। এটি বিকাশকারী অংশীদাররা প্রতি বণিকের জন্য পৃথক কার্ট প্রকাশ করে ইনপুট হিসাবে পাস করবে এবং র্যাঙ্কিংয়ের জন্য ব্যবহার করা যেতে পারে। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
DisplayTimeWindow (ঐচ্ছিক) - একটি বিষয়বস্তুর পৃষ্ঠে দেখানোর জন্য একটি সময় উইন্ডো সেট করুন | |||
টাইমস্ট্যাম্প শুরু করুন | ঐচ্ছিক | যুগের টাইমস্ট্যাম্প যার পরে বিষয়বস্তু পৃষ্ঠে দেখানো উচিত। যদি সেট না করা হয়, তাহলে বিষয়বস্তু পৃষ্ঠে দেখানোর যোগ্য। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
শেষ টাইমস্ট্যাম্প | ঐচ্ছিক | যুগের টাইমস্ট্যাম্প যার পরে বিষয়বস্তু পৃষ্ঠে আর দেখানো হয় না। যদি সেট না করা হয়, তাহলে বিষয়বস্তু পৃষ্ঠে দেখানোর যোগ্য। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
ShoppingList
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
অ্যাকশন উরি | প্রয়োজন | অংশীদারের অ্যাপে কেনাকাটার তালিকার গভীর লিঙ্ক। দ্রষ্টব্য: আপনি অ্যাট্রিবিউশনের জন্য গভীর লিঙ্ক ব্যবহার করতে পারেন। এই FAQ পড়ুন | উরি |
আইটেম সংখ্যা | প্রয়োজন | কেনাকাটার তালিকায় আইটেমের সংখ্যা। | পূর্ণসংখ্যা >= 1 |
শিরোনাম | ঐচ্ছিক | তালিকার শিরোনাম (উদাহরণস্বরূপ, আপনার মুদির তালিকা )। ডেভেলপার দ্বারা কোন শিরোনাম প্রদান করা না হলে, কেনাকাটার তালিকা ডিফল্ট। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 25 অক্ষরের নিচে (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাতে পারে) |
আইটেম লেবেল | প্রয়োজন | কেনাকাটার তালিকায় থাকা আইটেমগুলির জন্য লেবেলের তালিকা৷ কমপক্ষে 1টি লেবেল প্রদান করা আবশ্যক এবং অগ্রাধিকারের ক্রমে 10টি পর্যন্ত লেবেল প্রদান করা যেতে পারে; প্রদর্শিত লেবেলের প্রকৃত সংখ্যা ডিভাইস ফর্ম ফ্যাক্টরের উপর নির্ভর করে। | বিনামূল্যে পাঠ্য লেবেল তালিকা প্রস্তাবিত পাঠ্যের আকার: 20 অক্ষরের নিচে (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাতে পারে) |
ShoppingReorderCluster
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
অ্যাকশন উরি | প্রয়োজন | অংশীদারের অ্যাপে পুনরায় অর্ডার করার গভীর লিঙ্ক। দ্রষ্টব্য: আপনি অ্যাট্রিবিউশনের জন্য গভীর লিঙ্ক ব্যবহার করতে পারেন। এই FAQ পড়ুন | উরি |
অ্যাকশন টেক্সট | ঐচ্ছিক | রি-অর্ডারের বোতামের কল টু অ্যাকশন টেক্সট (উদাহরণস্বরূপ, আবার অর্ডার করুন )। ডেভেলপারের দ্বারা কোন অ্যাকশন টেক্সট প্রদান করা না হলে, রি-অর্ডার ডিফল্ট। এই বৈশিষ্ট্যটি 1.1.0 এর পরের সংস্করণে সমর্থিত। | স্ট্রিং |
আইটেম সংখ্যা | প্রয়োজন | আগের অর্ডারে আইটেমের সংখ্যা (শুধু পণ্যের সংখ্যা নয়)। উদাহরণ স্বরূপ: আগের ক্রমটিতে যদি 3টি ছোট কফি এবং 1টি ক্রসেন্ট থাকে, তাহলে এই সংখ্যাটি 4 হওয়া উচিত৷ | পূর্ণসংখ্যা >= 1 |
শিরোনাম | প্রয়োজন | পুনঃক্রম আইটেমের শিরোনাম। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 40 অক্ষরের নিচে (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাতে পারে) |
আইটেম লেবেল | ঐচ্ছিক (যদি প্রদান না করা হয়, পোস্টার ছবি প্রদান করা উচিত) | আগের অর্ডারের জন্য আইটেম লেবেলের তালিকা। অগ্রাধিকার অনুসারে 10টি লেবেল পর্যন্ত প্রদান করা যেতে পারে; প্রদর্শিত লেবেলের প্রকৃত সংখ্যা ডিভাইস ফর্ম ফ্যাক্টরের উপর নির্ভর করে। | বিনামূল্যে পাঠ্য তালিকা লেবেল প্রতি প্রস্তাবিত পাঠ্যের আকার: 20 অক্ষরের নিচে (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাতে পারে) |
পোস্টার ছবি | ঐচ্ছিক (যদি প্রদান না করা হয়, আইটেম লেবেল প্রদান করা উচিত) | আগের ক্রম আইটেম ছবি. অগ্রাধিকার অনুযায়ী 10টি পর্যন্ত ছবি দেওয়া যেতে পারে; প্রদর্শিত চিত্রের প্রকৃত সংখ্যা ডিভাইস ফর্ম ফ্যাক্টরের উপর নির্ভর করে। | নির্দেশিকা জন্য ইমেজ স্পেসিফিকেশন দেখুন. |
ShoppingOrderTrackingCluster
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
শিরোনাম | প্রয়োজন | ট্র্যাক করা প্যাকেজ/আইটেমগুলির একটি সংক্ষিপ্ত শিরোনাম বা ট্র্যাকিং নম্বর৷ | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 50টি অক্ষর (যে পাঠ্যটি খুব লম্বা তা উপবৃত্ত দেখাবে) |
অর্ডারের ধরন | প্রয়োজন | ট্র্যাক করা প্যাকেজ/আইটেমগুলির একটি সংক্ষিপ্ত শিরোনাম বা ট্র্যাকিং নম্বর৷ | Enum: IN_STORE_PICKUP, SAME_DAY_DELIVERY, MULTI_DAY_DELIVERY |
স্ট্যাটাস | প্রয়োজন | অর্ডারের বর্তমান অবস্থা। যেমন: "দেরিতে চলছে", "ট্রানজিটে", "বিলম্বিত", "শিপড", "ডেলিভার হয়েছে", "স্টক শেষ", "অর্ডার প্রস্তুত" | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 25টি অক্ষর (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাবে) |
অর্ডার করার সময় | প্রয়োজন | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প যেখানে অর্ডার দেওয়া হয়েছিল৷ প্রত্যাশিত ডেলিভারি সময় উইন্ডো উপস্থিত না থাকলে অর্ডার সময় প্রদর্শিত হবে | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
অ্যাকশন উরি | প্রয়োজন | অংশীদারের অ্যাপে অর্ডার ট্র্যাকিংয়ের গভীর লিঙ্ক। | উরি |
OrderDeliveryTimeWindow (ঐচ্ছিক) - অর্ডার দেওয়ার সময় থেকে প্রত্যাশিত/প্রকৃত ডেলিভারির সময় পর্যন্ত ট্র্যাক করা অর্ডারের জন্য একটি সময় উইন্ডো সেট করুন। | |||
অর্ডার ডেলিভারিটাইম উইন্ডো - শুরুর সময় | ঐচ্ছিক | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প যা পরে/যার পরে অর্ডার বিতরণ করা হবে বা পিকআপের জন্য প্রস্তুত হবে। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
অর্ডার ডেলিভারি টাইম উইন্ডো - শেষ সময় | ঐচ্ছিক | ইপক টাইমস্ট্যাম্প মিলিসেকেন্ডে/যার আগে অর্ডার ডেলিভারি করা হবে বা পিকআপের জন্য প্রস্তুত থাকবে। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
পোস্টার ছবি | ঐচ্ছিক | অর্ডারের অংশ এমন একটি আইটেম/পণ্যের ছবি। প্রস্তাবিত আকৃতির অনুপাত হল 1:1৷ | নির্দেশিকা জন্য ইমেজ স্পেসিফিকেশন দেখুন. |
আইটেম সংখ্যা | ঐচ্ছিক | অর্ডার আইটেম সংখ্যা. | পূর্ণসংখ্যা >= 1 |
বর্ণনা | ঐচ্ছিক | ক্রম অনুসারে আইটেমগুলি বর্ণনা করার জন্য পাঠ্যের একটি একক অনুচ্ছেদ৷ দ্রষ্টব্য: হয় বর্ণনা বা সাবটাইটেল তালিকা ব্যবহারকারীর কাছে প্রদর্শিত হবে, উভয়ই নয়। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্য আকার: 180 অক্ষর |
সাবটাইটেল তালিকা | ঐচ্ছিক | 3টি পর্যন্ত সাবটাইটেল, প্রতিটি সাবটাইটেলের সাথে পাঠ্যের একটি লাইন। দ্রষ্টব্য: হয় বর্ণনা বা সাবটাইটেল তালিকা ব্যবহারকারীর কাছে প্রদর্শিত হবে, উভয়ই নয়। | বিনামূল্যে পাঠ্য প্রতিটি সাবটাইটেলের জন্য প্রস্তাবিত পাঠ্য আকার: সর্বাধিক 50 অক্ষর |
অর্ডার মান - বর্তমান মূল্য | ঐচ্ছিক | অর্ডারের বর্তমান মান। | বিনামূল্যে পাঠ্য |
অর্ডার নম্বর | ঐচ্ছিক | অর্ডার নম্বর/আইডি যা অর্ডারটিকে স্বতন্ত্রভাবে সনাক্ত করতে ব্যবহার করা যেতে পারে। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্য আকার: সর্বাধিক 25 অক্ষর |
ট্র্যাকিং নম্বর | ঐচ্ছিক | অর্ডারের ডেলিভারির প্রয়োজন হলে অর্ডার/পার্সেল ডেলিভারির জন্য ট্র্যাকিং নম্বর। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্য আকার: সর্বাধিক 25 অক্ষর |
ইমেজ স্পেসিফিকেশন
ইমেজ সম্পদের জন্য প্রয়োজনীয় স্পেসিফিকেশন নীচে তালিকাভুক্ত করা হয়েছে:
আকৃতির অনুপাত | ন্যূনতম পিক্সেল | প্রস্তাবিত পিক্সেল |
---|---|---|
বর্গক্ষেত্র (1x1) অ-বৈশিষ্ট্যযুক্ত ক্লাস্টারগুলির জন্য পছন্দের৷ | 300x300 | 1200x1200 |
ল্যান্ডস্কেপ (1.91x1) বৈশিষ্ট্যযুক্ত ক্লাস্টার জন্য পছন্দ | 600x314 | 1200x628 |
প্রতিকৃতি (4x5) | 480x600 | 960x1200 |
ফাইল ফরম্যাট
PNG, JPG, স্ট্যাটিক GIF, WebP
সর্বোচ্চ ফাইলের আকার
5120 KB
অতিরিক্ত সুপারিশ
- ছবি নিরাপদ এলাকা: ছবির 80% কেন্দ্রে আপনার গুরুত্বপূর্ণ বিষয়বস্তু রাখুন।
- একটি স্বচ্ছ ব্যাকগ্রাউন্ড ব্যবহার করুন যাতে ছবিটি ডার্ক এবং লাইট থিম সেটিংসে সঠিকভাবে প্রদর্শিত হতে পারে।
ধাপ 2: ক্লাস্টার ডেটা প্রদান করুন
বিষয়বস্তু প্রকাশের কাজটি ব্যাকগ্রাউন্ডে কার্যকর করা বাঞ্ছনীয় (উদাহরণস্বরূপ, WorkManager ব্যবহার করে) এবং নিয়মিতভাবে বা একটি ইভেন্ট ভিত্তিতে নির্ধারিত (উদাহরণস্বরূপ, ব্যবহারকারী যখনই অ্যাপটি খোলে বা যখন ব্যবহারকারী তাদের কার্টে কিছু যোগ করেন)।
AppEngageShoppingClient
শপিং ক্লাস্টার প্রকাশের জন্য দায়ী।
নিম্নলিখিত APIগুলি ক্লায়েন্টে ক্লাস্টার প্রকাশ করার জন্য উন্মুক্ত হয়:
-
isServiceAvailable
-
publishRecommendationClusters
-
publishFeaturedCluster
-
publishShoppingCart
-
publishShoppingCarts
-
publishShoppingList
-
publishShoppingReorderCluster
-
publishShoppingOrderTrackingCluster
-
publishUserAccountManagementRequest
-
updatePublishStatus
-
deleteRecommendationsClusters
-
deleteFeaturedCluster
-
deleteShoppingCartCluster
-
deleteShoppingListCluster
-
deleteShoppingReorderCluster
-
deleteShoppingOrderTrackingCluster
-
deleteUserManagementCluster
-
deleteClusters
isServiceAvailable
পরিষেবাটি ইন্টিগ্রেশনের জন্য উপলব্ধ কিনা এবং ডিভাইসে সামগ্রী উপস্থাপন করা যেতে পারে কিনা তা পরীক্ষা করতে এই API ব্যবহার করা হয়।
client.isServiceAvailable.addOnCompleteListener { task -> if (task.isSuccessful) { // Handle IPC call success if(task.result) { // Service is available on the device, proceed with content publish // calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } }
client.isServiceAvailable().addOnCompleteListener(task - > { if (task.isSuccessful()) { // Handle success if(task.getResult()) { // Service is available on the device, proceed with content // publish calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } });
publishRecommendationClusters
RecommendationCluster
অবজেক্টের একটি তালিকা প্রকাশ করতে এই API ব্যবহার করা হয়।
একটি RecommendationCluster
অবজেক্টের নিম্নলিখিত বৈশিষ্ট্য থাকতে পারে:
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা |
---|---|---|
ShoppingEntity এর তালিকা | প্রয়োজন | এই সুপারিশ ক্লাস্টারের জন্য সুপারিশগুলি তৈরি করে এমন ShoppingEntity অবজেক্টের একটি তালিকা। |
শিরোনাম | প্রয়োজন | সুপারিশ ক্লাস্টার জন্য শিরোনাম. প্রস্তাবিত পাঠ্যের আকার: 25 অক্ষরের নিচে (অত্যধিক দীর্ঘ পাঠ্য উপবৃত্ত দেখাতে পারে) |
সাবটাইটেল | ঐচ্ছিক | সুপারিশ ক্লাস্টার জন্য সাবটাইটেল. |
অ্যাকশন উরি | ঐচ্ছিক | অংশীদার অ্যাপের পৃষ্ঠার গভীর লিঙ্ক যেখানে ব্যবহারকারীরা সুপারিশের সম্পূর্ণ তালিকা দেখতে পাবেন। দ্রষ্টব্য: আপনি অ্যাট্রিবিউশনের জন্য গভীর লিঙ্ক ব্যবহার করতে পারেন। এই FAQ পড়ুন |
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Black Friday Deals") .build()) .build())
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Black Friday Deals") .build()) .build());
যখন পরিষেবাটি অনুরোধটি গ্রহণ করে, নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে সঞ্চালিত হয়:
- সমস্ত বিদ্যমান সুপারিশ ক্লাস্টার ডেটা সরানো হয়েছে৷
- অনুরোধ থেকে ডেটা পার্স করা হয় এবং নতুন সুপারিশ ক্লাস্টারে সংরক্ষণ করা হয়।
একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
publishFeaturedCluster
এই API একটি FeaturedCluster
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়।
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() ... .build()) .build())
client.publishFeaturedCluster( new PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( new FeaturedCluster.Builder() ... .build()) .build());
যখন পরিষেবাটি অনুরোধটি গ্রহণ করে, নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে সঞ্চালিত হয়:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
FeaturedCluster
ডেটা সরানো হয়েছে৷ - অনুরোধের ডেটা পার্স করা হয় এবং আপডেট করা বৈশিষ্ট্যযুক্ত ক্লাস্টারে সংরক্ষণ করা হয়।
একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
publishShoppingCart
এই APIটি একটি ShoppingCartCluster
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়।
client.publishShoppingCart( PublishShoppingCartRequest.Builder() .setShoppingCart( ShoppingCart.Builder() ... .build()) .build())
client.publishShoppingCart( new PublishShoppingCartRequest.Builder() .setShoppingCart( new ShoppingCart.Builder() ... .build()) .build())
যখন পরিষেবাটি অনুরোধটি গ্রহণ করে, নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে সঞ্চালিত হয়:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
ShoppingCart
ডেটা সরানো হয়েছে। - অনুরোধের ডেটা পার্স করা হয় এবং আপডেট করা শপিং কার্ট ক্লাস্টারে সংরক্ষণ করা হয়।
একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
publishShoppingCarts
এই API একাধিক ShoppingCart
অবজেক্ট প্রকাশ করতে ব্যবহার করা হয়. এটি বিকাশকারী অংশীদার প্রতি বণিকের জন্য পৃথক কার্ট প্রকাশের ক্ষেত্রে প্রযোজ্য। এই API ব্যবহার করার সময় শিরোনামে বণিকের নাম অন্তর্ভুক্ত করুন।
client.publishShoppingCarts( PublishShoppingCartClustersRequest.Builder() .addShoppingCart( ShoppingCart.Builder() ... .build()) .build())
client.publishShoppingCarts( new PublishShoppingCartClustersRequest.Builder() .addShoppingCart( new ShoppingCart.Builder() ... .build()) .build())
যখন পরিষেবাটি অনুরোধটি গ্রহণ করে, নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে সঞ্চালিত হয়:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
ShoppingCart
ডেটা সরানো হয়েছে। - অনুরোধের ডেটা পার্স করা হয় এবং আপডেট করা শপিং কার্ট ক্লাস্টারে সংরক্ষণ করা হয়।
একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
publishShoppingList
এই APIটি একটি FoodShoppingList
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়।
client.publishFoodShoppingList( PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( FoodShoppingListEntity.Builder() ... .build()) .build())
client.publishFoodShoppingList( new PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( new FoodShoppingListEntity.Builder() ... .build()) .build());
যখন পরিষেবাটি অনুরোধটি গ্রহণ করে, নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে সঞ্চালিত হয়:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
FoodShoppingList
ডেটা মুছে ফেলা হয়। - অনুরোধের ডেটা পার্স করা হয় এবং আপডেট করা শপিং লিস্ট ক্লাস্টারে সংরক্ষণ করা হয়।
একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
publishShoppingReorderCluster
এই APIটি একটি ShoppingReorderCluster
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়।
client.publishShoppingReorderCluster( PublishShoppingReorderClusterRequest.Builder() .setReorderCluster( ShoppingReorderCluster.Builder() ... .build()) .build())
client.publishShoppingReorderCluster( new PublishShoppingReorderClusterRequest.Builder() .setReorderCluster( new ShoppingReorderCluster.Builder() ... .build()) .build());
যখন পরিষেবাটি অনুরোধটি গ্রহণ করে, নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে সঞ্চালিত হয়:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
ShoppingReorderCluster
ডেটা সরানো হয়েছে। - অনুরোধ থেকে ডেটা পার্স করা হয় এবং আপডেট করা পুনঃক্রম ক্লাস্টারে সংরক্ষণ করা হয়।
একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
publishShoppingOrderTrackingCluster
এই APIটি একটি ShoppingOrderTrackingCluster
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়।
client.publishShoppingOrderTrackingCluster( PublishShoppingOrderTrackingClusterRequest.Builder() .setShoppingOrderTrackingCluster( ShoppingOrderTrackingCluster.Builder() ... .build()) .build())
client.publishShoppingOrderTrackingCluster( new PublishShoppingOrderTrackingClusterRequest.Builder() .setShoppingOrderTrackingCluster( new ShoppingOrderTrackingCluster.Builder() ... .build()) .build());
যখন পরিষেবাটি অনুরোধটি গ্রহণ করে, নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে সঞ্চালিত হয়:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
ShoppingOrderTrackingCluster
ডেটা সরানো হয়েছে। - অনুরোধের ডেটা পার্স করা হয় এবং আপডেট করা শপিং অর্ডার ট্র্যাকিং ক্লাস্টারে সংরক্ষণ করা হয়।
একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
publishUserAccountManagementRequest
এই API একটি সাইন ইন কার্ড প্রকাশ করতে ব্যবহৃত হয়। সাইন ইন অ্যাকশন ব্যবহারকারীদের অ্যাপের সাইন ইন পৃষ্ঠায় নির্দেশ করে যাতে অ্যাপটি সামগ্রী প্রকাশ করতে পারে (বা আরও ব্যক্তিগতকৃত সামগ্রী সরবরাহ করতে পারে)
নিম্নলিখিত মেটাডেটা সাইন ইন কার্ডের অংশ -
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা |
---|---|---|
অ্যাকশন উরি | প্রয়োজন | ডিপলিংক টু অ্যাকশন (অর্থাৎ অ্যাপ সাইন ইন পৃষ্ঠায় নেভিগেট করে) |
ছবি | ঐচ্ছিক - প্রদান করা না হলে, শিরোনাম প্রদান করা আবশ্যক | কার্ডে দেখানো ছবি 1264x712 রেজোলিউশন সহ 16x9 আকৃতির অনুপাতের ছবি |
শিরোনাম | ঐচ্ছিক - প্রদান না করা হলে, ছবি প্রদান করতে হবে | কার্ডে শিরোনাম |
অ্যাকশন টেক্সট | ঐচ্ছিক | CTA-তে টেক্সট দেখানো হয়েছে (যেমন সাইন ইন) |
সাবটাইটেল | ঐচ্ছিক | কার্ডে ঐচ্ছিক সাবটাইটেল |
var SIGN_IN_CARD_ENTITY = SignInCardEntity.Builder() .addPosterImage( Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(500) .setImageWidthInPixel(500) .build()) .setActionText("Sign In") .setActionUri(Uri.parse("http://xx.com/signin")) .build() client.publishUserAccountManagementRequest( PublishUserAccountManagementRequest.Builder() .setSignInCardEntity(SIGN_IN_CARD_ENTITY) .build());
SignInCardEntity SIGN_IN_CARD_ENTITY = new SignInCardEntity.Builder() .addPosterImage( new Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(500) .setImageWidthInPixel(500) .build()) .setActionText("Sign In") .setActionUri(Uri.parse("http://xx.com/signin")) .build(); client.publishUserAccountManagementRequest( new PublishUserAccountManagementRequest.Builder() .setSignInCardEntity(SIGN_IN_CARD_ENTITY) .build());
যখন পরিষেবাটি অনুরোধটি গ্রহণ করে, নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে সঞ্চালিত হয়:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
UserAccountManagementCluster
ডেটা সরানো হয়েছে। - অনুরোধের ডেটা পার্স করা হয়েছে এবং আপডেট হওয়া UserAccountManagementCluster ক্লাস্টারে সংরক্ষণ করা হয়েছে।
একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
updatePublishStatus
যদি কোনও অভ্যন্তরীণ ব্যবসায়িক কারণে, ক্লাস্টারগুলির কোনওটিই প্রকাশিত না হয়, আমরা দৃঢ়ভাবে আপডেট পাবলিশ স্ট্যাটাস API ব্যবহার করে প্রকাশের স্থিতি আপডেট করার সুপারিশ করি৷ এটি গুরুত্বপূর্ণ কারণ:
- সমস্ত পরিস্থিতিতে স্ট্যাটাস প্রদান করা, এমনকি যখন বিষয়বস্তু প্রকাশিত হয় (স্ট্যাটাস == প্রকাশিত), ড্যাশবোর্ডগুলিকে পপুলেট করার জন্য গুরুত্বপূর্ণ যেগুলি আপনার ইন্টিগ্রেশনের স্বাস্থ্য এবং অন্যান্য মেট্রিক্স জানাতে এই স্পষ্ট স্ট্যাটাস ব্যবহার করে।
- যদি কোনো বিষয়বস্তু প্রকাশিত না হয় কিন্তু ইন্টিগ্রেশন স্ট্যাটাস ভাঙা না হয় (STATUS == NOT_PUBLISHED), Google অ্যাপ হেলথ ড্যাশবোর্ডে সতর্কতা ট্রিগার করা এড়াতে পারে। এটি নিশ্চিত করে যে প্রদানকারীর দৃষ্টিকোণ থেকে প্রত্যাশিত পরিস্থিতির কারণে বিষয়বস্তু প্রকাশ করা হয়নি।
- এটি ডেভেলপারদের তথ্য প্রকাশের বিপরীতে প্রকাশ না করার বিষয়ে অন্তর্দৃষ্টি প্রদান করতে সহায়তা করে।
- গুগল স্ট্যাটাস কোড ব্যবহার করে ব্যবহারকারীকে অ্যাপে নির্দিষ্ট কিছু ক্রিয়া করার জন্য চাপ দিতে পারে যাতে তারা অ্যাপের বিষয়বস্তু দেখতে পারে বা তা কাটিয়ে উঠতে পারে।
যোগ্য প্রকাশের স্ট্যাটাস কোডের তালিকা হল:
// Content is published
AppEngagePublishStatusCode.PUBLISHED,
// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,
// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,
// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,
// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,
// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,
// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,
// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,
// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER
যদি কোনো ব্যবহারকারী লগ ইন না করার কারণে বিষয়বস্তু প্রকাশিত না হয়, তাহলে Google সাইন ইন কার্ড প্রকাশ করার সুপারিশ করবে। যদি কোনো কারণে প্রদানকারীরা সাইন ইন কার্ড প্রকাশ করতে না পারে তাহলে আমরা স্ট্যাটাস কোড NOT_PUBLISHED_REQUIRES_SIGN_IN সহ updatePublishStatus API কল করার পরামর্শ দিই
client.updatePublishStatus( PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build())
client.updatePublishStatus( new PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build());
deleteRecommendationClusters
এই APIটি সুপারিশ ক্লাস্টারের বিষয়বস্তু মুছে ফেলার জন্য ব্যবহার করা হয়।
যখন পরিষেবাটি অনুরোধ গ্রহণ করে, তখন এটি সুপারিশ ক্লাস্টারগুলি থেকে বিদ্যমান ডেটা সরিয়ে দেয়। একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
deleteFeaturedCluster
এই APIটি বৈশিষ্ট্যযুক্ত ক্লাস্টারের বিষয়বস্তু মুছে ফেলার জন্য ব্যবহৃত হয়।
যখন পরিষেবাটি অনুরোধ গ্রহণ করে, এটি বৈশিষ্ট্যযুক্ত ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
deleteShoppingCartCluster
এই API শপিং কার্ট ক্লাস্টারের বিষয়বস্তু মুছে ফেলার জন্য ব্যবহার করা হয়।
যখন পরিষেবাটি অনুরোধ গ্রহণ করে, তখন এটি শপিং কার্ট ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
deleteShoppingListCluster
শপিং লিস্ট ক্লাস্টারের বিষয়বস্তু মুছতে এই API ব্যবহার করা হয়।
যখন পরিষেবাটি অনুরোধ গ্রহণ করে, তখন এটি শপিং তালিকা ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
deleteShoppingReorderCluster
শপিং রিঅর্ডার ক্লাস্টারের বিষয়বস্তু মুছতে এই API ব্যবহার করা হয়।
যখন পরিষেবাটি অনুরোধ গ্রহণ করে, তখন এটি শপিং রিঅর্ডার ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
deleteShoppingOrderTrackingCluster
শপিং অর্ডার ট্র্যাকিং ক্লাস্টারের বিষয়বস্তু মুছতে এই API ব্যবহার করা হয়।
যখন পরিষেবাটি অনুরোধটি পায়, তখন এটি শপিং অর্ডার ট্র্যাকিং ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
deleteUserManagementCluster
UserAccountManagement Cluster-এর বিষয়বস্তু মুছতে এই API ব্যবহার করা হয়।
যখন পরিষেবাটি অনুরোধটি গ্রহণ করে, তখন এটি UserAccountManagement ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
deleteClusters
এই API একটি প্রদত্ত ক্লাস্টার ধরনের বিষয়বস্তু মুছে ফেলার জন্য ব্যবহার করা হয়.
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build())
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build());
যখন পরিষেবাটি অনুরোধটি গ্রহণ করে, তখন এটি নির্দিষ্ট ক্লাস্টার প্রকারের সাথে মিলে যাওয়া সমস্ত ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। ক্লায়েন্টরা এক বা একাধিক ক্লাস্টার প্রকার পাস করতে বেছে নিতে পারেন। একটি ত্রুটির ক্ষেত্রে, সম্পূর্ণ অনুরোধ প্রত্যাখ্যান করা হয় এবং বিদ্যমান অবস্থা বজায় রাখা হয়।
ত্রুটি হ্যান্ডলিং
পাবলিশ এপিআই থেকে টাস্ক রেজাল্ট শোনার জন্য অত্যন্ত সুপারিশ করা হয় যাতে একটি সফল টাস্ক পুনরুদ্ধার এবং পুনরায় জমা দেওয়ার জন্য একটি ফলো-আপ পদক্ষেপ নেওয়া যেতে পারে।
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 | পরিষেবা কল খুব ঘন ঘন করা হয়. |
ধাপ 3: সম্প্রচারের উদ্দেশ্য পরিচালনা করুন
একটি কাজের মাধ্যমে প্রকাশ সামগ্রী API কল করার পাশাপাশি, একটি বিষয়বস্তু প্রকাশের জন্য অনুরোধ পাওয়ার জন্য একটি BroadcastReceiver
সেট আপ করতে হবে৷
সম্প্রচারের অভিপ্রায়ের লক্ষ্য মূলত অ্যাপ পুনরায় সক্রিয়করণ এবং ডেটা সিঙ্ককে বাধ্য করা। সম্প্রচারের অভিপ্রায়গুলি খুব ঘন ঘন পাঠানোর জন্য ডিজাইন করা হয়নি। এটি শুধুমাত্র তখনই ট্রিগার হয় যখন এনগেজ সার্ভিস নির্ধারণ করে যে বিষয়বস্তুটি বাসি হতে পারে (উদাহরণস্বরূপ, এক সপ্তাহ পুরানো)। এইভাবে, ব্যবহারকারীর একটি নতুন বিষয়বস্তুর অভিজ্ঞতা থাকতে পারে এমন আত্মবিশ্বাস রয়েছে, এমনকি যদি অ্যাপ্লিকেশনটি দীর্ঘ সময়ের জন্য কার্যকর না হয়।
BroadcastReceiver
নিম্নলিখিত দুটি উপায়ে সেট আপ করা আবশ্যক:
-
Context.registerReceiver()
ব্যবহার করেBroadcastReceiver
ক্লাসের একটি উদাহরণ ডায়নামিকভাবে নিবন্ধন করুন। এটি এখনও মেমরিতে লাইভ থাকা অ্যাপ্লিকেশনগুলি থেকে যোগাযোগ সক্ষম করে৷
class AppEngageBroadcastReceiver : BroadcastReceiver(){ // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION // broadcast is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is // received // Trigger shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast // is received // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast // is received // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is // received // Trigger shopping order tracking cluster publish when // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER 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)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Shopping Cart Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART)) // Register Shopping List Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST)) // Register Reorder Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER)) // Register Shopping Order Tracking Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER)) }
class AppEngageBroadcastReceiver extends BroadcastReceiver { // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast is // received // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast is // received // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is // received // Trigger reorder cluster publish when PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER // broadcast is received } public static void registerBroadcastReceivers(Context context) { context = context.getApplicationContext(); // Register Recommendation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Shopping Cart Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART)); // Register Shopping List Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST)); // Register Reorder Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER)); // Register Shopping Order Tracking Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER)); }
- আপনার
AndroidManifest.xml
ফাইলে<receiver>
ট্যাগ দিয়ে স্থিরভাবে একটি বাস্তবায়ন ঘোষণা করুন। এটি অ্যাপ্লিকেশনটিকে সম্প্রচারের অভিপ্রায় প্রাপ্ত করার অনুমতি দেয় যখন এটি চলছে না, এবং অ্যাপ্লিকেশনটিকে সামগ্রী প্রকাশ করার অনুমতি দেয়৷
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER" />
</intent-filter>
</receiver>
</application>
নিম্নলিখিত উদ্দেশ্যগুলি পরিষেবা দ্বারা পাঠানো হয়:
-
com.google.android.engage.action.PUBLISH_RECOMMENDATION
এই অভিপ্রায় প্রাপ্ত হলে একটিpublishRecommendationClusters
কল শুরু করার পরামর্শ দেওয়া হয়৷ -
com.google.android.engage.action.PUBLISH_FEATURED
এই উদ্দেশ্যটি প্রাপ্ত হলে একটিpublishFeaturedCluster
কল শুরু করার পরামর্শ দেওয়া হয়৷ -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART
এই অভিপ্রায়টি প্রাপ্ত হলে একটিpublishShoppingCart
কল শুরু করার পরামর্শ দেওয়া হয়৷ -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST
এই অভিপ্রায়টি প্রাপ্ত হলে একটিpublishShoppingList
কল শুরু করার পরামর্শ দেওয়া হয়৷ -
com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER
এই অভিপ্রায় প্রাপ্ত হলে একটিpublishReorderCluster
কল শুরু করার পরামর্শ দেওয়া হয়৷ -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER
এই অভিপ্রায়টি প্রাপ্ত হলে একটিpublishShoppingOrderTrackingCluster
কল শুরু করার পরামর্শ দেওয়া হয়৷
ইন্টিগ্রেশন ওয়ার্কফ্লো
আপনার ইন্টিগ্রেশন সম্পূর্ণ হওয়ার পরে যাচাই করার জন্য ধাপে ধাপে গাইডের জন্য, Engage ডেভেলপার ইন্টিগ্রেশন ওয়ার্কফ্লো দেখুন।
FAQs
প্রায়শই জিজ্ঞাসিত প্রশ্নগুলির জন্য Engage SDK দেখুন।
যোগাযোগ
ইন্টিগ্রেশন প্রক্রিয়া চলাকালীন কোনো প্রশ্ন থাকলে entering-developers@google.com-এ যোগাযোগ করুন। আমাদের দল যত তাড়াতাড়ি সম্ভব উত্তর দেয়।
পরবর্তী পদক্ষেপ
এই ইন্টিগ্রেশন সম্পন্ন করার পরে, আপনার পরবর্তী পদক্ষেপগুলি নিম্নরূপ:
- Enge-developers@google.com- এ একটি ইমেল পাঠান এবং আপনার সমন্বিত APK সংযুক্ত করুন যা Google দ্বারা পরীক্ষার জন্য প্রস্তুত৷
- ইন্টিগ্রেশন আশানুরূপ কাজ করছে তা নিশ্চিত করতে Google একটি যাচাইকরণ করে এবং অভ্যন্তরীণভাবে পর্যালোচনা করে। পরিবর্তনের প্রয়োজন হলে, Google যেকোনো প্রয়োজনীয় বিবরণের সাথে আপনার সাথে যোগাযোগ করবে।
- যখন পরীক্ষা সম্পূর্ণ হয় এবং কোন পরিবর্তনের প্রয়োজন হয় না, তখন Google আপনাকে অবহিত করার জন্য আপনার সাথে যোগাযোগ করে যে আপনি প্লে স্টোরে আপডেট করা এবং সমন্বিত APK প্রকাশ করা শুরু করতে পারেন।
- Google আপনার আপডেট করা APK প্লে স্টোরে প্রকাশিত হয়েছে তা নিশ্চিত করার পরে, আপনার সুপারিশ , বৈশিষ্ট্যযুক্ত , শপিং কার্ট , শপিং তালিকা , পুনঃক্রম ক্লাস্টার এবং শপিং অর্ডার ট্র্যাকিং ক্লাস্টার ক্লাস্টারগুলি প্রকাশ করা হতে পারে এবং ব্যবহারকারীদের কাছে দৃশ্যমান হতে পারে৷
Google একটি অন-ডিভাইস পৃষ্ঠ তৈরি করছে যা ব্যবহারকারীদের অ্যাপগুলিকে উল্লম্বভাবে সংগঠিত করে এবং ব্যক্তিগতকৃত অ্যাপ সামগ্রী ব্যবহার এবং আবিষ্কারের জন্য একটি নতুন নিমজ্জিত অভিজ্ঞতা সক্ষম করে৷ এই ফুলস্ক্রিন অভিজ্ঞতা ডেভেলপার অংশীদারদের তাদের অ্যাপের বাইরে একটি ডেডিকেটেড চ্যানেলে তাদের সেরা সমৃদ্ধ সামগ্রী প্রদর্শন করার সুযোগ দেয়।
এই নির্দেশিকাটিতে বিকাশকারী অংশীদারদের জন্য তাদের কেনাকাটার বিষয়বস্তু সংহত করার জন্য নির্দেশাবলী রয়েছে, এই নতুন পৃষ্ঠের এলাকা এবং বিনোদন স্থানের মতো বিদ্যমান Google সারফেস উভয়ই পূরণ করতে Engage SDK ব্যবহার করে৷
ইন্টিগ্রেশন বিস্তারিত
পরিভাষা
এই ইন্টিগ্রেশনে নিম্নলিখিত পাঁচটি ক্লাস্টার প্রকার রয়েছে: সুপারিশ , বৈশিষ্ট্যযুক্ত , শপিং কার্ট , শপিং তালিকা , পুনরায় সাজানো এবং শপিং অর্ডার ট্র্যাকিং ৷
সুপারিশ ক্লাস্টারগুলি কোনও পৃথক বিকাশকারী অংশীদার থেকে ব্যক্তিগতকৃত শপিংয়ের পরামর্শগুলি দেখায়। এই সুপারিশগুলি ব্যবহারকারীর কাছে ব্যক্তিগতকৃত বা সাধারণীকরণ করা যেতে পারে (উদাহরণস্বরূপ, ট্রেন্ডিং আইটেম)। আপনি উপযুক্ত হিসাবে দেখেন এমন পৃষ্ঠতল পণ্য, ইভেন্ট, বিক্রয়, প্রচার, সাবস্ক্রিপশনগুলিতে এগুলি ব্যবহার করুন।
আপনার সুপারিশগুলি নিম্নলিখিত কাঠামোটি গ্রহণ করে:
প্রস্তাবনা ক্লাস্টার: একটি ইউআই ভিউ যা একই বিকাশকারী অংশীদার থেকে একটি গ্রুপ সুপারিশ রয়েছে।
শপিংঅন্টিটি: একটি ক্লাস্টারে একটি একক আইটেম উপস্থাপন করে এমন একটি বস্তু।
বৈশিষ্ট্যযুক্ত ক্লাস্টারটি একটি ইউআই গ্রুপিংয়ের একাধিক বিকাশকারী অংশীদারদের কাছ থেকে সত্তার একটি নির্বাচন প্রদর্শন করে। এখানে একটি একক বৈশিষ্ট্যযুক্ত ক্লাস্টার থাকবে, যা ইউআইয়ের শীর্ষের কাছে সমস্ত প্রস্তাবনা ক্লাস্টারগুলির উপরে অগ্রাধিকার স্থাপনের সাথে প্রকাশিত হবে। প্রতিটি বিকাশকারী অংশীদারকে বৈশিষ্ট্যযুক্ত ক্লাস্টারে 10 টি সত্তা সম্প্রচারের অনুমতি দেওয়া হবে।
শপিং কার্ট ক্লাস্টারটি একটি ইউআই গ্রুপিংয়ের অনেক বিকাশকারী অংশীদারদের কাছ থেকে শপিং কার্টগুলির এক ঝাঁকুনির উঁকি দেখায়, ব্যবহারকারীদের তাদের অসামান্য গাড়িগুলি সম্পূর্ণ করতে নডিং করে। এখানে একটি একক শপিং কার্ট ক্লাস্টার রয়েছে, যা ইউআইয়ের শীর্ষের নিকটে প্রকাশিত হয়, সমস্ত প্রস্তাবনা ক্লাস্টারগুলির উপরে অগ্রাধিকার স্থাপনের সাথে। প্রতিটি বিকাশকারী অংশীদারকে শপিং কার্ট ক্লাস্টারে 3 টি
ShoppingCart
উদাহরণ সম্প্রচারের অনুমতি দেওয়া হয়।আপনার শপিং কার্টটি নিম্নলিখিত কাঠামো নেয়:
শপিং কার্ট ক্লাস্টার: একটি ইউআই ভিউ যা অনেক বিকাশকারী অংশীদারদের কাছ থেকে শপিং কার্টের পূর্বরূপগুলির একটি গ্রুপ রয়েছে।
শপিংকার্ট: শপিং কার্ট ক্লাস্টারে প্রদর্শিত হওয়ার জন্য একক বিকাশকারী অংশীদারের জন্য শপিং কার্ট পূর্বরূপের প্রতিনিধিত্বকারী একটি অবজেক্ট।
ShoppingCart
অবশ্যই কার্টে আইটেমগুলির মোট গণনা প্রদর্শন করতে হবে এবং ব্যবহারকারীর কার্টের কিছু আইটেমের জন্য চিত্রও অন্তর্ভুক্ত করতে পারে।
শপিং লিস্ট ক্লাস্টারটি একটি ইউআই গ্রুপিংয়ের একাধিক বিকাশকারী অংশীদারদের কাছ থেকে শপিং তালিকার এক ঝাঁকুনির উঁকি দেখায়, ব্যবহারকারীদের তাদের তালিকাগুলি আপডেট এবং সম্পূর্ণ করতে সংশ্লিষ্ট অ্যাপে ফিরে আসতে অনুরোধ করে। একটি একক শপিং তালিকা ক্লাস্টার আছে।
পুনরায় অর্ডার ক্লাস্টারটি এক ইউআই গ্রুপিংয়ের একাধিক বিকাশকারী অংশীদারদের কাছ থেকে পূর্ববর্তী আদেশগুলির এক ঝাঁকুনির উঁকি দেখায়, ব্যবহারকারীদের পুনরায় অর্ডার করতে অনুরোধ করে। একটি একক পুনরায় অর্ডার ক্লাস্টার আছে।
পুনরায় অর্ডার ক্লাস্টারটি অবশ্যই ব্যবহারকারীর আগের ক্রমে আইটেমগুলির মোট গণনা প্রদর্শন করতে হবে এবং অবশ্যই নিম্নলিখিতগুলির মধ্যে একটিও অন্তর্ভুক্ত করতে হবে:
- ব্যবহারকারীর আগের ক্রমে এক্স আইটেমগুলির জন্য চিত্রগুলি।
- ব্যবহারকারীর আগের ক্রমে এক্স আইটেমগুলির জন্য লেবেল।
শপিং অর্ডার ট্র্যাকিং ক্লাস্টারটি একটি ইউআই গ্রুপিংয়ের অনেক বিকাশকারী অংশীদারদের কাছ থেকে মুলতুবি থাকা বা সম্প্রতি সমাপ্ত শপিং অর্ডারগুলির এক ঝাঁকুনির উঁকি দেখায়, ব্যবহারকারীদের তাদের অর্ডারগুলি ট্র্যাক করতে দেয়।
সমস্ত সুপারিশ ক্লাস্টারগুলির উপরে অগ্রাধিকার স্থাপনের সাথে ইউআইয়ের শীর্ষের নিকটে একটি একক শপিংঅর্ডার ট্র্যাকিং ক্লাস্টার রয়েছে। প্রতিটি বিকাশকারী অংশীদারকে শপিং অর্ডার ট্র্যাকিং ক্লাস্টারে একাধিক শপিং অর্ডার ট্র্যাকিংজেন্টটি আইটেম সম্প্রচার করার অনুমতি দেওয়া হয়।
আপনার শপিং অর্ডারট্র্যাকিংক্লাস্টারটি নিম্নলিখিত কাঠামোটি নেয়:
- শপিং অর্ডারট্র্যাকিং ক্লাস্টার : একটি ইউআই ভিউ যা অনেক বিকাশকারী অংশীদারদের কাছ থেকে অর্ডার ট্র্যাকিং পূর্বরূপগুলির একটি গ্রুপ রয়েছে
- শপিং অর্ডার ট্র্যাকিংগেন্টিটি: শপিং অর্ডার ট্র্যাকিং ক্লাস্টারে প্রদর্শিত হওয়ার জন্য একক বিকাশকারী অংশীদারের জন্য শপিং অর্ডার ট্র্যাকিং পূর্বরূপের প্রতিনিধিত্বকারী একটি অবজেক্ট। শপিংঅর্ডার ট্র্যাকিংটিটিটি অবশ্যই অর্ডারটির স্থিতি এবং অর্ডার সময়টি প্রদর্শন করতে হবে। আমরা শপিংঅর্ডার ট্র্যাকজেন্টিটিটির জন্য প্রত্যাশিত বিতরণ সময়কে জনপ্রিয় করার জন্য দৃ strongly ়ভাবে সুপারিশ করি, যেমন এটি সরবরাহ করা হলে এটি ব্যবহারকারীদের কাছে প্রদর্শিত হয়।
প্রাক কাজ
সর্বনিম্ন এপিআই স্তর: 19
com.google.android.engage:engage-core
লাইব্রেরি:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.5.2'
}
আরও তথ্যের জন্য, অ্যান্ড্রয়েড 11 এ প্যাকেজ দৃশ্যমানতা দেখুন।
সারাংশ
নকশাটি একটি আবদ্ধ পরিষেবা বাস্তবায়নের উপর ভিত্তি করে।
একজন ক্লায়েন্ট যে ডেটা প্রকাশ করতে পারে তা বিভিন্ন ক্লাস্টার ধরণের জন্য নিম্নলিখিত সীমা সাপেক্ষে:
ক্লাস্টার টাইপ | ক্লাস্টার সীমা | একটি ক্লাস্টারে সর্বাধিক সত্তা সীমা |
---|---|---|
সুপারিশ ক্লাস্টার (গুলি) | সর্বাধিক 7 | সর্বাধিক 50 ShoppingEntity |
বৈশিষ্ট্যযুক্ত ক্লাস্টার | সর্বাধিক 1 | সর্বাধিক 20 ShoppingEntity |
শপিং কার্ট ক্লাস্টার | সর্বাধিক 1 | সর্বাধিক 3 ShoppingCart একাধিক কার্ট কেবল বণিক প্রতি পৃথক কার্ট সহ অ্যাপ্লিকেশনগুলির জন্য প্রত্যাশিত। |
শপিং লিস্ট ক্লাস্টার | সর্বাধিক 1 | সর্বাধিক 1 ShoppingListEntity |
শপিং পুনরায় অর্ডার ক্লাস্টার | সর্বাধিক 1 | সর্বাধিক 1 ReorderEntity |
শপিং অর্ডার ট্র্যাকিং ক্লাস্টার | সর্বাধিক 3 | সর্বাধিক 3 ShoppingOrderTrackingEntity |
পদক্ষেপ 1: সত্তা ডেটা সরবরাহ করুন
এসডিকে প্রতিটি আইটেমের প্রকারের প্রতিনিধিত্ব করতে বিভিন্ন সত্তাকে সংজ্ঞায়িত করেছে। নিম্নলিখিত সত্তাগুলি শপিং বিভাগের জন্য সমর্থিত:
-
ShoppingEntity
-
ShoppingCart
-
ShoppingList
-
Reorder
-
ShoppingOrderTracking
নীচের চার্টগুলি প্রতিটি ধরণের জন্য উপলভ্য বৈশিষ্ট্য এবং প্রয়োজনীয়তা উপলভ্য।
ShoppingEntity
ShoppingEntity
অবজেক্টটি একটি পণ্য, প্রচার, চুক্তি, সাবস্ক্রিপশন বা ইভেন্ট যা বিকাশকারী অংশীদাররা প্রকাশ করতে চায় তা উপস্থাপন করে।
ShoppingEntity
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
পোস্টার ছবি | প্রয়োজন | কমপক্ষে একটি চিত্র অবশ্যই সরবরাহ করতে হবে। | গাইডেন্সের জন্য চিত্রের স্পেসিফিকেশন দেখুন। |
অ্যাকশন ইউআরআই | প্রয়োজন | অ্যাপ্লিকেশনটিতে পৃষ্ঠার গভীর লিঙ্কটি সত্তা সম্পর্কে বিশদ প্রদর্শন করে। দ্রষ্টব্য: আপনি অ্যাট্রিবিউশনের জন্য গভীর লিঙ্কগুলি ব্যবহার করতে পারেন। এই FAQ দেখুন | উরি |
শিরোনাম | ঐচ্ছিক | সত্তার নাম। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 90 টি চার্জের নীচে (পাঠ্য যা খুব দীর্ঘ দীর্ঘ উপবৃত্তগুলি প্রদর্শন করতে পারে) |
মূল্য - বর্তমান | শর্তসাপেক্ষে প্রয়োজন | সত্তার বর্তমান মূল্য। স্ট্রাইকথ্রু দাম সরবরাহ করা হলে অবশ্যই সরবরাহ করতে হবে। | বিনামূল্যে পাঠ্য |
দাম - স্ট্রাইকথ্রু | ঐচ্ছিক | সত্তার মূল মূল্য, যা ইউআইতে আঘাত করা হয়। | বিনামূল্যে পাঠ্য |
কলআউট | ঐচ্ছিক | যদি উপলব্ধ থাকে তবে সত্তার জন্য একটি প্রচার, ইভেন্ট বা আপডেট বৈশিষ্ট্যযুক্ত কলআউট। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 45 টি চার্জের নীচে (পাঠ্য যা খুব দীর্ঘ দীর্ঘ উপবৃত্তগুলি প্রদর্শন করতে পারে) |
কলআউট সূক্ষ্ম মুদ্রণ | ঐচ্ছিক | কলআউটের জন্য সূক্ষ্ম মুদ্রণ পাঠ্য। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 45 টি চার্জের নীচে (পাঠ্য যা খুব দীর্ঘ দীর্ঘ উপবৃত্তগুলি প্রদর্শন করতে পারে) |
রেটিং (al চ্ছিক) - দ্রষ্টব্য: সমস্ত রেটিং আমাদের স্ট্যান্ডার্ড স্টার রেটিং সিস্টেম ব্যবহার করে প্রদর্শিত হয়। | |||
রেটিং - সর্বাধিক মান | ঐচ্ছিক | রেটিং স্কেলের সর্বোচ্চ মান। যদি রেটিংয়ের বর্তমান মানও সরবরাহ করা হয় তবে অবশ্যই সরবরাহ করতে হবে। | সংখ্যা> = 0.0 |
রেটিং - বর্তমান মান | ঐচ্ছিক | রেটিং স্কেলের বর্তমান মান। রেটিংয়ের সর্বাধিক মানও সরবরাহ করা হলে অবশ্যই সরবরাহ করতে হবে। | সংখ্যা> = 0.0 |
রেটিং - গণনা | ঐচ্ছিক | সত্তার জন্য রেটিংয়ের গণনা। দ্রষ্টব্য: যদি আপনার অ্যাপ্লিকেশনটি ব্যবহারকারীদের কাছে গণনা প্রদর্শিত হয় তা নিয়ন্ত্রণ করে তবে এই ক্ষেত্রটি সরবরাহ করুন। একটি সংক্ষিপ্ত স্ট্রিং ব্যবহার করুন। উদাহরণস্বরূপ, যদি গণনাটি 1,000,000 হয় তবে 1 এম এর মতো সংক্ষেপণ ব্যবহার করার বিষয়টি বিবেচনা করুন যাতে গণনাটি ছোট ডিসপ্লে আকারে কাটা না হয়। | স্ট্রিং |
রেটিং - গণনা মান | ঐচ্ছিক | সত্তার জন্য রেটিংয়ের গণনা। দ্রষ্টব্য: আপনি যদি নিজেকে ডিসপ্লে সংক্ষিপ্তসার যুক্তিটি পরিচালনা না করেন তবে এই ক্ষেত্রটি সরবরাহ করুন। যদি উভয় গণনা এবং গণনা মান উপস্থিত থাকে তবে গণনা ব্যবহারকারীদের কাছে প্রদর্শিত হয়। | লম্বা |
ডিসপ্লে টাইমওয়াইন্ডো (al চ্ছিক) - পৃষ্ঠের উপর কোনও সামগ্রী দেখানোর জন্য একটি সময় উইন্ডো সেট করুন | |||
টাইমস্ট্যাম্প শুরু করুন | ঐচ্ছিক | যুগের টাইমস্ট্যাম্প যার পরে সামগ্রীটি পৃষ্ঠের উপরে প্রদর্শিত হবে। যদি সেট না করা হয় তবে সামগ্রীটি পৃষ্ঠের উপরে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
শেষ টাইমস্ট্যাম্প | ঐচ্ছিক | যুগের টাইমস্ট্যাম্প যার পরে সামগ্রীটি আর পৃষ্ঠে প্রদর্শিত হয় না। যদি সেট না করা হয় তবে সামগ্রীটি পৃষ্ঠের উপরে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
ShoppingCart
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
অ্যাকশন ইউআরআই | প্রয়োজন | অংশীদারের অ্যাপে শপিং কার্টের গভীর লিঙ্ক। দ্রষ্টব্য: আপনি অ্যাট্রিবিউশনের জন্য গভীর লিঙ্কগুলি ব্যবহার করতে পারেন। এই FAQ দেখুন | উরি |
আইটেম সংখ্যা | প্রয়োজন | শপিং কার্টে আইটেমের সংখ্যা (কেবল পণ্য সংখ্যা নয়)। উদাহরণস্বরূপ: যদি কার্টে 3 টি অভিন্ন শার্ট এবং 1 টি টুপি থাকে তবে এই সংখ্যাটি 4 হওয়া উচিত। | পূর্ণসংখ্যা> = 1 |
অ্যাকশন টেক্সট | ঐচ্ছিক | শপিং কার্টে বোতামের অ্যাকশন পাঠ্য কল (উদাহরণস্বরূপ, আপনার শপিং ব্যাগ )। যদি বিকাশকারী দ্বারা কোনও ক্রিয়া পাঠ্য সরবরাহ না করা হয় তবে দেখুন কার্টটি ডিফল্ট। এই বৈশিষ্ট্যটি 1.1.0 সংস্করণে সমর্থিত। | স্ট্রিং |
শিরোনাম | ঐচ্ছিক | কার্টের শিরোনাম (উদাহরণস্বরূপ, আপনার শপিং ব্যাগ )। যদি বিকাশকারী দ্বারা কোনও শিরোনাম সরবরাহ না করা হয় তবে আপনার কার্টটি ডিফল্ট। যদি বিকাশকারী অংশীদার প্রতি বণিকের জন্য একটি পৃথক কার্ট প্রকাশ করে তবে দয়া করে শিরোনামে বণিকের নাম অন্তর্ভুক্ত করুন। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 25 টি চার্জের নীচে (পাঠ্য যা খুব দীর্ঘ দীর্ঘ উপবৃত্তগুলি প্রদর্শন করতে পারে) |
কার্ট ইমেজ | ঐচ্ছিক | কার্টে প্রতিটি পণ্যের চিত্র। অগ্রাধিকারের ক্রমে 10 টি পর্যন্ত চিত্র সরবরাহ করা যেতে পারে; প্রদর্শিত চিত্রগুলির প্রকৃত সংখ্যাটি ডিভাইস ফর্ম ফ্যাক্টরের উপর নির্ভর করে। | গাইডেন্সের জন্য চিত্রের স্পেসিফিকেশন দেখুন। |
আইটেম লেবেল | ঐচ্ছিক | শপিং তালিকায় আইটেমগুলির জন্য লেবেলের তালিকা। প্রদর্শিত লেবেলের প্রকৃত সংখ্যাটি ডিভাইস ফর্ম ফ্যাক্টরের উপর নির্ভর করে। | বিনামূল্যে পাঠ্য লেবেলের তালিকা প্রস্তাবিত পাঠ্যের আকার: 20 টি চার্জের কম (পাঠ্য যা খুব দীর্ঘ দীর্ঘ উপবৃত্তগুলি প্রদর্শন করতে পারে) |
শেষ ব্যবহারকারী ইন্টারঅ্যাকশন টাইমস্ট্যাম্প | ঐচ্ছিক | ব্যবহারকারী কার্টের সাথে ইন্টারঅ্যাক্ট করার সময় শেষবারের মতো চিহ্নিত করে মিলিসেকেন্ডের সংখ্যাটি যুগ থেকে কেটে গেছে। এটি বিকাশকারী অংশীদারদের দ্বারা বণিক প্রতি পৃথক কার্ট প্রকাশ করে এবং র্যাঙ্কিংয়ের জন্য ব্যবহৃত হতে পারে ইনপুট হিসাবে পাস করা হবে। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
ডিসপ্লে টাইমওয়াইন্ডো (al চ্ছিক) - পৃষ্ঠের উপর কোনও সামগ্রী দেখানোর জন্য একটি সময় উইন্ডো সেট করুন | |||
টাইমস্ট্যাম্প শুরু করুন | ঐচ্ছিক | যুগের টাইমস্ট্যাম্প যার পরে সামগ্রীটি পৃষ্ঠের উপরে প্রদর্শিত হবে। যদি সেট না করা হয় তবে সামগ্রীটি পৃষ্ঠের উপরে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
শেষ টাইমস্ট্যাম্প | ঐচ্ছিক | যুগের টাইমস্ট্যাম্প যার পরে সামগ্রীটি আর পৃষ্ঠে প্রদর্শিত হয় না। যদি সেট না করা হয় তবে সামগ্রীটি পৃষ্ঠের উপরে প্রদর্শিত হওয়ার যোগ্য। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
ShoppingList
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
অ্যাকশন ইউআরআই | প্রয়োজন | অংশীদারের অ্যাপে শপিং তালিকার গভীর লিঙ্ক। দ্রষ্টব্য: আপনি অ্যাট্রিবিউশনের জন্য গভীর লিঙ্কগুলি ব্যবহার করতে পারেন। এই FAQ দেখুন | উরি |
আইটেম সংখ্যা | প্রয়োজন | শপিং তালিকায় আইটেমের সংখ্যা। | পূর্ণসংখ্যা> = 1 |
শিরোনাম | ঐচ্ছিক | তালিকার শিরোনাম (উদাহরণস্বরূপ, আপনার মুদি তালিকা )। যদি বিকাশকারী দ্বারা কোনও শিরোনাম সরবরাহ না করা হয় তবে শপিং তালিকাটি ডিফল্ট। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 25 টি চার্জের নীচে (পাঠ্য যা খুব দীর্ঘ দীর্ঘ উপবৃত্তগুলি প্রদর্শন করতে পারে) |
আইটেম লেবেল | প্রয়োজন | শপিং তালিকায় আইটেমগুলির জন্য লেবেলের তালিকা। কমপক্ষে 1 টি লেবেল সরবরাহ করতে হবে এবং অগ্রাধিকারের ক্রমে 10 টি পর্যন্ত লেবেল সরবরাহ করা যেতে পারে; প্রদর্শিত লেবেলের প্রকৃত সংখ্যাটি ডিভাইস ফর্ম ফ্যাক্টরের উপর নির্ভর করে। | বিনামূল্যে পাঠ্য লেবেলের তালিকা প্রস্তাবিত পাঠ্যের আকার: 20 টি চার্জের কম (পাঠ্য যা খুব দীর্ঘ দীর্ঘ উপবৃত্তগুলি প্রদর্শন করতে পারে) |
ShoppingReorderCluster
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
অ্যাকশন ইউআরআই | প্রয়োজন | অংশীদারের অ্যাপে পুনরায় অর্ডার করার গভীর লিঙ্ক। দ্রষ্টব্য: আপনি অ্যাট্রিবিউশনের জন্য গভীর লিঙ্কগুলি ব্যবহার করতে পারেন। এই FAQ দেখুন | উরি |
অ্যাকশন টেক্সট | ঐচ্ছিক | পুনরায় অর্ডারটিতে বোতামের অ্যাকশন টেক্সট কল (উদাহরণস্বরূপ, আবার অর্ডার করুন )। যদি বিকাশকারী দ্বারা কোনও ক্রিয়া পাঠ্য সরবরাহ না করা হয় তবে পুনরায় অর্ডার ডিফল্ট। এই বৈশিষ্ট্যটি 1.1.0 সংস্করণে সমর্থিত। | স্ট্রিং |
আইটেম সংখ্যা | প্রয়োজন | পূর্ববর্তী ক্রমে আইটেমের সংখ্যা (কেবলমাত্র পণ্যগুলির সংখ্যা নয়)। উদাহরণস্বরূপ: যদি পূর্ববর্তী ক্রমে 3 টি ছোট কফি এবং 1 ক্রোস্যান্ট থাকে তবে এই সংখ্যাটি 4 হওয়া উচিত। | পূর্ণসংখ্যা> = 1 |
শিরোনাম | প্রয়োজন | পুনরায় অর্ডার আইটেমের শিরোনাম। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 40 টি চার্জের অধীন |
আইটেম লেবেল | ঐচ্ছিক (যদি সরবরাহ না করা হয় তবে পোস্টার চিত্রগুলি সরবরাহ করা উচিত) | পূর্ববর্তী ক্রমের জন্য আইটেম লেবেলের তালিকা। অগ্রাধিকারের ক্রমে 10 টি পর্যন্ত লেবেল সরবরাহ করা যেতে পারে; প্রদর্শিত লেবেলের প্রকৃত সংখ্যাটি ডিভাইস ফর্ম ফ্যাক্টরের উপর নির্ভর করে। | বিনামূল্যে পাঠ্যের তালিকা প্রতি লেবেল প্রতি প্রস্তাবিত পাঠ্য আকার: 20 টি চার্জের নীচে (যে পাঠ্যটি খুব দীর্ঘ হয় তা উপবৃত্তগুলি প্রদর্শন করতে পারে) |
পোস্টার ছবি | ঐচ্ছিক (যদি সরবরাহ না করা হয় তবে আইটেম লেবেল সরবরাহ করা উচিত) | পূর্ববর্তী ক্রমে আইটেমগুলির চিত্র। অগ্রাধিকারের ক্রমে 10 টি পর্যন্ত চিত্র সরবরাহ করা যেতে পারে; প্রদর্শিত চিত্রগুলির প্রকৃত সংখ্যাটি ডিভাইস ফর্ম ফ্যাক্টরের উপর নির্ভর করে। | গাইডেন্সের জন্য চিত্রের স্পেসিফিকেশন দেখুন। |
ShoppingOrderTrackingCluster
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
শিরোনাম | প্রয়োজন | প্যাকেজ/আইটেমগুলির একটি সংক্ষিপ্ত শিরোনাম ট্র্যাক করা হচ্ছে বা ট্র্যাকিং নম্বর। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 50 টি চর (পাঠ্য যা খুব দীর্ঘ দীর্ঘ উপবৃত্তগুলি দেখায়) |
অর্ডারের ধরন | প্রয়োজন | প্যাকেজ/আইটেমগুলির একটি সংক্ষিপ্ত শিরোনাম ট্র্যাক করা হচ্ছে বা ট্র্যাকিং নম্বর। | এনুম: in_store_pickup, MAY_DAY_DELIVIRY, মাল্টি_ডে_ডেলিভারি |
স্ট্যাটাস | প্রয়োজন | আদেশের বর্তমান অবস্থা। উদাহরণস্বরূপ: "দেরী", "ট্রানজিট", "বিলম্বিত", "শিপড", "ডেলিভারিড", "স্টকের বাইরে", "অর্ডার রেডি" | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: 25 টি চার্জ (পাঠ্য যা খুব দীর্ঘ দীর্ঘ উপবৃত্তগুলি দেখায়) |
অর্ডার করার সময় | প্রয়োজন | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প যেখানে অর্ডার দেওয়া হয়েছিল। যদি প্রত্যাশিত ডেলিভারি সময় উইন্ডোটি উপস্থিত না থাকে তবে অর্ডার সময় প্রদর্শিত হবে | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
অ্যাকশন ইউআরআই | প্রয়োজন | অংশীদারের অ্যাপে অর্ডার ট্র্যাকিংয়ের গভীর লিঙ্ক। | উরি |
অর্ডারডিলিভারিটাইমওয়াইন্ডো (al চ্ছিক) - অর্ডারটি প্রত্যাশিত/প্রকৃত বিতরণের সময় পর্যন্ত অর্ডার দেওয়ার সময় থেকে ট্র্যাক করা হচ্ছে এমন অর্ডারটির জন্য একটি সময় উইন্ডো সেট করুন। | |||
অর্ডারডেলিভারি টাইমওয়াইন্ডো - সময় শুরু করার সময় | ঐচ্ছিক | মিলিসেকেন্ডে এপোক টাইমস্ট্যাম্প/যার পরে অর্ডারটি সরবরাহ করা হবে বা পিকআপের জন্য প্রস্তুত থাকবে। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
অর্ডারডিলিভারি টাইমওয়াইন্ডো - শেষ সময় | ঐচ্ছিক | মিলিসেকেন্ডে এপোক টাইমস্ট্যাম্প/এর আগে/যার আদেশটি সরবরাহ করা হবে বা পিকআপের জন্য প্রস্তুত থাকবে। | মিলিসেকেন্ডে যুগের টাইমস্ট্যাম্প |
পোস্টার ছবি | ঐচ্ছিক | একটি আইটেম/পণ্যের চিত্র যা ক্রমের অংশ। প্রস্তাবিত দিক অনুপাত 1: 1 | গাইডেন্সের জন্য চিত্রের স্পেসিফিকেশন দেখুন। |
আইটেম সংখ্যা | ঐচ্ছিক | অর্ডার আইটেম সংখ্যা. | পূর্ণসংখ্যা> = 1 |
বর্ণনা | ঐচ্ছিক | ক্রমের আইটেমগুলি বর্ণনা করার জন্য পাঠ্যের একটি একক অনুচ্ছেদ। দ্রষ্টব্য: উভয় বিবরণ বা সাবটাইটেল তালিকা ব্যবহারকারীর কাছে প্রদর্শিত হবে, উভয়ই নয়। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্য আকার: 180 চরগুলি |
সাবটাইটেল তালিকা | ঐচ্ছিক | প্রতিটি সাবটাইটেল সহ 3 টি সাবটাইটেল পর্যন্ত পাঠ্যের একক লাইন। দ্রষ্টব্য: উভয় বিবরণ বা সাবটাইটেল তালিকা ব্যবহারকারীর কাছে প্রদর্শিত হবে, উভয়ই নয়। | বিনামূল্যে পাঠ্য প্রতিটি সাবটাইটেলের জন্য প্রস্তাবিত পাঠ্য আকার: সর্বোচ্চ 50 টি চার্জ |
অর্ডার মান - কারেন্টপ্রাইস | ঐচ্ছিক | আদেশের বর্তমান মান। | বিনামূল্যে পাঠ্য |
অর্ডার নম্বর | ঐচ্ছিক | অর্ডার নম্বর/আইডি যা অর্ডারটি অনন্যভাবে সনাক্ত করতে ব্যবহার করা যেতে পারে। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: সর্বোচ্চ 25 চরগুলি |
ট্র্যাকিং নম্বর | ঐচ্ছিক | অর্ডার/পার্সেল ডেলিভারির জন্য ট্র্যাকিং নম্বরটি যদি অর্ডারটির জন্য সরবরাহের প্রয়োজন হয়। | বিনামূল্যে পাঠ্য প্রস্তাবিত পাঠ্যের আকার: সর্বোচ্চ 25 চরগুলি |
ইমেজ স্পেসিফিকেশন
চিত্রের সম্পদের জন্য প্রয়োজনীয় স্পেসিফিকেশনগুলি নীচে তালিকাভুক্ত করা হয়েছে:
আকৃতির অনুপাত | ন্যূনতম পিক্সেল | প্রস্তাবিত পিক্সেল |
---|---|---|
বর্গক্ষেত্র (1x1) অ বৈশিষ্ট্যযুক্ত ক্লাস্টারগুলির জন্য পছন্দসই | 300x300 | 1200x1200 |
ল্যান্ডস্কেপ (1.91x1) বৈশিষ্ট্যযুক্ত ক্লাস্টারগুলির জন্য পছন্দ | 600x314 | 1200x628 |
প্রতিকৃতি (4x5) | 480x600 | 960x1200 |
ফাইল ফরম্যাট
পিএনজি, জেপিজি, স্ট্যাটিক জিআইএফ, ওয়েবপি
সর্বোচ্চ ফাইলের আকার
5120 KB
অতিরিক্ত সুপারিশ
- চিত্র নিরাপদ অঞ্চল: আপনার গুরুত্বপূর্ণ সামগ্রীটি চিত্রের 80% কেন্দ্রে রাখুন।
- একটি স্বচ্ছ পটভূমি ব্যবহার করুন যাতে চিত্রটি সঠিকভাবে অন্ধকার এবং হালকা থিম সেটিংসে প্রদর্শিত হতে পারে।
পদক্ষেপ 2: ক্লাস্টার ডেটা সরবরাহ করুন
বিষয়বস্তু প্রকাশের কাজটি ব্যাকগ্রাউন্ডে কার্যকর করা (উদাহরণস্বরূপ, ওয়ার্কম্যানেজার ব্যবহার করে) এবং নিয়মিত ভিত্তিতে বা ইভেন্টের ভিত্তিতে নির্ধারিত হওয়ার পরামর্শ দেওয়া হয় (উদাহরণস্বরূপ, প্রতিবার যখন ব্যবহারকারী অ্যাপটি খুলবে বা যখন ব্যবহারকারী কেবল তাদের কার্টে কিছু যুক্ত করেছে)।
AppEngageShoppingClient
শপিং ক্লাস্টার প্রকাশের জন্য দায়ী।
নিম্নলিখিত এপিআইগুলি ক্লায়েন্টে ক্লাস্টার প্রকাশের জন্য প্রকাশিত হয়:
-
isServiceAvailable
-
publishRecommendationClusters
-
publishFeaturedCluster
-
publishShoppingCart
-
publishShoppingCarts
-
publishShoppingList
-
publishShoppingReorderCluster
-
publishShoppingOrderTrackingCluster
-
publishUserAccountManagementRequest
-
updatePublishStatus
-
deleteRecommendationsClusters
-
deleteFeaturedCluster
-
deleteShoppingCartCluster
-
deleteShoppingListCluster
-
deleteShoppingReorderCluster
-
deleteShoppingOrderTrackingCluster
-
deleteUserManagementCluster
-
deleteClusters
isServiceAvailable
এই এপিআইটি পরিষেবাটি সংহতকরণের জন্য উপলব্ধ কিনা এবং সামগ্রীটি ডিভাইসে উপস্থাপন করা যায় কিনা তা পরীক্ষা করতে ব্যবহৃত হয়।
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
এই এপিআই RecommendationCluster
অবজেক্টগুলির একটি তালিকা প্রকাশ করতে ব্যবহৃত হয়।
একটি RecommendationCluster
অবজেক্টের নিম্নলিখিত বৈশিষ্ট্যগুলি থাকতে পারে:
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা |
---|---|---|
শপিংঅ্যান্টিটির তালিকা | প্রয়োজন | এই সুপারিশ ক্লাস্টারের জন্য সুপারিশগুলি তৈরি করে এমন শপিংঅন্টিটি অবজেক্টগুলির একটি তালিকা। |
শিরোনাম | প্রয়োজন | সুপারিশ ক্লাস্টারের জন্য শিরোনাম। প্রস্তাবিত পাঠ্যের আকার: 25 টি চার্জের নীচে (পাঠ্য যা খুব দীর্ঘ দীর্ঘ উপবৃত্তগুলি প্রদর্শন করতে পারে) |
সাবটাইটেল | ঐচ্ছিক | সুপারিশ ক্লাস্টারের জন্য সাবটাইটেল। |
অ্যাকশন ইউআরআই | ঐচ্ছিক | অংশীদার অ্যাপে পৃষ্ঠার গভীর লিঙ্ক যেখানে ব্যবহারকারীরা সুপারিশগুলির সম্পূর্ণ তালিকা দেখতে পারেন। দ্রষ্টব্য: আপনি অ্যাট্রিবিউশনের জন্য গভীর লিঙ্কগুলি ব্যবহার করতে পারেন। এই FAQ দেখুন |
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Black Friday Deals") .build()) .build())
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Black Friday Deals") .build()) .build());
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, তখন নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে ঘটে:
- সমস্ত বিদ্যমান সুপারিশ ক্লাস্টার ডেটা সরানো হয়েছে।
- অনুরোধের ডেটা পার্স করা হয় এবং নতুন সুপারিশ ক্লাস্টারগুলিতে সংরক্ষণ করা হয়।
কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
publishFeaturedCluster
এই এপিআই একটি FeaturedCluster
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়।
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() ... .build()) .build())
client.publishFeaturedCluster( new PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( new FeaturedCluster.Builder() ... .build()) .build());
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, তখন নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে ঘটে:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
FeaturedCluster
ডেটা সরানো হয়েছে। - অনুরোধ থেকে প্রাপ্ত ডেটা পোস্ট করা এবং আপডেট করা বৈশিষ্ট্যযুক্ত ক্লাস্টারে সংরক্ষণ করা হয়।
কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
publishShoppingCart
এই এপিআই একটি ShoppingCartCluster
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়।
client.publishShoppingCart( PublishShoppingCartRequest.Builder() .setShoppingCart( ShoppingCart.Builder() ... .build()) .build())
client.publishShoppingCart( new PublishShoppingCartRequest.Builder() .setShoppingCart( new ShoppingCart.Builder() ... .build()) .build())
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, তখন নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে ঘটে:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
ShoppingCart
ডেটা সরানো হয়েছে। - অনুরোধ থেকে প্রাপ্ত ডেটা পোস্ট করা এবং আপডেট হওয়া শপিং কার্ট ক্লাস্টারে সংরক্ষণ করা হয়।
কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
publishShoppingCarts
এই এপিআই একাধিক ShoppingCart
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়। এটি বিকাশকারী অংশীদার প্রতি বণিকের জন্য পৃথক কার্ট প্রকাশের ক্ষেত্রে প্রযোজ্য। এই এপিআই ব্যবহার করার সময় শিরোনামে বণিকের নাম অন্তর্ভুক্ত করুন।
client.publishShoppingCarts( PublishShoppingCartClustersRequest.Builder() .addShoppingCart( ShoppingCart.Builder() ... .build()) .build())
client.publishShoppingCarts( new PublishShoppingCartClustersRequest.Builder() .addShoppingCart( new ShoppingCart.Builder() ... .build()) .build())
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, তখন নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে ঘটে:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
ShoppingCart
ডেটা সরানো হয়েছে। - অনুরোধ থেকে প্রাপ্ত ডেটা পোস্ট করা এবং আপডেট হওয়া শপিং কার্ট ক্লাস্টারে সংরক্ষণ করা হয়।
কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
publishShoppingList
এই এপিআই একটি FoodShoppingList
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়।
client.publishFoodShoppingList( PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( FoodShoppingListEntity.Builder() ... .build()) .build())
client.publishFoodShoppingList( new PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( new FoodShoppingListEntity.Builder() ... .build()) .build());
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, তখন নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে ঘটে:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
FoodShoppingList
ডেটা সরানো হয়েছে। - অনুরোধ থেকে প্রাপ্ত ডেটা পোস্ট করা এবং আপডেট হওয়া শপিং লিস্ট ক্লাস্টারে সংরক্ষণ করা হয়।
কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
publishShoppingReorderCluster
এই এপিআই একটি ShoppingReorderCluster
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়।
client.publishShoppingReorderCluster( PublishShoppingReorderClusterRequest.Builder() .setReorderCluster( ShoppingReorderCluster.Builder() ... .build()) .build())
client.publishShoppingReorderCluster( new PublishShoppingReorderClusterRequest.Builder() .setReorderCluster( new ShoppingReorderCluster.Builder() ... .build()) .build());
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, তখন নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে ঘটে:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
ShoppingReorderCluster
ডেটা সরানো হয়েছে। - অনুরোধ থেকে প্রাপ্ত ডেটা পোস্ট করা এবং আপডেট হওয়া রিটার্ড ক্লাস্টারে সংরক্ষণ করা হয়।
কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
publishShoppingOrderTrackingCluster
এই এপিআই একটি ShoppingOrderTrackingCluster
অবজেক্ট প্রকাশ করতে ব্যবহৃত হয়।
client.publishShoppingOrderTrackingCluster( PublishShoppingOrderTrackingClusterRequest.Builder() .setShoppingOrderTrackingCluster( ShoppingOrderTrackingCluster.Builder() ... .build()) .build())
client.publishShoppingOrderTrackingCluster( new PublishShoppingOrderTrackingClusterRequest.Builder() .setShoppingOrderTrackingCluster( new ShoppingOrderTrackingCluster.Builder() ... .build()) .build());
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, তখন নিম্নলিখিত ক্রিয়াগুলি একটি লেনদেনের মধ্যে ঘটে:
- বিকাশকারী অংশীদার থেকে বিদ্যমান
ShoppingOrderTrackingCluster
ডেটা সরানো হয়েছে। - অনুরোধ থেকে প্রাপ্ত ডেটা পোস্ট করা এবং আপডেট হওয়া শপিং অর্ডার ট্র্যাকিং ক্লাস্টারে সংরক্ষণ করা হয়।
কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
publishUserAccountManagementRequest
এই এপিআই একটি সাইন ইন কার্ড প্রকাশ করতে ব্যবহৃত হয়। সাইনিন অ্যাকশন ব্যবহারকারীদের অ্যাপ্লিকেশনটির সাইন ইন পৃষ্ঠায় নির্দেশ দেয় যাতে অ্যাপটি সামগ্রী প্রকাশ করতে পারে (বা আরও ব্যক্তিগতকৃত সামগ্রী সরবরাহ করতে পারে)
নিম্নলিখিত মেটাডেটা কার্ড ইন সাইন এর একটি অংশ -
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা |
---|---|---|
অ্যাকশন ইউআরআই | প্রয়োজন | অ্যাকশন থেকে ডিপলিংক (অর্থাত্ অ্যাপ্লিকেশন সাইন ইন পৃষ্ঠায় নেভিগেট করে) |
ছবি | Al চ্ছিক - যদি সরবরাহ না করা হয় তবে শিরোনাম সরবরাহ করতে হবে | চিত্র কার্ডে দেখানো হয়েছে 1264x712 এর রেজোলিউশন সহ 16x9 দিক অনুপাতের চিত্রগুলি |
শিরোনাম | Al চ্ছিক - যদি সরবরাহ না করা হয় তবে চিত্র সরবরাহ করতে হবে | কার্ডে শিরোনাম |
অ্যাকশন টেক্সট | ঐচ্ছিক | সিটিএতে প্রদর্শিত পাঠ্য (অর্থাত্ সাইন ইন) |
সাবটাইটেল | ঐচ্ছিক | কার্ডে al চ্ছিক সাবটাইটেল |
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
ডেটা সরানো হয়েছে। - অনুরোধ থেকে প্রাপ্ত ডেটা পোস্ট করা এবং আপডেট হওয়া ইউজার অ্যাকাউন্টম্যানেজমেন্ট ক্লাস্টার ক্লাস্টারে সংরক্ষণ করা হয়।
কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
updatePublishStatus
যদি কোনও অভ্যন্তরীণ ব্যবসায়ের কারণে, ক্লাস্টারগুলির কোনওটিই প্রকাশিত হয় না, আমরা আপডেট প্রকাশের স্ট্যাটাস এপিআই ব্যবহার করে প্রকাশের স্থিতি আপডেট করার দৃ strongly ়ভাবে পরামর্শ দিই । এটি গুরুত্বপূর্ণ কারণ:
- সমস্ত পরিস্থিতিতে স্থিতি সরবরাহ করা, এমনকি সামগ্রীটি প্রকাশিত হলেও (স্থিতি == প্রকাশিত), ড্যাশবোর্ডগুলি পপুলেট করার জন্য গুরুত্বপূর্ণ যা আপনার সংহতকরণের স্বাস্থ্য এবং অন্যান্য মেট্রিকগুলি জানাতে এই সুস্পষ্ট স্থিতি ব্যবহার করে।
- যদি কোনও সামগ্রী প্রকাশিত না হয় তবে ইন্টিগ্রেশন স্ট্যাটাসটি ভাঙা না হয় (স্থিতি == নট_প্রেড), গুগল অ্যাপ হেলথ ড্যাশবোর্ডগুলিতে ট্রিগার সতর্কতাগুলি এড়াতে পারে। এটি নিশ্চিত করে যে সরবরাহকারীর দৃষ্টিকোণ থেকে প্রত্যাশিত পরিস্থিতির কারণে সামগ্রী প্রকাশিত হয় না।
- এটি বিকাশকারীদের যখন ডেটা প্রকাশিত হয় না তখন অন্তর্দৃষ্টি সরবরাহ করতে সহায়তা করে।
- গুগল অ্যাপটিতে কিছু নির্দিষ্ট ক্রিয়া করতে ব্যবহারকারীকে ন্যাজ করতে স্ট্যাটাস কোডগুলি ব্যবহার করতে পারে যাতে তারা অ্যাপের সামগ্রী দেখতে বা এটি কাটিয়ে উঠতে পারে।
যোগ্য প্রকাশের স্থিতি কোডগুলির তালিকা হ'ল:
// 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
কোনও ব্যবহারকারী লগ ইন না করার কারণে যদি সামগ্রীটি প্রকাশিত না হয় তবে গুগল সাইন ইন কার্ড প্রকাশের পরামর্শ দেবে। যদি কোনও কারণে সরবরাহকারীরা কার্ড ইন সাইনটি প্রকাশ করতে সক্ষম না হন তবে আমরা স্ট্যাটাস কোডটি নট_প্রেসড_আরকিউয়ার্স_সাইন_ইন দিয়ে আপডেটপুব্লিশস্ট্যাটাস এপিআইকে কল করার পরামর্শ দিই
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
এই এপিআই সুপারিশ ক্লাস্টারগুলির সামগ্রী মুছতে ব্যবহৃত হয়।
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, এটি সুপারিশ ক্লাস্টারগুলি থেকে বিদ্যমান ডেটা সরিয়ে দেয়। কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
deleteFeaturedCluster
এই এপিআই বৈশিষ্ট্যযুক্ত ক্লাস্টারের সামগ্রী মুছতে ব্যবহৃত হয়।
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, এটি বৈশিষ্ট্যযুক্ত ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
deleteShoppingCartCluster
এই এপিআই শপিং কার্ট ক্লাস্টারের সামগ্রী মুছতে ব্যবহৃত হয়।
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, এটি শপিং কার্ট ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
deleteShoppingListCluster
এই এপিআই শপিং লিস্ট ক্লাস্টারের সামগ্রী মুছতে ব্যবহৃত হয়।
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, এটি শপিং লিস্ট ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
deleteShoppingReorderCluster
এই এপিআই শপিং রিটার্ড ক্লাস্টারের সামগ্রী মুছতে ব্যবহৃত হয়।
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, তখন এটি শপিং রিটার্ড ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
deleteShoppingOrderTrackingCluster
এই এপিআই শপিং অর্ডার ট্র্যাকিং ক্লাস্টারের সামগ্রী মুছতে ব্যবহৃত হয়।
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, এটি শপিং অর্ডার ট্র্যাকিং ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
deleteUserManagementCluster
এই এপিআই ব্যবহারকারী অ্যাকাউন্ট ম্যানেজমেন্ট ক্লাস্টারের সামগ্রী মুছতে ব্যবহৃত হয়।
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, তখন এটি ব্যবহারকারী অ্যাকাউন্ট ম্যানেজমেন্ট ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
deleteClusters
এই এপিআই প্রদত্ত ক্লাস্টার প্রকারের সামগ্রী মুছতে ব্যবহৃত হয়।
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build())
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build());
পরিষেবাটি যখন অনুরোধটি গ্রহণ করে, এটি নির্দিষ্ট ক্লাস্টারের ধরণের সাথে মিলে সমস্ত ক্লাস্টার থেকে বিদ্যমান ডেটা সরিয়ে দেয়। ক্লায়েন্টরা এক বা একাধিক ক্লাস্টার প্রকার পাস করতে বেছে নিতে পারেন। কোনও ত্রুটির ক্ষেত্রে, পুরো অনুরোধটি প্রত্যাখ্যান করা হয় এবং বিদ্যমান রাষ্ট্রটি বজায় থাকে।
ত্রুটি হ্যান্ডলিং
এপিআই প্রকাশের মাধ্যমে টাস্কের ফলাফলটি শোনার জন্য অত্যন্ত সুপারিশ করা হয় যাতে একটি সফল কাজটি পুনরুদ্ধার এবং পুনরায় জমা দেওয়ার জন্য একটি ফলো-আপ অ্যাকশন নেওয়া যেতে পারে।
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 | পরিষেবা কলটি খুব ঘন ঘন করা হয়। |
পদক্ষেপ 3: সম্প্রচারের উদ্দেশ্যগুলি হ্যান্ডেল করুন
কোনও কাজের মাধ্যমে সামগ্রী এপিআই কলগুলি প্রকাশের পাশাপাশি, কোনও সামগ্রী প্রকাশের জন্য অনুরোধটি পাওয়ার জন্য একটি 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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast // is received // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast // is received // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is // received // Trigger shopping order tracking cluster publish when // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER 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)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Shopping Cart Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART)) // Register Shopping List Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST)) // Register Reorder Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER)) // Register Shopping Order Tracking Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER)) }
class AppEngageBroadcastReceiver extends BroadcastReceiver { // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast is // received // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast is // received // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is // received // Trigger reorder cluster publish when PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER // broadcast is received } public static void registerBroadcastReceivers(Context context) { context = context.getApplicationContext(); // Register Recommendation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Shopping Cart Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART)); // Register Shopping List Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST)); // Register Reorder Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER)); // Register Shopping Order Tracking Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER)); }
- আপনার
AndroidManifest.xml
ফাইলে<receiver>
ট্যাগ সহ স্ট্যাটিকভাবে একটি বাস্তবায়ন ঘোষণা করুন। এটি অ্যাপ্লিকেশনটিকে সম্প্রচারের উদ্দেশ্যগুলি গ্রহণ করার অনুমতি দেয় যখন এটি চলমান না হয় এবং অ্যাপ্লিকেশনটিকে সামগ্রীটি প্রকাশের অনুমতি দেয়।
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER" />
</intent-filter>
</receiver>
</application>
নিম্নলিখিত উদ্দেশ্যগুলি পরিষেবা দ্বারা প্রেরণ করা হয়:
-
com.google.android.engage.action.PUBLISH_RECOMMENDATION
যখন এই উদ্দেশ্যটি প্রাপ্ত হয় তখন একটিpublishRecommendationClusters
কল শুরু করার পরামর্শ দেওয়া হয়। -
com.google.android.engage.action.PUBLISH_FEATURED
এই অভিপ্রায় প্রাপ্ত হলে এটি একটিpublishFeaturedCluster
কল শুরু করার পরামর্শ দেওয়া হয়। -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART
যখন এই উদ্দেশ্যটি প্রাপ্ত হয় তখন একটিpublishShoppingCart
কল শুরু করার পরামর্শ দেওয়া হয়। -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST
যখন এই অভিপ্রায়টি প্রাপ্ত হয় তখন একটিpublishShoppingList
কল শুরু করার পরামর্শ দেওয়া হয়। -
com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER
যখন এই অভিপ্রায়টি প্রাপ্ত হয় তখন একটিpublishReorderCluster
কল শুরু করার পরামর্শ দেওয়া হয়। -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER
যখন এই অভিপ্রায়টি প্রাপ্ত হয় তখন একটিpublishShoppingOrderTrackingCluster
ট্র্যাকিংক্লাস্টার কল শুরু করার পরামর্শ দেওয়া হয়।
ইন্টিগ্রেশন ওয়ার্কফ্লো
এটি সম্পূর্ণ হওয়ার পরে আপনার সংহতকরণ যাচাই করার জন্য ধাপে ধাপে গাইডের জন্য, জড়িত বিকাশকারী ইন্টিগ্রেশন ওয়ার্কফ্লো দেখুন।
FAQs
এনগেজ এসডিকে প্রায়শই জিজ্ঞাসিত প্রশ্নাবলীর জন্য জিজ্ঞাসিত প্রশ্নগুলি দেখুন।
যোগাযোগ
ইন্টিগ্রেশন প্রক্রিয়া চলাকালীন কোনও প্রশ্ন থাকলে এনগেজ-ডেভেলপার্স@google.com এ যোগাযোগ করুন। আমাদের দল যত তাড়াতাড়ি সম্ভব জবাব দেয়।
পরবর্তী পদক্ষেপ
এই সংহতকরণটি শেষ করার পরে, আপনার পরবর্তী পদক্ষেপগুলি নিম্নরূপ:
- এনগেজ-ডেভেলপার্স@google.com এ একটি ইমেল প্রেরণ করুন এবং আপনার ইন্টিগ্রেটেড এপিকে সংযুক্ত করুন যা গুগল দ্বারা পরীক্ষার জন্য প্রস্তুত।
- গুগল একটি যাচাইকরণ সম্পাদন করে এবং ইন্টিগ্রেশনটি প্রত্যাশা অনুযায়ী কাজ করে তা নিশ্চিত করার জন্য অভ্যন্তরীণভাবে পর্যালোচনা করে। যদি পরিবর্তনগুলির প্রয়োজন হয় তবে গুগল আপনাকে কোনও প্রয়োজনীয় বিশদ সহ যোগাযোগ করে।
- যখন পরীক্ষার সম্পূর্ণ হয় এবং কোনও পরিবর্তন প্রয়োজন হয় না, গুগল আপনাকে অবহিত করতে যোগাযোগ করে যে আপনি প্লে স্টোরে আপডেট হওয়া এবং সংহত এপিকে প্রকাশ করা শুরু করতে পারেন।
- গুগল নিশ্চিত করার পরে যে আপনার আপডেট হওয়া এপিকে প্লে স্টোরে প্রকাশিত হয়েছে, আপনার সুপারিশ , বৈশিষ্ট্যযুক্ত , শপিং কার্ট , শপিং লিস্ট , পুনরায় অর্ডার ক্লাস্টার এবং শপিং অর্ডার ট্র্যাকিং ক্লাস্টার ক্লাস্টারগুলি ব্যবহারকারীদের কাছে প্রকাশিত এবং দৃশ্যমান হতে পারে।
গুগল একটি ডিভাইস পৃষ্ঠ তৈরি করছে যা উল্লম্বভাবে ব্যবহারকারীদের অ্যাপ্লিকেশনগুলিকে সংগঠিত করে এবং ব্যক্তিগতকৃত অ্যাপ্লিকেশন সামগ্রী গ্রহণ এবং আবিষ্কারের জন্য একটি নতুন নিমজ্জন অভিজ্ঞতা সক্ষম করে। এই ফুলস্ক্রিন অভিজ্ঞতা বিকাশকারী অংশীদারদের তাদের অ্যাপের বাইরে একটি উত্সর্গীকৃত চ্যানেলে তাদের সেরা সমৃদ্ধ সামগ্রী প্রদর্শন করার সুযোগ সরবরাহ করে।
এই গাইডটিতে বিকাশকারী অংশীদারদের তাদের শপিং সামগ্রী সংহত করার জন্য নির্দেশাবলী রয়েছে, এই নতুন পৃষ্ঠতল অঞ্চল এবং বিনোদন স্থানের মতো বিদ্যমান গুগল পৃষ্ঠতল উভয়কে জনপ্রিয় করতে এনগেজ এসডিকে ব্যবহার করে।
সংহতকরণ বিশদ
পরিভাষা
এই সংহতকরণে নিম্নলিখিত পাঁচটি ক্লাস্টার প্রকার অন্তর্ভুক্ত রয়েছে: সুপারিশ , বৈশিষ্ট্যযুক্ত , শপিং কার্ট , শপিং লিস্ট , পুনরায় অর্ডার এবং শপিং অর্ডার ট্র্যাকিং ।
সুপারিশ ক্লাস্টারগুলি কোনও পৃথক বিকাশকারী অংশীদার থেকে ব্যক্তিগতকৃত শপিংয়ের পরামর্শগুলি দেখায়। এই সুপারিশগুলি ব্যবহারকারীর কাছে ব্যক্তিগতকৃত বা সাধারণীকরণ করা যেতে পারে (উদাহরণস্বরূপ, ট্রেন্ডিং আইটেম)। আপনি উপযুক্ত হিসাবে দেখেন এমন পৃষ্ঠতল পণ্য, ইভেন্ট, বিক্রয়, প্রচার, সাবস্ক্রিপশনগুলিতে এগুলি ব্যবহার করুন।
আপনার সুপারিশগুলি নিম্নলিখিত কাঠামোটি গ্রহণ করে:
প্রস্তাবনা ক্লাস্টার: একটি ইউআই ভিউ যা একই বিকাশকারী অংশীদার থেকে একটি গ্রুপ সুপারিশ রয়েছে।
শপিংঅন্টিটি: একটি ক্লাস্টারে একটি একক আইটেম উপস্থাপন করে এমন একটি বস্তু।
বৈশিষ্ট্যযুক্ত ক্লাস্টারটি একটি ইউআই গ্রুপিংয়ের একাধিক বিকাশকারী অংশীদারদের কাছ থেকে সত্তার একটি নির্বাচন প্রদর্শন করে। এখানে একটি একক বৈশিষ্ট্যযুক্ত ক্লাস্টার থাকবে, যা ইউআইয়ের শীর্ষের কাছে সমস্ত প্রস্তাবনা ক্লাস্টারগুলির উপরে অগ্রাধিকার স্থাপনের সাথে প্রকাশিত হবে। Each developer partner will be allowed to broadcast up to 10 entities in the Featured cluster.
The Shopping Cart cluster shows a sneak peek of shopping carts from many developer partners in one UI grouping, nudging users to complete their outstanding carts. There is a single Shopping Cart cluster, which is surfaced near the top of the UI, with a priority placement above all Recommendation clusters. Each developer partner is allowed to broadcast up to 3
ShoppingCart
instances in the Shopping Cart cluster.Your Shopping Cart takes the following structure:
Shopping Cart Cluster: A UI view that contains a group of shopping cart previews from many developer partners.
ShoppingCart: An object representing the shopping cart preview for a single developer partner, to be displayed in the Shopping Cart cluster. The
ShoppingCart
must show the total count of items in the cart and may also include images for some items in the user's cart.
The Shopping List cluster shows a sneak peek of the shopping lists from multiple developer partners in one UI grouping, prompting users to return to the corresponding app to update and complete their lists. There is a single Shopping List cluster.
The Reorder cluster shows a sneak peek of the previous orders from multiple developer partners in one UI grouping, prompting users to reorder. There is a single Reorder cluster.
Reorder cluster must show the total count of items in the user's previous order and must also include one of the following:
- Images for X items in the user's previous order.
- Labels for X items in the user's previous order.
The Shopping Order Tracking cluster shows a sneak peek of pending or recently completed shopping orders from many developer partners in one UI grouping, allowing users to track their orders.
There is a single ShoppingOrderTracking cluster that is surfaced near the top of the UI, with a priority placement above all Recommendation clusters. Each developer partner is allowed to broadcast multiple ShoppingOrderTrackingEntity items in the Shopping Order Tracking cluster.
Your ShoppingOrderTrackingCluster takes the following structure:
- ShoppingOrderTracking Cluster : A UI view that contains a group of order tracking previews from many developer partners
- ShoppingOrderTrackingEntity : An object representing a shopping order tracking preview for a single developer partner, to be displayed in the Shopping Order Tracking cluster. The ShoppingOrderTrackingEntity must show the status of the order and the order time. We strongly recommend populating the expected delivery time for ShoppingOrderTrackingEntity, as it's displayed to users when provided.
প্রাক কাজ
Minimum API level: 19
Add the com.google.android.engage:engage-core
library to your app:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.5.2'
}
For more information, see Package visibility in Android 11 .
সারাংশ
The design is based on an implementation of a bound service .
The data a client can publish is subject to the following limits for different cluster types:
ক্লাস্টার টাইপ | Cluster limits | Maximum entity limits in a cluster |
---|---|---|
Recommendation Cluster(s) | At most 7 | At most 50 ShoppingEntity |
Featured Cluster | At most 1 | At most 20 ShoppingEntity |
Shopping Cart Cluster | At most 1 | At most 3 ShoppingCart Multiple carts only expected for apps with separate carts per merchant. |
Shopping List Cluster | At most 1 | At most 1 ShoppingListEntity |
Shopping Reorder Cluster | At most 1 | At most 1 ReorderEntity |
Shopping Order Tracking Cluster | সর্বাধিক 3 | At most 3 ShoppingOrderTrackingEntity |
Step 1: Provide entity data
The SDK has defined different entities to represent each item type. The following entities are supported for the Shopping category:
-
ShoppingEntity
-
ShoppingCart
-
ShoppingList
-
Reorder
-
ShoppingOrderTracking
The charts below outline available attributes and requirements for each type.
ShoppingEntity
The ShoppingEntity
object represents a product, promotion, deal, subscription, or event that developer partners want to publish.
ShoppingEntity
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
পোস্টার ছবি | প্রয়োজন | At least one image must be provided. | See Image Specifications for guidance. |
Action Uri | প্রয়োজন | The deep link to the page in the app displaying details about the entity. Note: You can use deep links for attribution. Refer to this FAQ | উরি |
শিরোনাম | ঐচ্ছিক | সত্তার নাম। | বিনামূল্যে পাঠ্য Recommended text size: under 90 chars (Text that is too long may show ellipses) |
Price - current | শর্তসাপেক্ষে প্রয়োজন | The current price of the entity. Must be provided if strikethrough price is provided. | বিনামূল্যে পাঠ্য |
Price - strikethrough | ঐচ্ছিক | The original price of the entity, which is be struck-through in the UI. | বিনামূল্যে পাঠ্য |
কলআউট | ঐচ্ছিক | Callout to feature a promo, event, or update for the entity, if available. | বিনামূল্যে পাঠ্য Recommended text size: under 45 chars (Text that is too long may show ellipses) |
Callout fine print | ঐচ্ছিক | Fine print text for the callout. | বিনামূল্যে পাঠ্য Recommended text size: under 45 chars (Text that is too long may show ellipses) |
Rating (Optional) - Note: All ratings are displayed using our standard star rating system. | |||
Rating - Max value | ঐচ্ছিক | রেটিং স্কেলের সর্বোচ্চ মান। 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 entity. Note: Provide this field if your app controls how the count is displayed to the users. Use a concise string. For example, if the count is 1,000,000, consider using an abbreviation like 1M so that the count isn't truncated on smaller display sizes. | স্ট্রিং |
Rating - Count Value | ঐচ্ছিক | The count of the ratings for the entity. Note: Provide this field if you don't handle the display abbreviation logic yourself. If both Count and Count Value are present, Count is displayed to users. | লম্বা |
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 |
ShoppingCart
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
Action Uri | প্রয়োজন | The deep link to the shopping cart in the partner's app. Note: You can use deep links for attribution. Refer to this FAQ | উরি |
আইটেম সংখ্যা | প্রয়োজন | The number of items (not just number of products) in the shopping cart. For example: If there are 3 identical shirts and 1 hat in the cart, this number should be 4. | Integer >= 1 |
অ্যাকশন টেক্সট | ঐচ্ছিক | The call to action text of the button on the Shopping Cart (for example, Your Shopping Bag ). If no action text is provided by the developer, View Cart is the default. This attribute is supported in version 1.1.0 onwards. | স্ট্রিং |
শিরোনাম | ঐচ্ছিক | The title of the cart (for example, Your Shopping Bag ). If no title is provided by the developer, Your cart is the default. If developer partner publishes a separate cart per merchant, please include merchant name in the title. | বিনামূল্যে পাঠ্য Recommended text size: under 25 chars (Text that is too long may show ellipses) |
Cart images | ঐচ্ছিক | Images of each product in the cart. Up to 10 images can be provided in order of priority; the actual number of images displayed depends on the device form factor. | See Image Specifications for guidance. |
Item labels | ঐচ্ছিক | The list of labels for items on the shopping list. The actual number of labels displayed depends on the device form factor. | List of free text labels Recommended text size: under 20 chars (Text that is too long may show ellipses) |
Last user interaction timestamp | ঐচ্ছিক | Number of milliseconds elapsed from the epoch, identifying the last time when user interacted with the cart. This will be passed as input by the developer partners publishing separate cart per merchant and maybe used for ranking. | Epoch timestamp in milliseconds |
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 |
ShoppingList
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
Action Uri | প্রয়োজন | The deep link to the shopping list in the partner's app. Note: You can use deep links for attribution. Refer to this FAQ | উরি |
আইটেম সংখ্যা | প্রয়োজন | The number of items in the shopping list. | Integer >= 1 |
শিরোনাম | ঐচ্ছিক | The title of the list (for example, Your Grocery List ). If no title is provided by the developer, Shopping list is the default. | বিনামূল্যে পাঠ্য Recommended text size: under 25 chars (Text that is too long may show ellipses) |
Item labels | প্রয়োজন | The list of labels for items on the shopping list. At least 1 label must be provided and up to 10 labels can be provided in order of priority; the actual number of labels displayed depends on the device form factor. | List of free text labels Recommended text size: under 20 chars (Text that is too long may show ellipses) |
ShoppingReorderCluster
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
Action Uri | প্রয়োজন | The deep link to reorder in the partner's app. Note: You can use deep links for attribution. Refer to this FAQ | উরি |
অ্যাকশন টেক্সট | ঐচ্ছিক | The call to action text of the button on the Reorder (for example, Order again ). If no action text is provided by the developer, Reorder is the default. This attribute is supported in version 1.1.0 onwards. | স্ট্রিং |
আইটেম সংখ্যা | প্রয়োজন | The number of items (not just number of products) in the previous order. For example: If there were 3 small coffees and 1 croissant in the previous order, this number should be 4. | Integer >= 1 |
শিরোনাম | প্রয়োজন | The title of the reorder item. | বিনামূল্যে পাঠ্য Recommended text size: under 40 chars (Text that is too long may show ellipses) |
Item labels | ঐচ্ছিক (If not provided, poster images should be provided) | The list of item labels for the previous order. Up to 10 labels can be provided in order of priority; the actual number of labels displayed depends on the device form factor. | List of free text Recommended text size per label: under 20 chars (Text that is too long may show ellipses) |
পোস্টার ছবি | ঐচ্ছিক (If not provided, item labels should be provided) | Images of the items in the previous order. Up to 10 images can be provided in order of priority; the actual number of images displayed depends on the device form factor. | See Image Specifications for guidance. |
ShoppingOrderTrackingCluster
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
শিরোনাম | প্রয়োজন | A short title of the package/items being tracked or the tracking number. | বিনামূল্যে পাঠ্য Recommended text size: 50 chars (Text that is too long will show ellipses) |
অর্ডারের ধরন | প্রয়োজন | A short title of the package/items being tracked or the tracking number. | Enum: IN_STORE_PICKUP, SAME_DAY_DELIVERY, MULTI_DAY_DELIVERY |
স্ট্যাটাস | প্রয়োজন | The current status of the order. For example: "Running late", "In transit", "Delayed", "Shipped", "Delivered", "Out of stock", "Order ready" | বিনামূল্যে পাঠ্য Recommended text size: 25 chars (Text that is too long will show ellipses) |
অর্ডার করার সময় | প্রয়োজন | The epoch timestamp in milliseconds at which the order was placed. Order time will be displayed if expected delivery time window is not present | Epoch timestamp in milliseconds |
Action Uri | প্রয়োজন | Deep link to the order tracking in the partner's app. | উরি |
OrderDeliveryTimeWindow (Optional) - Set a time window for the order that is being tracked from the time the order was placed to the time of expected/actual delivery. | |||
OrderDeliveryTimeWindow - Start Time | ঐচ্ছিক | The epoch timestamp in milliseconds on/after which the order will be delivered or be ready for pickup. | Epoch timestamp in milliseconds |
OrderDeliveryTimeWindow - End Time | ঐচ্ছিক | The epoch timestamp in milliseconds on/before which the order will be delivered or be ready for pickup. | Epoch timestamp in milliseconds |
পোস্টার ছবি | ঐচ্ছিক | Image of one item/product that is part of the order. Recommended aspect ratio is 1:1 | See Image Specifications for guidance. |
আইটেম সংখ্যা | ঐচ্ছিক | অর্ডার আইটেম সংখ্যা. | Integer >= 1 |
বর্ণনা | ঐচ্ছিক | A single paragraph of text to describe the items in the order. Note: Either description or subtitle list will be displayed to the user, not both. | বিনামূল্যে পাঠ্য 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. | বিনামূল্যে পাঠ্য Recommended text size for each subtitle: max 50 chars |
Order Value - CurrentPrice | ঐচ্ছিক | The current value of the order. | বিনামূল্যে পাঠ্য |
অর্ডার নম্বর | ঐচ্ছিক | The order number/ID that can be used to uniquely identify the order. | বিনামূল্যে পাঠ্য Recommended text size: max 25 chars |
ট্র্যাকিং নম্বর | ঐচ্ছিক | The tracking number for the order/parcel delivery in case the order requires a delivery. | বিনামূল্যে পাঠ্য Recommended text size: max 25 chars |
ইমেজ স্পেসিফিকেশন
Required specifications for image assets are listed below:
আকৃতির অনুপাত | ন্যূনতম পিক্সেল | প্রস্তাবিত পিক্সেল |
---|---|---|
বর্গক্ষেত্র (1x1) Preferred for non featured clusters | 300x300 | 1200x1200 |
ল্যান্ডস্কেপ (1.91x1) Preferred for featured clusters | 600x314 | 1200x628 |
Portrait (4x5) | 480x600 | 960x1200 |
ফাইল ফরম্যাট
PNG, JPG, static GIF, WebP
সর্বোচ্চ ফাইলের আকার
5120 KB
অতিরিক্ত সুপারিশ
- 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.
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).
AppEngageShoppingClient
is responsible for publishing shopping clusters.
Following APIs are exposed to publish clusters in the client:
-
isServiceAvailable
-
publishRecommendationClusters
-
publishFeaturedCluster
-
publishShoppingCart
-
publishShoppingCarts
-
publishShoppingList
-
publishShoppingReorderCluster
-
publishShoppingOrderTrackingCluster
-
publishUserAccountManagementRequest
-
updatePublishStatus
-
deleteRecommendationsClusters
-
deleteFeaturedCluster
-
deleteShoppingCartCluster
-
deleteShoppingListCluster
-
deleteShoppingReorderCluster
-
deleteShoppingOrderTrackingCluster
-
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.
A RecommendationCluster
object can have the following attributes:
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা |
---|---|---|
List of ShoppingEntity | প্রয়োজন | A list of ShoppingEntity objects that make up the recommendations for this Recommendation Cluster. |
শিরোনাম | প্রয়োজন | The title for the Recommendation Cluster. Recommended text size: under 25 chars (Text that is too long may show ellipses) |
সাবটাইটেল | ঐচ্ছিক | The subtitle for the Recommendation Cluster. |
Action Uri | ঐচ্ছিক | The deep link to the page in the partner app where users can see the complete list of recommendations. Note: You can use deep links for attribution. Refer to this FAQ |
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Black Friday Deals") .build()) .build())
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Black Friday Deals") .build()) .build());
When the service receives the request, the following actions take place within one transaction:
- All existing Recommendation Cluster data is removed.
- Data from the request is parsed and stored in new Recommendation Clusters.
In case of an error, the entire request is rejected and the existing state is maintained.
publishFeaturedCluster
This API is used to publish a FeaturedCluster
object.
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() ... .build()) .build())
client.publishFeaturedCluster( new PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( new FeaturedCluster.Builder() ... .build()) .build());
When the service receives the request, the following actions take place within one transaction:
- Existing
FeaturedCluster
data 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.
publishShoppingCart
This API is used to publish a ShoppingCartCluster
object.
client.publishShoppingCart( PublishShoppingCartRequest.Builder() .setShoppingCart( ShoppingCart.Builder() ... .build()) .build())
client.publishShoppingCart( new PublishShoppingCartRequest.Builder() .setShoppingCart( new ShoppingCart.Builder() ... .build()) .build())
When the service receives the request, the following actions take place within one transaction:
- Existing
ShoppingCart
data from the developer partner is removed. - Data from the request is parsed and stored in the updated Shopping Cart Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishShoppingCarts
This API is used to publish multiple ShoppingCart
objects. This is applicable to developer partner publishing separate carts per merchant. Include merchant name in the title when using this API.
client.publishShoppingCarts( PublishShoppingCartClustersRequest.Builder() .addShoppingCart( ShoppingCart.Builder() ... .build()) .build())
client.publishShoppingCarts( new PublishShoppingCartClustersRequest.Builder() .addShoppingCart( new ShoppingCart.Builder() ... .build()) .build())
When the service receives the request, the following actions take place within one transaction:
- Existing
ShoppingCart
data from the developer partner is removed. - Data from the request is parsed and stored in the updated Shopping Cart Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishShoppingList
This API is used to publish a FoodShoppingList
object.
client.publishFoodShoppingList( PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( FoodShoppingListEntity.Builder() ... .build()) .build())
client.publishFoodShoppingList( new PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( new FoodShoppingListEntity.Builder() ... .build()) .build());
When the service receives the request, the following actions take place within one transaction:
- Existing
FoodShoppingList
data from the developer partner is removed. - Data from the request is parsed and stored in the updated Shopping List Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishShoppingReorderCluster
This API is used to publish a ShoppingReorderCluster
object.
client.publishShoppingReorderCluster( PublishShoppingReorderClusterRequest.Builder() .setReorderCluster( ShoppingReorderCluster.Builder() ... .build()) .build())
client.publishShoppingReorderCluster( new PublishShoppingReorderClusterRequest.Builder() .setReorderCluster( new ShoppingReorderCluster.Builder() ... .build()) .build());
When the service receives the request, the following actions take place within one transaction:
- Existing
ShoppingReorderCluster
data from the developer partner is removed. - Data from the request is parsed and stored in the updated Reorder Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishShoppingOrderTrackingCluster
This API is used to publish a ShoppingOrderTrackingCluster
object.
client.publishShoppingOrderTrackingCluster( PublishShoppingOrderTrackingClusterRequest.Builder() .setShoppingOrderTrackingCluster( ShoppingOrderTrackingCluster.Builder() ... .build()) .build())
client.publishShoppingOrderTrackingCluster( new PublishShoppingOrderTrackingClusterRequest.Builder() .setShoppingOrderTrackingCluster( new ShoppingOrderTrackingCluster.Builder() ... .build()) .build());
When the service receives the request, the following actions take place within one transaction:
- Existing
ShoppingOrderTrackingCluster
data from the developer partner is removed. - Data from the request is parsed and stored in the updated Shopping Order Tracking 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 -
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা |
---|---|---|
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 |
অ্যাকশন টেক্সট | ঐচ্ছিক | Text Shown on the CTA (ie Sign in) |
সাবটাইটেল | ঐচ্ছিক | 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
UserAccountManagementCluster
data 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.
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.
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.
deleteShoppingCartCluster
This API is used to delete the content of Shopping Cart Cluster.
When the service receives the request, it removes the existing data from the Shopping Cart Cluster. In case of an error, the entire request is rejected and the existing state is maintained.
deleteShoppingListCluster
This API is used to delete the content of Shopping List Cluster.
When the service receives the request, it removes the existing data from the Shopping List Cluster. In case of an error, the entire request is rejected and the existing state is maintained.
deleteShoppingReorderCluster
This API is used to delete the content of Shopping Reorder Cluster.
When the service receives the request, it removes the existing data from the Shopping Reorder Cluster. In case of an error, the entire request is rejected and the existing state is maintained.
deleteShoppingOrderTrackingCluster
This API is used to delete the content of Shopping Order Tracking Cluster.
When the service receives the request, it removes the existing data from the Shopping Order Tracking 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.
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.
deleteClusters
This API is used to delete the content of a given cluster type.
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build())
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build());
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.
ত্রুটি কোড | ত্রুটির নাম | দ্রষ্টব্য |
---|---|---|
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
BroadcastReceiver
class 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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast // is received // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast // is received // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is // received // Trigger shopping order tracking cluster publish when // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER 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)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Shopping Cart Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART)) // Register Shopping List Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST)) // Register Reorder Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER)) // Register Shopping Order Tracking Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER)) }
class AppEngageBroadcastReceiver extends BroadcastReceiver { // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast is // received // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast is // received // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is // received // Trigger reorder cluster publish when PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER // broadcast is received } public static void registerBroadcastReceivers(Context context) { context = context.getApplicationContext(); // Register Recommendation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Shopping Cart Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART)); // Register Shopping List Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST)); // Register Reorder Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER)); // Register Shopping Order Tracking Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER)); }
- Statically declare an implementation with the
<receiver>
tag in yourAndroidManifest.xml
file. 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: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.shopping.PUBLISH_SHOPPING_CART" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER" />
</intent-filter>
</receiver>
</application>
The following intents are sent by the service:
-
com.google.android.engage.action.PUBLISH_RECOMMENDATION
It is recommended to start apublishRecommendationClusters
call when this intent is received. -
com.google.android.engage.action.PUBLISH_FEATURED
It is recommended to start apublishFeaturedCluster
call when this intent is received. -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART
It is recommended to start apublishShoppingCart
call when this intent is received. -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST
It is recommended to start apublishShoppingList
call when this intent is received. -
com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER
It is recommended to start apublishReorderCluster
call when this intent is received. -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER
It is recommended to start apublishShoppingOrderTrackingCluster
call when this intent is received.
Integration workflow
For a step-by-step guide on verifying your integration after it is complete, see Engage developer integration workflow .
FAQs
See Engage SDK Frequently Asked Questions for FAQs.
যোগাযোগ
Contact engage-developers@google.com if there are any questions during the integration process. Our team replies as soon as possible.
পরবর্তী পদক্ষেপ
After completing this integration, your next steps are as follows:
- Send an email to engage-developers@google.com and 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 , Shopping Cart , Shopping List , Reorder Cluster and Shopping Order Tracking Cluster clusters may be published and visible to users.
Google is building an on-device surface that organizes users' apps by verticals and enables a new immersive experience for personalized app content consumption and discovery. This fullscreen experience provides developer partners with an opportunity to showcase their best rich content in a dedicated channel outside of their app.
This guide contains instructions for developer partners to integrate their shopping content, using the Engage SDK to populate both this new surface area and existing Google surfaces like Entertainment Space.
Integration detail
পরিভাষা
This integration includes the following five cluster types: Recommendation , Featured , Shopping Cart , Shopping List , Reorder and Shopping Order Tracking .
Recommendation clusters show personalized shopping suggestions from an individual developer partner. These recommendations can be personalized to the user or generalized (for example, trending items). Use these to surface products, events, sales, promos, subscriptions as you see fit.
Your recommendations take the following structure:
Recommendation Cluster: A UI view that contains a group of recommendations from the same developer partner.
ShoppingEntity: An object representing a single item in a cluster.
The Featured cluster showcases a selection of entities from multiple developer partners in one UI grouping. There will be a single Featured cluster, which is surfaced near the top of the UI with a priority placement above all Recommendation clusters. Each developer partner will be allowed to broadcast up to 10 entities in the Featured cluster.
The Shopping Cart cluster shows a sneak peek of shopping carts from many developer partners in one UI grouping, nudging users to complete their outstanding carts. There is a single Shopping Cart cluster, which is surfaced near the top of the UI, with a priority placement above all Recommendation clusters. Each developer partner is allowed to broadcast up to 3
ShoppingCart
instances in the Shopping Cart cluster.Your Shopping Cart takes the following structure:
Shopping Cart Cluster: A UI view that contains a group of shopping cart previews from many developer partners.
ShoppingCart: An object representing the shopping cart preview for a single developer partner, to be displayed in the Shopping Cart cluster. The
ShoppingCart
must show the total count of items in the cart and may also include images for some items in the user's cart.
The Shopping List cluster shows a sneak peek of the shopping lists from multiple developer partners in one UI grouping, prompting users to return to the corresponding app to update and complete their lists. There is a single Shopping List cluster.
The Reorder cluster shows a sneak peek of the previous orders from multiple developer partners in one UI grouping, prompting users to reorder. There is a single Reorder cluster.
Reorder cluster must show the total count of items in the user's previous order and must also include one of the following:
- Images for X items in the user's previous order.
- Labels for X items in the user's previous order.
The Shopping Order Tracking cluster shows a sneak peek of pending or recently completed shopping orders from many developer partners in one UI grouping, allowing users to track their orders.
There is a single ShoppingOrderTracking cluster that is surfaced near the top of the UI, with a priority placement above all Recommendation clusters. Each developer partner is allowed to broadcast multiple ShoppingOrderTrackingEntity items in the Shopping Order Tracking cluster.
Your ShoppingOrderTrackingCluster takes the following structure:
- ShoppingOrderTracking Cluster : A UI view that contains a group of order tracking previews from many developer partners
- ShoppingOrderTrackingEntity : An object representing a shopping order tracking preview for a single developer partner, to be displayed in the Shopping Order Tracking cluster. The ShoppingOrderTrackingEntity must show the status of the order and the order time. We strongly recommend populating the expected delivery time for ShoppingOrderTrackingEntity, as it's displayed to users when provided.
প্রাক কাজ
Minimum API level: 19
Add the com.google.android.engage:engage-core
library to your app:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.5.2'
}
For more information, see Package visibility in Android 11 .
সারাংশ
The design is based on an implementation of a bound service .
The data a client can publish is subject to the following limits for different cluster types:
ক্লাস্টার টাইপ | Cluster limits | Maximum entity limits in a cluster |
---|---|---|
Recommendation Cluster(s) | At most 7 | At most 50 ShoppingEntity |
Featured Cluster | At most 1 | At most 20 ShoppingEntity |
Shopping Cart Cluster | At most 1 | At most 3 ShoppingCart Multiple carts only expected for apps with separate carts per merchant. |
Shopping List Cluster | At most 1 | At most 1 ShoppingListEntity |
Shopping Reorder Cluster | At most 1 | At most 1 ReorderEntity |
Shopping Order Tracking Cluster | সর্বাধিক 3 | At most 3 ShoppingOrderTrackingEntity |
Step 1: Provide entity data
The SDK has defined different entities to represent each item type. The following entities are supported for the Shopping category:
-
ShoppingEntity
-
ShoppingCart
-
ShoppingList
-
Reorder
-
ShoppingOrderTracking
The charts below outline available attributes and requirements for each type.
ShoppingEntity
The ShoppingEntity
object represents a product, promotion, deal, subscription, or event that developer partners want to publish.
ShoppingEntity
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
পোস্টার ছবি | প্রয়োজন | At least one image must be provided. | See Image Specifications for guidance. |
Action Uri | প্রয়োজন | The deep link to the page in the app displaying details about the entity. Note: You can use deep links for attribution. Refer to this FAQ | উরি |
শিরোনাম | ঐচ্ছিক | সত্তার নাম। | বিনামূল্যে পাঠ্য Recommended text size: under 90 chars (Text that is too long may show ellipses) |
Price - current | শর্তসাপেক্ষে প্রয়োজন | The current price of the entity. Must be provided if strikethrough price is provided. | বিনামূল্যে পাঠ্য |
Price - strikethrough | ঐচ্ছিক | The original price of the entity, which is be struck-through in the UI. | বিনামূল্যে পাঠ্য |
কলআউট | ঐচ্ছিক | Callout to feature a promo, event, or update for the entity, if available. | বিনামূল্যে পাঠ্য Recommended text size: under 45 chars (Text that is too long may show ellipses) |
Callout fine print | ঐচ্ছিক | Fine print text for the callout. | বিনামূল্যে পাঠ্য Recommended text size: under 45 chars (Text that is too long may show ellipses) |
Rating (Optional) - Note: All ratings are displayed using our standard star rating system. | |||
Rating - Max value | ঐচ্ছিক | রেটিং স্কেলের সর্বোচ্চ মান। 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 entity. Note: Provide this field if your app controls how the count is displayed to the users. Use a concise string. For example, if the count is 1,000,000, consider using an abbreviation like 1M so that the count isn't truncated on smaller display sizes. | স্ট্রিং |
Rating - Count Value | ঐচ্ছিক | The count of the ratings for the entity. Note: Provide this field if you don't handle the display abbreviation logic yourself. If both Count and Count Value are present, Count is displayed to users. | লম্বা |
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 |
ShoppingCart
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
Action Uri | প্রয়োজন | The deep link to the shopping cart in the partner's app. Note: You can use deep links for attribution. Refer to this FAQ | উরি |
আইটেম সংখ্যা | প্রয়োজন | The number of items (not just number of products) in the shopping cart. For example: If there are 3 identical shirts and 1 hat in the cart, this number should be 4. | Integer >= 1 |
অ্যাকশন টেক্সট | ঐচ্ছিক | The call to action text of the button on the Shopping Cart (for example, Your Shopping Bag ). If no action text is provided by the developer, View Cart is the default. This attribute is supported in version 1.1.0 onwards. | স্ট্রিং |
শিরোনাম | ঐচ্ছিক | The title of the cart (for example, Your Shopping Bag ). If no title is provided by the developer, Your cart is the default. If developer partner publishes a separate cart per merchant, please include merchant name in the title. | বিনামূল্যে পাঠ্য Recommended text size: under 25 chars (Text that is too long may show ellipses) |
Cart images | ঐচ্ছিক | Images of each product in the cart. Up to 10 images can be provided in order of priority; the actual number of images displayed depends on the device form factor. | See Image Specifications for guidance. |
Item labels | ঐচ্ছিক | The list of labels for items on the shopping list. The actual number of labels displayed depends on the device form factor. | List of free text labels Recommended text size: under 20 chars (Text that is too long may show ellipses) |
Last user interaction timestamp | ঐচ্ছিক | Number of milliseconds elapsed from the epoch, identifying the last time when user interacted with the cart. This will be passed as input by the developer partners publishing separate cart per merchant and maybe used for ranking. | Epoch timestamp in milliseconds |
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 |
ShoppingList
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
Action Uri | প্রয়োজন | The deep link to the shopping list in the partner's app. Note: You can use deep links for attribution. Refer to this FAQ | উরি |
আইটেম সংখ্যা | প্রয়োজন | The number of items in the shopping list. | Integer >= 1 |
শিরোনাম | ঐচ্ছিক | The title of the list (for example, Your Grocery List ). If no title is provided by the developer, Shopping list is the default. | বিনামূল্যে পাঠ্য Recommended text size: under 25 chars (Text that is too long may show ellipses) |
Item labels | প্রয়োজন | The list of labels for items on the shopping list. At least 1 label must be provided and up to 10 labels can be provided in order of priority; the actual number of labels displayed depends on the device form factor. | List of free text labels Recommended text size: under 20 chars (Text that is too long may show ellipses) |
ShoppingReorderCluster
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
Action Uri | প্রয়োজন | The deep link to reorder in the partner's app. Note: You can use deep links for attribution. Refer to this FAQ | উরি |
অ্যাকশন টেক্সট | ঐচ্ছিক | The call to action text of the button on the Reorder (for example, Order again ). If no action text is provided by the developer, Reorder is the default. This attribute is supported in version 1.1.0 onwards. | স্ট্রিং |
আইটেম সংখ্যা | প্রয়োজন | The number of items (not just number of products) in the previous order. For example: If there were 3 small coffees and 1 croissant in the previous order, this number should be 4. | Integer >= 1 |
শিরোনাম | প্রয়োজন | The title of the reorder item. | বিনামূল্যে পাঠ্য Recommended text size: under 40 chars (Text that is too long may show ellipses) |
Item labels | ঐচ্ছিক (If not provided, poster images should be provided) | The list of item labels for the previous order. Up to 10 labels can be provided in order of priority; the actual number of labels displayed depends on the device form factor. | List of free text Recommended text size per label: under 20 chars (Text that is too long may show ellipses) |
পোস্টার ছবি | ঐচ্ছিক (If not provided, item labels should be provided) | Images of the items in the previous order. Up to 10 images can be provided in order of priority; the actual number of images displayed depends on the device form factor. | See Image Specifications for guidance. |
ShoppingOrderTrackingCluster
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা | বিন্যাস |
---|---|---|---|
শিরোনাম | প্রয়োজন | A short title of the package/items being tracked or the tracking number. | বিনামূল্যে পাঠ্য Recommended text size: 50 chars (Text that is too long will show ellipses) |
অর্ডারের ধরন | প্রয়োজন | A short title of the package/items being tracked or the tracking number. | Enum: IN_STORE_PICKUP, SAME_DAY_DELIVERY, MULTI_DAY_DELIVERY |
স্ট্যাটাস | প্রয়োজন | The current status of the order. For example: "Running late", "In transit", "Delayed", "Shipped", "Delivered", "Out of stock", "Order ready" | বিনামূল্যে পাঠ্য Recommended text size: 25 chars (Text that is too long will show ellipses) |
অর্ডার করার সময় | প্রয়োজন | The epoch timestamp in milliseconds at which the order was placed. Order time will be displayed if expected delivery time window is not present | Epoch timestamp in milliseconds |
Action Uri | প্রয়োজন | Deep link to the order tracking in the partner's app. | উরি |
OrderDeliveryTimeWindow (Optional) - Set a time window for the order that is being tracked from the time the order was placed to the time of expected/actual delivery. | |||
OrderDeliveryTimeWindow - Start Time | ঐচ্ছিক | The epoch timestamp in milliseconds on/after which the order will be delivered or be ready for pickup. | Epoch timestamp in milliseconds |
OrderDeliveryTimeWindow - End Time | ঐচ্ছিক | The epoch timestamp in milliseconds on/before which the order will be delivered or be ready for pickup. | Epoch timestamp in milliseconds |
পোস্টার ছবি | ঐচ্ছিক | Image of one item/product that is part of the order. Recommended aspect ratio is 1:1 | See Image Specifications for guidance. |
আইটেম সংখ্যা | ঐচ্ছিক | অর্ডার আইটেম সংখ্যা. | Integer >= 1 |
বর্ণনা | ঐচ্ছিক | A single paragraph of text to describe the items in the order. Note: Either description or subtitle list will be displayed to the user, not both. | বিনামূল্যে পাঠ্য 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. | বিনামূল্যে পাঠ্য Recommended text size for each subtitle: max 50 chars |
Order Value - CurrentPrice | ঐচ্ছিক | The current value of the order. | বিনামূল্যে পাঠ্য |
অর্ডার নম্বর | ঐচ্ছিক | The order number/ID that can be used to uniquely identify the order. | বিনামূল্যে পাঠ্য Recommended text size: max 25 chars |
ট্র্যাকিং নম্বর | ঐচ্ছিক | The tracking number for the order/parcel delivery in case the order requires a delivery. | বিনামূল্যে পাঠ্য Recommended text size: max 25 chars |
ইমেজ স্পেসিফিকেশন
Required specifications for image assets are listed below:
আকৃতির অনুপাত | ন্যূনতম পিক্সেল | প্রস্তাবিত পিক্সেল |
---|---|---|
বর্গক্ষেত্র (1x1) Preferred for non featured clusters | 300x300 | 1200x1200 |
ল্যান্ডস্কেপ (1.91x1) Preferred for featured clusters | 600x314 | 1200x628 |
Portrait (4x5) | 480x600 | 960x1200 |
ফাইল ফরম্যাট
PNG, JPG, static GIF, WebP
সর্বোচ্চ ফাইলের আকার
5120 KB
অতিরিক্ত সুপারিশ
- 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.
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).
AppEngageShoppingClient
is responsible for publishing shopping clusters.
Following APIs are exposed to publish clusters in the client:
-
isServiceAvailable
-
publishRecommendationClusters
-
publishFeaturedCluster
-
publishShoppingCart
-
publishShoppingCarts
-
publishShoppingList
-
publishShoppingReorderCluster
-
publishShoppingOrderTrackingCluster
-
publishUserAccountManagementRequest
-
updatePublishStatus
-
deleteRecommendationsClusters
-
deleteFeaturedCluster
-
deleteShoppingCartCluster
-
deleteShoppingListCluster
-
deleteShoppingReorderCluster
-
deleteShoppingOrderTrackingCluster
-
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.
A RecommendationCluster
object can have the following attributes:
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা |
---|---|---|
List of ShoppingEntity | প্রয়োজন | A list of ShoppingEntity objects that make up the recommendations for this Recommendation Cluster. |
শিরোনাম | প্রয়োজন | The title for the Recommendation Cluster. Recommended text size: under 25 chars (Text that is too long may show ellipses) |
সাবটাইটেল | ঐচ্ছিক | The subtitle for the Recommendation Cluster. |
Action Uri | ঐচ্ছিক | The deep link to the page in the partner app where users can see the complete list of recommendations. Note: You can use deep links for attribution. Refer to this FAQ |
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Black Friday Deals") .build()) .build())
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Black Friday Deals") .build()) .build());
When the service receives the request, the following actions take place within one transaction:
- All existing Recommendation Cluster data is removed.
- Data from the request is parsed and stored in new Recommendation Clusters.
In case of an error, the entire request is rejected and the existing state is maintained.
publishFeaturedCluster
This API is used to publish a FeaturedCluster
object.
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() ... .build()) .build())
client.publishFeaturedCluster( new PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( new FeaturedCluster.Builder() ... .build()) .build());
When the service receives the request, the following actions take place within one transaction:
- Existing
FeaturedCluster
data 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.
publishShoppingCart
This API is used to publish a ShoppingCartCluster
object.
client.publishShoppingCart( PublishShoppingCartRequest.Builder() .setShoppingCart( ShoppingCart.Builder() ... .build()) .build())
client.publishShoppingCart( new PublishShoppingCartRequest.Builder() .setShoppingCart( new ShoppingCart.Builder() ... .build()) .build())
When the service receives the request, the following actions take place within one transaction:
- Existing
ShoppingCart
data from the developer partner is removed. - Data from the request is parsed and stored in the updated Shopping Cart Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishShoppingCarts
This API is used to publish multiple ShoppingCart
objects. This is applicable to developer partner publishing separate carts per merchant. Include merchant name in the title when using this API.
client.publishShoppingCarts( PublishShoppingCartClustersRequest.Builder() .addShoppingCart( ShoppingCart.Builder() ... .build()) .build())
client.publishShoppingCarts( new PublishShoppingCartClustersRequest.Builder() .addShoppingCart( new ShoppingCart.Builder() ... .build()) .build())
When the service receives the request, the following actions take place within one transaction:
- Existing
ShoppingCart
data from the developer partner is removed. - Data from the request is parsed and stored in the updated Shopping Cart Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishShoppingList
This API is used to publish a FoodShoppingList
object.
client.publishFoodShoppingList( PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( FoodShoppingListEntity.Builder() ... .build()) .build())
client.publishFoodShoppingList( new PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( new FoodShoppingListEntity.Builder() ... .build()) .build());
When the service receives the request, the following actions take place within one transaction:
- Existing
FoodShoppingList
data from the developer partner is removed. - Data from the request is parsed and stored in the updated Shopping List Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishShoppingReorderCluster
This API is used to publish a ShoppingReorderCluster
object.
client.publishShoppingReorderCluster( PublishShoppingReorderClusterRequest.Builder() .setReorderCluster( ShoppingReorderCluster.Builder() ... .build()) .build())
client.publishShoppingReorderCluster( new PublishShoppingReorderClusterRequest.Builder() .setReorderCluster( new ShoppingReorderCluster.Builder() ... .build()) .build());
When the service receives the request, the following actions take place within one transaction:
- Existing
ShoppingReorderCluster
data from the developer partner is removed. - Data from the request is parsed and stored in the updated Reorder Cluster.
In case of an error, the entire request is rejected and the existing state is maintained.
publishShoppingOrderTrackingCluster
This API is used to publish a ShoppingOrderTrackingCluster
object.
client.publishShoppingOrderTrackingCluster( PublishShoppingOrderTrackingClusterRequest.Builder() .setShoppingOrderTrackingCluster( ShoppingOrderTrackingCluster.Builder() ... .build()) .build())
client.publishShoppingOrderTrackingCluster( new PublishShoppingOrderTrackingClusterRequest.Builder() .setShoppingOrderTrackingCluster( new ShoppingOrderTrackingCluster.Builder() ... .build()) .build());
When the service receives the request, the following actions take place within one transaction:
- Existing
ShoppingOrderTrackingCluster
data from the developer partner is removed. - Data from the request is parsed and stored in the updated Shopping Order Tracking 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 -
বৈশিষ্ট্য | প্রয়োজনীয়তা | বর্ণনা |
---|---|---|
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 |
অ্যাকশন টেক্সট | ঐচ্ছিক | Text Shown on the CTA (ie Sign in) |
সাবটাইটেল | ঐচ্ছিক | 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
UserAccountManagementCluster
data 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.
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.
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.
deleteShoppingCartCluster
This API is used to delete the content of Shopping Cart Cluster.
When the service receives the request, it removes the existing data from the Shopping Cart Cluster. In case of an error, the entire request is rejected and the existing state is maintained.
deleteShoppingListCluster
This API is used to delete the content of Shopping List Cluster.
When the service receives the request, it removes the existing data from the Shopping List Cluster. In case of an error, the entire request is rejected and the existing state is maintained.
deleteShoppingReorderCluster
This API is used to delete the content of Shopping Reorder Cluster.
When the service receives the request, it removes the existing data from the Shopping Reorder Cluster. In case of an error, the entire request is rejected and the existing state is maintained.
deleteShoppingOrderTrackingCluster
This API is used to delete the content of Shopping Order Tracking Cluster.
When the service receives the request, it removes the existing data from the Shopping Order Tracking 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.
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.
deleteClusters
This API is used to delete the content of a given cluster type.
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build())
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build());
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.
ত্রুটি কোড | ত্রুটির নাম | দ্রষ্টব্য |
---|---|---|
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
BroadcastReceiver
class 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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast // is received // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast // is received // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is // received // Trigger shopping order tracking cluster publish when // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER 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)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Shopping Cart Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART)) // Register Shopping List Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST)) // Register Reorder Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER)) // Register Shopping Order Tracking Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER)) }
class AppEngageBroadcastReceiver extends BroadcastReceiver { // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast is // received // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast is // received // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is // received // Trigger reorder cluster publish when PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER // broadcast is received } public static void registerBroadcastReceivers(Context context) { context = context.getApplicationContext(); // Register Recommendation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Shopping Cart Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART)); // Register Shopping List Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST)); // Register Reorder Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER)); // Register Shopping Order Tracking Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER)); }
- Statically declare an implementation with the
<receiver>
tag in yourAndroidManifest.xml
file. 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: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.shopping.PUBLISH_SHOPPING_CART" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER" />
</intent-filter>
</receiver>
</application>
The following intents are sent by the service:
-
com.google.android.engage.action.PUBLISH_RECOMMENDATION
It is recommended to start apublishRecommendationClusters
call when this intent is received. -
com.google.android.engage.action.PUBLISH_FEATURED
It is recommended to start apublishFeaturedCluster
call when this intent is received. -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART
It is recommended to start apublishShoppingCart
call when this intent is received. -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST
It is recommended to start apublishShoppingList
call when this intent is received. -
com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER
It is recommended to start apublishReorderCluster
call when this intent is received. -
com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER
It is recommended to start apublishShoppingOrderTrackingCluster
call when this intent is received.
Integration workflow
For a step-by-step guide on verifying your integration after it is complete, see Engage developer integration workflow .
FAQs
See Engage SDK Frequently Asked Questions for FAQs.
যোগাযোগ
Contact engage-developers@google.com if there are any questions during the integration process. Our team replies as soon as possible.
পরবর্তী পদক্ষেপ
After completing this integration, your next steps are as follows:
- Send an email to engage-developers@google.com and 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 , Shopping Cart , Shopping List , Reorder Cluster and Shopping Order Tracking Cluster clusters may be published and visible to users.