Google, kullanıcıların uygulamalarını sektörlere göre düzenleyen ve kişiselleştirilmiş uygulama içeriği tüketimi ve keşfi için yeni bir sürükleyici deneyim sunan cihaz üzerinde bir yüzey oluşturuyor. Bu tam ekran deneyimi, geliştirici iş ortaklarına en iyi zengin içeriklerini uygulamalarının dışında özel bir kanalda sergileme fırsatı sunar.
Bu kılavuzda, geliştirici iş ortaklarının hem bu yeni alan alanını hem de mevcut Google alanlarını doldurmak için Engage SDK'sını kullanarak video içeriklerini entegre etme talimatları yer almaktadır.
Entegrasyon ayrıntısı
Terminoloji
Bu entegrasyon şu üç küme türünü içerir: Öneri, Devam ve Öne Çıkan.
Öneri kümeleri, tek bir geliştirici iş ortağının izleyebileceğiniz içeriklerle ilgili kişiselleştirilmiş önerilerini gösterir.
Önerileriniz aşağıdaki yapıya göre yapılır:
Öneri Kümesi: Aynı geliştirici iş ortağının bir öneri grubunu içeren kullanıcı arayüzü görünümü.
Varlık: Bir kümedeki tek bir öğeyi temsil eden nesne. Varlık; film, TV programı, TV dizisi, canlı video ve daha fazlası olabilir. Desteklenen varlık türlerinin listesi için Varlık verileri sağlama bölümüne bakın.
Devam kümesi, birden fazla geliştirici iş ortağının tamamlanmamış videolarını ve alakalı yeni yayınlanan bölümlerini tek bir kullanıcı arayüzü gruplandırmasında gösterir. Her geliştirici iş ortağının, Devam kümesinde en fazla 10 öğe yayınlamasına izin verilir. Araştırmalar, kişiselleştirilmiş devamlılık içerikleriyle birlikte kişiselleştirilmiş önerilerin en iyi kullanıcı etkileşimini oluşturduğunu göstermiştir.
Öne Çıkan kümesi, birden fazla geliştirici iş ortağından seçilen öğeleri tek bir kullanıcı arayüzü gruplandırmasında gösterir. Tek bir Öne Çıkan küme bulunur. Bu küme, kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm Öneriler kümelerinin üzerinde öncelikli olarak yerleştirilir. Her geliştirici iş ortağının Öne Çıkanlar kümesinde en fazla 10 varlık yayınlamasına izin verilir.
Ön çalışma
Minimum API düzeyi: 19
com.google.android.engage:engage-core
kitaplığını uygulamanıza ekleyin:
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'
}
Daha fazla bilgi için Android 11'de paket görünürlüğü başlıklı makaleyi inceleyin.
Özet
Tasarım, bağlantılı bir hizmet uygulamasına dayanır.
Bir istemcinin yayınlayabileceği veriler, farklı küme türleri için aşağıdaki sınırlara tabidir:
Küme türü | Küme sınırları | Bir kümedeki maksimum öğe sınırları |
---|---|---|
Öneri Kümeleri | En çok 5 | En fazla 50 |
Devam Kümesi | En fazla 1 | En fazla 10 |
Öne Çıkan Küme | En fazla 1 | En fazla 10 |
0. Adım: Mevcut Media Home SDK entegrasyonundan taşıma
Mevcut entegrasyondan veri modellerini eşleme
Mevcut bir Media Home entegrasyonundan geçiş yapıyorsanız aşağıdaki tabloda, mevcut SDK'lardaki veri modellerinin yeni Engage SDK'sıyla nasıl eşleneceği özetlenmiştir:
MediaHomeVideoContract entegrasyon eşdeğeri | Engage SDK entegrasyon eşdeğeri |
---|---|
com.google.android.mediahome.video.PreviewChannel
|
com.google.android.engage.common.datamodel.RecommendationCluster
|
com.google.android.mediahome.video.PreviewChannel.Builder
|
com.google.android.engage.common.datamodel.RecommendationCluster.Builder
|
com.google.android.mediahome.video.PreviewChannelHelper
|
com.google.android.engage.video.service.AppEngageVideoClient
|
com.google.android.mediahome.video.PreviewProgram |
Ayrı sınıflara ayrılmıştır: EventVideo ,
LiveStreamingVideo , Movie ,
TvEpisode , TvSeason , TvShow ,
VideoClipEntity
|
com.google.android.mediahome.video.PreviewProgram.Builder
|
Ayrı sınıflardaki oluşturuculara ayrılmıştır: EventVideo , LiveStreamingVideo , Movie , TvEpisode , TvSeason , TvShow , VideoClipEntity
|
com.google.android.mediahome.video.VideoContract |
Artık gerekli değil. |
com.google.android.mediahome.video.WatchNextProgram |
Ayrı sınıflardaki özelliklere bölünmüş olmalıdır:
EventVideoEntity , LiveStreamingVideoEntity ,
MovieEntity , TvEpisodeEntity ,
TvSeasonEntity , TvShowEntity ,
VideoClipEntity |
com.google.android.mediahome.video.WatchNextProgram.Builder
|
Ayrı sınıflardaki özelliklere bölünmüş olmalıdır:
EventVideoEntity , LiveStreamingVideoEntity ,
MovieEntity , TvEpisodeEntity ,
TvSeasonEntity , TvShowEntity ,
VideoClipEntity |
Media Home SDK'sında ve Engage SDK'sında küme yayınlama
Media Home SDK'da kümeler ve varlıklar, ayrı API'ler aracılığıyla yayınlanıyordu:
// 1. Fetch existing channels
List<PreviewChannel> channels = PreviewChannelHelper.getAllChannels();
// 2. If there are no channels, publish new channels
long channelId = PreviewChannelHelper.publishChannel(builder.build());
// 3. If there are existing channels, decide whether to update channel contents
PreviewChannelHelper.updatePreviewChannel(channelId, builder.build());
// 4. Delete all programs in the channel
PreviewChannelHelper.deleteAllPreviewProgramsByChannelId(channelId);
// 5. publish new programs in the channel
PreviewChannelHelper.publishPreviewProgram(builder.build());
Engage SDK'sı ile küme ve öğe yayınlama tek bir API çağrısında birleştirilir. Bir kümeye ait tüm öğeler, ilgili kümeyle birlikte yayınlanır:
Kotlin
RecommendationCluster.Builder() .addEntity(MOVIE_ENTITY) .addEntity(MOVIE_ENTITY) .addEntity(MOVIE_ENTITY) .setTitle("Top Picks For You") .build()
Java
new RecommendationCluster.Builder() .addEntity(MOVIE_ENTITY) .addEntity(MOVIE_ENTITY) .addEntity(MOVIE_ENTITY) .setTitle("Top Picks For You") .build();
1. adım: Öğe verilerini sağlayın
SDK'da her öğe türünü temsil eden farklı varlıklar tanımlanmıştır. İzleme kategorisi için aşağıdaki varlıkları destekliyoruz:
Aşağıdaki tabloda her türün özellikleri ve koşulları özetlenmiştir.
MovieEntity
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | |
Poster resimleri | Zorunlu | En az bir resim gereklidir ve resim en boy oranına sahip olmalıdır. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimlerin aktarılması önerilir.)
Yardım için Resim Özellikleri bölümüne bakın. |
Oynatma URI'si | Zorunlu |
Filmi oynatmaya başlamak için sağlayıcı uygulamasının derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Bilgi sayfası uri'si | İsteğe bağlı |
Filmle ilgili ayrıntıları göstermek için sağlayıcı uygulamasının derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Yayın tarihi | Zorunlu | Milisaniye cinsinden. |
Kullanılabilirlik | Zorunlu | KULLANILABİLİR: İçerik başka bir işlem yapılmadan kullanıcı tarafından kullanılabilir. FREE_WITH_SUBSCRIPTION: İçerik, kullanıcı abone olduktan sonra kullanılabilir. PAID_CONTENT: İçerik kullanıcının satın almasını veya kiralamasını gerektiriyor. SATIN ALINDI: İçerik kullanıcı tarafından satın alınmış veya kiralanmış. |
Teklif fiyatı | İsteğe bağlı | Serbest metin |
Süre | Zorunlu | Milisaniye cinsinden. |
Tür | Zorunlu | Serbest metin |
İçerik derecelendirmeleri | Zorunlu | Serbest metin, sektör standardını takip edin. (Örnek) |
Sonraki türü izle | Koşullu olarak zorunlu | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM ET: Kullanıcı bu içeriğin 1 dakikadan uzun bir kısmını izlemişse YENİ: Kullanıcı, bazı bölümlü içeriklerin mevcut tüm bölümlerini izlemiştir ancak yeni bir bölüm yayınlanmıştır ve tam olarak bir bölüm izlenmemiştir. Bu, TV programları, bir serideki kaydedilmiş futbol maçları vb. için kullanılabilir. SONRAKİ: Kullanıcı, bazı bölümlerden oluşan içeriğin bir veya daha fazla bölümünün tamamını izlemiştir, ancak ya birden fazla bölüm kalmıştır ya da son bölümün "YENİ" olmadığı ve kullanıcı bölüm içeriğini izlemeye başlamadan önce yayınlandığı tam bir bölüm kalmıştır. İZLEMELENECEKLER LİSTESİ: Kullanıcı, izlemek istediği içerikleri manuel olarak seçmek için bir filme, etkinliğe veya diziye izleme listesine eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşullu olarak zorunlu | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Milisaniye cinsinden |
Son oynatma konumu zamanı | Koşullu olarak zorunlu | Öğe, Devam kümesindeyse ve WatchNextType Continue (Devam) durumunda olduğunda sağlanmalıdır. Milisaniye cinsinden. |
TvShowEntity
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | |
Poster resimleri | Zorunlu | En az bir resim gereklidir ve resim en boy oranına sahip olmalıdır. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimler göndermeniz önerilir.)
Yardım için Resim Özellikleri bölümüne bakın. |
Bilgi sayfası uri'si | Zorunlu |
TV programının ayrıntılarını göstermek için sağlayıcı uygulamasına ait derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Oynatma URI'si | İsteğe bağlı |
TV programını oynatmaya başlamak için sağlayıcı uygulamasının derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
İlk bölümün yayın tarihi | Zorunlu | Milisaniye cinsinden. |
Son bölümün yayın tarihi | İsteğe bağlı | Milisaniye cinsinden. |
Kullanılabilirlik | Zorunlu | KULLANILABİLİR: İçerik başka bir işlem yapılmadan kullanıcı tarafından kullanılabilir. FREE_WITH_SUBSCRIPTION: İçerik, kullanıcı abone olduktan sonra kullanılabilir. PAID_CONTENT: İçerik kullanıcının satın almasını veya kiralamasını gerektiriyor. SATIN ALINDI: İçerik kullanıcı tarafından satın alınmış veya kiralanmış. |
Teklif fiyatı | İsteğe bağlı | Serbest metin |
Sezon sayısı | Zorunlu | Pozitif tam sayı |
Tür | Zorunlu | Serbest metin |
İçerik derecelendirmeleri | Zorunlu | Serbest metin, endüstri standardına uyun. (Örnek) |
Sonraki videoyu izleme türü | Koşullu olarak zorunlu | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM ET: Kullanıcı bu içeriğin 1 dakikadan uzun bir kısmını izlemişse YENİ: Kullanıcı, bazı bölümlü içeriklerin mevcut tüm bölümlerini izlemiştir ancak yeni bir bölüm yayınlanmıştır ve tam olarak bir bölüm izlenmemiştir. Bu, TV programları, bir serideki kaydedilmiş futbol maçları vb. için kullanılabilir. SONRAKİ: Kullanıcı, bazı bölümlerden oluşan içeriğin bir veya daha fazla bölümünün tamamını izlemiştir, ancak ya birden fazla bölüm kalmıştır ya da son bölümün "YENİ" olmadığı ve kullanıcı bölüm içeriğini izlemeye başlamadan önce yayınlandığı tam bir bölüm kalmıştır. İZLEMELENECEKLER LİSTESİ: Kullanıcı, izlemek istediği içerikleri manuel olarak seçmek için bir filme, etkinliğe veya diziye izleme listesine eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşullu olarak zorunlu | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Milisaniye cinsinden |
Son oynatma konumu zamanı | Koşullu olarak zorunlu | Öğe, Devam kümesindeyse ve WatchNextType Continue (Devam) durumunda olduğunda sağlanmalıdır. Milisaniye cinsinden. |
TvSeasonEntity
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | |
Poster resimleri | Zorunlu | En az bir resim gereklidir ve resim en boy oranına sahip olmalıdır. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimler göndermeniz önerilir.)
Yardım için Resim Özellikleri bölümüne bakın. |
Bilgi sayfası uri'si | Zorunlu |
TV dizisi sezonunun ayrıntılarını göstermek için sağlayıcı uygulamasının derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Oynatma URI'si | İsteğe bağlı |
TV dizisi sezonunun oynatılmasını başlatmak için sağlayıcı uygulamasına ait derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Sezon numarasını göster |
İsteğe bağlı 1.3.1 sürümünde kullanılabilir |
Dize |
İlk bölümün yayın tarihi | Zorunlu | Milisaniye cinsinden. |
Son bölümün yayın tarihi | İsteğe bağlı | Milisaniye cinsinden. |
Kullanılabilirlik | Zorunlu | KULLANILABİLİR: İçerik başka bir işlem yapılmadan kullanıcı tarafından kullanılabilir. FREE_WITH_SUBSCRIPTION: İçerik, kullanıcı abone olduktan sonra kullanılabilir. PAID_CONTENT: İçerik kullanıcının satın almasını veya kiralamasını gerektiriyor. SATIN ALINDI: İçerik kullanıcı tarafından satın alınmış veya kiralanmış. |
Teklif fiyatı | İsteğe bağlı | Serbest metin |
Bölüm sayısı | Zorunlu | Pozitif tam sayı |
Tür | Zorunlu | Serbest metin |
İçerik derecelendirmeleri | Zorunlu | Serbest metin, sektör standardını takip edin. (Örnek) |
Sonraki videoyu izleme türü | Koşullu olarak zorunlu | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM ET: Kullanıcı bu içeriğin 1 dakikadan uzun bir kısmını izlemişse YENİ: Kullanıcı, bazı bölümlü içeriklerin mevcut tüm bölümlerini izlemiştir ancak yeni bir bölüm yayınlanmıştır ve tam olarak bir bölüm izlenmemiştir. Bu, TV programları, bir serideki kaydedilmiş futbol maçları vb. için kullanılabilir. SONRAKİ: Kullanıcı, bazı bölümlerden oluşan içeriğin bir veya daha fazla bölümünün tamamını izlemiştir, ancak ya birden fazla bölüm kalmıştır ya da son bölümün "YENİ" olmadığı ve kullanıcı bölüm içeriğini izlemeye başlamadan önce yayınlandığı tam bir bölüm kalmıştır. İZLEMELENECEKLER LİSTESİ: Kullanıcı, izlemek istediği içerikleri manuel olarak seçmek için bir filme, etkinliğe veya diziye izleme listesine eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşullu olarak zorunlu | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Milisaniye cinsinden |
Son oynatma konumu zamanı | Koşullu olarak zorunlu | Öğe, Devam kümesindeyse ve WatchNextType Continue (Devam) durumunda olduğunda sağlanmalıdır. Milisaniye cinsinden. |
TvEpisodeEntity
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | |
Poster resimleri | Zorunlu | En az bir resim gereklidir ve resim en boy oranına sahip olmalıdır. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimler göndermeniz önerilir.)
Yardım için Resim Özellikleri'ne bakın. |
Oynatma URI'si | Zorunlu |
Bölümün oynatılmasını başlatmak için sağlayıcı uygulamasının derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Bilgi sayfası uri'si | İsteğe bağlı |
TV programı bölümüyle ilgili ayrıntıları göstermek için sağlayıcı uygulamasının derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Bölüm numarasını göster |
İsteğe bağlı 1.3.1 sürümünde kullanılabilir |
Dize |
Yayınlanma tarihi | Zorunlu | Milisaniye cinsinden. |
Kullanılabilirlik | Zorunlu | KULLANILABİLİR: İçerik başka bir işlem yapılmadan kullanıcı tarafından kullanılabilir. FREE_WITH_SUBSCRIPTION: İçerik, kullanıcı abone olduktan sonra kullanılabilir. PAID_CONTENT: İçerik kullanıcının satın almasını veya kiralamasını gerektiriyor. SATIN ALINDI: İçerik kullanıcı tarafından satın alınmış veya kiralanmış. |
Teklif fiyatı | İsteğe bağlı | Serbest metin |
Süre | Zorunlu | Milisaniye cinsinden pozitif bir değer olmalıdır. |
Tür | Zorunlu | Serbest metin |
İçerik derecelendirmeleri | Zorunlu | Serbest metin, sektör standardını takip edin. (Örnek) |
Sonraki videoyu izleme türü | Koşullu olarak zorunlu | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM ET: Kullanıcı bu içeriğin 1 dakikadan uzun bir kısmını izlemişse YENİ: Kullanıcı, bazı bölümlü içeriklerin mevcut tüm bölümlerini izlemiştir ancak yeni bir bölüm yayınlanmıştır ve tam olarak bir bölüm izlenmemiştir. Bu, TV programları, bir serideki kaydedilmiş futbol maçları vb. için kullanılabilir. SONRAKİ: Kullanıcı, bazı bölümlerden oluşan içeriğin bir veya daha fazla bölümünün tamamını izlemiştir, ancak ya birden fazla bölüm kalmıştır ya da son bölümün "YENİ" olmadığı ve kullanıcı bölüm içeriğini izlemeye başlamadan önce yayınlandığı tam bir bölüm kalmıştır. İZLEMELENECEKLER LİSTESİ: Kullanıcı, izlemek istediği içerikleri manuel olarak seçmek için bir filme, etkinliğe veya diziye izleme listesine eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşullu olarak zorunlu | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Milisaniye cinsinden |
Son oynatma konumu zamanı | Koşullu olarak zorunlu | Öğe, Devam kümesindeyse ve WatchNextType Continue (Devam) durumunda olduğunda sağlanmalıdır. Milisaniye cinsinden. |
LiveStreamingVideoEntity
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | |
Poster resimleri | Zorunlu | En az bir resim gereklidir ve resim en boy oranına sahip olmalıdır. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimler göndermeniz önerilir.)
Yardım için Resim Özellikleri bölümüne bakın. |
Oynatma URI'si | Zorunlu |
Videoyu oynatmaya başlamak için sağlayıcı uygulamasının derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Yayıncı | Zorunlu | Serbest metin |
Başlangıç zamanı | İsteğe bağlı | Milisaniye cinsinden. |
Bitiş zamanı | İsteğe bağlı | Milisaniye cinsinden. |
Görüntüleme sayısı | İsteğe bağlı | Serbest metin, yerelleştirilmelidir. |
Sonraki videoyu izleme türü | Koşullu olarak zorunlu | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM ET: Kullanıcı bu içeriğin 1 dakikadan uzun bir kısmını izlemişse YENİ: Kullanıcı, bazı bölümlü içeriklerin mevcut tüm bölümlerini izlemiştir ancak yeni bir bölüm yayınlanmıştır ve tam olarak bir bölüm izlenmemiştir. Bu, TV programları, bir serideki kaydedilmiş futbol maçları vb. için kullanılabilir. SONRAKİ: Kullanıcı, bazı bölümlerden oluşan içeriğin bir veya daha fazla bölümünün tamamını izlemiştir, ancak ya birden fazla bölüm kalmıştır ya da son bölümün "YENİ" olmadığı ve kullanıcı bölüm içeriğini izlemeye başlamadan önce yayınlandığı tam bir bölüm kalmıştır. İZLEMELENECEKLER LİSTESİ: Kullanıcı, izlemek istediği içerikleri manuel olarak seçmek için bir filme, etkinliğe veya diziye izleme listesine eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşullu olarak zorunlu | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Milisaniye cinsinden |
Son oynatma konumu zamanı | Koşullu olarak zorunlu | Öğe Devam kümesindeyse ve WatchNextType CONTINUE ise sağlanmalıdır. Milisaniye cinsinden. |
VideoClipEntity
VideoClipEntity
nesnesi, TikTok veya YouTube gibi sosyal medya platformlarından gelen bir video öğesini temsil eder.
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | |
Poster resimleri | Zorunlu | En az bir resim gereklidir ve en boy oranına sahip olmalıdır. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimlerin aktarılması önerilir.)
Yardım için Resim Özellikleri bölümüne bakın. |
Oynatma URI'si | Zorunlu |
Videoyu oynatmaya başlamak için sağlayıcı uygulamasının derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Oluşturma zamanı | Zorunlu | Milisaniye cinsinden. |
Süre | Zorunlu | Milisaniye cinsinden pozitif bir değer olmalıdır. |
İçerik üretici | Zorunlu | Serbest metin |
İçerik üretici resmi | İsteğe bağlı | İçerik üretici avatarının resmi |
Görüntüleme sayısı | İsteğe bağlı | Serbest metin, yerelleştirilmelidir. |
Sonraki videoyu izleme türü | Koşullu olarak zorunlu | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM ET: Kullanıcı bu içeriğin 1 dakikadan uzun bir kısmını izlemişse YENİ: Kullanıcı, bazı bölümlü içeriklerin mevcut tüm bölümlerini izlemiştir ancak yeni bir bölüm yayınlanmıştır ve tam olarak bir bölüm izlenmemiştir. Bu, TV programları, bir serideki kaydedilmiş futbol maçları vb. için kullanılabilir. SONRAKİ: Kullanıcı, bazı bölümlerden oluşan içeriğin bir veya daha fazla bölümünün tamamını izlemiştir, ancak ya birden fazla bölüm kalmıştır ya da son bölümün "YENİ" olmadığı ve kullanıcı bölüm içeriğini izlemeye başlamadan önce yayınlandığı tam bir bölüm kalmıştır. İZLEMELENECEKLER LİSTESİ: Kullanıcı, izlemek istediği içerikleri manuel olarak seçmek için bir filme, etkinliğe veya diziye izleme listesine eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşullu olarak zorunlu | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Milisaniye cinsinden |
Son oynatma konumu zamanı | Koşullu olarak zorunlu | Öğe Devam kümesindeyse ve WatchNextType CONTINUE ise sağlanmalıdır. Dönem milisaniye cinsinden. |
Resim özellikleri
Aşağıdaki bölümde, resim öğeleri için gerekli özellikler listelenmiştir:
Dosya biçimleri
PNG, JPG, statik GIF, WebP
Maksimum dosya boyutu
5.120 KB
Ek öneriler
- Resim güvenli alanı: Önemli içeriklerinizi yatay ve dikey yönde ortalanmış olarak resmin %80'ini kaplayacak şekilde yerleştirin.
Örnek
Kotlin
var movie = MovieEntity.Builder() .setName("Avengers") .addPosterImage(Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(960) .setImageWidthInPixel(408) .build()) .setPlayBackUri(Uri.parse("http://tv.com/playback/1")) .setReleaseDateEpochMillis(1633032895L) .setAvailability(ContentAvailability.AVAILABILITY_AVAILABLE) .setDurationMillis(12345678L) .addGenre("action") .addContentRating("R") .setWatchNextType(WatchNextType.TYPE_NEW) .setLastEngagementTimeMillis(1664568895L) .build()
Java
MovieEntity movie = new MovieEntity.Builder() .setName("Avengers") .addPosterImage( new Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(960) .setImageWidthInPixel(408) .build()) .setPlayBackUri(Uri.parse("http://tv.com/playback/1")) .setReleaseDateEpochMillis(1633032895L) .setAvailability(ContentAvailability.AVAILABILITY_AVAILABLE) .setDurationMillis(12345678L) .addGenre("action") .addContentRating("R") .setWatchNextType(WatchNextType.TYPE_NEW) .setLastEngagementTimeMillis(1664568895L) .build();
2. adım: Küme verilerini sağlayın
İçerik yayınlama işinin arka planda (ör. WorkManager kullanılarak) yürütülmesi ve düzenli olarak veya etkinlik bazında (ör. kullanıcı uygulamayı her açtığında ya da sepete bir şey eklediğinde) planlanması önerilir.
AppEngagePublishClient
, kümeleri yayınlamaktan sorumludur. İstemcide aşağıdaki API'ler kullanılabilir:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Bu API, hizmetin entegrasyon için kullanılıp kullanılamadığını ve içeriğin cihazda sunulup sunulamayacağını kontrol etmek için kullanılır.
Kotlin
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. } }
Java
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
Bu API, RecommendationCluster
nesnelerinin listesini yayınlamak için kullanılır.
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build() ) .build() )
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build()) .build());
Hizmet isteği aldığında tek bir işlemde aşağıdaki işlemler gerçekleşir:
- Geliştirici iş ortağının mevcut
RecommendationCluster
verileri kaldırılır. - İstekten gelen veriler ayrıştırılır ve güncellenmiş öneri kümesinde depolanır.
Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
publishFeaturedCluster
Bu API, FeaturedCluster
nesnelerinin listesini yayınlamak için kullanılır.
Kotlin
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishFeaturedCluster( new PublishFeaturedClustersRequest.Builder() .addFeaturedCluster( new FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Hizmet isteği aldığında tek bir işlemde aşağıdaki işlemler gerçekleşir:
- Geliştirici iş ortağının mevcut
FeaturedCluster
verileri kaldırılır. - İstekten gelen veriler ayrıştırılır ve güncellenen Öne Çıkan Küme'de depolanır.
Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.
publishContinuationCluster
Bu API, ContinuationCluster
nesnesi yayınlamak için kullanılır.
Kotlin
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishContinuationCluster( new PublishContinuationClusterRequest.Builder() .setContinuationCluster( new ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Hizmet isteği aldığında, bir işlem içinde aşağıdaki işlemler gerçekleştirilir:
- Geliştirici iş ortağının mevcut
ContinuationCluster
verileri kaldırılır. - İstekten elde edilen veriler ayrıştırılır ve güncellenmiş Devam Kümesinde depolanır.
Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
publishUserAccountManagementRequest
Bu API, oturum açma kartı yayınlamak için kullanılır. Oturum açma işlemi, uygulamanın içerik yayınlayabilmesi (veya daha kişiselleştirilmiş içerik sunabilmesi) için kullanıcıları uygulamanın oturum açma sayfasına yönlendirir.
Aşağıdaki meta veriler, oturum açma kartının bir parçasıdır:
Özellik | Şartlar | Açıklama |
---|---|---|
İşlem Uri | Zorunlu | İşleme derin bağlantı (ör. uygulamanın oturum açma sayfasına yönlendirme) |
Resim | İsteğe bağlı: Sağlanmazsa başlık sağlanmalıdır |
Kartta gösterilen resim 1264x712 çözünürlüğe sahip 16x9 en boy oranına sahip resimler |
Başlık | İsteğe bağlı: Sağlanmazsa resim sağlanmalıdır | Karttaki başlık |
İşlem metni | İsteğe bağlı | CTA'da Gösterilen Metin (ör. Oturum aç) |
Alt başlık | İsteğe bağlı | Kartta isteğe bağlı altyazı |
Kotlin
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());
Java
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());
Hizmet isteği aldığında tek bir işlemde aşağıdaki işlemler gerçekleşir:
- Geliştirici iş ortağının mevcut
UserAccountManagementCluster
verileri kaldırılır. - İstekten gelen veriler ayrıştırılır ve güncellenen UserAccountManagementCluster kümesinde depolanır.
Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
updatePublishStatus
Dahili bir işletme nedeniyle kümelerin hiçbiri yayınlanmıyorsa updatePublishStatus API'sini kullanarak yayınlama durumunu güncellemenizi önemle tavsiye ederiz. Bu önemlidir, çünkü:
- İçerik yayınlandığında bile (STATUS == PUBLISHED) tüm senaryolarda durumu sağlamak, entegrasyonunuzun durumunu ve diğer metriklerini iletmek için bu açık durumu kullanan kontrol panellerini doldurmak açısından çok önemlidir.
- Hiçbir içerik yayınlanmamışsa ancak entegrasyon durumu bozulmamışsa (STATUS == NOT_PUBLISHED) Google, uygulama sağlığı kontrol panellerinde uyarı tetiklemekten kaçınabilir. Bu bildirim, sağlayıcı açısından beklenen bir durum nedeniyle içeriğin yayınlanmadığını onaylar.
- Geliştiricilerin verilerin ne zaman yayınlandığı ve ne zaman yayınlanmadığı hakkında analizler sunmasına yardımcı olur.
- Google, kullanıcının uygulama içeriğini görmesini veya bu engeli aşmasını sağlamak için uygulamada belirli işlemleri yapmasına teşvik etmek amacıyla durum kodlarını kullanabilir.
Uygun yayınlama durumu kodlarının listesi şunlardır:
// 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
İçerik, kullanıcının giriş yapmaması nedeniyle yayınlanmıyorsa Google, oturum açma kartını yayınlamanızı önerir. Sağlayıcılar herhangi bir nedenle oturum açma kartını yayınlayamıyorsa NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla updatePublishStatus API'sini çağırmanızı öneririz.
Kotlin
client.updatePublishStatus( PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build())
Java
client.updatePublishStatus( new PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build());
deleteRecommendationClusters
Bu API, öneri kümelerinin içeriğini silmek için kullanılır.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Hizmet, isteği aldığında mevcut verileri Öneri Kümelerinden kaldırır. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
deleteFeaturedCluster
Bu API, Öne Çıkan Küme'nin içeriğini silmek için kullanılır.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Hizmet, isteği aldığında Öne Çıkan Küme'deki mevcut verileri kaldırır. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
deleteContinuationCluster
Bu API, Devam Kümesi'nin içeriğini silmek için kullanılır.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Hizmet, isteği aldığında mevcut verileri Devam Kümesi'nden kaldırır. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
deleteUserManagementCluster
Bu API, UserAccountManagement kümesinin içeriğini silmek için kullanılır.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Hizmet, isteği aldığında mevcut verileri UserAccountManagement kümesinden kaldırır. Hata durumunda isteğinin tamamı reddedilir ve mevcut durum korunur.
deleteClusters
Bu API, belirli bir küme türünün içeriğini silmek için kullanılır.
Kotlin
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build())
Java
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build());
Hizmet, isteği aldığında belirtilen küme türleriyle eşleşen tüm kümelerdeki mevcut verileri kaldırır. İstemciler bir veya daha fazla küme türünü geçirmeyi seçebilir. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
Hata işleme
Yayınlama API'lerinden görev sonucunu dinlemeniz önemle tavsiye edilir. Böylece, başarılı bir görevi kurtarıp yeniden göndermek için takip işlemi yapabilirsiniz.
Kotlin
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 } } } }
Java
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 } } } });
Hata, hata kodu olarak nedeni dahil edilerek AppEngageException
olarak döndürülür.
Hata kodu | Hata adı | Not |
---|---|---|
1 |
SERVICE_NOT_FOUND |
Hizmet, belirtilen cihazda kullanılamıyor. |
2 |
SERVICE_NOT_AVAILABLE |
Hizmet belirtilen cihazda kullanılabilir ancak arama sırasında kullanılamaz (örneğin, açıkça devre dışı bırakılmıştır). |
3 |
SERVICE_CALL_EXECUTION_FAILURE |
Görev yürütülemedi, ileti dizisi sorunları nedeniyle başarısız oldu. Bu durumda, işlemi yeniden deneyebilirsiniz. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Arayan kullanıcının servis araması yapmasına izin verilmiyor. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
İstek geçersiz veriler içeriyor (örneğin, izin verilenden daha fazla sayıda küme). |
6 |
SERVICE_CALL_INTERNAL |
Hizmet tarafında bir hata var. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Servis çağrısı çok sık yapılıyor. |
3. Adım: Yayın amaçlarını ele alın
Bir iş aracılığıyla içerik yayınlama API çağrıları yapmanın yanı sıra, içerik yayınlama isteğini almak için bir BroadcastReceiver
oluşturmanız da gerekir.
Yayın niyetinin amacı, temel olarak uygulamayı yeniden etkinleştirmek ve veri senkronizasyonunu zorlamaktır. Yayın amaçları çok sık gönderilecek şekilde tasarlanmamıştır. Yalnızca Engage Hizmeti içeriğin güncel olmayabileceğini (ör. bir haftalık) belirlediğinde tetiklenir. Bu sayede, uygulama uzun süre çalıştırılmamış olsa bile kullanıcının yeni bir içerik deneyimi yaşayabileceğinden emin olabilirsiniz.
BroadcastReceiver
aşağıdaki iki şekilde ayarlanmalıdır:
Context.registerReceiver()
kullanarakBroadcastReceiver
sınıfının bir örneğini dinamik olarak kaydedin. Bu sayede, bellekte hâlâ etkin olan uygulamalardan iletişim kurulabilir.
Kotlin
class AppEngageBroadcastReceiver : BroadcastReceiver(){ // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } fun registerBroadcastReceivers(context: Context){ var context = context context = context.applicationContext // Register Recommendation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Continuation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION)) }
Java
class AppEngageBroadcastReceiver extends BroadcastReceiver { // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } public static void registerBroadcastReceivers(Context context) { context = context.getApplicationContext(); // Register Recommendation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Continuation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION)); }
AndroidManifest.xml
dosyanızda<receiver>
etiketiyle uygulamayı statik olarak beyan edin. Bu, uygulamanın çalışmadığı zamanlarda yayın istekleri almasına ve uygulamanın içeriği yayınlamasına olanak tanır.
<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.PUBLISH_CONTINUATION" />
</intent-filter>
</receiver>
</application>
Hizmet tarafından aşağıdaki intent'ler gönderilir:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
Bu niyeti alırkenpublishRecommendationClusters
çağrısı başlatmanız önerilir.com.google.android.engage.action.PUBLISH_FEATURED
Bu intent'i aldığınızdapublishFeaturedCluster
çağrısı başlatmanız önerilir.com.google.android.engage.action.PUBLISH_CONTINUATION
Bu niyeti aldığınızdapublishContinuationCluster
çağrısı başlatmanız önerilir.
Entegrasyon iş akışı
Entegrasyonunuz tamamlandıktan sonra doğrulamayla ilgili adım adım açıklamalı bir kılavuz için Engage geliştirici entegrasyon iş akışı başlıklı makaleyi inceleyin.
SSS
SSS için Engage SDK'sı hakkında sık sorulan sorular başlıklı makaleyi inceleyin.
İletişim
Entegrasyon sürecinde herhangi bir sorunuz olursa engagement-developers@google.com adresiyle iletişime geçin.
Sonraki adımlar
Bu entegrasyonu tamamladıktan sonra uygulayacağınız adımlar şunlardır:
- Engage-developers@google.com adresine e-posta gönderin ve Google tarafından test edilmeye hazır olan entegre APK'nızı ekleyin.
- Google, entegrasyonun beklendiği gibi çalıştığından emin olmak için bir doğrulama ve şirket içi inceleme gerçekleştirir. Değişiklik yapılması gerekiyorsa Google gerekli tüm bilgileri sizinle paylaşır.
- Test tamamlandığında ve herhangi bir değişiklik gerekmediğinde Google, güncellenmiş ve entegre APK'yı Play Store'da yayınlamaya başlayabileceğinizi bildirmek için sizinle iletişime geçer.
- Google, güncellenmiş APK'nızın Play Store'da yayınlandığını onayladıktan sonra Öneri, Öne Çıkan ve Devam kümeleriniz yayınlanabilir ve kullanıcılar tarafından görülebilir.