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 yüzey alanını hem de mevcut Google yüzeylerini doldurmak için Engage SDK'sını kullanarak ses içeriklerini entegre etme talimatları yer almaktadır.
Entegrasyon ayrıntısı
Terminoloji
Bu entegrasyon aşağıdaki üç küme türünü içerir: Öneri, Devam ve Öne Çıkan.
Öneri kümeleri, tek bir geliştirici iş ortağının okunacak içerikleriyle ilgili kişiselleştirilmiş önerilerini gösterir.
Önerileriniz aşağıdaki yapıya sahiptir:
Öneri Kümesi: Aynı geliştirici iş ortağının bir öneri grubunu içeren kullanıcı arayüzü görünümü.
Şekil 1. Tek bir iş ortağından gelen bir öneri grubunu gösteren Entertainment Space kullanıcı arayüzü. Varlık: Bir kümedeki tek bir öğeyi temsil eden nesne. Öğeler oynatma listesi, sesli kitap, podcast vb. olabilir. Desteklenen varlık türlerinin listesi için Öğe verileri sağlama bölümüne bakın.
Şekil 2. Tek bir iş ortağının Öneriler Kümesi'ndeki tek bir öğeyi gösteren Entertainment Space kullanıcı arayüzü.
Devam kümesi, birden fazla geliştirici iş ortağının kullanıcılarının son zamanlarda etkileşim kurduğu ses içeriklerini 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.
Şekil 3. Birden fazla iş ortağının tamamlanmamış önerilerini 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 Çıkan kümesi, birden fazla geliştirici iş ortağının öğelerinden oluşan bir seçkiyi tek bir kullanıcı arayüzü gruplandırmasında gösterir. Tek bir Öne Çıkan küme olacak. Bu küme, kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm Öneriler kümelerinin üzerinde öncelikli yerleşimde 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ğının önerilerini içeren öne çıkan bir kümeyi 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.5.2'
}
Ö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 fazla 7 | En fazla 50 |
Devam Kümesi | En fazla 1 | En fazla 20 |
Öne Çıkan Küme | En fazla 1 | En fazla 20 |
1. adım: Öğe verilerini sağlayın
SDK, her öğe türünü temsil etmek için farklı öğeler tanımlamıştır. Dinleme kategorisi için aşağıdaki öğeleri destekliyoruz:
MusicAlbumEntity
MusicArtistEntity
MusicTrackEntity
MusicVideoEntity
PlaylistEntity
PodcastSeriesEntity
PodcastEpisodeEntity
LiveRadioStationEntity
AudiobookEntity
Aşağıdaki grafiklerde, her tür için kullanılabilen özellikler ve koşullar özetlenmiştir.
MusicAlbumEntity
MusicAlbumEntity
nesnesi bir müzik albümünü (ör. Taylor Swift'in Midnights albümü) temsil eder.
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | Müzik albümünün başlığı. |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri bölümüne bakın. |
Bilgi sayfası uri'si | Zorunlu |
Müzik albümüyle ilgili ayrıntılar 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 |
Sanatçılar | Zorunlu | Müzik albümündeki sanatçıların listesi. |
Oynatma URI'si | İsteğe bağlı |
Albümü sağlayıcı uygulamasında oynatmaya başlayan derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Açıklama | İsteğe bağlı | Gösterilirse 200 karakterden uzun olmamalıdır. |
Şarkı sayısı | İsteğe bağlı | Müzik albümündeki şarkı sayısı. |
Türler | İsteğe bağlı | Müzik albümündeki türlerin listesi. |
Albüm biçimi | İsteğe bağlı |
ALBUM (LP ve çift LP dahil) EP TEK Karışık liste |
Plak şirketleri | İsteğe bağlı | Albümle ilişkili müzik etiketlerinin listesi. |
Cihaza indirilenler | İsteğe bağlı | Müzik albümünün cihaza indirilip indirilmediğini belirten Boole değeri. |
Müstehcen | İsteğe bağlı |
İçeriğin uygunsuz olup olmadığını belirten bir boole değeri Uygunsuz içerik barındıran veya ebeveyn uyarısı içeren öğeler TRUE olarak ayarlanmalıdır. Uygunsuz öğeler "E" etiketiyle gösterilir. |
Yayın tarihi | İsteğe bağlı | Albümün çıkış tarihi (milisaniye cinsinden). |
Süre | İsteğe bağlı | Albümün milisaniye cinsinden süresi. |
Son etkileşim zamanı | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. Sıralama için kullanılabilir. Milisaniye cinsinden |
Tamamlanan ilerleme yüzdesi | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. 0 ile 100 arasında bir tam sayı |
MusicArtistEntity
MusicArtistEntity
nesnesi bir müzik sanatçısını (ör. Adele) temsil eder.
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | Müzik sanatçısının adı. |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri bölümüne bakın. |
Bilgi sayfası uri'si | Zorunlu |
Müzik sanatçısı hakkında ayrıntılar 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ı |
Sanatçının şarkılarının sağlayıcı uygulamasında çalmaya başladığı derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Açıklama | İsteğe bağlı | Gösterilirse 200 karakterden uzun olmamalıdır. |
Son etkileşim zamanı | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. Sıralama için kullanılabilir. Milisaniye cinsinden |
MusicTrackEntity
MusicTrackEntity
nesnesi bir müzik parçasını (ör. Coldplay'in Yellow şarkısı) temsil eder.
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | Müzik parçasının başlığı. |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri bölümüne bakın. |
Oynatma URI'si | Zorunlu |
Müzik parçasını sağlayıcı uygulamasında çalmaya başlayan derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Sanatçılar | Zorunlu | Müzik parçasının sanatçılarının listesi. |
Bilgi sayfası uri'si | İsteğe bağlı |
Müzik parçasıyla ilgili ayrıntılar için sağlayıcı uygulamasına giden derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Açıklama | İsteğe bağlı | Gösterilirse 200 karakterden uzun olmamalıdır. |
Süre | İsteğe bağlı | Parçanın milisaniye cinsinden süresi. |
Albüm | İsteğe bağlı | Şarkının ait olduğu albümün adı. |
Cihaza indirilenler | İsteğe bağlı | Müzik parçasının cihaza indirilip indirilmediğini belirten Boole değeri. |
Müstehcen | İsteğe bağlı |
İçeriğin uygunsuz olup olmadığını belirten bir boole değeri Uygunsuz içerik barındıran veya ebeveyn uyarısı içeren öğeler TRUE olarak ayarlanmalıdır. Uygunsuz öğeler "E" etiketiyle gösterilir. |
Son etkileşim zamanı | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. Sıralama için kullanılabilir. Milisaniye cinsinden |
Tamamlanan ilerleme yüzdesi | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. 0 ile 100 arasında bir tam sayı |
MusicVideoEntity
MusicVideoEntity
nesnesi bir müzik videosunu temsil eder (ör. The Weeknd - Take My Breath (Resmi Müzik Videosu)).
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | Müzik videosunun başlığı. |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri bölümüne bakın. |
Oynatma URI'si | Zorunlu |
Müzik videosunu sağlayıcı uygulamasında oynatmaya başlayan derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Bilgi sayfası uri'si | İsteğe bağlı |
Müzik videosu ile ilgili ayrıntılar için sağlayıcı uygulamasına derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Süre | İsteğe bağlı | Videonun milisaniye cinsinden süresi. |
Görüntüleme sayısı | İsteğe bağlı | Videonun görüntüleme sayısı (serbest metin biçiminde). |
Sanatçılar | İsteğe bağlı | Müzik videosundaki sanatçıların listesi. |
İçerik derecelendirmesi | İsteğe bağlı | Parçanın içerik derecelendirmelerinin listesi. |
Açıklama | İsteğe bağlı | Gösterilirse 200 karakterden uzun olmamalıdır. |
Cihaza indirilenler | İsteğe bağlı | Müzik videosunun cihaza indirilip indirilmediğini belirten boole değeri. |
Müstehcen | İsteğe bağlı |
İçeriğin uygunsuz olup olmadığını belirten bir boole değeri Uygunsuz içerik barındıran veya ebeveyn uyarısı içeren öğeler TRUE olarak ayarlanmalıdır. Uygunsuz öğeler "E" etiketiyle gösterilir. |
Son etkileşim zamanı | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. Sıralama için kullanılabilir. Milisaniye cinsinden |
Tamamlanan ilerleme yüzdesi | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. 0 ile 100 arasında bir tam sayı |
PlaylistEntity
PlaylistEntity
nesnesi, bir müzik oynatma listesini (ör. ABD'deki En Popüler 10 Oynatma Listesi) temsil eder.
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | Oynatma listesinin başlığı. |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri bölümüne bakın. |
Oynatma URI'si | Zorunlu |
Sağlayıcı uygulamasında müzik oynatma listesini oynatmaya başlayan derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Bilgi sayfası uri'si | İsteğe bağlı |
Müzik listesiyle ilgili ayrıntılar için sağlayıcı uygulamasına giden derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Süre | İsteğe bağlı | Oynatma listesinin milisaniye cinsinden süresi. |
Şarkı sayısı | İsteğe bağlı | Müzik oynatma listesindeki şarkıların sayısı. |
Açıklama | İsteğe bağlı | Gösterilirse 200 karakterden uzun olmamalıdır. |
Cihaza indirilenler | İsteğe bağlı | Oynatma listesinin cihaza indirilip indirilmediğini belirten Boole değeri. |
Müstehcen | İsteğe bağlı |
İçeriğin uygunsuz olup olmadığını belirten bir boole değeri Uygunsuz içerik barındıran veya ebeveyn uyarısı içeren öğeler TRUE olarak ayarlanmalıdır. Uygunsuz öğeler "E" etiketiyle gösterilir. |
Son etkileşim zamanı | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. Sıralama için kullanılabilir. Milisaniye cinsinden |
Tamamlanan ilerleme yüzdesi | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. 0 ile 100 arasında bir tam sayı |
PodcastSeriesEntity
PodcastSeriesEntity
nesnesi bir podcast serisini (ör. This American Life) temsil eder.
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | Podcast serisinin başlığı. |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri bölümüne bakın. |
Bilgi sayfası uri'si | Zorunlu |
Podcast serisi hakkında ayrıntılar için sağlayıcı uygulamasına 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ı |
Podcast serisini sağlayıcı uygulamasında oynatmaya başlayan derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Bölüm sayısı | İsteğe bağlı | Podcast serisindeki bölüm sayısı. |
Prodüksiyon adı | İsteğe bağlı | Podcast serisinin prodüksiyonunun adı. |
Barındırıcılar | İsteğe bağlı | Podcast serisinin sunucularının listesi. |
Türler | İsteğe bağlı | Podcast serisinin türlerinin listesi. |
Cihaza indirilenler | İsteğe bağlı | Podcast'in cihaza indirilip indirilmediğini belirten Boole değeri. |
Açıklama | İsteğe bağlı | Gösterilirse 200 karakterden uzun olmamalıdır. |
Müstehcen | İsteğe bağlı |
İçeriğin uygunsuz olup olmadığını belirten bir boole değeri Uygunsuz içerik barındıran veya ebeveyn uyarısı içeren öğeler TRUE olarak ayarlanmalıdır. Uygunsuz öğeler "E" etiketiyle gösterilir. |
Son etkileşim zamanı | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. Sıralama için kullanılabilir. Milisaniye cinsinden |
PodcastEpisodeEntity
PodcastEpisodeEntity
nesnesi bir podcast serisini temsil eder (ör. Spark Bird, 754. Bölüm: This American Life).
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | Podcast bölümünün başlığı. |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri bölümüne bakın. |
Oynatma URI'si | Zorunlu |
Podcast bölümünü sağlayıcı uygulamasında oynatmaya başlayan derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Podcast dizisi başlığı | Zorunlu | Bölümün ait olduğu podcast serisinin adı. |
Süre | Zorunlu | Podcast bölümünün milisaniye cinsinden süresi. |
Yayınlanma tarihi | Zorunlu | Podcast'in yayınlanma tarihi (milisaniye cinsinden) |
Bilgi sayfası uri'si | İsteğe bağlı |
Podcast bölümüyle ilgili ayrıntılar 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 |
Prodüksiyon adı | İsteğe bağlı | Podcast serisinin prodüksiyonunun adı. |
Bölüm dizini | İsteğe bağlı | Serideki bölümün dizini (ilk dizin 1'dir). |
Barındırıcılar | İsteğe bağlı | Podcast bölümünün sunucularının listesi. |
Türler | İsteğe bağlı | Podcast bölümünün türlerinin listesi. |
Cihaza indirilenler | İsteğe bağlı | Podcast bölümünün cihaza indirilip indirilmediğini belirten Boole değeri. |
Açıklama | İsteğe bağlı | Gösterilirse 200 karakterden uzun olmamalıdır. |
Video Podcast Aboneliği | İsteğe bağlı | Podcast bölümünün video içeriği içerip içermediğini belirten Boole değeri |
Müstehcen | İsteğe bağlı |
İçeriğin uygunsuz olup olmadığını belirten bir boole değeri Uygunsuz içerik barındıran veya ebeveyn uyarısı içeren öğeler TRUE olarak ayarlanmalıdır. Uygunsuz öğeler "E" etiketiyle gösterilir. |
Sonrakini Dinle Türü | İsteğe bağlı |
Devam Kümesindeki Öğeler İçin Önerilir TYPE_CONTINUE: Bitmemiş bir ses öğesini devam ettirin. TYPE_NEXT: Bir serinin yeni birinde devam edin. TYPE_NEW: Yeni yayınlandı. |
Son etkileşim zamanı | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. Sıralama için kullanılabilir. Milisaniye cinsinden |
Tamamlanan ilerleme yüzdesi | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. 0 ile 100 arasında bir tam sayı |
LiveRadioStationEntity
LiveRadioStationEntity
nesnesi, canlı bir radyo istasyonunu (ör. 98.1 The Breeze) temsil eder.
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | Canlı radyo istasyonunun başlığı. |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri bölümüne bakın. |
Oynatma URI'si | Zorunlu |
Sağlayıcı uygulamasında radyo istasyonunu oynatmaya başlayan bir derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Bilgi sayfası uri'si | İsteğe bağlı |
Radyo istasyonuyla ilgili ayrıntılar için sağlayıcı uygulamasına giden derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
Sıklık | İsteğe bağlı | Radyo istasyonunun yayın frekansı (ör. "98.1 FM"). |
Program adı | İsteğe bağlı | Radyo istasyonunda şu anda çalan program. |
Barındırıcılar | İsteğe bağlı | Radyo istasyonunun sunucularının listesi. |
Açıklama | İsteğe bağlı | Gösterilirse 200 karakterden uzun olmamalıdır. |
Son etkileşim zamanı | İsteğe bağlı |
Devam kümesindeki öğeler için önerilir. Sıralama için kullanılabilir. Milisaniye cinsinden |
AudiobookEntity
AudiobookEntity
nesnesi, bir sesli kitabı temsil eder (ör. Michelle Obama'nın Becoming adlı kitabının sesli kitabı).
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri'ne bakın. |
Yazar | Zorunlu | En az bir yazar adı sağlanmalıdır. |
Anlatıcı | Zorunlu | En az bir anlatıcı adı sağlanmalıdır. |
İşlem bağlantısı uri'si | Zorunlu |
Sesli kitabın 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ınlanma tarihi | İsteğe bağlı | Sağlandıysa sıfır noktası milisaniye cinsinden. |
Açıklama | İsteğe bağlı | Gösterilirse 200 karakterden uzun olmamalıdır. |
Fiyat | İsteğe bağlı | Serbest metin |
Süre | İsteğe bağlı | Sağlanması durumunda pozitif bir değer olmalıdır. |
Tür | İsteğe bağlı | Kitapla ilişkili türlerin listesi. |
Dizi adı | İsteğe bağlı | Sesli kitabın ait olduğu serinin adı (örneğin, Harry Potter). |
Seri birimi dizini | İsteğe bağlı | Serideki sesli kitabın dizini. 1, serideki ilk sesli kitaptır. Örneğin, Harry Potter ve Azkaban Tutsağı serinin 3. kitabıysa bu değer 3 olarak ayarlanmalıdır. |
Devam kitabı türü | İsteğe bağlı |
TYPE_CONTINUE: Bitirilmemiş bir kitabı devam ettirin. TYPE_NEXT: Bir serinin yeni birinde devam edin. TYPE_NEW: Yeni yayınlandı. |
Son Etkileşim Zamanı | Koşullu olarak gerekli | Öğe Devam kümesinde olduğunda sağlanmalıdır. Milisaniye cinsinden. |
Tamamlanan yüzde | Koşullu olarak gerekli |
Öğe Devam kümesinde olduğunda sağlanmalıdır. *Yeni* edinilen sesli kitaplar, okumaya devam etme kümesinin bir parçası olabilir. Değer 0'dan büyük ve 100'den küçük olmalıdır. |
DisplayTimeWindow: Bir içeriğin yüzeyde gösterileceği zaman aralığını ayarlama | ||
Başlangıç zaman damgası | İsteğe bağlı |
İçeriğin yüzeyde gösterilmesi gereken epoch zaman damgası. Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur. Milisaniye cinsinden. |
Bitiş zaman damgası | İsteğe bağlı |
İçeriğin artık platformda gösterilmeyeceği zaman damgası. Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur. Milisaniye cinsinden. |
Resim özellikleri
Resim öğeleri için gerekli özellikler aşağıda listelenmiştir:
En boy oranı | Şartlar | Minimum piksel sayısı | Önerilen piksel sayısı |
---|---|---|---|
Kare (1x1) | Zorunlu | 300x300 | 1.200x1.200 |
Yatay (1,91x1) | İsteğe bağlı | 600x314 | 1.200x628 |
Dikey (4x5) | İsteğe bağlı | 480x600 | 960x1200 |
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.
Örnekler
MusicAlbumEntity musicAlbumEntity =
new MusicAlbumEntity.Builder()
.setName(NAME)
.addPosterImage(new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(960)
.setImageWidthInPixel(408)
.build())
.setPlayBackUri("https://play.google/album/play")
.setInfoPageUri("https://play.google/album/info")
.setDescription("A description of this album.")
.addArtist("Artist")
.addGenre("Genre")
.addMusicLabel("Label")
.addContentRating("Rating")
.setSongsCount(960)
.setReleaseDateEpochMillis(1633032895L)
.setDurationMillis(1633L)
.build();
AudiobookEntity audiobookEntity =
new AudiobookEntity.Builder()
.setName("Becoming")
.addPosterImage(new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(960)
.setImageWidthInPixel(408)
.build())
.addAuthor("Michelle Obama")
.addNarrator("Michelle Obama")
.setActionLinkUri(
Uri.parse("https://play.google/audiobooks/1"))
.setDurationMillis(16335L)
.setPublishDateEpochMillis(1633032895L)
.setDescription("An intimate, powerful, and inspiring memoir")
.setPrice("$16.95")
.addGenre("biography")
.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ılamayacağı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("Trending music") .build()) .build())
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Trending music") .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() ... .build()) .build())
Java
client.publishFeaturedCluster( new PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( new FeaturedCluster.Builder() ... .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.
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( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.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
ContinuationCluster
verileri kaldırılır. - İstekten gelen veriler ayrıştırılır ve güncellenen Devam Kümesi'nde 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. uygulamada 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. 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 Eden Küme'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 istek tamamen 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_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build())
Java
client.deleteClusters( new DeleteClustersRequest.Builder() .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ü iletmeyi 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.
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, belirli bir 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ütme, mesaj dizileriyle ilgili sorunlar nedeniyle başarısız oldu. Bu durumda, işlem yeniden denenebilir. |
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 intent'lerini işleme
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 niyetleri ç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()
sınıfının bir örneğiniContext.registerReceiver()
kullanarak dinamik olarak kaydedin.BroadcastReceiver
Bu sayede, bellekte hâlâ etkin olan uygulamalardan iletişim kurulabilir.
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ığında yayın intent'leri almasına ve 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 amacı aldığınızdapublishRecommendationClusters
ç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 amacı 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ık Sorulan Sorular başlıklı makaleyi inceleyin.
İletişim
Entegrasyon işlemi sırasında sorularınız olursa engage-developers@google.com adresiyle iletişime geçebilirsiniz. Ekibimiz en kısa sürede yanıt verecektir.
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 entegre APK'nızı ekleyin.
- Google, entegrasyonun beklendiği gibi çalıştığından emin olmak için dahili olarak bir doğrulama ve inceleme gerçekleştirir. Değişiklik yapılması gerekirse Google gerekli bilgileri sizinle 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 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ınlanır ve kullanıcılara gösterilir.