Engage SDK Watch: Instrukcje dotyczące integracji technicznej z usługami innych firm
Zwiększaj zaangażowanie w aplikację, docierając do użytkowników tam, gdzie się znajdują. Wprowadź obsługę pakietu Engage SDK, aby dostarczać treści z sekcji Oglądaj dalej i spersonalizowane rekomendacje bezpośrednio do użytkowników na różnych platformach na urządzeniu, takich jak Kolekcje, Entertainment Space i Sklep Play. Integracja dodaje do średniego pliku APK mniej niż 50 KB (po skompresowaniu) i zajmuje większości aplikacji około tygodnia pracy programisty. Więcej informacji znajdziesz na naszej stronie dla firm.
Ten przewodnik zawiera instrukcje dla partnerów deweloperów dotyczące integracji treści wideo za pomocą pakietu Engage SDK, aby wypełniać zarówno tę nową powierzchnię, jak i dotychczasowe powierzchnie Google.
Szczegóły integracji
Terminologia
Ta integracja obejmuje 3 typy klastrów: Rekomendacje, Kontynuacja i Wyróżnione.
Klastry rekomendacji wyświetlają spersonalizowane sugestie dotyczące treści do obejrzenia od poszczególnych partnerów będących deweloperami.
Rekomendacje mają następującą strukturę:
Klaster rekomendacji: widok interfejsu, który zawiera grupę rekomendacji od tego samego partnera dewelopera.
Rysunek 1. Interfejs Entertainment Space z grupą rekomendacji od jednego partnera.
Jednostka: obiekt reprezentujący pojedynczy element w klastrze. Elementem może być film, program telewizyjny, serial, wideo na żywo i inne treści. Listę obsługiwanych typów elementów znajdziesz w sekcji Podaj dane o elementach.
Rysunek 2. Interfejs Entertainment Space przedstawiający pojedynczyelement w ramach klastra rekomendacji jednego z partnerów.
Klaster Kontynuacja zawiera niedokończone filmy i odpowiednie nowe odcinki od różnych partnerów deweloperów w jednej grupie interfejsu. Każdy partner-deweloper będzie mógł transmitować maksymalnie 10 podmiotów w klastrze Continuation. Badania wykazały, że spersonalizowane rekomendacje
wraz ze spersonalizowanymi treściami kontynuacyjnymi zapewniają największe zaangażowanie użytkowników.
Rysunek 3. Interfejs Entertainment Space z klastrem kontynuacji z niedokończonymi rekomendacjami od wielu partnerów (obecnie widoczna jest tylko jedna rekomendacja).
Klaster Polecane zawiera wybrane podmioty od różnych partnerów deweloperów w jednej grupie interfejsu. Będzie on wyświetlany w górnej części interfejsu użytkownika i będzie miał priorytetowe miejsce nad wszystkimi klastrami rekomendacji. Każdy partner deweloper będzie mógł transmitować maksymalnie 10 podmiotów w klastrze Wyróżnione.
Rysunek 4. Interfejs Entertainment Space z grupą polecanych treści zawierającą rekomendacje od wielu partnerów (obecnie widoczna jest tylko jedna rekomendacja).
Przygotowanie
Minimalny poziom interfejsu API: 19
Dodaj bibliotekę com.google.android.engage:engage-core do aplikacji:
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'}
Dane, które klient może publikować, podlegają tym limitom w przypadku różnych typów klastrów:
Typ klastra
Limity klastra
Maksymalne limity elementów w klastrze
Klastry rekomendacji
Maksymalnie 7
Maksymalnie 50
Klaster kontynuacji
Maksymalnie 1
Maksymalnie 20
Polecany klaster
Maksymalnie 1
Maksymalnie 20
Krok 0. Migracja z dotychczasowej integracji pakietu SDK Media Home
Mapowanie modeli danych z istniejącej integracji
Jeśli migrujesz z istniejącej integracji strony głównej multimediów, w tej tabeli znajdziesz informacje o tym, jak mapować modele danych w istniejących pakietach SDK na nowy pakiet Engage SDK:
Podzielone na atrybuty w osobnych klasach:
EventVideoEntity, LiveStreamingVideoEntity,
MovieEntity, TvEpisodeEntity,
TvSeasonEntity, TvShowEntity,
VideoClipEntity
Publikowanie klastrów w pakiecie Media Home SDK a Engage SDK
W przypadku pakietu Media Home SDK klastry i elementy były publikowane za pomocą osobnych interfejsów API:
// 1. Fetch existing channelsList<PreviewChannel>channels=PreviewChannelHelper.getAllChannels();// 2. If there are no channels, publish new channelslongchannelId=PreviewChannelHelper.publishChannel(builder.build());// 3. If there are existing channels, decide whether to update channel contentsPreviewChannelHelper.updatePreviewChannel(channelId,builder.build());// 4. Delete all programs in the channelPreviewChannelHelper.deleteAllPreviewProgramsByChannelId(channelId);// 5. publish new programs in the channelPreviewChannelHelper.publishPreviewProgram(builder.build());
W przypadku pakietu Engage SDK publikowanie klastrów i encji jest połączone w jedno wywołanie interfejsu API. Wszystkie podmioty należące do klastra są publikowane razem z tym klastrem:
Kotlin
RecommendationCluster.Builder().addEntity(MOVIE_ENTITY).addEntity(MOVIE_ENTITY).addEntity(MOVIE_ENTITY).setTitle("Top Picks For You").build()
Java
newRecommendationCluster.Builder().addEntity(MOVIE_ENTITY).addEntity(MOVIE_ENTITY).addEntity(MOVIE_ENTITY).setTitle("Top Picks For You").build();
Krok 1. Podaj dane podmiotu
Pakiet SDK ma zdefiniowane różne obiekty reprezentujące każdy typ produktu. W przypadku kategorii Zegarki obsługujemy te typy:
W tabeli poniżej znajdziesz atrybuty i wymagania dotyczące każdego typu.
MovieEntity
Atrybut
Wymaganie
Uwagi
Nazwa
Wymagany
Obrazy plakatu
Wymagany
Wymagany jest co najmniej 1 obraz, który musi mieć format. (Preferowany jest format poziomy, ale zalecamy przesyłanie obrazów zarówno w orientacji pionowej, jak i poziomej w różnych scenariuszach).
DOSTĘPNE: treści są dostępne dla użytkownika bez konieczności podejmowania dalszych działań.
FREE_WITH_SUBSCRIPTION: treść jest dostępna po zakupieniu subskrypcji przez użytkownika.
PAID_CONTENT: treści wymagają zakupu lub wypożyczenia przez użytkownika.
KUPIONE: treści zostały kupione lub wypożyczone przez użytkownika.
Cena oferty
Opcjonalny
Dowolny tekst
Czas działania
Wymagany
W milisekundach.
Gatunek
Wymagany
Dowolny tekst
Oceny treści
Opcjonalny
Dowolny tekst, zgodny ze standardem branżowym.
(Przykład)
Rodzaj sekcji „Obejrzyj następny”
Wymagane warunkowo
Musi być podany, gdy produkt znajduje się w klastrze kontynuacji, i musi być jednym z tych 4 typów:
KONTYNUUJ: użytkownik obejrzał już ponad minutę tych treści.
NOWY: użytkownik obejrzał wszystkie dostępne odcinki treści epizodycznych, ale pojawił się nowy odcinek i jest dokładnie 1 nieobejrzany odcinek. Dotyczy to seriali, nagranych meczów piłki nożnej w serii itp.
NEXT: użytkownik obejrzał co najmniej 1 odcinek treści epizodycznych, ale pozostało więcej niż 1 odcinek lub dokładnie 1 odcinek, przy czym ostatni odcinek nie jest oznaczony jako „NOWY” i został opublikowany przed rozpoczęciem oglądania treści epizodycznych przez użytkownika.
LISTA DO OBEJRZENIA: użytkownik wyraźnie wybrał opcję dodania filmu, wydarzenia lub serialu do listy do obejrzenia, aby ręcznie wybrać, co chce obejrzeć w następnej kolejności.
Czas ostatniego działania związanego z zaangażowaniem
Wymagane warunkowo
Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji. w milisekundach od początku epoki.
Czas ostatniej pozycji odtwarzania
Wymagane warunkowo
Musi być podany, gdy element znajduje się w klastrze Kontynuacja, a WatchNextType ma wartość CONTINUE. W milisekundach od początku epoki.
TvShowEntity
Atrybut
Wymaganie
Uwagi
Nazwa
Wymagany
Obrazy plakatu
Wymagany
Wymagany jest co najmniej 1 obraz, który musi mieć format. (Preferowany jest format poziomy, ale zalecamy przesyłanie obrazów zarówno w orientacji pionowej, jak i poziomej w różnych scenariuszach).
DOSTĘPNE: treści są dostępne dla użytkownika bez konieczności podejmowania dalszych działań.
FREE_WITH_SUBSCRIPTION: treść jest dostępna po zakupieniu subskrypcji przez użytkownika.
PAID_CONTENT: treści wymagają zakupu lub wypożyczenia przez użytkownika.
KUPIONE: treści zostały kupione lub wypożyczone przez użytkownika.
Cena oferty
Opcjonalny
Dowolny tekst
Liczba sezonów
Wymagany
Dodatnia liczba całkowita
Gatunek
Wymagany
Dowolny tekst
Oceny treści
Opcjonalny
Dowolny tekst, zgodny ze standardem branżowym.
(Przykład)
Rodzaj sekcji „Obejrzyj następny”
Wymagane warunkowo
Musi być podany, gdy produkt znajduje się w klastrze kontynuacji, i musi być jednym z tych 4 typów:
KONTYNUUJ: użytkownik obejrzał już ponad minutę tych treści.
NOWY: użytkownik obejrzał wszystkie dostępne odcinki treści epizodycznych, ale pojawił się nowy odcinek i jest dokładnie 1 nieobejrzany odcinek. Dotyczy to seriali, nagranych meczów piłki nożnej w serii itp.
NEXT: użytkownik obejrzał co najmniej 1 odcinek treści epizodycznych, ale pozostało więcej niż 1 odcinek lub dokładnie 1 odcinek, przy czym ostatni odcinek nie jest oznaczony jako „NOWY” i został opublikowany przed rozpoczęciem oglądania treści epizodycznych przez użytkownika.
LISTA DO OBEJRZENIA: użytkownik wyraźnie wybrał opcję dodania filmu, wydarzenia lub serialu do listy do obejrzenia, aby ręcznie wybrać, co chce obejrzeć w następnej kolejności.
Czas ostatniego działania związanego z zaangażowaniem
Wymagane warunkowo
Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji. w milisekundach od początku epoki.
Czas ostatniej pozycji odtwarzania
Wymagane warunkowo
Musi być podany, gdy element znajduje się w klastrze Kontynuacja, a WatchNextType ma wartość CONTINUE. W milisekundach od początku epoki.
TvSeasonEntity
Atrybut
Wymaganie
Uwagi
Nazwa
Wymagany
Obrazy plakatu
Wymagany
Wymagany jest co najmniej 1 obraz, który musi mieć format. (Preferowany jest format poziomy, ale zalecamy przesyłanie obrazów zarówno w orientacji pionowej, jak i poziomej w różnych scenariuszach).
DOSTĘPNE: treści są dostępne dla użytkownika bez konieczności podejmowania dalszych działań.
FREE_WITH_SUBSCRIPTION: treść jest dostępna po zakupieniu subskrypcji przez użytkownika.
PAID_CONTENT: treści wymagają zakupu lub wypożyczenia przez użytkownika.
KUPIONE: treści zostały kupione lub wypożyczone przez użytkownika.
Cena oferty
Opcjonalny
Dowolny tekst
Liczba odcinków
Wymagany
Dodatnia liczba całkowita
Gatunek
Wymagany
Dowolny tekst
Oceny treści
Opcjonalny
Dowolny tekst, zgodny ze standardem branżowym.
(Przykład)
Rodzaj sekcji „Obejrzyj następny”
Wymagane warunkowo
Musi być podany, gdy produkt znajduje się w klastrze kontynuacji, i musi być jednym z tych 4 typów:
KONTYNUUJ: użytkownik obejrzał już ponad minutę tych treści.
NOWY: użytkownik obejrzał wszystkie dostępne odcinki treści epizodycznych, ale pojawił się nowy odcinek i jest dokładnie 1 nieobejrzany odcinek. Dotyczy to seriali, nagranych meczów piłki nożnej w serii itp.
NEXT: użytkownik obejrzał co najmniej 1 odcinek treści epizodycznych, ale pozostało więcej niż 1 odcinek lub dokładnie 1 odcinek, przy czym ostatni odcinek nie jest oznaczony jako „NOWY” i został opublikowany przed rozpoczęciem oglądania treści epizodycznych przez użytkownika.
LISTA DO OBEJRZENIA: użytkownik wyraźnie wybrał opcję dodania filmu, wydarzenia lub serialu do listy do obejrzenia, aby ręcznie wybrać, co chce obejrzeć w następnej kolejności.
Czas ostatniego działania związanego z zaangażowaniem
Wymagane warunkowo
Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji. w milisekundach od początku epoki.
Czas ostatniej pozycji odtwarzania
Wymagane warunkowo
Musi być podany, gdy element znajduje się w klastrze Kontynuacja, a WatchNextType ma wartość CONTINUE. W milisekundach od początku epoki.
TvEpisodeEntity
Atrybut
Wymaganie
Uwagi
Nazwa
Wymagany
Obrazy plakatu
Wymagany
Wymagany jest co najmniej 1 obraz, który musi mieć format. (Preferowany jest format poziomy, ale zalecamy przesyłanie obrazów zarówno w orientacji pionowej, jak i poziomej w różnych scenariuszach).
DOSTĘPNE: treści są dostępne dla użytkownika bez konieczności podejmowania dalszych działań.
FREE_WITH_SUBSCRIPTION: treść jest dostępna po zakupieniu subskrypcji przez użytkownika.
PAID_CONTENT: treści wymagają zakupu lub wypożyczenia przez użytkownika.
KUPIONE: treści zostały kupione lub wypożyczone przez użytkownika.
Cena oferty
Opcjonalny
Dowolny tekst
Czas działania
Wymagany
Musi to być dodatnia wartość w milisekundach.
Gatunek
Wymagany
Dowolny tekst
Oceny treści
Opcjonalny
Dowolny tekst, zgodny ze standardem branżowym.
(Przykład)
Rodzaj sekcji „Obejrzyj następny”
Wymagane warunkowo
Musi być podany, gdy produkt znajduje się w klastrze kontynuacji, i musi być jednym z tych 4 typów:
KONTYNUUJ: użytkownik obejrzał już ponad minutę tych treści.
NOWY: użytkownik obejrzał wszystkie dostępne odcinki treści epizodycznych, ale pojawił się nowy odcinek i jest dokładnie 1 nieobejrzany odcinek. Dotyczy to seriali, nagranych meczów piłki nożnej w serii itp.
NEXT: użytkownik obejrzał co najmniej 1 odcinek treści epizodycznych, ale pozostało więcej niż 1 odcinek lub dokładnie 1 odcinek, przy czym ostatni odcinek nie jest oznaczony jako „NOWY” i został opublikowany przed rozpoczęciem oglądania treści epizodycznych przez użytkownika.
LISTA DO OBEJRZENIA: użytkownik wyraźnie wybrał opcję dodania filmu, wydarzenia lub serialu do listy do obejrzenia, aby ręcznie wybrać, co chce obejrzeć w następnej kolejności.
Czas ostatniego działania związanego z zaangażowaniem
Wymagane warunkowo
Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji. w milisekundach od początku epoki.
Czas ostatniej pozycji odtwarzania
Wymagane warunkowo
Musi być podany, gdy element znajduje się w klastrze Kontynuacja, a WatchNextType ma wartość CONTINUE. W milisekundach od początku epoki.
LiveStreamingVideoEntity
Atrybut
Wymaganie
Uwagi
Nazwa
Wymagany
Obrazy plakatu
Wymagany
Wymagany jest co najmniej 1 obraz, który musi mieć format. (Preferowany jest format poziomy, ale zalecamy przesyłanie obrazów zarówno w orientacji pionowej, jak i poziomej w różnych scenariuszach).
Musi być podany, gdy produkt znajduje się w klastrze kontynuacji, i musi być jednym z tych 4 typów:
KONTYNUUJ: użytkownik obejrzał już ponad minutę tych treści.
NOWY: użytkownik obejrzał wszystkie dostępne odcinki treści epizodycznych, ale pojawił się nowy odcinek i jest dokładnie 1 nieobejrzany odcinek. Dotyczy to seriali, nagranych meczów piłki nożnej w serii itp.
NEXT: użytkownik obejrzał co najmniej 1 odcinek treści epizodycznych, ale pozostało więcej niż 1 odcinek lub dokładnie 1 odcinek, przy czym ostatni odcinek nie jest oznaczony jako „NOWY” i został opublikowany przed rozpoczęciem oglądania treści epizodycznych przez użytkownika.
LISTA DO OBEJRZENIA: użytkownik wyraźnie wybrał opcję dodania filmu, wydarzenia lub serialu do listy do obejrzenia, aby ręcznie wybrać, co chce obejrzeć w następnej kolejności.
Czas ostatniego działania związanego z zaangażowaniem
Wymagane warunkowo
Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji. w milisekundach od początku epoki.
Czas ostatniej pozycji odtwarzania
Wymagane warunkowo
Musi być podany, gdy element znajduje się w klastrze Kontynuacja, a WatchNextType ma wartość CONTINUE. W milisekundach od początku epoki.
VideoClipEntity
Obiekt VideoClipEntity reprezentuje film pochodzący z mediów społecznościowych, takich jak TikTok czy YouTube.
Atrybut
Wymaganie
Uwagi
Nazwa
Wymagany
Obrazy plakatu
Wymagany
Wymagany jest co najmniej 1 obraz, który musi mieć format. (Preferowany jest format poziomy, ale zalecamy przesyłanie obrazów zarówno w orientacji pionowej, jak i poziomej w różnych scenariuszach).
Musi być podany, gdy produkt znajduje się w klastrze kontynuacji, i musi być jednym z tych 4 typów:
KONTYNUUJ: użytkownik obejrzał już ponad minutę tych treści.
NOWY: użytkownik obejrzał wszystkie dostępne odcinki treści epizodycznych, ale pojawił się nowy odcinek i jest dokładnie 1 nieobejrzany odcinek. Dotyczy to seriali, nagranych meczów piłki nożnej w serii itp.
NEXT: użytkownik obejrzał co najmniej 1 odcinek treści epizodycznych, ale pozostało więcej niż 1 odcinek lub dokładnie 1 odcinek, przy czym ostatni odcinek nie jest oznaczony jako „NOWY” i został opublikowany przed rozpoczęciem oglądania treści epizodycznych przez użytkownika.
LISTA DO OBEJRZENIA: użytkownik wyraźnie wybrał opcję dodania filmu, wydarzenia lub serialu do listy do obejrzenia, aby ręcznie wybrać, co chce obejrzeć w następnej kolejności.
Czas ostatniego działania związanego z zaangażowaniem
Wymagane warunkowo
Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji. w milisekundach od początku epoki.
Czas ostatniej pozycji odtwarzania
Wymagane warunkowo
Musi być podany, gdy element znajduje się w klastrze Kontynuacja, a WatchNextType ma wartość CONTINUE. W milisekundach od początku epoki.
Specyfikacja obrazu
W tej sekcji znajdziesz wymagane specyfikacje komponentów z obrazem:
Formaty plików
PNG, JPG, statyczny GIF, WebP
Maksymalny rozmiar pliku
5120 KB
Dodatkowe rekomendacje
Bezpieczny obszar obrazu: ważne treści umieść w środkowych 80% obrazu.
Zalecamy wykonywanie zadania publikowania treści w tle (np. za pomocą WorkManager) i regularne planowanie go lub planowanie na podstawie zdarzeń (np. za każdym razem, gdy użytkownik otwiera aplikację lub gdy właśnie dodał coś do koszyka).
AppEngagePublishClient odpowiada za publikowanie klastrów. W kliencie dostępne są te interfejsy API:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Ten interfejs API służy do sprawdzania, czy usługa jest dostępna do integracji i czy treści można wyświetlać na urządzeniu.
Kotlin
client.isServiceAvailable.addOnCompleteListener{task->
if(task.isSuccessful){// Handle IPC call successif(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 successif(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
Ten interfejs API służy do publikowania listy obiektów RecommendationCluster.
Kotlin
client.publishRecommendationClusters(PublishRecommendationClustersRequest.Builder().addRecommendationCluster(RecommendationCluster.Builder().addEntity(entity1).addEntity(entity2).setTitle("Top Picks For You").build()).build())
Java
client.publishRecommendationClusters(newPublishRecommendationClustersRequest.Builder().addRecommendationCluster(newRecommendationCluster.Builder().addEntity(entity1).addEntity(entity2).setTitle("Top Picks For You").build()).build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:
Istniejące dane RecommendationCluster od partnera dewelopera zostaną usunięte.
Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze rekomendacji.
W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.
publishFeaturedCluster
Ten interfejs API służy do publikowania listy obiektów FeaturedCluster.
Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:
Istniejące dane ContinuationCluster od partnera dewelopera zostaną usunięte.
Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze kontynuacji.
W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.
publishUserAccountManagementRequest
Ten interfejs API służy do publikowania karty logowania . Działanie logowania przekierowuje użytkowników na stronę logowania aplikacji, aby mogła ona publikować treści (lub udostępniać bardziej spersonalizowane treści).
Karta logowania zawiera te metadane:
Atrybut
Wymaganie
Opis
Identyfikator URI działania
Wymagane
Precyzyjny link do działania (np. przejście do strony logowania w aplikacji)
Obraz
Opcjonalny – jeśli nie zostanie podany, musi zostać podany tytuł
Obraz wyświetlany na karcie
Obrazy o formacie 16:9 i rozdzielczości 1264 x 712
Tytuł
Opcjonalny – jeśli nie zostanie podany, należy podać obraz
Tytuł na karcie
Tekst działania
Opcjonalny
Tekst wyświetlany w wezwaniu do działania (np. Zaloguj się)
Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:
Dotychczasowe dane UserAccountManagementCluster od partnera dewelopera zostaną usunięte.
Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze UserAccountManagementCluster.
W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.
updatePublishStatus
Jeśli z jakiegokolwiek powodu wewnętrznego żadna z grup nie jest opublikowana, zdecydowanie zalecamy zaktualizowanie stanu publikacji za pomocą interfejsu updatePublishStatus API.
Jest to ważne, ponieważ :
Podawanie stanu we wszystkich scenariuszach, nawet gdy treść jest opublikowana (STATUS == PUBLISHED), jest kluczowe do wypełniania paneli, które używają tego stanu do przekazywania informacji o kondycji i innych danych integracji.
Jeśli żadne treści nie są publikowane, ale stan integracji nie jest przerwany (STATUS == NOT_PUBLISHED), Google może uniknąć wywoływania alertów na panelach stanu aplikacji. Potwierdza, że treści nie są publikowane z powodu oczekiwanej z punktu widzenia dostawcy sytuacji.
Pomaga deweloperom określać, kiedy dane są publikowane, a kiedy nie.
Google może używać kodów stanu, aby zachęcać użytkownika do podejmowania określonych działań w aplikacji, dzięki którym będzie mógł wyświetlić jej zawartość lub rozwiązać problem.
Lista kwalifikujących się kodów stanu publikacji :
// 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
Jeśli treści nie są publikowane, ponieważ użytkownik nie jest zalogowany, Google zaleca opublikowanie karty logowania.
Jeśli z jakiegokolwiek powodu dostawcy nie mogą opublikować karty logowania, zalecamy wywołanie interfejsu API updatePublishStatus z kodem stanu NOT_PUBLISHED_REQUIRES_SIGN_IN.
Ten interfejs API służy do usuwania treści z grup rekomendacji.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Gdy usługa otrzyma prośbę, usunie dotychczasowe dane z klastrów rekomendacji. W przypadku błędu cała prośba zostanie odrzucona, a dotychczasowy stan zostanie zachowany.
deleteFeaturedCluster
Ten interfejs API służy do usuwania treści z wyróżnionego klastra.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Gdy usługa otrzyma żądanie, usunie istniejące dane z wyróżnionego klastra. W przypadku błędu cała prośba zostanie odrzucona, a dotychczasowy stan zostanie zachowany.
deleteContinuationCluster
Ten interfejs API służy do usuwania treści z klastra kontynuacji.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra kontynuacji. W przypadku błędu cała prośba zostanie odrzucona, a dotychczasowy stan zostanie zachowany.
deleteUserManagementCluster
Ten interfejs API służy do usuwania zawartości klastra UserAccountManagement.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra UserAccountManagement. W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.
deleteClusters
Ten interfejs API służy do usuwania treści danego typu klastra.
Gdy usługa otrzyma żądanie, usunie istniejące dane ze wszystkich klastrów pasujących do określonych typów klastrów. Klienci mogą przekazywać jeden lub wiele typów klastrów. W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan pozostaje bez zmian.
Obsługa błędów
Zdecydowanie zalecamy odsłuchanie wyniku zadania z interfejsów API publikowania, aby można było podjąć działania następcze w celu odzyskania i ponownego przesłania zadania, które zakończyło się niepowodzeniem.
Kotlin
client.publishRecommendationClusters(PublishRecommendationClustersRequest.Builder().addRecommendationCluster(..).build()).addOnCompleteListener{task->
if(task.isSuccessful){// do something}else{valexception=task.exceptionif(exceptionisAppEngageException){@AppEngageErrorCodevalerrorCode=exception.errorCodeif(errorCode==AppEngageErrorCode.SERVICE_NOT_FOUND){// do something}}}}
Java
client.publishRecommendationClusters(newPublishRecommendationClustersRequest.Builder().addRecommendationCluster(...).build()).addOnCompleteListener(task->{if(task.isSuccessful()){// do something}else{Exceptionexception=task.getException();if(exceptioninstanceofAppEngageException){@AppEngageErrorCodeinterrorCode=((AppEngageException)exception).getErrorCode();if(errorCode==AppEngageErrorCode.SERVICE_NOT_FOUND){// do something}}}});
Błąd jest zwracany jako obiekt AppEngageException, a jego przyczyna jest podana jako kod błędu.
Kod błędu
Nazwa błędu
Uwaga:
1
SERVICE_NOT_FOUND
Usługa jest niedostępna na danym urządzeniu.
2
SERVICE_NOT_AVAILABLE
Usługa jest dostępna na danym urządzeniu, ale w momencie połączenia nie jest dostępna (np. jest wyraźnie wyłączona).
3
SERVICE_CALL_EXECUTION_FAILURE
Nie udało się wykonać zadania z powodu problemów z wątkami. W takim przypadku można ponowić próbę.
4
SERVICE_CALL_PERMISSION_DENIED
Element wywołujący nie ma uprawnień do wykonania wywołania usługi.
5
SERVICE_CALL_INVALID_ARGUMENT
Żądanie zawiera nieprawidłowe dane (np. więcej klastrów niż dozwolona liczba).
6
SERVICE_CALL_INTERNAL
Po stronie usługi wystąpił błąd.
7
SERVICE_CALL_RESOURCE_EXHAUSTED
Wywołanie usługi jest wykonywane zbyt często.
Krok 3. Obsługa intencji transmisji
Oprócz wywoływania interfejsu API publikowania treści za pomocą zadania musisz też skonfigurować BroadcastReceiver, aby otrzymywać prośby o publikowanie treści.
Celem intencji transmisji jest głównie ponowna aktywacja aplikacji i wymuszenie synchronizacji danych. Intencje transmisji nie są przeznaczone do wysyłania zbyt często. Jest ona wywoływana tylko wtedy, gdy usługa Engage uzna, że treść może być nieaktualna (np. ma tydzień). Dzięki temu użytkownik może mieć pewność, że będzie korzystać z najnowszych treści, nawet jeśli aplikacja nie była uruchamiana przez dłuższy czas.
BroadcastReceiver musi być skonfigurowany na 2 sposoby:
Dynamiczne rejestrowanie instancji klasy BroadcastReceiver za pomocą Context.registerReceiver(). Umożliwia to komunikację z aplikacjami, które są nadal aktywne w pamięci.
Kotlin
classAppEngageBroadcastReceiver: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}funregisterBroadcastReceivers(context:Context){varcontext=contextcontext=context.applicationContext// Register Recommendation Cluster Publish Intentcontext.registerReceiver(AppEngageBroadcastReceiver(),IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION),com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,/*scheduler=*/null)// Register Featured Cluster Publish Intentcontext.registerReceiver(AppEngageBroadcastReceiver(),IntentFilter(Intents.ACTION_PUBLISH_FEATURED),com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,/*scheduler=*/null)// Register Continuation Cluster Publish Intentcontext.registerReceiver(AppEngageBroadcastReceiver(),IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION),com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,/*scheduler=*/null)}
Java
classAppEngageBroadcastReceiverextendsBroadcastReceiver{// 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}publicstaticvoidregisterBroadcastReceivers(Contextcontext){context=context.getApplicationContext();// Register Recommendation Cluster Publish Intentcontext.registerReceiver(newAppEngageBroadcastReceiver(),newIntentFilter(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 Intentcontext.registerReceiver(newAppEngageBroadcastReceiver(),newIntentFilter(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 Intentcontext.registerReceiver(newAppEngageBroadcastReceiver(),newIntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION),com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,/*scheduler=*/null);}
Statycznie zadeklaruj implementację za pomocą tagu <receiver> w pliku AndroidManifest.xml. Dzięki temu aplikacja może odbierać intencje transmisji, gdy nie jest uruchomiona, a także publikować treści.
Odpowiedzi na najczęstsze pytania znajdziesz w tym artykule.
Kontakt
Jeśli podczas procesu integracji pojawią się pytania, skontaktuj się z nami pod adresem engage-developers@google.com.
Dalsze kroki
Po zakończeniu integracji wykonaj te czynności:
Wyślij e-maila na adres engage-developers@google.com i załącz zintegrowany pakiet APK gotowy do testowania przez Google.
Google przeprowadza weryfikację i sprawdza wewnętrznie, czy integracja działa zgodnie z oczekiwaniami. Jeśli zajdzie taka potrzeba, skontaktujemy się z Tobą, aby przekazać niezbędne informacje.
Gdy testy zostaną zakończone i nie będą potrzebne żadne zmiany, skontaktujemy się z Tobą, aby poinformować, że możesz rozpocząć publikowanie zaktualizowanego i zintegrowanego pliku APK w Sklepie Play.
Gdy potwierdzimy, że zaktualizowany pakiet APK został opublikowany w Sklepie Play, klastry Rekomendacja, Wyróżnione i Kontynuacja mogą zostać opublikowane i będą widoczne dla użytkowników.
Treść strony i umieszczone na niej fragmenty kodu podlegają licencjom opisanym w Licencji na treści. Java i OpenJDK są znakami towarowymi lub zastrzeżonymi znakami towarowymi należącymi do firmy Oracle lub jej podmiotów stowarzyszonych.
