Engage SDK Health and Fitness: Üçüncü taraf teknik entegrasyon talimatları

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 gösterme fırsatı sunar.Bu kılavuz, geliştirici iş ortaklarına bu yeni yüzey alanını doldurmak için Engage SDK'sını kullanarak sağlık ve fitness içeriklerini entegre etme talimatlarını içerir.

Entegrasyon ayrıntıları

Terminoloji

Bu entegrasyon şu üç küme türünü içerir: Recommendation, Öne Çıkan ve Devam.

  • Öneri kümeleri, bağımsız bir geliştirici iş ortağından kişiselleştirilmiş sağlık ve fitness önerilerini gösterir. Bu öneriler kullanıcıya göre kişiselleştirilebilir veya genelleştirilebilir (örneğin, trend olan fitness ve sağlık). Bunları sağlık ve fitness ile ilgili makaleleri veya kişileri yüzeye çıkarmak için kullanın.

    • Öneri kümesi; ArticleEntity, PersonEntity veya EventEntity'den oluşabilir ancak farklı varlık türlerinin bir karışımını içeremez.

    Ö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. Bu entegrasyon, Öneri Kümesi kullanılarak ortaya çıkarılacak bazı varlıklar sunar:

      • MakaleEntity: ArticleEntity, sağlık ve fitness ile ilgili metin tabanlı içeriğe yönelik bir öneriyi temsil eder. Makaleler, blog yayınları, pazarlama içerikleri, haber snippet'leri vb. için kullanılabilir.

        Şekil 1: Öneriler kümesinde tek bir ArticleEntity öğesinin gösterildiği kullanıcı arayüzü.
      • PersonEntity: PersonEntity bir kişiyi temsil eder. Sağlık ve fitness ile ilgili bir koçu ya da herhangi bir kişiyi öne çıkarmanız önerilebilir.

        Şekil 2: Öneriler kümesinde tek bir PersonEntity öğesinin gösterildiği kullanıcı arayüzü.
      • EventEntity: EventEntity, gelecekte gerçekleşecek bir etkinliği temsil eder. Etkinlik başlangıç zamanı, kullanıcılara aktarılması gereken önemli bir bilgidir. Bu varlık kan bağışı kampı, antrenmanlar, spor salonu veya yoga dersleri gibi sağlık ve fitness ile ilgili etkinlikleri göstermek için kullanılabilir.

        Şekil 3: Öneriler kümesinde tek bir EventEntity'yi gösteren kullanıcı arayüzü.
  • Devam kümesi, tek bir kullanıcı arayüzü gruplandırmasında birden fazla geliştirici iş ortağından kullanıcıların yakın zamanda etkileşimde bulunduğu içerikleri gösterir. Her geliştirici iş ortağının devam kümesinde en fazla 10 varlık yayınlamasına izin verilir.

    Devam içeriğiniz aşağıdaki yapıyı alabilir:

    • MakaleEntity: ArticleEntity, sağlık ve fitness ile ilgili metin tabanlı içerik için bir öneriyi temsil eder. Bu varlık, tamamlanmamış haber makalelerini veya kullanıcının bıraktığı yerden tüketmeye devam etmek istediği diğer içerikleri temsil etmek için kullanılabilir. Ör. sağlık veya fitness ile ilgili konularda haber snippet'i, blog yayını snippet'i.

      Şekil 6. Bir Devam kümesi içinde tek bir articleEntity gösteren kullanıcı arayüzü.
    • EventReservationEntity: EventReservationEntity, bir etkinlik için rezervasyonu temsil eder ve kullanıcıların yaklaşan ya da devam eden fitness ve sağlık etkinliği rezervasyonlarını takip etmesine yardımcı olur. Ör. Eğitim etkinlikleri

      Şekil 8. Bir Continuation kümesi içinde tek bir EventReservationEntity gösteren kullanıcı arayüzü.
  • Öne Çıkan kümesi, birçok geliştirici iş ortağından seçilen hero GenericFeaturedEntity öğesini tek bir kullanıcı arayüzü gruplandırmasında gösteren bir kullanıcı arayüzü görünümüdür. 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ümesi bulunur. Her geliştirici iş ortağının Öne Çıkanlar kümesinde, birden fazla uygulama geliştiricisine ait birçok varlık (potansiyel olarak farklı türde) ile, desteklenen türde tek bir varlık yayınlamasına izin verilir.

    • GenelFeaturedEntity: Öne Çıkan öğenin, geliştiricilerin tek bir en iyi içeriği için kullanılması ve kullanıcıların ilgi çekici ve alakalı olacak tek bir en önemli içeriği temsil etmesi açısından Öneri öğesinden farklıdır.

      Şekil 12: Öne çıkan bir kümedeki tek bir hero GeneralFeaturedEntity kartının gösterildiği kullanıcı arayüzü

Ön çalışma

Minimum API düzeyi: 19

com.google.android.play:engage 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.4.1'
}

Özet

Tasarım, bağlı hizmetin uygulanması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 minimum varlık sınırları Bir kümedeki maksimum varlık sınırları
Öneri Kümeleri En çok 5 En az 5 En çok 25 (ArticleEntity, PersonEntity veya EventEntity)
Devam Kümesi En fazla 1 En az 1 En fazla 10 (ArticleEntity veya EventReservationEntity)
Öne Çıkan Küme En fazla 1 En az 1 En çok 10 (GenericFeaturedEntity)

1. adım: Öğe verilerini sağlayın

SDK'da her öğe türünü temsil eden farklı varlıklar tanımlanmıştır. Sağlık ve Fitness kategorisi için aşağıdaki varlıkları destekliyoruz:

  1. GenericFeaturedEntity
  2. ArticleEntity
  3. PersonEntity
  4. EventEntity
  5. EventReservationEntity

Aşağıdaki grafiklerde, her tür için kullanılabilir özellikler ve gereksinimler özetlenmektedir.

GenericFeaturedEntity

Özellik Şartlar Açıklama Biçim
İşlem URI'sı Zorunlu

Sağlayıcı uygulamasındaki varlığa derin bağlantı.

Not: İlişkilendirme için derin bağlantılar kullanabilirsiniz. Bu SSS'ye bakın

URI
Poster resimleri Zorunlu

Birden fazla resim sağlandığında yalnızca 1 resim gösterilir. Önerilen en boy oranı 16:9'dur

Not: Rozet sağlanmışsa lütfen resmin hem üst hem de alt kısmında 24 d/sn güvenli alan bırakın

Yardım için Resim Özellikleri'ne bakın.
Başlık İsteğe bağlı Varlığın başlığıdır.

Serbest metin

Önerilen metin boyutu: 50 karakter

Açıklama İsteğe bağlı

Tüzel kişiyi açıklayan tek bir paragraflık metin.

Not: Kullanıcıya açıklama veya altyazı listesi gösterilir, ikisi birden gösterilmez.

Serbest metin

Önerilen metin boyutu: 180 karakter

Altyazı listesi İsteğe bağlı

En fazla 3 altyazı ve her altyazıda tek satırlık metin.

Not: Kullanıcıya açıklama veya altyazı listesi gösterilir, ikisi birden gösterilmez.

Serbest metin

Her altyazı için önerilen metin boyutu: maksimum 50 karakter

Rozetler İsteğe bağlı

Her rozet, serbest metin (maks. 15 karakter) veya küçük resimdir.

Resmin/videonun üzerinde özel kullanıcı deneyimi kullanımı (ör. resmin üzerinde rozetle yer paylaşımlı olarak)

  • Ör. "Canlı güncelleme"
  • Ör. Makale okuma süresi

Rozet - Metin İsteğe bağlı

Rozet başlığı

Not: Rozet için metin veya resim gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum 15 karakter

Rozet - Resim İsteğe bağlı

Küçük resim

Özel kullanıcı deneyimi değerlendirmesi (ör. resimde/video küçük resminde rozet yer paylaşımı olarak).

Not: Rozet için metin veya resim gereklidir

Yardım için Resim Özellikleri'ne bakın.
İçerik Kategorileri İsteğe bağlı Varlıktaki içeriğin kategorisini açıklayın.

Sıralama Listesi

Yol gösterici bilgiler için İçerik Kategorisi bölümüne bakın.

ArticleEntity

Özellik Şartlar Açıklama Biçim
İşlem URI'sı Zorunlu

Sağlayıcı uygulamasındaki varlığa derin bağlantı.

Not: İlişkilendirme için derin bağlantılar kullanabilirsiniz. Bu SSS'ye bakın

URI
Başlık Zorunlu Varlığın başlığıdır.

Serbest metin

Önerilen metin boyutu: Maksimum 50 karakter

Poster resimleri İsteğe bağlı

Birden fazla resim sağlandığında yalnızca 1 resim gösterilir. Önerilen en boy oranı 16:9'dur

Not: Resim kesinlikle önerilir. Rozet sağlanırsa lütfen resmin hem üst hem de alt kısmında 24 d/sn güvenli alan bırakın

Yardım için Resim Özellikleri'ne bakın.
Kaynak - Başlık İsteğe bağlı Yazarın, kuruluşun veya muhabirin adı

Serbest metin

Önerilen metin boyutu: 25 karakterden kısa

Kaynak - Resim İsteğe bağlı Yazar, kuruluş, muhabir gibi kaynağın resmi Yardım için Resim Özellikleri'ne bakın.
Açıklama İsteğe bağlı

Tüzel kişiyi açıklayan tek bir paragraflık metin.

Not: Kullanıcıya açıklama veya altyazı listesi gösterilir, ikisi birden gösterilmez.

Serbest metin

Önerilen metin boyutu: 180 karakter

Altyazı listesi İsteğe bağlı

En fazla 3 altyazı ve her altyazıda tek satırlık metin.

Not: Kullanıcıya açıklama veya altyazı listesi gösterilir, ikisi birden gösterilmez.

Serbest metin

Her altyazı için önerilen metin boyutu: maksimum 50 karakter

Rozetler İsteğe bağlı

Her rozet, serbest metin (maks. 15 karakter) veya küçük resimdir.

Resmin/videonun üzerinde özel kullanıcı deneyimi kullanımı (ör. resmin üzerinde rozetle yer paylaşımlı olarak)

  • Ör. "Canlı güncelleme"
  • Ör. Makale okuma süresi

Rozet - Metin İsteğe bağlı

Rozet başlığı

Not: Rozet için metin veya resim gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum 15 karakter

Rozet - Resim İsteğe bağlı

Küçük resim

Özel kullanıcı deneyimi değerlendirmesi (ör. resimde/video küçük resminde rozet yer paylaşımı olarak).

Not: Rozet için metin veya resim gereklidir

Yardım için Resim Özellikleri'ne bakın.
İçeriğin Yayınlanma Zamanı İsteğe bağlı Bu, içeriğin uygulamada yayınlandığı / güncellendiği zamanı gösteren, milisaniye cinsinden dönem zaman damgasıdır. Milisaniye cinsinden Epoch zaman damgası
Son Etkileşim Zamanı Koşula Bağlı Olarak Zorunlu

Kullanıcının bu varlıkla en son etkileşime geçtiği milisaniye cinsinden dönem zaman damgası.

Not: Söz konusu varlık, devamlılık kümesinin bir parçasıysa bu alan zorunludur.

Milisaniye cinsinden Epoch zaman damgası
İlerleme Yüzdesi Koşula Bağlı Olarak Zorunlu

Bugüne kadar kullanıcı tarafından tüketilen tam içeriğin yüzdesi.

Not: Söz konusu varlık, devamlılık kümesinin bir parçasıysa bu alan zorunludur.

0~100 dahil olmak üzere bu değerler arasında bir tam sayı değeri.
İçerik Kategorileri İsteğe bağlı Varlıktaki içeriğin kategorisini açıklayın.

Sıralama Listesi

Yol gösterici bilgiler için İçerik Kategorisi bölümüne bakın.

PersonEntity

Özellik Şartlar Açıklama Biçim
İşlem URI'sı Zorunlu

Sağlayıcı uygulamasındaki varlığa derin bağlantı.

Not: İlişkilendirme için derin bağlantılar kullanabilirsiniz. Bu SSS'ye bakın

URI
Profil - Ad Zorunlu Profil adı veya kimliği ya da herkese açık kullanıcı adı (ör. "Can Doğru", "@TeamPixel" vb.)

Dize

Önerilen metin boyutu: Maksimum 50 karakter

Profil - Avatar Zorunlu

Kullanıcının profil resmi veya avatar resmi.

Not: Kare 1:1 resim olmalıdır.

Yardım için Resim Özellikleri'ne bakın.
Profil - Ek Metin İsteğe bağlı Profil herkese açık kullanıcı adı gibi serbest metinler olmalıdır.

Serbest metin

Önerilen metin boyutu: Maksimum 15 karakter

Profil - Ek Resim İsteğe bağlı Doğrulanmış rozet gibi küçük bir resim. Yardım için Resim Özellikleri'ne bakın.
Başlık resmi İsteğe bağlı

Birden fazla resim sağlandığında yalnızca 1 resim gösterilir. Önerilen en boy oranı 16:9'dur

Not: Resim kesinlikle önerilir. Rozet sağlanırsa lütfen resmin hem üst hem de alt kısmında 24 d/sn güvenli alan bırakın

Yardım için Resim Özellikleri'ne bakın.
Popülerlik - Sayı İsteğe bağlı

Üstbilgi resmini temsil eder. Profil resminden farklı olmalıdır. Bu özellik, ilgili kişiyi yaptığı iş gibi vurgulamaya yardımcı olacak ek bir resim varsa kullanılabilir.

Not: Resim en boy oranı 16:9 olmalıdır. Rozet sağlanırsa lütfen resmin hem üst hem de alt kısmında 24 d/sn güvenli bir alan bırakın

Dize

Önerilen metin boyutu: Sayı + etiket için toplam maksimum 20 karakter

Popülerlik - Sayı Değeri İsteğe bağlı

Takipçi sayısı veya popülerlik değeri.

Not: Uygulamanız, büyük bir sayının farklı ekran boyutları için nasıl optimize edilmesi gerektiğine dair mantığı işlemek istemiyorsa Sayı Değeri'ni sağlayın. Hem Sayı hem de Sayı Değeri sağlanırsa Sayı kullanılır.

Uzun
Popülerlik - Etiket İsteğe bağlı Popülerlik etiketinin ne olduğunu belirtin (ör. "Beğenilenler").

Dize

Önerilen metin boyutu: Sayı + etiket için toplam maksimum 20 karakter

Popülerlik - Görsel İsteğe bağlı

Etkileşimin ne için olduğunu belirtin. Örneğin, Beğenmeler simgesi, Emoji'ler gösteren resim.

1'den fazla resim eklenebilir ancak tüm form faktörlerinde bunların hepsi gösterilmeyebilir.

Not: Kare 1:1 resim olmalıdır.

Yardım için Resim Özellikleri'ne bakın.
Puan - Maksimum değer Zorunlu

Derecelendirme ölçeğinin maksimum değeri.

Geçerli puan değeri de sağlanmışsa sağlanmalıdır.

Sayı >= 0,0
Puan - Geçerli değer Zorunlu

Derecelendirme ölçeğinin mevcut değeri.

Maksimum puan değeri de sağlanmışsa sağlanmalıdır.

Sayı >= 0,0
Puan - Sayı İsteğe bağlı

Varlık için puan sayısıdır.

Not: Uygulamanız, bunun kullanıcılara nasıl gösterileceğini kontrol etmek istiyorsa bu alanı sağlayın. Lütfen kullanıcıya gösterilebilecek kısa ve öz dizeyi sağlayın. Örneğin, sayı 1.000.000 ise daha küçük ekran boyutlarında kısaltılmaması için 1 milyon gibi kısaltmalar kullanabilirsiniz.

Dize
Puan - Sayı Değeri İsteğe bağlı

Varlık için puan sayısıdır.

Not: Ekran kısaltma mantığını kendiniz kullanmak istemiyorsanız bu alanı sağlayın. Hem Sayı hem de Sayım Değeri mevcutsa kullanıcılara göstermek için Sayı özelliğini kullanırız

Uzun
Konum - Ülke İsteğe bağlı Kişinin bulunduğu veya hizmet verdiği ülke.

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Şehir İsteğe bağlı Kişinin bulunduğu veya hizmet verdiği şehir.

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Görünen Adres İsteğe bağlı Kullanıcının bulunduğu veya reklam yayınladığı adres kullanıcıya gösterilir.

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Açık Adres İsteğe bağlı Kişinin bulunduğu veya hizmet verdiği açık adres (varsa).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Eyalet İsteğe bağlı Kişinin bulunduğu veya hizmet verdiği eyalet (varsa).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Posta kodu İsteğe bağlı Kişinin bulunduğu veya hizmet verdiği yerin posta kodu (varsa).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Mahalle İsteğe bağlı Söz konusu kişinin bulunduğu veya hizmet verdiği mahalle (varsa).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Rozetler İsteğe bağlı

Her rozet, serbest metin (maks. 15 karakter) veya küçük resimdir.

Rozet - Metin İsteğe bağlı

Rozet başlığı

Not: Rozet için metin veya resim gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum 15 karakter

Rozet - Resim İsteğe bağlı

Küçük resim

Özel kullanıcı deneyimi değerlendirmesi (ör. resimde/video küçük resminde rozet yer paylaşımı olarak).

Not: Rozet için metin veya resim gereklidir

Yardım için Resim Özellikleri'ne bakın.
Açıklama İsteğe bağlı

Tüzel kişiyi açıklayan tek bir paragraflık metin.

Not: Kullanıcıya açıklama veya altyazı listesi gösterilir, ikisi birden gösterilmez.

Serbest metin

Önerilen metin boyutu: 180 karakter

Altyazı listesi İsteğe bağlı

En fazla 3 altyazı ve her altyazıda tek satırlık metin.

Not: Kullanıcıya açıklama veya altyazı listesi gösterilir, ikisi birden gösterilmez.

Serbest metin

Her altyazı için önerilen metin boyutu: maksimum 50 karakter

İçerik Kategorileri İsteğe bağlı Varlıktaki içeriğin kategorisini açıklayın.

Uygun Sıralamaların Listesi

  • TYPE_HEALTH_AND_FITENESS (ör. Yoga/fitness eğitmeni)
  • TYPE_HOME_AND_OTO (ör. Tesisatçı)
  • TYPE_SPORTS (ör. Oyuncu)
  • TÜR_TARİH VERME

Yol gösterici bilgiler için İçerik Kategorisi bölümüne bakın.

EventEntity

Özellik Şartlar Açıklama Biçim
İşlem URI'sı Zorunlu

Sağlayıcı uygulamasındaki varlığa derin bağlantı.

Not: İlişkilendirme için derin bağlantılar kullanabilirsiniz. Bu SSS'ye bakın

URI
Başlık Zorunlu Varlığın başlığıdır.

Dize

Önerilen metin boyutu: Maksimum 50 karakter

Başlangıç zamanı Zorunlu

Etkinliğin başlamasının beklendiği zamanın zaman damgası.

Not: Bu değer, milisaniye cinsinden gösterilir.

Milisaniye cinsinden Epoch zaman damgası
Etkinlik modu Zorunlu

Etkinliğin sanal mı, yüz yüze mi yoksa her ikisi de mi olacağını belirten bir alan.

Enum: VIRTUAL, IN_PERSON veya HYBRID
Poster resimleri Zorunlu

Birden fazla resim sağlandığında yalnızca 1 resim gösterilir. Önerilen en boy oranı 16:9'dur

Not: Resim kesinlikle önerilir. Rozet sağlanırsa lütfen resmin hem üst hem de alt kısmında 24 d/sn güvenli alan bırakın

Yardım için Resim Özellikleri'ne bakın.
Konum - Ülke Koşula Bağlı Olarak Zorunlu

Etkinliğin gerçekleştiği ülke.

Not: Bu, IN_PERSON veya HYBRID olan etkinlikler için gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Şehir Koşula Bağlı Olarak Zorunlu

Etkinliğin gerçekleştiği şehir.

Not: Bu, IN_PERSON veya HYBRID olan etkinlikler için gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Görünen Adres Koşula Bağlı Olarak Zorunlu

Etkinliğin gerçekleşeceği ve kullanıcıya gösterilmesi gereken adres veya mekan adı.

Not: Bu, IN_PERSON veya HYBRID olan etkinlikler için gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Açık Adres İsteğe bağlı Etkinliğin barındırıldığı konumun açık adresi (varsa).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Eyalet İsteğe bağlı Etkinliğin barındırıldığı eyalet veya il (geçerliyse).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Posta kodu İsteğe bağlı Etkinliğin barındırıldığı konumun posta kodu (varsa).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Mahalle İsteğe bağlı Etkinliğin düzenlendiği mahalle (geçerliyse).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Bitiş zamanı İsteğe bağlı

Etkinliğin sona ermesinin beklendiği dönem zaman damgası.

Not: Bu değer, milisaniye cinsinden gösterilir.

Milisaniye cinsinden Epoch zaman damgası
Açıklama İsteğe bağlı

Tüzel kişiyi açıklayan tek bir paragraflık metin.

Not: Kullanıcıya açıklama veya altyazı listesi gösterilir, ikisi birden gösterilmez.

Serbest metin

Önerilen metin boyutu: 180 karakter

Altyazı listesi İsteğe bağlı

En fazla 3 altyazı ve her altyazıda tek satırlık metin.

Not: Kullanıcıya açıklama veya altyazı listesi gösterilir, ikisi birden gösterilmez.

Serbest metin

Her altyazı için önerilen metin boyutu: maksimum 50 karakter

Rozetler İsteğe bağlı

Her rozet, serbest metin (maks. 15 karakter) veya küçük resimdir.

Rozet - Metin İsteğe bağlı

Rozet başlığı

Not: Rozet için metin veya resim gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum 15 karakter

Rozet - Resim İsteğe bağlı

Küçük resim

Özel kullanıcı deneyimi değerlendirmesi (ör. resimde/video küçük resminde rozet yer paylaşımı olarak).

Not: Rozet için metin veya resim gereklidir

Yardım için Resim Özellikleri'ne bakın.
Fiyat - CurrentPrice Koşula bağlı olarak gerekli

Etkinlik biletinin/kartın mevcut fiyatı.

Üstü çizili fiyat sağlanmışsa bu değer de sağlanmalıdır.

Serbest metin
Fiyat - StrikethroughPrice İsteğe bağlı Etkinlik biletinin/kartın orijinal fiyatı. Serbest metin
Fiyat Açıklama Metni İsteğe bağlı Promosyon, etkinlik veya üye indirimi varsa bunları öne çıkarmak için fiyat açıklama metni.

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinde üç nokta gösterilebilir)

İçerik Kategorileri İsteğe bağlı Varlıktaki içeriğin kategorisini açıklayın.

Uygun Sıralamaların Listesi

  • TYPE_MovieS_AND_TV_SHOWS (ör. Sinema)
  • TYPE_DIGITAL_GAMES (ör. e-Spor)
  • TYPE_MUSIC (Ör. Konser)
  • TYPE_TRAVEL_AND_LOCAL (Ör. Tur, festival)
  • TYPE_HEALTH_AND_FITENESS (ör. Yoga dersi)
  • TYPE_EDUCATION (Ör. Sınıf)
  • TYPE_SPORTS (ör. Futbol maçı)
  • TYPE_DAting (ör. buluşma)

Yol gösterici bilgiler için İçerik Kategorisi bölümüne bakın.

EventReservationEntity

Özellik Şartlar Açıklama Biçim
İşlem URI'sı Zorunlu

Sağlayıcı uygulamasındaki varlığa derin bağlantı.

Not: İlişkilendirme için derin bağlantılar kullanabilirsiniz. Bu SSS'ye bakın

URI
Başlık Zorunlu Varlığın başlığıdır.

Dize

Önerilen metin boyutu: Maksimum 50 karakter

Başlangıç zamanı Zorunlu

Etkinliğin başlamasının beklendiği zamanın zaman damgası.

Not: Bu değer, milisaniye cinsinden gösterilir.

Milisaniye cinsinden Epoch zaman damgası
Etkinlik modu Zorunlu

Etkinliğin sanal mı, yüz yüze mi yoksa her ikisi de mi olacağını belirten bir alan.

Enum: VIRTUAL, IN_PERSON veya HYBRID
Konum - Ülke Koşula Bağlı Olarak Zorunlu

Etkinliğin gerçekleştiği ülke.

Not: Bu, IN_PERSON veya HYBRID olan etkinlikler için gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Şehir Koşula Bağlı Olarak Zorunlu

Etkinliğin gerçekleştiği şehir.

Not: Bu, IN_PERSON veya HYBRID olan etkinlikler için gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Görünen Adres Koşula Bağlı Olarak Zorunlu

Etkinliğin gerçekleşeceği ve kullanıcıya gösterilmesi gereken adres veya mekan adı.

Not: Bu, IN_PERSON veya HYBRID olan etkinlikler için gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Açık Adres İsteğe bağlı Etkinliğin barındırıldığı konumun açık adresi (varsa).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Eyalet İsteğe bağlı Etkinliğin barındırıldığı eyalet veya il (geçerliyse).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Posta kodu İsteğe bağlı Etkinliğin barındırıldığı konumun posta kodu (varsa).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Konum - Mahalle İsteğe bağlı Etkinliğin düzenlendiği mahalle (geçerliyse).

Serbest metin

Önerilen metin boyutu: Maksimum ~20 karakter

Poster resimleri İsteğe bağlı

Birden fazla resim sağlandığında yalnızca 1 resim gösterilir. Önerilen en boy oranı 16:9'dur

Not: Resim kesinlikle önerilir. Rozet sağlanırsa lütfen resmin hem üst hem de alt kısmında 24 d/sn güvenli alan bırakın

Yardım için Resim Özellikleri'ne bakın.
Bitiş zamanı İsteğe bağlı

Etkinliğin sona ermesinin beklendiği dönem zaman damgası.

Not: Bu değer, milisaniye cinsinden gösterilir.

Milisaniye cinsinden Epoch zaman damgası
Servis Sağlayıcı - Ad İsteğe bağlı

Servis sağlayıcının adı.

Not: Servis sağlayıcı için metin veya resim gereklidir.

Serbest metin. Ör. etkinliği düzenleyenin/turun adı
Servis Sağlayıcı - Resim İsteğe bağlı

Servis sağlayıcının logosu/resmi.

Not: Servis sağlayıcı için metin veya resim gereklidir.

Yardım için Resim Özellikleri'ne bakın.
Açıklama İsteğe bağlı

Tüzel kişiyi açıklayan tek bir paragraflık metin.

Not: Kullanıcıya açıklama veya altyazı listesi gösterilir, ikisi birden gösterilmez.

Serbest metin

Önerilen metin boyutu: 180 karakter

Altyazı listesi İsteğe bağlı

En fazla 3 altyazı ve her altyazıda tek satırlık metin.

Not: Kullanıcıya açıklama veya altyazı listesi gösterilir, ikisi birden gösterilmez.

Serbest metin

Her altyazı için önerilen metin boyutu: maksimum 50 karakter

Rozetler İsteğe bağlı

Her rozet, serbest metin (maks. 15 karakter) veya küçük resimdir.

Rozet - Metin İsteğe bağlı

Rozet başlığı

Not: Rozet için metin veya resim gereklidir

Serbest metin

Önerilen metin boyutu: Maksimum 15 karakter

Rozet - Resim İsteğe bağlı

Küçük resim

Özel kullanıcı deneyimi değerlendirmesi (ör. resimde/video küçük resminde rozet yer paylaşımı olarak).

Not: Rozet için metin veya resim gereklidir

Yardım için Resim Özellikleri'ne bakın.
Rezervasyon Kimliği İsteğe bağlı Etkinlik rezervasyonunun rezervasyon kimliği. Serbest metin
Fiyat - CurrentPrice Koşula bağlı olarak gerekli

Etkinlik biletinin/kartın mevcut fiyatı.

Üstü çizili fiyat sağlanmışsa bu değer de sağlanmalıdır.

Serbest metin
Fiyat - StrikethroughPrice İsteğe bağlı Etkinlik biletinin/kartın orijinal fiyatı. Serbest metin
Fiyat Açıklama Metni İsteğe bağlı Promosyon, etkinlik veya üye indirimi varsa bunları öne çıkarmak için fiyat açıklama metni.

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinde üç nokta gösterilebilir)

Puan - Maksimum değer İsteğe bağlı

Derecelendirme ölçeğinin maksimum değeri.

Geçerli puan değeri de sağlanmışsa sağlanmalıdır.

Sayı >= 0,0
Puan - Geçerli değer İsteğe bağlı

Derecelendirme ölçeğinin mevcut değeri.

Maksimum puan değeri de sağlanmışsa sağlanmalıdır.

Sayı >= 0,0
Puan - Sayı İsteğe bağlı

Etkinlik için verilen puan sayısı.

Not: Uygulamanız, bunun kullanıcılara nasıl gösterileceğini kontrol etmek istiyorsa bu alanı sağlayın. Lütfen kullanıcıya gösterilebilecek kısa ve öz dizeyi sağlayın. Örneğin, sayı 1.000.000 ise daha küçük ekran boyutlarında kısaltılmaması için 1 milyon gibi kısaltmalar kullanabilirsiniz.

Dize
Puan - Sayı Değeri İsteğe bağlı

Etkinlik için verilen puan sayısı.

Not: Ekran kısaltma mantığını kendiniz kullanmak istemiyorsanız bu alanı sağlayın. Hem Sayı hem de Sayım Değeri mevcutsa kullanıcılara göstermek için Sayı özelliğini kullanırız

Uzun
İçerik Kategorileri İsteğe bağlı Varlıktaki içeriğin kategorisini açıklayın.

Uygun Sıralamaların Listesi

  • TYPE_MovieS_AND_TV_SHOWS (ör. Sinema)
  • TYPE_DIGITAL_GAMES (ör. e-Spor)
  • TYPE_MUSIC (Ör. Konser)
  • TYPE_TRAVEL_AND_LOCAL (Ör. Tur, festival)
  • TYPE_HEALTH_AND_FITENESS (ör. Yoga dersi)
  • TYPE_EDUCATION (Ör. Sınıf)
  • TYPE_SPORTS (ör. Futbol maçı)
  • TYPE_DAting (ör. buluşma)

Yol gösterici bilgiler için İçerik Kategorisi bölümüne bakın.

Resim özellikleri

Resim öğeleri için gerekli özellikler aşağıdaki tabloda listelenmiştir:

En boy oranı Minimum piksel sayısı Önerilen piksel sayısı

Kare (1x1)

Tercih edilen

300x300 1.200x1.200
Yatay (1,91x1) 600x314 1.200x628
Dikey (4x5) 480x600 960 x 1.200

Google'ın resimlere erişebilmesi için resimlerin herkese açık CDN'lerde barındırılması gerekir.

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.
  • Resmin Koyu ve Açık tema ayarlarında düzgün bir şekilde gösterilebilmesi için şeffaf bir arka plan kullanın.

İçerik Kategorisi

İçerik kategorisi, uygulamaların birden fazla kategoriye ait içerik yayınlamasına olanak tanır. Bu işlem, içeriği önceden tanımlanmış kategorilerden bazılarıyla eşler. Örneğin:

  • TYPE_EDUCATION
  • TYPE_SPORTS
  • TYPE_MOVIES_AND_TV_SHOWS
  • TYPE_BOOKS
  • TYPE_AUDIOBOOKS
  • TYPE_MUSIC
  • TYPE_DIGITAL_GAMES
  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_HOME_AND_AUTO
  • TYPE_BUSINESS
  • TYPE_NEWS
  • TYPE_FOOD_AND_DRINK
  • TYPE_SHOPPING
  • TYPE_HEALTH_AND_FITENESS
  • TYPE_MEDICAL
  • TYPE_PARENTING
  • TYPE_DATING

Google'ın resimlere erişebilmesi için resimlerin herkese açık CDN'lerde barındırılması gerekir.

İçerik kategorilerini kullanma kuralları

  1. MakaleEntity ve GenelFeaturedEntity gibi bazı varlıklar, içerik kategorilerinin herhangi birini kullanmaya uygundur. EventEntity, EventReservationEntity, PersonEntity gibi diğer varlıklar için bu kategorilerin yalnızca bir alt kümesi uygundur. Listeyi doldurmadan önce varlık türü için uygun kategorilerin listesini kontrol edin.
  2. Bazı içerik kategorileri için Genel öğeler ile ContentCategory'ın bir kombinasyonu yerine spesifik varlık türünü kullanın:

  3. ContentCategory alanı isteğe bağlıdır ve içerik daha önce belirtilen kategorilerden hiçbirine ait değilse boş bırakılmalıdır.

  4. Birden fazla içerik kategorisi sağlanmışsa bunları, en alakalı içerik kategorisi listede ilk sırada yer alan içerikle alaka sırasına göre sağlayın.

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 küme yayınlamak için aşağıdaki API'lerden yararlanabilirsiniz:

  • 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ınlanmadıysa 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 edinmesine 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ın yayınlanmasını ö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() kullanarak BroadcastReceiver 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ırken publishRecommendationClusters araması başlatmanız önerilir.
  • com.google.android.engage.action.PUBLISH_FEATURED Bu niyeti alırken publishFeaturedCluster çağrısı başlatmanız önerilir.
  • com.google.android.engage.action.PUBLISH_CONTINUATION Bu niyeti alırken publishContinuationCluster ç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 lütfen Engage-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.