इस गाइड में, डेवलपर के लिए निर्देश दिए गए हैं. इनमें बताया गया है कि Engage SDK का इस्तेमाल करके, सुझाए गए वीडियो कॉन्टेंट को Google के प्लैटफ़ॉर्म पर कैसे इंटिग्रेट किया जा सकता है. जैसे, टीवी, फ़ोन, और टैबलेट. ऐसा करने से, इन प्लैटफ़ॉर्म पर लोगों को उनकी दिलचस्पी के हिसाब से सुझाव दिखेंगे.
सुझाव दिखाने के लिए, सुझाव क्लस्टर का इस्तेमाल किया जाता है. इसकी मदद से, एक ही यूज़र इंटरफ़ेस (यूआई) ग्रुपिंग में, कई ऐप्लिकेशन से फ़िल्में और टीवी शो दिखाए जा सकते हैं. हर डेवलपर पार्टनर, सुझावों के हर क्लस्टर में ज़्यादा से ज़्यादा 25 इकाइयां ब्रॉडकास्ट कर सकता है. साथ ही, हर अनुरोध के लिए, ज़्यादा से ज़्यादा सात सुझाव क्लस्टर हो सकते हैं.
सेशन की तैयारी
शुरुआती निर्देश वाली गाइड में, सेशन की तैयारी के निर्देशों को पूरा करें.
- फ़ोरग्राउंड सेवा पर पब्लिशिंग की प्रोसेस पूरी करें.
- सुझावों का डेटा, दिन में ज़्यादा से ज़्यादा एक बार पब्लिश करें. यह डेटा, इनमें से किसी एक वजह से पब्लिश किया जा सकता है:
- उपयोगकर्ता का दिन में पहली बार लॉग इन करना. (या)
- उपयोगकर्ता का ऐप्लिकेशन के साथ इंटरैक्ट करना शुरू करना.
इंटिग्रेशन
AppEngagePublishClient, सुझाव क्लस्टर को पब्लिश करता है. सुझावों का ऑब्जेक्ट पब्लिश करने के लिए, publishRecommendationClusters तरीके का इस्तेमाल करें.
client.publishRecommendationClusters(recommendationRequest)
सुझाव क्लस्टर को अपसर्ट करना
क्लस्टर, इकाइयों की लॉजिकल ग्रुपिंग होती है. कोड के इन उदाहरणों में बताया गया है कि अपनी पसंद के हिसाब से क्लस्टर कैसे बनाए जा सकते हैं. साथ ही, पब्लिश करने का अनुरोध कैसे बनाया जा सकता है और सभी क्लस्टर को अपसर्ट कैसे किया जा सकता है.
RecommendationClusterType से तय होता है कि
क्लस्टर कैसे दिखेगा.
// cluster for popular movies
val recommendationCluster1 = RecommendationCluster
.Builder()
.addEntity(movie1)
.addEntity(movie2)
.addEntity(movie3)
.addEntity(movie4)
.addEntity(tvShow)
// This cluster is meant to be used as an individual provider row
.setRecommendationClusterType(TYPE_PROVIDER_ROW)
.setTitle("Popular Movies")
.build()
// cluster for live TV programs
val recommendationCluster2 = RecommendationCluster
.Builder()
.addEntity(liveTvProgramEntity1)
.addEntity(liveTvProgramEntity2)
.addEntity(liveTvProgramEntity3)
.addEntity(liveTvProgramEntity4)
.addEntity(liveTvProgramEntity5)
// This cluster is meant to be used as an individual provider row
.setRecommendationClusterType(TYPE_PROVIDER_ROW)
.setTitle("Popular Live TV Programs")
.build()
// creating a publishing request
val recommendationRequest = PublishRecommendationClustersRequest
.Builder()
.setSyncAcrossDevices(true)
.setAccountProfile(accountProfile)
.addRecommendationCluster(recommendationCluster1)
.addRecommendationCluster(recommendationCluster2)
.build()
सेवा को अनुरोध मिलने पर, एक ही लेन-देन में ये कार्रवाइयां होती हैं:
- डेवलपर पार्टनर का मौजूदा
RecommendationsClusterडेटा हटा दिया जाता है. - अनुरोध से मिले डेटा को पार्स करके, अपडेट किए गए
RecommendationsClusterमें सेव किया जाता है. गड़बड़ी होने पर, पूरे अनुरोध को अस्वीकार कर दिया जाता है और मौजूदा स्थिति बनी रहती है.
क्रॉस-डिवाइस सिंक
SyncAcrossDevices फ़्लैग से कंट्रोल किया जाता है कि उपयोगकर्ता के सुझाव क्लस्टर का डेटा, Google TV के साथ शेयर किया जाए या नहीं. साथ ही, इससे यह भी तय होता है कि यह डेटा, टीवी, फ़ोन, टैबलेट जैसे उसके डिवाइसों पर उपलब्ध हो या नहीं. सुझाव की सुविधा काम करे, इसके लिए इसे 'सही' पर सेट करना ज़रूरी है.
सहमति लेना
मीडिया ऐप्लिकेशन में, क्रॉस-डिवाइस सिंक करने की सुविधा को चालू या बंद करने के लिए, साफ़ तौर पर सेटिंग उपलब्ध होनी चाहिए. उपयोगकर्ता को इस सुविधा के फ़ायदों के बारे में बताएं. साथ ही, उपयोगकर्ता की पसंद को एक बार सेव करें और publishRecommendations अनुरोध में उसके मुताबिक सेटिंग लागू करें. क्रॉस-डिवाइस सुविधा का ज़्यादा से ज़्यादा फ़ायदा पाने के लिए, पुष्टि करें कि ऐप्लिकेशन को उपयोगकर्ता की सहमति मिली हो और SyncAcrossDevices को true पर सेट किया गया हो.
Engage का डेटा मिटाना
Google TV के सर्वर से, उपयोगकर्ता का डेटा मैन्युअल तरीके से मिटाने के लिए, client.deleteClusters() तरीके का इस्तेमाल करें. डेटा को 60 दिनों तक सेव रखने की सामान्य अवधि से पहले भी मिटाया जा सकता है. अनुरोध मिलने पर, सेवा खाते की प्रोफ़ाइल या पूरे खाते के लिए, Engage का मौजूदा सारा डेटा मिटा देती है.
The DeleteReason एनम से, डेटा मिटाने की वजह तय होती है.
यहां दिया गया कोड, लॉग आउट करने पर सुझावों को हटाता है.
// If the user logs out from your media app, you must make the following call
// to remove recommendations data from the current Google TV device, otherwise,
// the recommendations data persists on the current Google TV device until 60
// days later.
client.deleteClusters(
new DeleteClustersRequest.Builder()
.setAccountProfile(AccountProfile())
.setReason(DeleteReason.DELETE_REASON_USER_LOG_OUT)
.build()
)
// If the user revokes the consent to share data with Google TV, you must make
// the following call to remove recommendations data from all current Google TV
// devices. Otherwise, the recommendations data persists until 60 days later.
client.deleteClusters(
new DeleteClustersRequest.Builder()
.setAccountProfile(AccountProfile())
.setReason(DeleteReason.DELETE_REASON_LOSS_OF_CONSENT)
.build()
)
इकाइयां बनाना
एसडीके में, हर आइटम टाइप को दिखाने के लिए अलग-अलग इकाइयां तय की गई हैं. सुझाव क्लस्टर के लिए, ये इकाइयां इस्तेमाल की जा सकती हैं:
जानकारी देना
हर इकाई के लिए, छोटा ब्यौरा दें. जब उपयोगकर्ता कर्सर को इकाई पर ले जाएगा, तब यह ब्यौरा दिखेगा. इससे उन्हें ज़्यादा जानकारी मिलेगी.
कॉल-टू-ऐक्शन टेक्स्ट
हर इकाई के लिए, कॉल-टू-ऐक्शन टेक्स्ट दें. यह ज़रूरी नहीं है. उपयोगकर्ता को यह टेक्स्ट इसलिए दिखेगा, ताकि वह इंटरैक्ट करे.
टैग
हर इकाई के लिए, टैग की सूची दें. यह ज़रूरी नहीं है. टैग का इस्तेमाल, कैटगरी में बांटने और फ़िल्टर करने के लिए किया जा सकता है.
प्लैटफ़ॉर्म के हिसाब से प्लेबैक यूआरआई
हर प्लैटफ़ॉर्म के लिए, प्लेबैक यूआरआई बनाएं. जैसे: Android TV, Android या iOS. इससे सिस्टम, संबंधित प्लैटफ़ॉर्म पर वीडियो चलाने के लिए सही यूआरआई चुन सकता है.
अगर सभी प्लैटफ़ॉर्म के लिए प्लेबैक यूआरआई एक ही हैं, तो हर प्लैटफ़ॉर्म के लिए इसे दोहराएं.
// Required. Set this when you want recommended entities to show up on
// Google TV
val playbackUriTv = PlatformSpecificUri
.Builder()
.setPlatformType(PlatformType.TYPE_ANDROID_TV)
.setActionUri(Uri.parse("https://www.example.com/entity_uri_for_tv"))
.build()
// Optional. Set this when you want recommended entities to show up on
// Google TV Android app
val playbackUriAndroid = PlatformSpecificUri
.Builder()
.setPlatformType(PlatformType.TYPE_ANDROID_MOBILE)
.setActionUri(Uri.parse("https://www.example.com/entity_uri_for_android"))
.build()
// Optional. Set this when you want recommended entities to show up on
// Google TV iOS app
val playbackUriIos = PlatformSpecificUri
.Builder()
.setPlatformType(PlatformType.TYPE_IOS)
.setActionUri(Uri.parse("https://www.example.com/entity_uri_for_ios"))
.build()
val platformSpecificPlaybackUris =
Arrays.asList(playbackUriTv, playbackUriAndroid, playbackUriIos)
// Provide appropriate rating for the system.
val contentRating = new RatingSystem
.Builder()
.setAgencyName("MPAA")
.setRating("PG-13")
.build()
पोस्टर इमेज
पोस्टर इमेज के लिए, यूआरआई और पिक्सल डाइमेंशन (ऊंचाई और चौड़ाई) की ज़रूरत होती है. अलग-अलग फ़ॉर्म फ़ैक्टर के लिए, कई पोस्टर इमेज उपलब्ध कराएं. हालांकि, पुष्टि करें कि सभी इमेज का आसपेक्ट रेशियो 16:9 हो और ऊंचाई कम से कम 200 पिक्सल हो. ऐसा करने से, "सुझाव" इकाई सही तरीके से दिखेगी. खास तौर पर, Google के टीवी, फ़िल्में वगैरह एक ही जगह पर देखने की सुविधामें. 200 पिक्सल से कम ऊंचाई वाली इमेज नहीं दिखाई जा सकती हैं.
Image image1 = new Image.Builder()
.setImageUri(Uri.parse("http://www.example.com/entity_image1.png");)
.setImageHeightInPixel(300)
.setImageWidthInPixel(169)
.build()
Image image2 = new Image.Builder()
.setImageUri(Uri.parse("http://www.example.com/entity_image2.png");)
.setImageHeightInPixel(640)
.setImageWidthInPixel(360)
.build()
// And other images for different form factors.
val images = Arrays.asList(image1, image2)
सुझाव की वजह
सुझाव की वजह बताएं. यह ज़रूरी नहीं है. Google TV इसका इस्तेमाल करके, यह वजह बता सकता है कि उपयोगकर्ता को कोई खास फ़िल्म या टीवी शो क्यों सुझाया गया है.
//Allows us to construct reason: "Because it is top 10 on your Channel"
val topOnPartner = RecommendationReasonTopOnPartner
.Builder()
.setNum(10) //any valid integer value
.build()
//Allows us to construct reason: "Because it is popular on your Channel"
val popularOnPartner = RecommendationReasonPopularOnPartner
.Builder()
.build()
//Allows us to construct reason: "New to your channel, or Just added"
val newOnPartner = RecommendationReasonNewOnPartner
.Builder()
.build()
//Allows us to construct reason: "Because you watched Star Wars"
val watchedSimilarTitles = RecommendationReasonWatchedSimilarTitles
.addSimilarWatchedTitleName("Movie or TV Show Title")
.addSimilarWatchedTitleName("Movie or TV Show Title")
.Builder()
.build()
//Allows us to construct reason: "Recommended for you by ChannelName"
val recommendedForUser = RecommendationReasonRecommendedForUser
.Builder()
.build()
val watchAgain = RecommendationReasonWatchAgain
.Builder()
.build()
val fromUserWatchList = RecommendationReasonFromUserWatchlist
.Builder()
.build()
val userLikedOnPartner = RecommendationReasonUserLikedOnPartner
.Builder()
.setTitleName("Movie or TV Show Title")
.build()
val generic = RecommendationReasonGeneric.Builder().build()
दिखाने की समयसीमा
अगर कोई इकाई सिर्फ़ कुछ समय के लिए उपलब्ध होनी चाहिए, तो उसके लिए कस्टम समयसीमा सेट करें. समयसीमा सेट न करने पर, इकाइयां 60 दिनों के बाद अपने-आप खत्म हो जाएंगी और मिट जाएंगी. इसलिए, समयसीमा सिर्फ़ तब सेट करें, जब इकाइयों को जल्द खत्म करना हो. उपलब्धता की ऐसी कई समयसीमाएं तय करें.
val window1 = DisplayTimeWindow
.Builder()
.setStartTimeStampMillis(now()+ 1.days.toMillis())
.setEndTimeStampMillis(now()+ 30.days.toMillis())
val window2 = DisplayTimeWindow
.Builder()
.setEndTimeStampMillis(now()+ 30.days.toMillis())
val availabilityTimeWindows: List<DisplayTimeWindow> = listof(window1,window2)
DataFeedElementId
अगर आपने Google TV के साथ, मीडिया कैटलॉग या मीडिया ऐक्शन फ़ीड को इंटिग्रेट किया है,
तो आपको फ़िल्म या टीवी शो के लिए अलग-अलग इकाइयां बनाने की ज़रूरत नहीं है. इसके बजाय, आप
MediaActionFeedEntity बना सकते हैं. इसमें,
DataFeedElementId का ज़रूरी फ़ील्ड शामिल होता है. यह आईडी यूनीक होना चाहिए और मीडिया ऐक्शन फ़ीड में मौजूद आईडी से मेल खाना चाहिए. ऐसा इसलिए, क्योंकि इससे इनजेस्ट किए गए फ़ीड कॉन्टेंट की पहचान करने और मीडिया कॉन्टेंट को ढूंढने में मदद मिलती है.
val id = "dataFeedElementId"
MovieEntity
MovieEntity बनाने का उदाहरण यहां दिया गया है. इसमें सभी ज़रूरी फ़ील्ड शामिल हैं:
val movieEntity = MovieEntity.Builder()
.setName("Movie name")
.setDescription("A sentence describing movie.")
.addPlatformSpecificPlaybackUri(platformSpecificPlaybackUris)
.addPosterImages(images)
// Suppose the duration is 2 hours, it is 72000000 in milliseconds
.setDurationMills(72000000)
.setCallToActionText("Watch Now")
.addTag("Action")
.build()
आपके पास, अतिरिक्त डेटा उपलब्ध कराने का विकल्प है. जैसे, शैलियां, कॉन्टेंट रेटिंग, रिलीज़ की तारीख, सुझाव की वजह, और उपलब्धता की समयसीमा. Google TV इसका इस्तेमाल, बेहतर तरीके से दिखाने या फ़िल्टर करने के लिए कर सकता है.
val genres = Arrays.asList("Action", "Science fiction");
val rating1 = RatingSystem.Builder().setAgencyName("MPAA").setRating("pg-13").build();
val contentRatings = Arrays.asList(rating1);
//Suppose release date is 11-02-2025
val releaseDate = 1739233800000L
val movieEntity = MovieEntity.Builder()
...
.addGenres(genres)
.setReleaseDateEpochMillis(releaseDate)
.addContentRatings(contentRatings)
.setRecommendationReason(topOnPartner or watchedSimilarTitles)
.addAllAvailabilityTimeWindows(availabilityTimeWindows)
.build()
TvShowEntity
TvShowEntity बनाने का उदाहरण यहां दिया गया है. इसमें सभी ज़रूरी फ़ील्ड शामिल हैं:
val tvShowEntity = TvShowEntity.Builder()
.setName("Show title")
.setDescription("A sentence describing TV Show.")
.addPlatformSpecificPlaybackUri(platformSpecificPlaybackUris)
.addPosterImages(images)
.setCallToActionText("Watch Now")
.addTag("Drama")
.build();
आपके पास, अतिरिक्त डेटा उपलब्ध कराने का विकल्प है. जैसे, शैलियां, कॉन्टेंट रेटिंग, सुझाव की वजह, ऑफ़र की कीमत, सीज़न की संख्या या उपलब्धता की समयसीमा. Google TV इसका इस्तेमाल, बेहतर तरीके से दिखाने या फ़िल्टर करने के लिए कर सकता है.
val genres = Arrays.asList("Action", "Science fiction");
val rating1 = RatingSystem.Builder()
.setAgencyName("MPAA")
.setRating("pg-13")
.build();
val price = Price.Builder()
.setCurrentPrice("$14.99")
.setStrikethroughPrice("$16.99")
.build();
val contentRatings = Arrays.asList(rating1);
val seasonCount = 5;
val tvShowEntity = TvShowEntity.Builder()
...
.addGenres(genres)
.addContentRatings(contentRatings)
.setRecommendationReason(topOnPartner or watchedSimilarTitles)
.addAllAvailabilityTimeWindows(availabilityTimeWindows)
.setSeasonCount(seasonCount)
.setPrice(price)
.build()
MediaActionFeedEntity
MediaActionFeedEntity बनाने का उदाहरण यहां दिया गया है. इसमें सभी ज़रूरी फ़ील्ड शामिल हैं:
val mediaActionFeedEntity = MediaActionFeedEntity.Builder()
.setDataFeedElementId(id)
.setCallToActionText("Watch Now")
.addTag("Action")
.build()
आपके पास, अतिरिक्त डेटा उपलब्ध कराने का विकल्प है. जैसे, ब्यौरा, सुझाव की वजह, और दिखाने की समयसीमा. Google TV इसका इस्तेमाल, बेहतर तरीके से दिखाने या फ़िल्टर करने के लिए कर सकता है.
val mediaActionFeedEntity = MediaActionFeedEntity.Builder()
.setName("Movie name or TV Show name")
.setDescription("A sentence describing an entity")
.setRecommendationReason(topOnPartner or watchedSimilarTitles)
.addPosterImages(images)
.build()
LiveTvChannelEntity
यह लाइव टीवी चैनल को दिखाता है. LiveTvChannelEntity बनाने का उदाहरण यहां दिया गया है. इसमें सभी ज़रूरी फ़ील्ड शामिल हैं:
val liveTvChannelEntity = LiveTvChannelEntity.Builder()
.setName("Channel Name")
// ID of the live TV channel
.setEntityId("https://www.example.com/channel/12345")
.setDescription("A sentence describing this live TV channel.")
// channel playback uri must contain at least PlatformType.TYPE_ANDROID_TV
.addPlatformSpecificPlaybackUri(channelPlaybackUris)
.addLogoImage(logoImage)
.setCallToActionText("Watch Now")
.addTag("News")
.build()
आपके पास, अतिरिक्त डेटा उपलब्ध कराने का विकल्प है. जैसे, कॉन्टेंट रेटिंग या सुझाव की वजह.
val rating1 = RatingSystem.Builder()
.setAgencyName("MPAA")
.setRating("pg-13")
.build()
val contentRatings = Arrays.asList(rating1)
val liveTvChannelEntity = LiveTvChannelEntity.Builder()
...
.addContentRatings(contentRatings)
.setRecommendationReason(topOnPartner)
.build()
LiveTvProgramEntity
यह लाइव टीवी प्रोग्राम कार्ड को दिखाता है. यह कार्ड, लाइव टीवी चैनल पर प्रसारित हो रहा होता है या प्रसारित होने वाला होता है. LiveTvProgramEntity बनाने का उदाहरण यहां दिया गया है. इसमें सभी ज़रूरी फ़ील्ड शामिल हैं:
val liveTvProgramEntity = LiveTvProgramEntity.Builder()
// First set the channel information
.setChannelName("Channel Name")
.setChannelId("https://www.example.com/channel/12345")
// channel playback uri must contain at least PlatformType.TYPE_ANDROID_TV
.addPlatformSpecificPlaybackUri(channelPlaybackUris)
.setChannelLogoImage(channelLogoImage)
// Then set the program or card specific information.
.setName("Program Name")
.setEntityId("https://www.example.com/schedule/123")
.setDescription("Program Description")
.addAvailabilityTimeWindow(
DisplayTimeWindow.Builder()
.setStartTimestampMillis(1756713600000L)// 2025-09-01T07:30:00+0000
.setEndTimestampMillis(1756715400000L))// 2025-09-01T08:00:00+0000
.addPosterImage(programImage)
.setCallToActionText("Watch Now")
.addTag("Sports")
.build()
आपके पास, अतिरिक्त डेटा उपलब्ध कराने का विकल्प है. जैसे, कॉन्टेंट रेटिंग, शैलियां या सुझाव की वजह.
val rating1 = RatingSystem.Builder()
.setAgencyName("MPAA")
.setRating("pg-13")
.build()
val contentRatings = Arrays.asList(rating1)
val genres = Arrays.asList("Action", "Science fiction")
val liveTvProgramEntity = LiveTvProgramEntity.Builder()
...
.addContentRatings(contentRatings)
.addGenres(genres)
.setRecommendationReason(topOnPartner)
.build()