Kullanıcılarınıza bulundukları yerde ulaşarak uygulama etkileşimini artırın. Engage SDK'yı entegre ederek "İzlemeye Devam Edin" içeriklerini ve kişiselleştirilmiş önerileri doğrudan kullanıcılara birden fazla cihaz üzerinde çalışarak içeriklerinizi öne çıkaran yüzeyde (Koleksiyonlar, Entertainment Space ve Google Play Store) sunun. Entegrasyon, ortalama APK'ya 50 KB'tan daha az (sıkıştırılmış) ekler ve çoğu uygulama için yaklaşık bir haftalık geliştirici süresi alır. Daha fazla bilgi için işletme sitemizi ziyaret edin.
Bu kılavuzda, geliştirici iş ortaklarının Engage SDK'yı kullanarak video içeriklerini hem bu yeni yüzey alanına hem de mevcut Google yüzeylerine entegre etme talimatları yer almaktadır.
Kategori desteği ve yüzeyler
Engage SDK yüzey uygunluğu, uygulamanızın içerik kategorisine bağlıdır. Belirli platformlara uygunluk durumunuzu belirlemek için aşağıdaki tabloyu kullanın:
| Durum | İçerik kategorisi veya kullanım alanı | Desteklenen yüzeyler |
|---|---|---|
|
Desteklenir (Tüm platformlarda kullanılabilir) |
|
|
|
Kısmen destekleniyor (Bazı platformlarda kullanılabilir) |
|
|
| Desteklenmiyor |
|
Android becerileri
GitHub'da gösterEngage SDK'yı entegre etme
android skills add engage-sdk-integrationEntegrasyon ayrıntısı
Bu bölümde, video içeriği için Engage SDK ile entegrasyon yapmak üzere gereken adımlar, veri modelleri ve terminoloji ayrıntılı olarak açıklanmaktadır.
Terminoloji
Bu entegrasyon şu üç küme türünü içerir: Öneri, Devam ve Öne Çıkanlar.
Öneri kümeleri, belirli bir geliştirici iş ortağının izlenecek içerikleriyle ilgili 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 kullanıcı arayüzü görünümü.
Şekil 1. Tek bir iş ortağından öneri kümesi gösteren Entertainment Space kullanıcı arayüzü. 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 verilerini sağlama bölümüne bakın.
Şekil 2. Tek bir iş ortağının öneri kümesinde tek bir öğeyi gösteren Entertainment Space kullanıcı arayüzü.
Devam kümesi, birden fazla geliştirici iş ortağının tamamlanmamış videolarını ve yeni yayınlanan ilgili bölümlerini tek bir kullanıcı arayüzü grubunda gösterir. Her geliştirici iş ortağının, devamlılık kümesinde en fazla 10 öğe yayınlamasına izin verilir. Araştırmalar, kişiselleştirilmiş önerilerin ve kişiselleştirilmiş devam içeriklerinin kullanıcı etkileşimini en üst düzeye çıkardığını gösteriyor.
Şekil 3. Birden fazla iş ortağından tamamlanmamış öneriler içeren bir devam kümesini gösteren Entertainment Space kullanıcı arayüzü (şu anda yalnızca bir öneri görünür). Öne Çıkanlar kümesi, birden fazla geliştirici iş ortağının seçili öğelerini tek bir kullanıcı arayüzü grubunda gösterir. Tek bir Öne Çıkan küme olacak ve bu küme, tüm Öneri kümelerinin üzerinde öncelikli bir yerleşimle kullanıcı arayüzünün üst kısmına yakın bir yerde gösterilecek. Her geliştirici iş ortağının, Öne Çıkanlar kümesinde en fazla 10 öğe yayınlamasına izin verilir.
Şekil 4. Birden fazla iş ortağından öneriler içeren Öne Çıkanlar kümesini gösteren Entertainment Space kullanıcı arayüzü (şu anda yalnızca bir öneri görünür).
Ö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.6.0'
}
Daha fazla bilgi için Android 11'de paket görünürlüğü başlıklı makaleyi inceleyin.
Özet
Tasarım, bağlama hizmetinin uygulanmasına dayanır.
Bir istemcinin yayınlayabileceği veriler, farklı küme türleri için aşağıdaki sınırlamalara tabidir:
| Küme türü | Küme sınırları | Bir kümedeki maksimum öğe sınırları |
|---|---|---|
| Öneri Kümeleri | En fazla 7 | En fazla 50 |
| Devam Kümesi | En fazla 1 | En fazla 20 |
| Öne Çıkan Küme | En fazla 1 | En fazla 20 |
0. adım: Mevcut Media Home SDK entegrasyonundan geçiş
Bu bölümde, mevcut Media Home SDK veri modellerinizi ve API çağrılarınızı Engage SDK'ya nasıl taşıyacağınız açıklanmaktadır.
Mevcut entegrasyondaki 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'ya nasıl eşleneceği açıklanmaktadır:
| MediaHomeVideoContract entegrasyonu 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 ayrılmış: EventVideo,
LiveStreamingVideo, Movie,
TvEpisode, TvSeason, TvShow,
VideoClipEntity
|
com.google.android.mediahome.video.PreviewProgram.Builder
|
Ayrı sınıflardaki oluşturuculara bölünmüş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ünmüştür:
EventVideoEntity, LiveStreamingVideoEntity,
MovieEntity, TvEpisodeEntity,
TvSeasonEntity, TvShowEntity,
VideoClipEntity |
com.google.android.mediahome.video.WatchNextProgram.Builder
|
Ayrı sınıflardaki özelliklere bölünmüştür:
EventVideoEntity, LiveStreamingVideoEntity,
MovieEntity, TvEpisodeEntity,
TvSeasonEntity, TvShowEntity,
VideoClipEntity |
Media Home SDK'da Engage SDK'ya kıyasla kümeleri yayınlama
Media Home SDK'da kümeler ve öğeler 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 öğe yayınlama, tek bir API çağrısında birleştirilir. Bir kümeye ait tüm öğeler, o 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: Tüzel kişi verilerini sağlayın
SDK, her öğe türünü temsil etmek için farklı varlıklar tanımlamıştır. İzleme kategorisi için aşağıdaki varlıkları destekliyoruz:
Aşağıdaki grafikte 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 en boy oranı belirtilmelidir. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimlerin iletilmesi önerilir.)
Yönergeler için Resim Özellikleri'ni inceleyin. |
| Oynatma URI'si | Mobil için gerekli |
Filmi oynatmaya başlamak için sağlayıcı uygulamasına yönlendiren derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın |
| Platforma özgü oynatma URI'leri | Mobil için isteğe bağlı, Google TV için zorunlu |
Filmi oynatmaya başlamak için sağlayıcı uygulamasına platforma özel derin bağlantılar. |
| Bilgi sayfası URI'si | İsteğe bağlı |
Filmle ilgili ayrıntıları göstermek için sağlayıcı uygulamasına yönlendiren derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın |
| Çıkış tarihi | İsteğe bağlı | Epoch milisaniye cinsinden. |
| Kullanılabilirlik | İsteğe bağlı | AVAILABLE: İçerik, başka bir işlem yapılmasına gerek kalmadan kullanıcı tarafından kullanılabilir. FREE_WITH_SUBSCRIPTION: İçerik, kullanıcı abonelik satın aldıktan sonra kullanılabilir. PAID_CONTENT: İçeriğin kullanıcı tarafından satın alınması veya kiralanması gerekir. PURCHASED: İç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 | İsteğe bağlı | Serbest metin |
| İçerik derecelendirmeleri | İsteğe bağlı | Serbest metin, endüstri standardına uyun. Örnek |
| Harekete geçirici mesaj | İsteğe bağlı | Harekete geçirici mesaj olarak gösterilecek serbest metin. |
| Etiketler | İsteğe bağlı | Varlıkla ilişkili etiketlerin listesi. |
| Sıradaki video türü | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: CONTINUE: Kullanıcı bu içeriğin 1 dakikadan fazlasını izlemiştir. YENİ: Kullanıcı, bölümlerden oluşan bir içeriğin mevcut tüm bölümlerini izlemiş ancak yeni bir bölüm yayınlanmış ve izlenmemiş tam bir bölüm var. Bu, TV programları veya bir serideki kaydedilmiş futbol maçları gibi bölümlere ayrılmış içerikler için geçerlidir. NEXT: Kullanıcı, bölümler hâlindeki bir içeriğin bir veya daha fazla bölümünü tamamen izlemiştir ancak birden fazla bölüm ya da tam olarak bir bölüm kalmıştır. Son bölüm "YENİ" değildir ve kullanıcı, bölümler hâlindeki içeriği izlemeye başlamadan önce yayınlanmıştır. İZLEME LİSTESİ: Kullanıcı, daha sonra izlemek istediği içerikleri manuel olarak seçmek için bir filmi, etkinliği veya diziyi izleme listesine eklemeyi açıkça tercih etmiştir. |
| Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır. Epoch milisaniye cinsinden. |
| Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType, CONTINUE ise sağlanmalıdır. Epoch milisaniye cinsinden. |
TvShowEntity
| Özellik | Şartlar | Notlar |
|---|---|---|
| Ad | Zorunlu | |
| Poster resimleri | Zorunlu | En az bir resim gereklidir ve en boy oranı belirtilmelidir. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimlerin iletilmesi önerilir.)
Yönergeler için Resim Özellikleri'ni inceleyin. |
| Bilgi sayfası URI'si | Zorunlu |
TV programının ayrıntılarını göstermek için sağlayıcı uygulamasına yönlendiren derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın |
| Oynatma URI'si | İsteğe bağlı |
TV programını oynatmaya başlamak için sağlayıcı uygulamasına yönlendiren derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın |
| Platforma özgü oynatma URI'leri | Mobil için isteğe bağlı, Google TV için zorunlu |
TV programını oynatmaya başlamak için sağlayıcı uygulamasına platforma özel derin bağlantılar. |
| İlk bölümün yayın tarihi | İsteğe bağlı | Epoch milisaniye cinsinden. |
| Son bölümün yayın tarihi | İsteğe bağlı | Epoch milisaniye cinsinden. |
| Kullanılabilirlik | İsteğe bağlı | AVAILABLE: İçerik, başka bir işlem yapılmasına gerek kalmadan kullanıcı tarafından kullanılabilir. FREE_WITH_SUBSCRIPTION: İçerik, kullanıcı abonelik satın aldıktan sonra kullanılabilir. PAID_CONTENT: İçeriğin kullanıcı tarafından satın alınması veya kiralanması gerekir. PURCHASED: İçerik, kullanıcı tarafından satın alınmış veya kiralanmıştır. |
| Teklif fiyatı | İsteğe bağlı | Serbest metin |
| Sezon sayısı | İsteğe bağlı | Pozitif tam sayı |
| Tür | İsteğe bağlı | Serbest metin |
| İçerik derecelendirmeleri | İsteğe bağlı | Serbest metin, endüstri standardına uyun. Örnek |
| Harekete geçirici mesaj | İsteğe bağlı | Harekete geçirici mesaj olarak gösterilecek serbest metin. |
| Etiketler | İsteğe bağlı | Varlıkla ilişkili etiketlerin listesi. |
| Sıradaki video türü | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: CONTINUE: Kullanıcı bu içeriğin 1 dakikadan fazlasını izlemiştir. YENİ: Kullanıcı, bölümlerden oluşan bir içeriğin mevcut tüm bölümlerini izlemiş ancak yeni bir bölüm yayınlanmış ve izlenmemiş tam bir bölüm var. Bu, TV programları veya bir serideki kaydedilmiş futbol maçları gibi bölümlere ayrılmış içerikler için geçerlidir. NEXT: Kullanıcı, bölümler hâlindeki bir içeriğin bir veya daha fazla bölümünü tamamen izlemiştir ancak birden fazla bölüm ya da tam olarak bir bölüm kalmıştır. Son bölüm "YENİ" değildir ve kullanıcı, bölümler hâlindeki içeriği izlemeye başlamadan önce yayınlanmıştır. İZLEME LİSTESİ: Kullanıcı, daha sonra izlemek istediği içerikleri manuel olarak seçmek için bir filmi, etkinliği veya diziyi izleme listesine eklemeyi açıkça tercih etmiştir. |
| Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır. Epoch milisaniye cinsinden. |
| Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType, CONTINUE ise sağlanmalıdır. Epoch milisaniye cinsinden. |
TvSeasonEntity
| Özellik | Şartlar | Notlar |
|---|---|---|
| Ad | Zorunlu | |
| Poster resimleri | Zorunlu | En az bir resim gereklidir ve en boy oranı belirtilmelidir. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimlerin iletilmesi önerilir.)
Yönergeler için Resim Özellikleri'ni inceleyin. |
| Bilgi sayfası URI'si | Zorunlu |
TV programı sezonunun ayrıntılarını göstermek için sağlayıcı uygulamasına yönlendiren derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın |
| Oynatma URI'si | İsteğe bağlı |
TV programı sezonunu oynatmaya başlamak için sağlayıcı uygulamasına yönlendiren derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına 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 | İsteğe bağlı | Epoch milisaniye cinsinden. |
| Son bölümün yayın tarihi | İsteğe bağlı | Epoch milisaniye cinsinden. |
| Kullanılabilirlik | İsteğe bağlı | AVAILABLE: İçerik, başka bir işlem yapılmasına gerek kalmadan kullanıcı tarafından kullanılabilir. FREE_WITH_SUBSCRIPTION: İçerik, kullanıcı abonelik satın aldıktan sonra kullanılabilir. PAID_CONTENT: İçeriğin kullanıcı tarafından satın alınması veya kiralanması gerekir. PURCHASED: İç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ı | İsteğe bağlı | Pozitif tam sayı |
| Tür | İsteğe bağlı | Serbest metin |
| İçerik derecelendirmeleri | İsteğe bağlı | Serbest metin, endüstri standardına uyun. Örnek |
| Harekete geçirici mesaj | İsteğe bağlı | Harekete geçirici mesaj olarak gösterilecek serbest metin. |
| Etiketler | İsteğe bağlı | Varlıkla ilişkili etiketlerin listesi. |
| Sıradaki video türü | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: CONTINUE: Kullanıcı bu içeriğin 1 dakikadan fazlasını izlemiştir. YENİ: Kullanıcı, bölümlerden oluşan bir içeriğin mevcut tüm bölümlerini izlemiş ancak yeni bir bölüm yayınlanmış ve izlenmemiş tam bir bölüm var. Bu, TV programları veya bir serideki kaydedilmiş futbol maçları gibi bölümlere ayrılmış içerikler için geçerlidir. NEXT: Kullanıcı, bölümler hâlindeki bir içeriğin bir veya daha fazla bölümünü tamamen izlemiştir ancak birden fazla bölüm ya da tam olarak bir bölüm kalmıştır. Son bölüm "YENİ" değildir ve kullanıcı, bölümler hâlindeki içeriği izlemeye başlamadan önce yayınlanmıştır. İZLEME LİSTESİ: Kullanıcı, daha sonra izlemek istediği içerikleri manuel olarak seçmek için bir filmi, etkinliği veya diziyi izleme listesine eklemeyi açıkça tercih etmiştir. |
| Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır. Epoch milisaniye cinsinden. |
| Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType, CONTINUE ise sağlanmalıdır. Epoch milisaniye cinsinden. |
TvEpisodeEntity
| Özellik | Şartlar | Notlar |
|---|---|---|
| Ad | Zorunlu | |
| Poster resimleri | Zorunlu | En az bir resim gereklidir ve en boy oranı belirtilmelidir. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimler iletmeniz önerilir.)
Yönergeler için Resim Özellikleri'ni inceleyin. |
| Oynatma URI'si | Mobil için zorunlu |
Bölümü oynatmaya başlamak için sağlayıcı uygulamasına yönlendiren derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın |
| Platforma özgü oynatma URI'leri | Mobil için isteğe bağlı, Google TV için zorunlu |
Bölümü oynatmaya başlamak için sağlayıcı uygulamasına platforma özel derin bağlantılar. |
| 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ına yönlendiren derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın |
| Program adı | Mobil için isteğe bağlı; Google TV'de İzlemeye Devam Edin için zorunlu | Bölümün ait olduğu TV programının başlığı. |
| Sezon numarası | Mobil için isteğe bağlı; Google TV'de İzlemeye Devam Edin için zorunlu | Dize |
| Bölüm numarasını göster |
Mobil için isteğe bağlı; Google TV'de İzlemeye Devam Edin için zorunlu 1.3.1 sürümünde kullanılabilir |
Dize |
| Yayınlanma tarihi | İsteğe bağlı | Epoch milisaniye cinsinden. |
| Kullanılabilirlik | İsteğe bağlı | AVAILABLE: İçerik, başka bir işlem yapılmasına gerek kalmadan kullanıcı tarafından kullanılabilir. FREE_WITH_SUBSCRIPTION: İçerik, kullanıcı abonelik satın aldıktan sonra kullanılabilir. PAID_CONTENT: İçeriğin kullanıcı tarafından satın alınması veya kiralanması gerekir. PURCHASED: İç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 | İsteğe bağlı | Serbest metin |
| İçerik derecelendirmeleri | İsteğe bağlı | Serbest metin, endüstri standardına uyun. Örnek |
| Harekete geçirici mesaj | İsteğe bağlı | Harekete geçirici mesaj olarak gösterilecek serbest metin. |
| Etiketler | İsteğe bağlı | Varlıkla ilişkili etiketlerin listesi. |
| Sıradaki video türü | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: CONTINUE: Kullanıcı bu içeriğin 1 dakikadan fazlasını izlemiştir. YENİ: Kullanıcı, bölümlerden oluşan bir içeriğin mevcut tüm bölümlerini izlemiş ancak yeni bir bölüm yayınlanmış ve izlenmemiş tam bir bölüm var. Bu, TV programları veya bir serideki kaydedilmiş futbol maçları gibi bölümlere ayrılmış içerikler için geçerlidir. NEXT: Kullanıcı, bölümler hâlindeki bir içeriğin bir veya daha fazla bölümünü tamamen izlemiştir ancak birden fazla bölüm ya da tam olarak bir bölüm kalmıştır. Son bölüm "YENİ" değildir ve kullanıcı, bölümler hâlindeki içeriği izlemeye başlamadan önce yayınlanmıştır. İZLEME LİSTESİ: Kullanıcı, daha sonra izlemek istediği içerikleri manuel olarak seçmek için bir filmi, etkinliği veya diziyi izleme listesine eklemeyi açıkça tercih etmiştir. |
| Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır. Epoch milisaniye cinsinden. |
| Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType, CONTINUE ise sağlanmalıdır. Epoch milisaniye cinsinden. |
LiveStreamingVideoEntity
| Özellik | Şartlar | Notlar |
|---|---|---|
| Ad | Zorunlu | |
| Poster resimleri | Zorunlu | En az bir resim gereklidir ve en boy oranı belirtilmelidir. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimlerin iletilmesi önerilir.)
Yönergeler için Resim Özellikleri'ni inceleyin. |
| Oynatma URI'si | Mobil için zorunlu |
Videoyu oynatmaya başlamak için sağlayıcı uygulamasına yönlendiren derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın |
| Platforma özgü oynatma URI'leri | Mobil için isteğe bağlı, Google TV için zorunlu |
Videoyu oynatmaya başlamak için sağlayıcı uygulamasına yönlendiren platforma özel derin bağlantılar. |
| Yayıncı | İsteğe bağlı | Serbest metin |
| Başlangıç zamanı | İsteğe bağlı | Epoch milisaniye cinsinden. |
| Bitiş zamanı | İsteğe bağlı | Epoch milisaniye cinsinden. |
| Görüntüleme sayısı | İsteğe bağlı | Serbest metin, yerelleştirilmelidir. |
| Harekete geçirici mesaj | İsteğe bağlı | Harekete geçirici mesaj olarak gösterilecek serbest metin. |
| Etiketler | İsteğe bağlı | Varlıkla ilişkili etiketlerin listesi. |
| Sıradaki video türü | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: CONTINUE: Kullanıcı bu içeriğin 1 dakikadan fazlasını izlemiştir. YENİ: Kullanıcı, bölümlerden oluşan bir içeriğin mevcut tüm bölümlerini izlemiş ancak yeni bir bölüm yayınlanmış ve izlenmemiş tam bir bölüm var. Bu, TV programları veya bir serideki kaydedilmiş futbol maçları gibi bölümlere ayrılmış içerikler için geçerlidir. NEXT: Kullanıcı, bölümler hâlindeki bir içeriğin bir veya daha fazla bölümünü tamamen izlemiştir ancak birden fazla bölüm ya da tam olarak bir bölüm kalmıştır. Son bölüm "YENİ" değildir ve kullanıcı, bölümler hâlindeki içeriği izlemeye başlamadan önce yayınlanmıştır. İZLEME LİSTESİ: Kullanıcı, daha sonra izlemek istediği içerikleri manuel olarak seçmek için bir filmi, etkinliği veya diziyi izleme listesine eklemeyi açıkça tercih etmiştir. |
| Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır. Epoch milisaniye cinsinden. |
| Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType, CONTINUE ise sağlanmalıdır. Epoch milisaniye cinsinden. |
VideoClipEntity
VideoClipEntity nesnesi, TikTok veya YouTube gibi sosyal medyadan gelen bir video öğesini temsil eder.
| Özellik | Şartlar | Notlar |
|---|---|---|
| Ad | Zorunlu | |
| Poster resimleri | Zorunlu | En az bir resim gereklidir ve en boy oranı belirtilmelidir. (Yatay tercih edilir ancak farklı senaryolar için hem dikey hem de yatay resimlerin iletilmesi önerilir.)
Yönergeler için Resim Özellikleri'ni inceleyin. |
| Oynatma URI'si | Mobil için zorunlu |
Videoyu oynatmaya başlamak için sağlayıcı uygulamasına yönlendiren derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın |
| Platforma özgü oynatma URI'leri | Mobil için isteğe bağlı, Google TV için zorunlu |
Videoyu oynatmaya başlamak için sağlayıcı uygulamasına yönlendiren, platforma özel derin bağlantılar. |
| Oluşturulma tarihi | İsteğe bağlı | Epoch milisaniye cinsinden. |
| Süre | Zorunlu | Milisaniye cinsinden pozitif bir değer olmalıdır. |
| Oluşturan | İsteğe bağlı | 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. |
| Harekete geçirici mesaj | İsteğe bağlı | Harekete geçirici mesaj olarak gösterilecek serbest metin. |
| Etiketler | İsteğe bağlı | Varlıkla ilişkili etiketlerin listesi. |
| Sıradaki video türü | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır ve aşağıdaki dört türden biri olmalıdır: CONTINUE: Kullanıcı bu içeriğin 1 dakikadan fazlasını izlemiştir. YENİ: Kullanıcı, bölümlerden oluşan bir içeriğin mevcut tüm bölümlerini izlemiş ancak yeni bir bölüm yayınlanmış ve izlenmemiş tam bir bölüm var. Bu, TV programları veya bir serideki kaydedilmiş futbol maçları gibi bölümlere ayrılmış içerikler için geçerlidir. NEXT: Kullanıcı, bölümler hâlindeki bir içeriğin bir veya daha fazla bölümünü tamamen izlemiştir ancak birden fazla bölüm ya da tam olarak bir bölüm kalmıştır. Son bölüm "YENİ" değildir ve kullanıcı, bölümler hâlindeki içeriği izlemeye başlamadan önce yayınlanmıştır. İZLEME LİSTESİ: Kullanıcı, daha sonra izlemek istediği içerikleri manuel olarak seçmek için bir filmi, etkinliği veya diziyi izleme listesine eklemeyi açıkça tercih etmiştir. |
| Son etkileşim zamanı | Koşula bağlı olarak gerekli | Öğe, devam kümesindeyse sağlanmalıdır. Epoch milisaniye cinsinden. |
| Son oynatma konumu zamanı | Koşula bağlı olarak gerekli | Öğe, Devam kümesindeyse ve WatchNextType, CONTINUE ise sağlanmalıdır. Epoch 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)
.setCallToActionText("Watch Now")
.addTag("Action")
.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)
.setCallToActionText("Watch Now")
.addTag("Action")
.build();
2. adım: Küme verilerini sağlama
İçerik yayınlama işinin arka planda yürütülmesi (ör. WorkManager kullanılarak) ve düzenli olarak veya etkinlik bazında (ör. kullanıcı uygulamayı her açtığında ya da sepetine bir şey eklediğinde) planlanması önerilir.
AppEngagePublishClient, kümeleri yayınlamaktan sorumludur. İstemcide aşağıdaki API'ler kullanılabilir:
isServiceAvailablepublishRecommendationClusterspublishFeaturedClusterpublishContinuationClusterpublishUserAccountManagementRequestupdatePublishStatusdeleteRecommendationsClustersdeleteFeaturedClusterdeleteContinuationClusterdeleteUserManagementClusterdeleteClusters
isServiceAvailable
Bu API, hizmetin entegrasyon için kullanılabilir olup olmadığını ve içeriğin cihazda sunulup sunulamayacağını kontrol etmek için kullanılır.
Engage SDK 1.6.0 ve sonraki sürümler için (Önerilen)
Android becerileri
GitHub'da gösterEngage SDK entegrasyonu
android skills add engage-sdk-integrationUse the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.Yayınlamayı planladığınız her küme türü için hizmet kullanılabilirliğini kontrol edebilirsiniz. isServiceAvailable API'si, hizmet kullanılabilirliğinin kontrol edilmesi gereken küme türlerini içeren bir istek nesnesi (ServiceAvailabilityRequest) kabul eder. ServiceAvailabilityRequest için gereken ClusterType enum değerlerini aşağıdaki tabloda bulabilirsiniz.
| Cluster Type (Küme Türü) | Küme Türü Sabiti | Tam Sayı Değeri |
|---|---|---|
| Bilinmiyor | TYPE_UNKNOWN |
0 |
| Öneri Kümesi | TYPE_RECOMMENDATION |
1 |
| Öne Çıkan Küme | TYPE_FEATURED |
2 |
| Devam Kümesi | TYPE_CONTINUATION |
3 |
| Kullanıcı Yönetimi Kümesi | TYPE_ENGAGEMENT |
8 |
| Abonelik Kümesi | TYPE_SUBSCRIPTION |
12 |
Kotlin
val request = ServiceAvailabilityRequest.Builder()
.addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
.addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
.build()
client.isServiceAvailable(request).addOnCompleteListener { task ->
if (task.isSuccessful) {
val availabilityMap = task.result
if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
// Proceed with publishing continuation content
}
if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
// Proceed with publishing recommendation content
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
}
Java
ServiceAvailabilityRequest request =
new ServiceAvailabilityRequest.Builder()
.addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
.addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
.build();
client.isServiceAvailable(request).addOnCompleteListener(task -> {
if (task.isSuccessful()) {
Map<Integer, Boolean> availabilityMap = task.getResult();
if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
// Proceed with publishing continuation content
}
if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
// Proceed with publishing recommendation content
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
});
Koşullu Hizmet Kullanılabilirliği Özelliği
Bazı entegre uygulamalar, yayınlama maliyetlerini azaltmak için Engage hizmetini aralıklı olarak etkinleştiren ve devre dışı bırakan özel bir yapılandırma ister. Ancak bu aralıklı içerik besleme stratejisi, kullanıcı deneyimini olumsuz etkiler: Eski içerikler sunulmaz ve bazı platformlarda yayınlanmaz.
Engage SDK'sı, 1.6.0 sürümünden itibaren belirli küme türlerinin kullanılabilirliğini kontrol etmenize olanak tanır. Uygulamanız aralıklı besleme kullanıyorsa:
- Devam kümeleri (ör. İzlemeye Devam Edin), desteklenen tüm cihazlarda varsayılan olarak etkin kalır.
- Diğer küme türleri (ör. Öneriler) aralıklı olarak etkinleştirilir ve devre dışı bırakılır.
Bu varsayılan yapılandırma ihtiyaçlarınıza uygun değilse engage-developers@google.com ile iletişime geçin.
1.6.0 sürümünden önceki SDK sürümleri için (Desteği sonlandırıldı)
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 eylemler gerçekleşir:
- Geliştirici iş ortağından alınan mevcut
RecommendationClusterverileri kaldırılır. - İstekteki veriler ayrıştırılır ve güncellenen öneri kümesinde depolanır.
Hata 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 PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
new FeaturedCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build());
Hizmet isteği aldığında tek bir işlemde aşağıdaki eylemler gerçekleşir:
- Geliştirici iş ortağından alınan mevcut
FeaturedClusterverileri kaldırılır. - İstekteki veriler ayrıştırılır ve güncellenen Öne Çıkan Küme'de depolanır.
Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
publishContinuationCluster
Bu API, bir 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 tek bir işlemde aşağıdaki eylemler gerçekleşir:
- Geliştirici iş ortağından alınan mevcut
ContinuationClusterverileri kaldırılır. - İstekten alınan veriler ayrıştırılır ve güncellenen devam kümesinde depolanır.
Hata 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, kullanıcıları uygulamanın oturum açma sayfasına yönlendirir. Böylece uygulama, içerik yayınlayabilir (veya daha kişiselleştirilmiş içerik sunabilir).
Aşağıdaki meta veriler, oturum açma kartının bir parçasıdır:
| Özellik | Şartlar | Açıklama |
|---|---|---|
| İşlem URI'si | Zorunlu | İşleme derin bağlantı (ör. uygulama oturum açma sayfasına yönlendirir) |
| 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 oranlı 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ı | Karttaki İsteğ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 eylemler gerçekleşir:
- Geliştirici iş ortağından alınan mevcut
UserAccountManagementClusterverileri kaldırılır. - İstekteki veriler ayrıştırılır ve güncellenen UserAccountManagementCluster kümesinde depolanır.
Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
updatePublishStatus
Dahili bir işletme nedeni nedeniyle kümelerden hiçbiri yayınlanmazsa updatePublishStatus API'yi kullanarak yayınlama durumunu güncellemenizi kesinlikle öneririz. Bu önemlidir, çünkü :
- İçerik yayınlandığında bile (STATUS == PUBLISHED) tüm senaryolarda durumun sağlanması, 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ınlanmadıysa ancak entegrasyon durumu bozuk değilse (STATUS == NOT_PUBLISHED) Google, uygulama sağlığı kontrol panellerinde uyarıların tetiklenmesini önleyebilir. İçeriğin, sağlayıcı açısından beklenen bir durum nedeniyle yayınlanmadığını onaylar.
- Geliştiricilerin, verilerin ne zaman yayınlandığı ve ne zaman yayınlanmadığı hakkında bilgi vermesine yardımcı olur.
- Google, kullanıcıyı uygulamada belirli işlemleri yapmaya teşvik etmek için durum kodlarını kullanabilir. Böylece kullanıcı, uygulama içeriğini görebilir veya sorunu çözebilir.
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ın yayınlanmasını önerir. Sağlayıcılar herhangi bir nedenle oturum açma kartını yayınlayamazsa NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla updatePublishStatus API'sini çağırmalarını ö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());
deleteRecommendationsClusters
Bu API, öneri kümelerinin içeriğini silmek için kullanılır.
Kotlin
client.deleteRecommendationsClusters()
Java
client.deleteRecommendationsClusters();
Hizmet, isteği aldığında mevcut verileri Öneri Kümeleri'nden kaldırır. Hata 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. Hata 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 devamlılık kümesinden kaldırır. Hata 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ğ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 mevcut verileri belirtilen küme türleriyle eşleşen tüm kümelerden kaldırır. İstemciler bir veya daha fazla küme türü iletmeyi seçebilir. Hata 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şlemi yapılabilmesi amacıyla yayınlama API'lerinden gelen görev sonucunu dinlemeniz ö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, nedenini hata kodu olarak içeren bir 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 (ör. açıkça devre dışı bırakılmıştır). |
3 |
SERVICE_CALL_EXECUTION_FAILURE |
İş parçacığı sorunları nedeniyle görev yürütülemedi. Bu durumda işlem yeniden denenebilir. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Arayanın hizmet çağrısı yapmasına izin verilmiyor. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
İstek geçersiz veriler içeriyor (örneğin, izin verilen küme sayısından fazla küme). |
6 |
SERVICE_CALL_INTERNAL |
Hizmet tarafında bir hata var. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Hizmet çağrısı çok sık yapılıyor. |
3. adım: Yayın amaçlarını işleme
İçerik yayınlama Content API çağrılarını bir iş aracılığıyla yapmanın yanı sıra içerik yayınlama isteğini almak için bir BroadcastReceiver oluşturmanız da gerekir.
Yayın intent'lerinin amacı, genellikle uygulamayı yeniden etkinleştirmek ve veri senkronizasyonunu zorunlu kılmaktır. Yayın intent'leri çok sık gönderilecek şekilde tasarlanmamıştır. Yalnızca Engage Service, içeriğin eski (ör. bir haftalık) olabileceğini belirlediğinde tetiklenir. Bu sayede, uygulama uzun bir süre boyunca çalıştırılmamış olsa bile kullanıcının yeni bir içerik deneyimi yaşayabileceğinden daha emin olunur.
BroadcastReceiver, aşağıdaki iki şekilde ayarlanmalıdır:
Context.registerReceiver()kullanarakBroadcastReceiversınıfının bir örneğini dinamik olarak kaydedin. Bu sayede, bellekte hâlâ etkin olan uygulamalardan iletişim sağlanabilir.
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),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Featured Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Continuation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
}
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),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
}
AndroidManifest.xmldosyanızda<receiver>etiketiyle bir uygulama statik olarak beyan edilmelidir. Bu, uygulamanın çalışmadığı zamanlarda yayın intent'lerini almasına ve içeriği yayınlamasına olanak tanır.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
</intent-filter>
</receiver>
</application>
Hizmet tarafından aşağıdaki intent'ler gönderilir:
com.google.android.engage.action.PUBLISH_RECOMMENDATIONBu intent alındığındapublishRecommendationClustersçağrısı başlatılması önerilir.com.google.android.engage.action.PUBLISH_FEATUREDBu intent'i aldığınızdapublishFeaturedClusteraraması başlatmanız önerilir.com.google.android.engage.action.PUBLISH_CONTINUATIONBu intent alındığındapublishContinuationClusteraraması başlatılması önerilir.
Entegrasyon iş akışı
Entegrasyonunuz tamamlandıktan sonra doğrulama işlemiyle ilgili adım adım açıklamalı kılavuz için Engage geliştirici entegrasyonu iş akışı başlıklı makaleyi inceleyin.
SSS
Sık sorulan sorular için Engage SDK Sık Sorulan Sorular bölümüne bakın.
İletişim
Entegrasyon sürecinde herhangi bir sorunuz olursa engage-developers@google.com ile iletişime geçin.
Sonraki adımlar
Bu entegrasyonu tamamladıktan sonraki adımlarınız şunlardır:
engage-developers@google.comadresine 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 dahili olarak doğrulama ve inceleme yapar. Değişiklik gerekmesi durumunda Google, gerekli ayrıntıları paylaşmak için sizinle iletişime geçer.
- Test tamamlandığında ve herhangi bir değişiklik gerekmediğinde Google, güncellenmiş ve entegre edilmiş 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 Çıkanlar ve Devam kümeleriniz yayınlanabilir ve kullanıcılara gösterilebilir.