Google tworzy interfejs na urządzeniu, który porządkuje aplikacje użytkowników według branży i umożliwia nowe wciągające wrażenia podczas przeglądania i odtwarzania spersonalizowanych treści w aplikacji. Tryb pełnoekranowy daje partnerom deweloperom możliwość zaprezentowania swoich najlepszych treści w ramach dedykowanego kanału poza aplikacją.
Ten przewodnik zawiera instrukcje dla partnerów deweloperów dotyczące integracji treści do odczytu maszynowego za pomocą pakietu SDK Engage w celu wypełniania nowej powierzchni oraz istniejących powierzchni Google.
Szczegóły integracji
Terminologia
Ta integracja obejmuje 3 typy klasterów: Recommendation (Rekomendacja), Continuation (Kontynuacja) i Featured (Polecane).
Gromadzą rekomendacje, czyli spersonalizowane sugestie dotyczące treści do przeczytania od konkretnego partnera deweloperskiego.
Rekomendacje mają następującą strukturę:
Klaster rekomendacji: widok interfejsu użytkownika zawierający grupę rekomendacji od jednego partnera deweloperskiego.
Rysunek 1. Interfejs Entertainment Space pokazujący grupę rekomendacji od jednego partnera. Jednostka: obiekt reprezentujący pojedynczy element w klastrze. Może to być e-book, audiobook, seria książek itp. Listę obsługiwanych typów encji znajdziesz w sekcji Przygotowanie danych encji.
Rysunek 2. Interfejs Entertainment Space pokazujący pojedynczy element w ramach klastra rekomendacji jednego partnera.
Klaster Kontynuacja wyświetla niedokończone książki od wielu partnerów deweloperów w jednej grupie UI. Każdy partner deweloper może przesyłać maksymalnie 10 elementów w klastrze kontynuacji.
Rysunek 3. Interfejs Entertainment Space: klaster kontynuacji z nieukończonymi rekomendacjami od wielu partnerów (obecnie widoczna jest tylko jedna rekomendacja). Klaster Polecane prezentuje wybór elementów od kilku partnerów dewelopera w postaci 1 grupowanego interfejsu. Będzie jeden wyróżniony klaster, który będzie wyświetlany u góry interfejsu w priorytetowym miejscu nad wszystkimi innymi klastrami rekomendacji. Każdy partner deweloper może transmitować maksymalnie 10 elementów w klastrze Polecane.
Rysunek 4. Interfejs Entertainment Space z klasterem polecanych treści z rekomendacjami 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'
}
Podsumowanie
Projekt jest oparty na implementacji usługi z ograniczeniami.
Dane, które klient może publikować, podlegają następującym limitom dotyczącym różnych typów klastrów:
| Typ klastra | Limity klastra | Maksymalne limity elementów w klastrze |
|---|---|---|
| Klastry rekomendacji | Maksymalnie 5 | Maksymalnie 50 |
| Klaster kontynuacji | Maksymalnie 1 | Maksymalnie 10 |
| Polecany klaster | Maksymalnie 1 | Maksymalnie 10 |
Krok 1. Podaj dane o podmiocie
Pakiet SDK definiuje różne elementy, które reprezentują poszczególne typy elementów. W ramach kategorii Odczyt obsługujemy te typy jednostek:
EbookEntityAudiobookEntityBookSeriesEntity
W tabelach poniżej znajdziesz dostępne atrybuty i wymagania dotyczące poszczególnych typów.
EbookEntity
Obiekt EbookEntity reprezentuje e-booka (np. e-booka Becoming autorstwa Michelle Obamy).
| Atrybut | Wymaganie | Uwagi |
|---|---|---|
| Nazwa | Wymagany | |
| obrazy plakatu, | Wymagany | Musisz podać co najmniej 1 obraz. Więcej informacji znajdziesz w specyfikacji zdjęć. |
| Autor | Wymagany | Musisz podać co najmniej 1 nazwę autora. |
| Identyfikator URI linku do działania | Wymagany |
Precyzyjny link do aplikacji dostawcy e-booka. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania |
| Data publikacji | Opcjonalnie | W milisekundach od początku epoki, jeśli podano. |
| Opis | Opcjonalnie | Jeśli podasz tę wartość, musi ona mieć maksymalnie 200 znaków. |
| Cena | Opcjonalnie | Tekst otwarty |
| Liczba stron | Opcjonalnie | Musi to być dodatnia liczba całkowita. |
| Gatunek | Opcjonalnie | Lista gatunków powiązanych z książką. |
| Nazwa serii | Opcjonalnie | Nazwa serii, do której należy e-book (np. Harry Potter). |
| Indeks jednostki serii | Opcjonalnie | Indeks e-booka w serii, gdzie 1 to pierwszy e-book w serii. Jeśli na przykład Harry Potter i Więzień Azkabanu jest 3 książką w serii, wartość ta powinna wynosić 3. |
| Kontynuuj rezerwację typu | Opcjonalnie |
TYPE_CONTINUE – wznowienie nieukończonej książki. TYPE_NEXT – kontynuowanie nowej serii. TYPE_NEW - nowość |
| Ostatni czas zaangażowania | Wymagane warunkowo |
Musi być podany, gdy produkt znajduje się w klastrze kontynuacji. *Nowo* zakupione e-booki mogą być częścią klastra „Kontynuuj czytanie”. W milisekundach epoki. |
| Postęp – procent ukończenia | Wymagane warunkowo |
Ta wartość musi być podana, gdy element znajduje się w klastrze kontynuacji. Wartość musi być większa niż 0 i mniejsza niż 100. |
| DisplayTimeWindow – ustawienie okna czasowego, w którym treści mają być wyświetlane na urządzeniu | ||
| Sygnatura czasowa rozpoczęcia | Opcjonalnie |
Sygnatura czasowa epoki, po której treści mają być wyświetlane na powierzchni. Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie. W milisekundach od początku epoki. |
| Sygnatura czasowa zakończenia | Opcjonalnie |
Znak czasu epoki, po którym treści nie są już wyświetlane na powierzchni. Jeśli nie skonfigurujesz tej zasady, treści mogą być wyświetlane na powierzchni. W milisekundach od początku epoki. |
AudiobookEntity
Obiekt AudiobookEntity reprezentuje audiobook (np. audiobook Becoming Michelle Obama).
| Atrybut | Wymaganie | Uwagi |
|---|---|---|
| Nazwa | Wymagany | |
| obrazy plakatu, | Wymagany | Musisz podać co najmniej 1 obraz. Więcej informacji znajdziesz w specyfikacji zdjęć. |
| Autor | Wymagany | Musisz podać co najmniej 1 nazwę autora. |
| Narrator | Wymagany | Należy podać co najmniej jednego lektora. |
| Identyfikator URI linku do działania | Wymagany |
Precyzyjny link do aplikacji dostawcy audiobooka. Uwaga: na potrzeby atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania |
| Data publikacji | Opcjonalnie | W milisekundach od początku epoki, jeśli podano. |
| Opis | Opcjonalnie | Jeśli podasz tę wartość, musi ona mieć maksymalnie 200 znaków. |
| Cena | Opcjonalnie | Dowolny tekst |
| Czas działania | Opcjonalnie | Jeśli zostanie podana, musi być wartością dodatnią. |
| Gatunek | Opcjonalnie | Lista gatunków powiązanych z książką. |
| Nazwa serii | Opcjonalnie | Nazwa serii, do której należy audiobook (np. Harry Potter). |
| Indeks jednostki serii | Opcjonalnie | Indeks audiobooka w serii, gdzie 1 oznacza pierwszy audiobook w serii. Jeśli na przykład Harry Potter i Więzień Azkabanu jest 3 książką w serii, wartość ta powinna wynosić 3. |
| Kontynuuj rezerwację typu | Opcjonalnie |
TYPE_CONTINUE – wznowienie nieukończonej książki. TYPE_NEXT – kontynuowanie nowej serii. TYPE_NEW - nowość |
| Ostatni czas zaangażowania | Wymagane warunkowo | Musi być podany, gdy produkt znajduje się w klastrze kontynuacji. W milisekundach epoki. |
| Postęp – procent ukończenia | Wymagane warunkowo |
Musi być podany, gdy produkt znajduje się w klastrze kontynuacji. *Nowo* zakupione audiobooki mogą być częścią grupy Kontynuuj czytanie. Wartość musi być większa niż 0 i mniejsza niż 100. |
| DisplayTimeWindow – ustawienie okna czasowego, w którym treści mają być wyświetlane na urządzeniu | ||
| Sygnatura czasowa rozpoczęcia | Opcjonalnie |
Sygnatura czasowa epoki, po której treści mają być wyświetlane na powierzchni. Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie. W milisekundach od początku epoki. |
| Sygnatura czasowa zakończenia | Opcjonalnie |
Znak czasu epoki, po którym treści nie są już wyświetlane na powierzchni. Jeśli nie skonfigurujesz tej zasady, treści mogą być wyświetlane na powierzchni. W milisekundach od początku epoki. |
BookSeriesEntity
Obiekt BookSeriesEntity reprezentuje serię książek (np. Harry Potter, która zawiera 7 książek).
| Atrybut | Wymaganie | Uwagi |
|---|---|---|
| Nazwa | Wymagany | |
| obrazy plakatu, | Wymagany | Musisz podać co najmniej 1 obraz. Więcej informacji znajdziesz w specyfikacji zdjęć. |
| Autor | Wymagany | Musisz podać co najmniej 1 nazwę autora. |
| Identyfikator URI linku do działania | Wymagany |
Precyzyjny link do aplikacji dostawcy audiobooka lub e-booka. Uwaga: na potrzeby atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania |
| Liczba książek | Wymagany | Liczba książek z serii. |
| Opis | Opcjonalnie | Jeśli podasz tę wartość, musi ona mieć maksymalnie 200 znaków. |
| Gatunek | Opcjonalnie | Lista gatunków powiązanych z książką. |
| Kontynuuj rezerwację typu | Opcjonalnie |
TYPE_CONTINUE – wznowienie nieukończonej książki. TYPE_NEXT – kontynuowanie nowej serii. TYPE_NEW - nowość |
| Ostatni czas zaangażowania | Wymagane warunkowo | Musi być podany, gdy produkt znajduje się w klastrze kontynuacji. W milisekundach epoki. |
| Postęp – procent ukończenia | Wymagane warunkowo | Musi być podany, gdy produkt znajduje się w klastrze kontynuacji. *Nowo* nabyte serie książek mogą być częścią grupy kontynuacji. Wartość musi być większa niż 0 i mniejsza niż 100. |
| DisplayTimeWindow – ustawienie okna czasowego, w którym treści mają być wyświetlane na urządzeniu | ||
| Sygnatura czasowa rozpoczęcia | Opcjonalnie |
Sygnatura czasowa epoki, po której treści mają być wyświetlane na powierzchni. Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie. W milisekundach od początku epoki. |
| Sygnatura czasowa zakończenia | Opcjonalnie |
Znak czasu epoki, po którym treści nie są już wyświetlane na powierzchni. Jeśli nie skonfigurujesz tej zasady, treści mogą być wyświetlane na powierzchni. W milisekundach od początku epoki. |
Specyfikacja obrazu
Wymagania dotyczące komponentów z obrazem:
| Format obrazu | Wymaganie | Minimalna liczba pikseli | Zalecany rozmiar w pikselach |
|---|---|---|---|
| Kwadrat (1 x 1) | Wymagany | 300x300 | 1200x1200 |
| Poziomy (1,91 x 1) | Opcjonalnie | 600 x 314 | 1200 x 628 |
| Orientacja pionowa (4 x 5) | Opcjonalnie | 480 x 600 | 960 x 1200 |
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.
Przykład
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();
Krok 2. Podaj dane klastra
Zalecamy, aby zadanie publikowania treści było wykonywane w tle (np. za pomocą WorkManagera) i zaplanowane w sposób regularny lub w zależności od zdarzenia (np. za każdym razem, gdy użytkownik otworzy aplikację lub doda produkt do koszyka).
Za publikowanie klastrów odpowiada AppEngagePublishClient. W kliencie są dostępne następujące interfejsy API:
isServiceAvailablepublishRecommendationClusterspublishFeaturedClusterpublishContinuationClusterpublishUserAccountManagementRequestupdatePublishStatusdeleteRecommendationsClustersdeleteFeaturedClusterdeleteContinuationClusterdeleteUserManagementClusterdeleteClusters
isServiceAvailable
Ten interfejs API służy do sprawdzania, czy usługa jest dostępna do integracji i czy treści mogą być wyświetlane na urządzeniu.
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
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("Reconnect with yourself") .build()) .build())
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Reconnect with yourself") .build()) .build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykona te działania:
- Istniejące dane
RecommendationClusterod partnera dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze rekomendacji.
W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.
publishFeaturedCluster
Ten interfejs API służy do publikowania listy obiektów FeaturedCluster.
Kotlin
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() ... .build()) .build())
Java
client.publishFeaturedCluster( new PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( new FeaturedCluster.Builder() ... .build()) .build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykona te działania:
- Istniejące dane
FeaturedClusterod partnera dewelopera zostaną usunięte. - Dane z zapytania są analizowane i przechowywane w zaktualizowanym zbiorze polecanych.
W przypadku błędu żądanie w całości jest odrzucane, a obecny stan zostaje zachowany.
publishContinuationCluster
Ten interfejs API służy do publikowania obiektu ContinuationCluster.
Kotlin
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(book_entity1) .addEntity(book_entity2) .build()) .build())
Java
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(book_entity1) .addEntity(book_entity2) .build()) .build())
Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykona te działania:
- Istniejące dane
ContinuationClusterod partnera dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze kontynuacji.
W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.
publishUserAccountManagementRequest
Ten interfejs API służy do publikowania karty logowania. Działanie logowania kieruje użytkowników na stronę logowania w aplikacji, aby aplikacja mogła publikować treści (lub udostępniać bardziej spersonalizowane treści).
Te metadane są częścią karty logowania:
| Atrybut | Wymaganie | Opis |
|---|---|---|
| Identyfikator URI działania | Wymagane | Precyzyjny link do działania (np. otwiera stronę logowania w aplikacji) |
| Obraz | Opcjonalnie – jeśli nie zostanie podany, należy podać tytuł. |
Obraz widoczny na karcie obrazy w formacie 16 x 9 o rozdzielczości 1264 x 712; |
| Tytuł | Opcjonalnie – jeśli nie zostanie podany, należy podać obraz | Tytuł na karcie |
| Tekst wezwania do działania | Opcjonalnie | Tekst wezwania do działania (np. Zaloguj się) |
| Podtytuł | Opcjonalnie | Opcjonalny tekst na karcie |
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());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykonywane są te działania:
- Dotychczasowe dane
UserAccountManagementClusterod partnera dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze UserAccountManagementCluster.
W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.
updatePublishStatus
Jeśli z jakiegokolwiek wewnętrznego powodu biznesowego żaden z klastrów nie został opublikowany, zdecydowanie zalecamy zaktualizowanie stanu publikowania przy użyciu interfejsu API updatePublishStatus. To ważne, ponieważ :
- Podanie stanu we wszystkich scenariuszach, nawet po opublikowaniu treści (STATUS == PUBLISHED), ma kluczowe znaczenie przy wypełnianiu paneli, które używają tego stanu wprost do przekazywania danych o stanie i innych wskaźnikach związanych z integracją.
- Jeśli nie ma opublikowanych treści, ale integracja nie jest uszkodzona (STATUS = NOT_PUBLISHED), Google może nie uruchamiać alertów na panelach danych dotyczących zdrowia w aplikacji. Potwierdza ono, że treść nie została opublikowana z powodu oczekiwanej sytuacji z punktu widzenia dostawcy.
- Pomaga deweloperom udostępniać informacje o tym, kiedy dane są publikowane, a kiedy nie.
- Google może używać kodów stanu, aby zachęcić użytkownika do wykonania określonych działań w aplikacji, dzięki którym będzie on mógł zobaczyć jej zawartość lub ją pokonać.
Lista kodów stanu publikacji, które kwalifikują się do opublikowania:
// 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.
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
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 istniejące dane z klastrów rekomendacji. W przypadku błędu cała prośba zostaje odrzucona, a obecny stan jest 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 klastra wyróżnionego. W przypadku błędu cała prośba zostaje odrzucona, a obecny stan jest zachowany.
deleteContinuationCluster
Ten interfejs API służy do usuwania zawartości 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 zostaje odrzucona, a obecny stan jest zachowany.
deleteUserManagementCluster
Ten interfejs API służy do usuwania treści z klastra UserAccountManagement.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Gdy usługa otrzyma żądanie, usuwa istniejące dane z klastra UserAccountManagement. W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.
deleteClusters
Ten interfejs API służy do usuwania treści danego typu klastra.
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());
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ła prośba jest odrzucana, a istniejący stan jest zachowany.
Obsługa błędów
Zdecydowanie zalecamy wsłuchiwanie się w wyniki zadania z interfejsów API do publikowania, aby móc podjąć dalsze działania w celu odzyskania i ponownego przesłania udanego zadania.
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
}
}
}
});
Błąd jest zwracany jako AppEngageException, a jego przyczyna jest podana w postaci kodu 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 nie jest dostępna w momencie połączenia (na przykład 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żesz spróbować ponownie. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Rozmówca nie może nawiązać połączenia z usługą. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
Żądanie zawiera nieprawidłowe dane (np. więcej niż dozwoloną liczbę klastrów). |
6 |
SERVICE_CALL_INTERNAL |
Po stronie usługi wystąpił błąd. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Dzwonienie do zespołu pomocy jest wykonywane zbyt często. |
Krok 3. Obsługa intencji transmisji
Oprócz wywoływania interfejsu Content API za pomocą zadania musisz też skonfigurować BroadcastReceiver, aby odbierać prośby o publikowanie treści.
Intencje przesyłania strumieniowego służą głównie do ponownego aktywowania aplikacji i wymuszania synchronizacji danych. Intencje dotyczące transmisji nie są przeznaczone do wysyłania bardzo często. Jest ona wywoływana tylko wtedy, gdy usługa Engage stwierdzi, że treści mogą być nieaktualne (np. mają tydzień). Dzięki temu użytkownicy będą mieli większą pewność, że będą mieli dostęp do nowych treści, nawet jeśli aplikacja nie była uruchamiana od dłuższego czasu.
BroadcastReceiver trzeba skonfigurować na 2 sposoby:
- Dynamicznie zarejestruj wystąpienie klasy
BroadcastReceiverza pomocąContext.registerReceiver(). Umożliwia to komunikację z aplikacji, które są nadal aktywne w pamięci.
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));
}
- Statycznie deklaruj implementację z tagiem
<receiver>w plikuAndroidManifest.xml. Dzięki temu aplikacja może otrzymywać intencje transmisji, gdy nie jest uruchomiona, i może publikować treści.
<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>
Usługa wyśle te zamiary:
com.google.android.engage.action.PUBLISH_RECOMMENDATIONPo otrzymaniu tej intencji zalecamy uruchomienie wywołaniapublishRecommendationClusters.com.google.android.engage.action.PUBLISH_FEATUREDGdy otrzymasz ten zamiar, zalecamy rozpoczęcie rozmowypublishFeaturedCluster.- com.google.android.engage.action.PUBLISH_CONTINUATION
It is recommended to start apublishContinuationCluster` podczas otrzymywania tego zamiaru.
Proces integracji
Szczegółowy przewodnik dotyczący weryfikacji integracji po jej zakończeniu znajdziesz w artykule Procedura integracji Engage z aplikacją dewelopera.
Najczęstsze pytania
Najczęstsze pytania dotyczące Engage SDK znajdziesz w artykule Najczęstsze pytania dotyczące Engage SDK.
Kontakt
Jeśli masz pytania dotyczące procesu integracji, wyślij e-maila na adres Engage-developers@google.com. Nasz zespół odpowie tak szybko, jak to będzie możliwe.
Dalsze kroki
Po zakończeniu tej integracji wykonaj te czynności:
- Wyślij e-maila na adres Engage-developers@google.com i załącz zintegrowany plik APK, który jest gotowy do testowania przez Google.
- Google przeprowadzi wewnętrzną weryfikację i sprawdzenie, aby upewnić się, że integracja działa zgodnie z oczekiwaniami. Jeśli będą potrzebne zmiany, skontaktujemy się z Tobą, aby przekazać niezbędne informacje.
- Gdy testy zostaną zakończone i nie trzeba będzie wprowadzać żadnych zmian, skontaktujemy się z Tobą, aby poinformować, że możesz rozpocząć publikowanie zaktualizowanego i zintegrowanego pliku APK w Google Play.
- Gdy Google potwierdzi, że zaktualizowany plik APK został opublikowany w Sklepie Play, Twoje grupy rekomendacji, polecanych i kontynuacji będą publikowane i widoczne dla użytkowników.