Google tworzy platformę na urządzeniu, która porządkuje aplikacje użytkowników według branż i zapewnia nowe, immersyjne środowisko do przeglądania i odkrywania treści z aplikacji. Tryb pełnoekranowy daje deweloperom możliwość zaprezentowania swoich najlepszych szczegółowych treści na specjalnym kanale poza aplikacją.
Ten przewodnik zawiera instrukcje dla partnerów deweloperów dotyczące integracji treści dotyczących jedzenia za pomocą pakietu Engage SDK, aby wypełnić nową powierzchnię i dotychczasowe powierzchnie Google.
Szczegóły integracji
Terminologia
Ta integracja obejmuje 5 typów klastrów: Recommendation (Rekomendacje), Featured (Polecane), Food Shopping Cart (Koszyk z produktami spożywczymi), Food Shopping List (Lista zakupów z produktami spożywczymi) i Reorder (Ponowne zamawianie).
Grupy rekomendacji zawierają spersonalizowane sugestie dotyczące jedzenia od konkretnego partnera deweloperskiego. Te rekomendacje mogą być spersonalizowane dla danego użytkownika lub ogólne (np. nowości w sprzedaży). Używaj ich do wyświetlania przepisów, sklepów, potraw, produktów spożywczych itp. według własnego uznania.
- Klastry rekomendacji mogą składać się z elementów typu
ProductEntity
,StoreEntity
lubRecipeEntity
, ale nie mogą zawierać różnych typów elementów.
- Klastry rekomendacji mogą składać się z elementów typu
Klaster Polecane zawiera zbiór elementów od wielu partnerów programistów w jednym układzie interfejsu. Będzie 1 polecany klaster, który będzie widoczny u góry interfejsu użytkownika i umieszczony priorytetowo nad wszystkimi klastrami rekomendacji. Każdy partner deweloper może transmitować maksymalnie 10 elementów w klastrze Polecane.
Klaster Koszyk na zakupy spożywcze zawiera w jednym układzie interfejsu podgląd koszyków na zakupy spożywcze pochodzących od wielu partnerów deweloperów, a także zachęca użytkowników do sfinalizowania otwartych koszyków. Jest jeden klaster koszyka zakupów spożywczych.
Klaster koszyka na zakupy żywności musi pokazywać łączną liczbę produktów w koszyku i może również zawierać zdjęcia X produktów w koszyku użytkownika.
Grupa Lista zakupów zawiera w jednym obszarze interfejsu podgląd list zakupów od wielu partnerów deweloperów, a także prośbę o powrót do odpowiedniej aplikacji w celu zaktualizowania i uzupełnienia list. Jest jeden klaster dotyczący listy zakupów spożywczych.
Klaster Zmień kolejność pokazuje wcześniejsze zamówienia od kilku partnerów deweloperów w jednej grupie UI, co informuje użytkowników o zmianie kolejności. Jest 1 klaster „Zmien kolejność”.
Grupa ponownego zamówienia musi zawierać łączną liczbę produktów z poprzedniego zamówienia użytkownika. Musi też zawierać co najmniej jedną z tych informacji:
- Obrazy X elementów z poprzedniego zamówienia użytkownika.
- Etykiety X produktów w poprzednim zamówieniu użytkownika.
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 ograniczeniom w przypadku różnych typów klastrów:
Typ klastra | Limity klastra | Maksymalne limity elementów w klastrze |
---|---|---|
Klastry rekomendacji | Maksymalnie 5 | Maksymalnie 25 (ProductEntity , RecipeEntity lub StoreEntity ) |
Polecany klaster | Maksymalnie 1 | Maksymalnie 10 (ProductEntity , RecipeEntity lub StoreEntity ) |
Klaster koszyka na zakupy spożywcze | Maksymalnie 1 | Maksymalnie 1 ShoppingCartEntity |
Grupa „Lista zakupów – jedzenie” | Maksymalnie 1 | Maksymalnie 1 ShoppingListEntity |
Grupa ponownego zamawiania jedzenia | Maksymalnie 1 | Maksymalnie 1 ReorderEntity |
Krok 1. Podaj dane o podmiocie
Pakiet SDK definiuje różne elementy, które reprezentują poszczególne typy elementów. W przypadku kategorii Żywność obsługujemy te typy jednostek:
ProductEntity
StoreEntity
RecipeEntity
FoodShoppingCart
FoodShoppingList
FoodReorderCluster
W tabelach poniżej znajdziesz dostępne atrybuty i wymagania dotyczące poszczególnych typów.
ProductEntity
Obiekt ProductEntity
reprezentuje pojedynczy produkt (np. artykuł spożywczy, danie z restauracji lub promocję), który partnerzy deweloperzy chcą opublikować.
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
obrazy plakatu, | Wymagany | Musisz podać co najmniej 1 obraz. | Więcej informacji znajdziesz w specyfikacji zdjęć. |
Identyfikator URI działania | Wymagany |
Precyzyjny link do strony w aplikacji z informacjami o produkcie. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania |
Identyfikator URI |
Tytuł | Opcjonalnie | Nazwa produktu. | Tekst otwarty Zalecany rozmiar tekstu: poniżej 90 znaków (zbyt długi tekst może zawierać wielokropki) |
Cena - bieżąca | Wymagane warunkowo | Obecna cena produktu. Jeśli podano przekreśloną cenę, ta wartość jest wymagana. |
Tekst otwarty |
Cena – przekreślenie | Opcjonalnie | Pierwotna cena elementu, przekreślona w interfejsie. | Dowolny tekst |
Objaśnienie | Opcjonalnie | Objaśnienie, które powinno zawierać promocję, wydarzenie lub aktualizację produktu, jeśli są dostępne. | Tekst otwarty Zalecany rozmiar tekstu: poniżej 45 znaków (zbyt długi tekst może zawierać wielokropki) |
Drobny druk w ramach objaśnienia | Opcjonalnie | Drobny druk objaśnienia. | Tekst otwarty Zalecany rozmiar tekstu: poniżej 45 znaków (zbyt długi tekst może zawierać wielokropki) |
Ocena (opcjonalnie) – uwaga: wszystkie oceny są wyświetlane w standardowym systemie ocen za pomocą gwiazdek. | |||
Ocena – wartość maksymalna | Opcjonalnie | Maksymalna wartość skali ocen. Musi być podana, jeśli podana jest też aktualna wartość oceny. |
Liczba >= 0,0 |
Rating - Current value | Opcjonalnie | Bieżąca wartość skali ocen. Atrybut ten jest wymagany, jeśli podano także maksymalną wartość oceny. |
Liczba >= 0,0 |
Rating - Count (Liczba ocen) | Opcjonalnie | Liczba ocen produktu. Uwaga: wypełnij to pole, jeśli Twoja aplikacja kontroluje sposób wyświetlania liczby użytkownikom. Użyj zwięzłego ciągu znaków. Jeśli np. liczba wynosi 1 000 000, rozważ użycie skrótu, np. 1 mln, aby liczba nie była obcinana w mniejszych rozmiarach wyświetlacza. |
Ciąg znaków |
Rating - Count Value | Opcjonalnie | Liczba ocen produktu. Uwaga: wypełnij to pole, jeśli nie obsługujesz samodzielnie logiki wyświetlania skrótu. Jeśli występują zarówno parametry Liczba, jak i Wartość liczby, użytkownikom wyświetlana jest liczba. |
Długie |
DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na platformie | |||
Sygnatura czasowa rozpoczęcia | Opcjonalnie |
sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie; Jeśli nie skonfigurujesz tej zasady, treści mogą być wyświetlane na powierzchni. |
Sygnatura czasowa od początku epoki w milisekundach |
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. |
Sygnatura czasowa epoki w milisekundach |
StoreEntity
Obiekt StoreEntity
reprezentuje pojedynczy sklep, który partnerzy deweloperzy chcą opublikować, np. restaurację lub sklep spożywczy.
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
obrazy plakatu, | Wymagany | Musisz podać co najmniej 1 obraz. | Więcej informacji znajdziesz w specyfikacji zdjęć. |
Identyfikator URI działania | Wymagany | Link do strony w aplikacji, na której znajdują się szczegóły dotyczące sklepu. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania |
Identyfikator URI |
Tytuł | Opcjonalnie | Nazwa sklepu. | Tekst otwarty Zalecany rozmiar tekstu: poniżej 45 znaków (zbyt długi tekst może zawierać wielokropki) |
Lokalizacja | Opcjonalnie | Lokalizacja sklepu. | Dowolny tekst Zalecane rozmiary tekstu: poniżej 45 znaków (za długi tekst może zawierać wielokropki) |
Objaśnienie | Opcjonalnie | Ramka z informacją o promocji, wydarzeniu lub aktualizacji sklepu (jeśli jest dostępna). | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (zbyt długi tekst może zawierać wielokropki) |
Drobny druk w ramach objaśnienia | Opcjonalnie | Drobny druk objaśnienia. | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (za długi tekst może zawierać wielokropki) |
Opis | Opcjonalnie | Opis sklepu. | Tekst otwarty Zalecana długość tekstu: poniżej 90 znaków (za długi tekst może być wyświetlany z wielokropem) |
Uwaga: wszystkie oceny są wyświetlane za pomocą naszego standardowego systemu oceny za pomocą gwiazdek. | |||
Ocena – wartość maksymalna | Opcjonalnie | Maksymalna wartość skali ocen. Musi być podana, jeśli podana jest też aktualna wartość oceny. |
Liczba >= 0,0 |
Rating - Current value | Opcjonalnie | Bieżąca wartość skali ocen. Atrybut ten jest wymagany, jeśli podano także maksymalną wartość oceny. |
Liczba >= 0,0 |
Rating - Count (Liczba ocen) | Opcjonalnie | Liczba ocen sklepu. Uwaga: wypełnij to pole, jeśli aplikacja ma kontrolować sposób wyświetlania tego elementu użytkownikom. Podaj krótki ciąg znaków, który może być wyświetlany użytkownikowi. Jeśli na przykład liczba wynosi 1 000 000, możesz użyć skrótów, takich jak 1 mln, aby nie została przycięta na mniejszych ekranach. |
Ciąg znaków |
Rating - Count Value | Opcjonalnie | Liczba ocen sklepu. Uwaga: podaj to pole, jeśli nie chcesz samodzielnie obsługiwać wyświetlanych skrótów. Jeśli występują zarówno liczba, jak i wartość liczby, wyświetlimy użytkownikom liczbę. |
Długie |
RecipeEntity
Obiekt RecipeEntity
reprezentuje element przepisu, który partnerzy deweloperzy chcą opublikować.
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
obrazy plakatu, | Wymagany | Musisz podać co najmniej 1 obraz. | Więcej informacji znajdziesz w specyfikacji zdjęć. |
Identyfikator URI działania | Wymagany | Precyzyjny link do strony w aplikacji, która wyświetla szczegółowe informacje o przepisie. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania |
Identyfikator URI |
Tytuł | Opcjonalnie | Nazwa przepisu. | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (za długi tekst może zawierać wielokropki) |
Autor | Opcjonalnie | Autor przepisu. | Tekst otwarty Zalecany rozmiar tekstu: poniżej 45 znaków (zbyt długi tekst może zawierać wielokropki) |
Czas gotowania/przygotowania | Opcjonalnie | Czas gotowania według przepisu. | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (za długi tekst może zawierać wielokropki) |
Objaśnienie | Opcjonalnie | Wskazówka dotycząca promocji, wydarzenia lub aktualizacji przepisu (jeśli są dostępne). | Tekst otwarty Zalecany rozmiar tekstu: poniżej 45 znaków (zbyt długi tekst może zawierać wielokropki) |
Kategoria | Opcjonalnie | Kategoria przepisu. | Tekst otwarty Zalecane rozmiary tekstu: poniżej 45 znaków (za długi tekst może zawierać wielokropki) |
Opis | Opcjonalnie | Opis przepisu. | Tekst otwarty Zalecany rozmiar tekstu: poniżej 90 znaków (zbyt długi tekst może zawierać wielokropki) |
Uwaga: wszystkie oceny są wyświetlane za pomocą naszego standardowego systemu oceny za pomocą gwiazdek. | |||
Ocena – wartość maksymalna | Opcjonalnie | Maksymalna wartość skali ocen. Musi być podana, jeśli podana jest też aktualna wartość oceny. |
Liczba >= 0,0 |
Rating - Current value | Opcjonalnie | Bieżąca wartość skali ocen. Atrybut ten jest wymagany, jeśli podano także maksymalną wartość oceny. |
Liczba >= 0,0 |
Rating - Count (Liczba ocen) | Opcjonalnie | Liczba ocen przepisu. Uwaga: wypełnij to pole, jeśli aplikacja ma kontrolować sposób wyświetlania tego elementu użytkownikom. Podaj krótki ciąg znaków, który może być wyświetlany użytkownikowi. Jeśli np. liczba wynosi 1 000 000, rozważ użycie skrótu, np. 1 mln, aby nie została ona obcięta w mniejszych rozmiarach wyświetlacza. |
Ciąg znaków |
Rating - Count Value | Opcjonalnie | Liczba ocen przepisu. Uwaga: podaj to pole, jeśli nie chcesz samodzielnie obsługiwać wyświetlanych skrótów. Jeśli występują zarówno liczba, jak i wartość liczby, wyświetlimy użytkownikom liczbę. |
Długie |
FoodShoppingCart
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Identyfikator URI działania | Wymagany |
Precyzyjny link do koszyka w aplikacji partnera. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania |
Identyfikator URI |
Liczba elementów | Wymagany | Liczba produktów (a nie tylko liczba produktów) w koszyku. Przykład: jeśli w koszyku są 3 pomarańcze i 1 jabłko, liczba ta powinna wynosić 4. |
Liczba całkowita > 1 |
Tytuł | Opcjonalnie | Tytuł koszyka (np. Twój koszyk). Jeśli deweloper nie poda tytułu, domyślnie zostanie użyty tytuł Twój kosz. |
Tekst otwarty Zalecane rozmiary tekstu: poniżej 25 znaków (tekst, który jest zbyt długi, może zawierać wielokropki) |
Tekst wezwania do działania | Opcjonalnie |
Tekst wezwania do działania na przycisku w koszyku (np. Twój koszyk). Jeśli deweloper nie poda tekstu działania, domyślnie będzie to Wyświetl koszyk. Ten atrybut jest obsługiwany od wersji 1.1.0. |
Ciąg znaków |
Obrazy koszyka | Opcjonalnie | obrazy każdego produktu w koszyku. Można przesłać maksymalnie 10 obrazów w kolejności według priorytetu. Rzeczywista liczba wyświetlanych obrazów zależy od formatu urządzenia. |
Wskazówki znajdziesz w specyfikacjach obrazów. |
Etykiety elementów | Opcjonalnie | Lista etykiet produktów na liście zakupów. Rzeczywista liczba wyświetlanych etykiet zależy od formatu urządzenia. |
Lista etykiet tekstowych Zalecany rozmiar tekstu: poniżej 20 znaków (zbyt długi tekst może zawierać wielokropki) |
DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, 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 powinny być wyświetlane na danej platformie; Jeśli nie skonfigurujesz tej zasady, treści mogą być wyświetlane na powierzchni. |
Sygnatura czasowa od początku epoki w milisekundach |
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. |
Sygnatura czasowa od początku epoki w milisekundach |
FoodShoppingList
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Identyfikator URI działania | Wymagany |
Precyzyjny link do listy zakupów w aplikacji partnera. Uwaga: na potrzeby atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania |
Identyfikator URI |
Liczba elementów | Wymagany | Liczba produktów na liście zakupów. | Liczba całkowita > 1 |
Tytuł | Opcjonalnie |
Tytuł listy (np. Lista zakupów). Jeśli deweloper nie poda tytułu, domyślnie zostanie wyświetlona lista zakupów. |
Tekst otwarty Zalecany rozmiar tekstu: poniżej 25 znaków (zbyt długi tekst może zawierać wielokropki) |
Etykiety elementów | Wymagany | Lista etykiet produktów na liście zakupów. Musisz podać co najmniej 1 etykietę, a maksymalnie 10 etykiet w kolejności priorytetów. Rzeczywista liczba wyświetlanych etykiet zależy od formatu urządzenia. |
Lista etykiet tekstowych Zalecana długość tekstu: mniej niż 20 znaków (tekst, który jest zbyt długi, może zawierać wielokropki) |
FoodReorderCluster
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Identyfikator URI działania | Wymagany |
Precyzyjny link do zmiany kolejności w aplikacji partnera. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania |
Identyfikator URI |
Tekst wezwania do działania | Opcjonalnie |
Tekst wezwania do działania przycisku „Zamówienie ponownie” (np. Zamówienie ponownie). Jeśli deweloper nie poda tekstu działania, domyślnie będzie to Zmień kolejność. Ten atrybut jest obsługiwany od wersji 1.1.0. |
Ciąg znaków |
Liczba elementów | Wymagany |
Liczba elementów (nie tylko liczba produktów) w poprzednim zamówieniu. Na przykład: jeśli w poprzednim zamówieniu były 3 małe kawy i 1 rogalik, liczba ta powinna wynosić 4. |
Liczba całkowita > 1 |
Tytuł | Wymagany | Tytuł produktu, którego dotyczy zmiana. | Tekst otwarty Zalecana długość tekstu: mniej niż 40 znaków (za długi tekst może być wyświetlany z wielokropem) |
Etykiety elementów | Opcjonalnie (jeśli nie podano, należy przesłać obrazy plakatów) |
Lista etykiet produktów w poprzednim zamówieniu. Można podać maksymalnie 10 etykiet w kolejności według priorytetu. Rzeczywista liczba wyświetlanych etykiet zależy od formatu urządzenia. |
Lista dowolnego tekstu Zalecane rozmiary tekstu na etykietę: poniżej 20 znaków(ewentualne wielokropki mogą oznaczać zbyt długi tekst) |
obrazy plakatu, | Opcjonalnie (jeśli nie podano, należy podać etykiety produktów) |
Zdjęcia produktów z poprzedniego zamówienia. Możesz przesłać maksymalnie 10 obrazów w kolejności priorytetów. Rzeczywista liczba wyświetlanych obrazów zależy od formatu urządzenia. |
Więcej informacji znajdziesz w specyfikacji zdjęć. |
Specyfikacja obrazu
Wymagania dotyczące komponentów z obrazem:
Format obrazu | Minimalna liczba pikseli | Zalecany rozmiar w pikselach |
---|---|---|
Kwadrat (1 x 1) Preferowany |
300x300 | 1200 x 1200 |
Prostokąt w orientacji poziomej (1,91 x 1) | 600 x 314 | 1200x628 |
Orientacja pionowa (4 x 5) | 480 x 600 | 960x1200 |
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.
- Użyj przezroczystego tła, aby obraz był prawidłowo wyświetlany w ustawieniach motywu ciemnego i jasnego.
Krok 2. Podaj dane klastra
Zaleca się, aby zadanie publikowania treści było wykonywane w tle (np. za pomocą narzędzia WorkManager) i zaplanowane w regularnych odstępach czasu lub w określonych zdarzeniach (na przykład za każdym razem, gdy użytkownik otworzy aplikację lub gdy użytkownik właśnie dodał coś do koszyka).
Organizacja AppEngageFoodClient
jest odpowiedzialna za publikowanie klastrów żywności.
Do publikowania klastrów w kliencie służą te interfejsy API:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishFoodShoppingCart
publishFoodShoppingList
publishReorderCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteFoodShoppingCartCluster
deleteFoodShoppingListCluster
deleteReorderCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Ten interfejs API służy do sprawdzania, czy usługa jest dostępna do integracji i czy można wyświetlić treści 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
.
Obiekt RecommendationCluster
może mieć te atrybuty:
Atrybut | Wymaganie | Opis |
---|---|---|
Lista ProductEntity, StoreEntity lub RecipeEntity | Wymagany | Lista elementów, które składają się na rekomendacje w tym klastrze rekomendacji. Encje w jednym klastrze muszą być tego samego typu. |
Tytuł | Wymagany | Tytuł klastra rekomendacji (np. Duże oszczędności na menu na Święto Dziękczynienia). Zalecany rozmiar tekstu: poniżej 25 znaków (zbyt długi tekst może zawierać wielokropki) |
Podtytuł | Opcjonalnie | Podtytuł klastra rekomendacji. |
Identyfikator URI działania | Opcjonalnie |
Precyzyjny link do strony w aplikacji partnera, na której użytkownicy mogą zobaczyć pełną listę rekomendacji. Uwaga: na potrzeby atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania |
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Big savings on Thanksgiving menu") .build()) .build())
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Big savings on Thanksgiving menu") .build()) .build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykona te działania:
- Wszystkie istniejące dane klastra rekomendacji zostaną usunięte.
- Dane z zapytania są analizowane i przechowywane w nowych klastrach 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 obiektu 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:
- Dotychczasowe dane
FeaturedCluster
pochodzące od partnera dewelopera zostaną usunięte. - Dane z zapytania są analizowane i przechowywane w zaktualizowanym zbiorze polecanych.
W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.
publishFoodShoppingCart
Ten interfejs API służy do publikowania obiektu FoodShoppingCart
.
Kotlin
client.publishFoodShoppingCart( PublishFoodShoppingCartClusterRequest.Builder() .setShoppingCart( FoodShoppingCart.Builder() ... .build()) .build())
Java
client.publishFoodShoppingCart( new PublishFoodShoppingCartClusterRequest.Builder() .setShoppingCart( new FoodShoppingCart.Builder() ... .build()) .build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykona te działania:
- Dotychczasowe dane
FoodShoppingCart
pochodzące od partnera dewelopera zostaną usunięte. - Dane z zapytania są analizowane i przechowywane w zaktualizowanym klastrze koszyka z zakupami.
W przypadku błędu żądanie w całości jest odrzucane, a obecny stan zostaje zachowany.
publishFoodShoppingList
Ten interfejs API służy do publikowania obiektu FoodShoppingList
.
Kotlin
client.publishFoodShoppingList( PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( FoodShoppingListEntity.Builder() ... .build()) .build())
Java
client.publishFoodShoppingList( new PublishFoodShoppingListRequest.Builder() .setFoodShoppingList( new FoodShoppingListEntity.Builder() ... .build()) .build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykonywane są te działania:
- Istniejące dane
FoodShoppingList
od partnera dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze listy zakupów.
W przypadku błędu żądanie w całości jest odrzucane, a obecny stan zostaje zachowany.
publishReorderCluster
Ten interfejs API służy do publikowania obiektu FoodReorderCluster
.
Kotlin
client.publishReorderCluster( PublishReorderClusterRequest.Builder() .setReorderCluster( FoodReorderCluster.Builder() ... .build()) .build())
Java
client.publishReorderCluster( new PublishReorderClusterRequest.Builder() .setReorderCluster( new FoodReorderCluster.Builder() ... .build()) .build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykona te działania:
- Istniejące dane
FoodReorderCluster
od partnera dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze do ponownego uporządkowania.
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 podano, należy przesłać zdjęcie | 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
UserAccountManagementCluster
od 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 tych klastrów nie został opublikowany, zdecydowanie zalecamy zaktualizowanie stanu publikacji za pomocą interfejsu updatePublishStatus API. To ważne, ponieważ :
- Podanie stanu we wszystkich scenariuszach, nawet gdy treści są opublikowane (STATUS = PUBLISHED), jest kluczowe dla wypełniania paneli, które używają tego stanu do wyświetlania stanu i innych danych integracji.
- 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, że treści nie są publikowane 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 zawartości klastrów rekomendacji.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Po otrzymaniu żądania usługa usuwa 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.
deleteFoodShoppingCartCluster
Ten interfejs API służy do usuwania treści z grupy koszyka zakupowego dotyczącą produktów spożywczych.
Kotlin
client.deleteFoodShoppingCartCluster()
Java
client.deleteFoodShoppingCartCluster();
Gdy usługa otrzyma żądanie, usunie istniejące dane z grupy koszyka zakupowego dotyczącą produktów spożywczych. W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan zostaje zachowany.
deleteFoodShoppingListCluster
Ten interfejs API służy do usuwania treści z klastra listy zakupów z pokarmem.
Kotlin
client.deleteFoodShoppingListCluster()
Java
client.deleteFoodShoppingListCluster();
Gdy usługa otrzyma prośbę, usunie istniejące dane z klastra listy zakupów z pokarmem. W przypadku błędu cała prośba zostaje odrzucona, a obecny stan jest zachowany.
deleteReorderCluster
Ten interfejs API służy do usuwania zawartości z FoodReorderCluster.
Kotlin
client.deleteReorderCluster()
Java
client.deleteReorderCluster();
Po otrzymaniu żądania usługa usuwa istniejące dane z klastra Zmień kolejność. 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();
Po otrzymaniu żądania usługa usuwa istniejące dane z klastra zarządzania kontami użytkowników. W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan zostaje zachowany.
deleteClusters
Ten interfejs API służy do usuwania zawartości klastra określonego typu.
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());
Po otrzymaniu żądania usługa usuwa istniejące dane ze wszystkich klastrów pasujących do określonych typów klastrów. Klienty mogą przesyłać 1 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 ma uprawnień do zgłoszenia. |
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 |
wywołanie usługi jest wykonywane zbyt często; |
Krok 3. Obsługa intencji przesyłania
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żytkownik ma pewność, że będzie mieć dostęp do aktualnych treści, nawet jeśli aplikacja nie była uruchamiana przez długi czas.
BroadcastReceiver
trzeba skonfigurować na 2 sposoby:
- Dynamicznie zarejestruj wystąpienie klasy
BroadcastReceiver
za 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 shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART
// broadcast is received
// Trigger shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST
// broadcast is received
// Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER 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 Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART));
// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_LIST));
// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER));
}
- Zadeklaruj statycznie implementację za pomocą tagu
<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.food.PUBLISH_FOOD_SHOPPING_CART" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER" />
</intent-filter>
</receiver>
</application>
Usługa wyśle te intencje:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
Gdy otrzymasz tę intencję, zalecamy rozpoczęcie rozmowypublishRecommendationClusters
.com.google.android.engage.action.PUBLISH_FEATURED
Gdy otrzymasz ten zamiar, zalecamy rozpoczęcie rozmowypublishFeaturedCluster
.com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART
W przypadku otrzymania tego zamiaru zalecamy nawiązanie połączeniapublishFoodShoppingCart
.com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST
W przypadku otrzymania tego zamiaru zalecamy nawiązanie połączeniapublishFoodShoppingList
.com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER
Gdy otrzymasz ten zamiar, zalecamy rozpoczęcie rozmowypublishReorderCluster
.
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 możliwe.
Dalsze kroki
Po zakończeniu integracji należy wykonać następujące czynności:
- Wyślij e-maila na adres engage-developers@google.com i załącz zintegrowany pakiet APK, który jest gotowy do przetestowania 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 Rekomendacja, Polecane, Koszyk, Lista zakupów i Ponowne zamówienie będą opublikowane i widoczne dla użytkowników.