Google, kullanıcıların uygulamalarını sektörlere göre düzenleyen ve kişiselleştirilmiş uygulama içeriğinin tüketilmesi ve keşfedilmesi için yeni bir etkileyici 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ılavuz, geliştirici iş ortaklarının hem bu yeni yüzey alanını hem de mevcut Google yüzeylerini doldurmak için Engage SDK'sını kullanarak video içeriklerini entegre etmelerine yönelik talimatları içerir.
Entegrasyon ayrıntıları
Terminoloji
Bu entegrasyon şu üç küme türünü içerir: Öneri, Devam ve Öne Çıkan.
Öneri kümeleri, bağımsız bir geliştirici iş ortağından izlenecek içerik için kişiselleştirilmiş öneriler gösterir.
Önerileriniz aşağıdaki yapıya sahiptir:
Öneri Kümesi: Aynı geliştirici iş ortağından gelen bir grup öneriyi içeren bir kullanıcı arayüzü görünümü.
Varlık: 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, tek bir kullanıcı arayüzü gruplandırmasında tamamlanmamış videoları ve birden fazla geliştirici iş ortağından yeni yayınlanan alakalı bölümleri gösterir. Her geliştirici iş ortağının Devam kümesinde en fazla 10 varlık 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 alınmış çeşitli varlıkları tek bir kullanıcı arayüzü gruplandırmasında gösterir. Kullanıcı arayüzünün üst kısmına yakın bir yerde gösterilen ve tüm öneri kümelerinin üzerinde öncelikli yerleşime sahip tek bir Öne Çıkan küme olacaktır. 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üğü bölümüne bakın.
Özet
Tasarım, bağlı hizmet uygulamasına dayanır.
İstemcilerin 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 varlık 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 modellerini yeni Engage SDK'sı ile nasıl eşleyeceğiniz özetlenmiştir:
MediaHomeVideoContract entegrasyon eşdeğeri | Engage SDK entegrasyonu 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 bölünmüş: 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 ihtiyacım kalmadı. |
com.google.android.mediahome.video.WatchNextProgram |
Ayrı sınıflardaki özelliklere bölünür:
EventVideoEntity , LiveStreamingVideoEntity ,
MovieEntity , TvEpisodeEntity ,
TvSeasonEntity , TvShowEntity ,
VideoClipEntity |
com.google.android.mediahome.video.WatchNextProgram.Builder
|
Ayrı sınıflardaki özelliklere bölünür:
EventVideoEntity , LiveStreamingVideoEntity ,
MovieEntity , TvEpisodeEntity ,
TvSeasonEntity , TvShowEntity ,
VideoClipEntity |
Media Home SDK'sında küme yayınlama ile 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 ile küme ve varlık yayınlama tek bir API çağrısında birleştirilir. Bir kümeye ait olan tüm varlıklar bu 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ürle ilgili özellikler ve gereklilikler özetlenmiştir.
MovieEntity
Ö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'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ın gösterildiği 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 | Dönem 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ı bir abonelik satın aldıktan 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ıştır. |
Teklif fiyatı | İsteğe bağlı | Serbest metin |
Süre | Zorunlu | Milisaniye cinsinden. |
Tür | Zorunlu | Serbest metin |
İçerik derecelendirmeleri | Zorunlu | Serbest metin, endüstri standardına uyun. (Örnek) |
Sonraki türü izle | Koşula bağlı olarak gerekli | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM: Kullanıcı bu içeriği zaten 1 dakikadan daha uzun süre izledi. YENİ: Kullanıcı, bazı bölümlerden oluşan içeriklerden mevcut tüm bölümleri izlemiştir ancak yeni bir bölüm yayınlanmıştır ve izlenmemiş tam bir bölüm kalmıştır. Bu özellik; TV programları, bir dizideki kayıtlı futbol maçları vb. için geçerlidir. 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. İZLEME LİSTESİ: Kullanıcı, izleyecekleri bir sonraki videoyu manuel olarak seçmek için izleme listesine film, etkinlik veya dizi eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType Continue (Devam) durumunda olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
TvShowEntity
Ö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'ne bakın. |
Bilgi sayfası URI'si | Zorunlu |
TV programının ayrıntılarını gösteren 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 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 | Dönem milisaniye cinsinden. |
En son bölümün yayın tarihi | İsteğe bağlı | Dönem 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ı bir abonelik satın aldıktan 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ıştır. |
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 türü izle | Koşula bağlı olarak gerekli | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM: Kullanıcı bu içeriği zaten 1 dakikadan daha uzun süre izledi. YENİ: Kullanıcı, bazı bölümlerden oluşan içeriklerden mevcut tüm bölümleri izlemiştir ancak yeni bir bölüm yayınlanmıştır ve izlenmemiş tam bir bölüm kalmıştır. Bu özellik; TV programları, bir dizideki kayıtlı futbol maçları vb. için geçerlidir. 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. İZLEME LİSTESİ: Kullanıcı, izleyecekleri bir sonraki videoyu manuel olarak seçmek için izleme listesine film, etkinlik veya dizi eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType Continue (Devam) durumunda olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
TvSeasonEntity
Ö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'ne bakın. |
Bilgi sayfası URI'si | Zorunlu |
TV programı sezonuyla ilgili ayrıntıları gösteren 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 programının sezonunu 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 |
Gösterilen sezon numarası |
İsteğe bağlı 1.3.1 sürümünde kullanılabilir |
Dize |
İlk bölümün yayın tarihi | Zorunlu | Dönem milisaniye cinsinden. |
En son bölümün yayın tarihi | İsteğe bağlı | Dönem 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ı bir abonelik satın aldıktan 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ıştır. |
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, endüstri standardına uyun. (Örnek) |
Sonraki türü izle | Koşula bağlı olarak gerekli | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM: Kullanıcı bu içeriği zaten 1 dakikadan daha uzun süre izledi. YENİ: Kullanıcı, bazı bölümlerden oluşan içeriklerden mevcut tüm bölümleri izlemiştir ancak yeni bir bölüm yayınlanmıştır ve izlenmemiş tam bir bölüm kalmıştır. Bu özellik; TV programları, bir dizideki kayıtlı futbol maçları vb. için geçerlidir. 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. İZLEME LİSTESİ: Kullanıcı, izleyecekleri bir sonraki videoyu manuel olarak seçmek için izleme listesine film, etkinlik veya dizi eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType Continue (Devam) durumunda olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
TvEpisodeEntity
Ö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'ne bakın. |
Oynatma URI'si | Zorunlu |
Bölümü 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ı |
TV programı bölümüyle ilgili ayrıntıların gösterildiği 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 | Dönem 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ı bir abonelik satın aldıktan 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ıştır. |
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, endüstri standardına uyun. (Örnek) |
Sonraki türü izle | Koşula bağlı olarak gerekli | Öğe Devam kümesinde olduğunda sağlanmal��dır ve aşağıdaki dört türden biri olmalıdır: DEVAM: Kullanıcı bu içeriği zaten 1 dakikadan daha uzun süre izledi. YENİ: Kullanıcı, bazı bölümlerden oluşan içeriklerden mevcut tüm bölümleri izlemiştir ancak yeni bir bölüm yayınlanmıştır ve izlenmemiş tam bir bölüm kalmıştır. Bu özellik; TV programları, bir dizideki kayıtlı futbol maçları vb. için geçerlidir. 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. İZLEME LİSTESİ: Kullanıcı, izleyecekleri bir sonraki videoyu manuel olarak seçmek için izleme listesine film, etkinlik veya dizi eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType Continue (Devam) durumunda olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
LiveStreamingVideoEntity
Ö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'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ı | Dönem milisaniye cinsinden. |
Bitiş zamanı | İsteğe bağlı | Dönem milisaniye cinsinden. |
İzlenme sayısı | İsteğe bağlı | Serbest metin, yerelleştirilmelidir. |
Sonraki türü izle | Koşula bağlı olarak gerekli | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM: Kullanıcı bu içeriği zaten 1 dakikadan daha uzun süre izledi. YENİ: Kullanıcı, bazı bölümlerden oluşan içeriklerden mevcut tüm bölümleri izlemiştir ancak yeni bir bölüm yayınlanmıştır ve izlenmemiş tam bir bölüm kalmıştır. Bu özellik; TV programları, bir dizideki kayıtlı futbol maçları vb. için geçerlidir. 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. İZLEME LİSTESİ: Kullanıcı, izleyecekleri bir sonraki videoyu manuel olarak seçmek için izleme listesine film, etkinlik veya dizi eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType Continue (Devam) durumunda olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
VideoClipEntity
VideoClipEntity
nesnesi, TikTok veya YouTube gibi sosyal medyadan gelen bir video varlığını 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'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 | Dönem milisaniye cinsinden. |
Süre | Zorunlu | Milisaniye cinsinden pozitif bir değer olmalıdır. |
Kurucu | Zorunlu | Serbest metin |
Oluşturan resmi | İsteğe bağlı | İçerik üretici avatarının resmi |
İzlenme sayısı | İsteğe bağlı | Serbest metin, yerelleştirilmelidir. |
Sonraki türü izle | Koşula bağlı olarak gerekli | Öğe Devam kümesinde olduğunda sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: DEVAM: Kullanıcı bu içeriği zaten 1 dakikadan daha uzun süre izledi. YENİ: Kullanıcı, bazı bölümlerden oluşan içeriklerden mevcut tüm bölümleri izlemiştir ancak yeni bir bölüm yayınlanmıştır ve izlenmemiş tam bir bölüm kalmıştır. Bu özellik; TV programları, bir dizideki kayıtlı futbol maçları vb. için geçerlidir. 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. İZLEME LİSTESİ: Kullanıcı, izleyecekleri bir sonraki videoyu manuel olarak seçmek için izleme listesine film, etkinlik veya dizi eklemeyi açıkça seçmiştir. |
Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesinde olduğunda sağlanmalıdır. Dönem milisaniye cinsinden. |
Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType Continue (Devam) durumunda olduğunda 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 ortaya, resmin% 80'lik kısmına 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 (örneğin, WorkManager kullanılarak) yürütülmesi ve düzenli olarak ya da etkinlik temelinde (örneğin, kullanıcı uygulamayı her açtığında veya alışveriş sepetine ürün 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 uygun olup olmadığını ve içeriğin cihazda sunulup sunulamayacağını kontrol etmek amacıyla 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
nesnelerin 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, bir işlem içinde aşağıdaki işlemler gerçekleştirilir:
- Geliştirici iş ortağındaki mevcut
RecommendationCluster
verileri kaldırılır. - İstekten elde edilen veriler ayrıştırılır ve güncellenen Öneri Kümesinde depolanır.
Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.
publishFeaturedCluster
Bu API, FeaturedCluster
nesnelerin 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, bir işlem içinde aşağıdaki işlemler gerçekleştirilir:
- Geliştirici iş ortağındaki mevcut
FeaturedCluster
verileri kaldırılır. - İstekteki veriler ayrıştırılır ve güncellenmiş Öne Çıkan Kümede 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ğındaki mevcut
ContinuationCluster
verileri kaldırılır. - İstekten elde edilen veriler ayrıştırılır ve güncellenmiş Devam Kümesinde depolanır.
Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.
publishUserAccountManagementRequest
Bu API, bir 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 sağlayabilmesi) 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'sı | Zorunlu | İşlem için derin bağlantı (ör. uygulamada oturum açma sayfasına gider) |
Resim | İsteğe bağlı: Sağlanmamışsa başlık belirtilmelidir |
Kartta Gösterilen Resim 1264x712 çözünürlüklü, 16x9 en boy oranında resimler |
Başlık | İsteğe bağlı: Sağlanmamışsa resim sağlanmalıdır | Karttaki Başlık |
İşlem Metni | İsteğe bağlı | CTA'da (ör. Oturum Aç) gösterilen metin |
Alt başlık | İsteğe bağlı | Kartta İsteğe Bağlı Alt Başlık |
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, bir işlem içinde aşağıdaki işlemler gerçekleştirilir:
- Geliştirici iş ortağındaki mevcut
UserAccountManagementCluster
verileri kaldırılır. - İstekten elde edilen veriler ayrıştırılır ve güncellenmiş UserAccountManagementCluster Kümesinde depolanır.
Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.
updatePublishStatus
İşletmeyle ilgili herhangi bir nedenle kümelerden hiçbiri yayınlanmaz. Yayınlama durumunu updatePublishStatus API'sini kullanarak güncellemenizi kesinlikle öneririz. Bu önemlidir, çünkü :
- İçerik yayınlandığında bile tüm senaryolarda durumu belirtmek (STATUS == YAYINLANDI) entegrasyonunuzun durumunu ve diğer metriklerini iletmek için bu uygunsuz durumu kullanan kontrol panellerini doldurmak açısından çok önemlidir.
- Hiçbir içerik yayınlanmadıysa ancak entegrasyon durumu bozuk değilse (STATUS == NOT_PUBLISHED) Google, uygulamanın sağlık 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ığıyla ilgili bilgi sağlamasına yardımcı olur.
- Google, uygulama içeriğini görebilmeleri veya üstesinden gelebilmesi amacıyla, durum kodlarını kullanıcıyı uygulamada belirli işlemleri yapmaya yönlendirmek için kullanabilir.
Uygun yayınlama durum 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, bir kullanıcı giriş yapmadığı için yayınlanmazsa Google, Oturum Açma kartını yayınlamanızı önerir. Sağlayıcılar herhangi bir nedenle Oturum Açma kartını yayınlayamazsa updatePublishStatus API'sini NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla ç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. Bir 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 mevcut verileri Öne Çıkan Küme'den kaldırır. Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.
deleteContinuationCluster
Bu API, Devam Kümesinin içeriğini silmek için kullanılır.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Hizmet, isteği aldığında mevcut verileri Devam Kümesinden kaldırır. Bir 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. Bir hata olması durumunda, isteğin 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ümelerden mevcut verileri kaldırır. İstemciler bir veya daha fazla küme türünü geçirmeyi seçebilir. Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.
Hata işleme
Başarılı bir görevi kurtarmak ve yeniden göndermek için takip işleminin yapılabilmesi için görev sonucunun publish API'lerinden dinlenmesi önemle tavsiye edilir.
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, nedeni hata kodu olarak eklenmiş bir AppEngageException
olarak döndürülür.
Hata kodu | Not |
---|---|
SERVICE_NOT_FOUND |
Hizmet, belirtilen cihazda kullanılamıyor. |
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). |
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. |
SERVICE_CALL_PERMISSION_DENIED |
Arayanın hizmet çağrısı yapmasına izin verilmiyor. |
SERVICE_CALL_INVALID_ARGUMENT |
İstek geçersiz veriler içeriyor (örneğin, izin verilen küme sayısından daha fazla). |
SERVICE_CALL_INTERNAL |
Hizmet tarafında bir hata oluştu. |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Hizmet çağrısı çok sık yapılıyor. |
3. Adım: Yayın amaçlarını ele alın
İçerik yayınlama isteğini almak için bir iş üzerinden Content API çağrıları yapmanın yanı sıra bir BroadcastReceiver
oluşturmak da gerekir.
Amaca dayalı yayınların amacı, temel olarak uygulamanın yeniden etkinleştirilmesini sağlamak ve veri senkronizasyonunu zorunlu kılmaktır. Yayın amaçları çok sık gönderilecek şekilde tasarlanmamıştır. Bu işlem yalnızca Etkileşim Hizmeti tarafından içeriğin eski (örneğin, bir hafta önce) olabileceğini belirlediğinde tetiklenir. Bu şekilde, uygulama uzun bir süredir çalıştırılmamış olsa bile kullanıcının yeni bir içerik deneyimine sahip olabileceğine dair güven artar.
BroadcastReceiver
aşağıdaki iki şekilde ayarlanmalıdır:
Context.registerReceiver()
kullanarakBroadcastReceiver
sınıfının bir örneğini dinamik olarak kaydedin. Bu, hâlâ bellekte bulunan uygulamalardan iletişim kurulmasını sağlar.
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ızdaki<receiver>
etiketi ile bir uygulamayı statik olarak bildirin. 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>
Aşağıdaki intentler hizmet tarafından 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 niyeti alırkenpublishFeaturedCluster
araması 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ışı
İşlem tamamlandıktan sonra entegrasyonunuzu doğrulamayla ilgili adım adım açıklamalı kılavuz için Etkileşim kurma geliştirici entegrasyonu iş akışı başlıklı makaleyi inceleyin.
SSS
SSS'ler için Etkileşim SDK'sıyla İlgili Sık Sorulan Sorular bölümüne bakın.
İ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 şu adımları uygulayabilirsiniz:
- 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 doğrulama ve dahili inceleme gerçekleştirir. Değişiklik gerekirse Google gerekli bilgileri vermek için sizinle iletişime geçer.
- Test tamamlandığında ve değişiklik gerekmiyorsa 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üncellenen 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ılara gösterilebilir.