Google tworzy na urządzeniu platformę, która porządkuje aplikacje według branż i umożliwia korzystanie ze spersonalizowanych treści w aplikacji. i odkrywania. Dzięki temu partnerzy mogą mają możliwość zaprezentowania swoich najlepszych, bogatych materiałów na specjalnym kanale do aplikacji.
Ten przewodnik zawiera instrukcje dla partnerów tworzących rozwiązania dotyczące integrowania żywności za pomocą pakietu SDK dla agencji, aby wypełniać ten nowy obszar dostępnych na platformach Google.
Szczegóły integracji
Terminologia
Ta integracja obejmuje 5 typów klastrów: Recommendation, Polecane, Koszyk na zakupy żywności, Lista zakupów spożywczych i Zmień kolejność.
Klastry rekomendacji pokazują spersonalizowane sugestie dotyczące jedzenia opracowane przez z konkretnym partnerem ds. deweloperów. Rekomendacje te można dostosować do użytkownika lub uogólnione (np. „nowe produkty z wyprzedaży”). Za ich pomocą możesz wyświetlać przepisy, sklepy, naczynia, artykuły spożywcze itd., zależnie od potrzeb.
- Klaster rekomendacji może składać się z
ProductEntity
,StoreEntity
lubRecipeEntity
, ale nie stanowią kombinacji różnych typów elementów.
Ilustracja : „ProductEntity”, `StoreEntity` i RecipeEntity. (*Interfejs tylko do celów poglądowych) - Klaster rekomendacji może składać się z
Klaster Polecane prezentuje wybranego bohatera:
ProductEntity
,StoreEntity
lubRecipeEntity
od wielu partnerów deweloperów w jednym interfejsie grupowania. W pobliżu jest 1 klaster cech u góry interfejsu, gdzie priorytetowe jest miejsce nad wszystkimi Rekomendacjami klastrów. Każdy partner deweloperów może transmitować jeden podmiot obsługiwanego typu w sekcji Polecane, z wieloma elementami (potencjalnie różnych różnych typów) od różnych deweloperów aplikacji w klastrze Polecane.Rysunek : Polecany klaster z obiektem „RecipeEntity”. (*Interfejs tylko do celów poglądowych) Klaster Food Shopping Cart daje możliwość robienia zakupów spożywczych koszyki od wielu deweloperów w jednej grupie UI, co zachęca użytkowników do sfinalizować swoje zaległe koszyki. Jeden koszyk na jedzenie klastra.
Klaster koszyka na zakupy żywności musi pokazywać łączną liczbę produktów w koszyka i może również zawierać obrazy X produktów z koszyka użytkownika.
Ilustracja: Grupowanie wózków na zakupy żywności partnera. (*Interfejs tylko do celów poglądowych)
Klaster Food Shopping List pokazuje podgląd sklepów spożywczych od wielu partnerów dewelopera w jednej grupie UI, co zachęca użytkowników do wróć do odpowiedniej aplikacji, aby zaktualizować i uzupełnić listy. Jest jedną listę zakupów związanych z żywnością.
Ilustracja: Zbiór list zakupów spożywczych z jednej partnera. (*Interfejs tylko do celów poglądowych) Klaster Zmień kolejność pokazuje ujęcia z poprzednich zamówień kilku partnerów w ramach jednej grupy interfejsu, co ułatwia użytkownikom zmianę kolejności. Jest 1 klaster Zmień kolejność.
Zmień kolejność klastrów musi wyświetlać łączną liczbę elementów w poprzedniego zamówienia użytkownika i musi też zawierać jeden z następujących elementów:
- Obrazy X produktów w poprzedniej kolejności użytkownika.
- Etykiety X elementów w poprzedniej kolejności użytkownika.
Ilustracja: Gromada Zmiana kolejności jedzenia partnera. (*Interfejs tylko do celów poglądowych)
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 opiera się na implementacji powiązanego usługi.
Dane, które klient może publikować, podlegają następującym limitom dla różnych typy klastrów:
Typ klastra | Limity klastra | Maksymalne limity encji w klastrze |
---|---|---|
Klastry rekomendacji | Maksymalnie 5 | Maksymalnie 25 (ProductEntity , RecipeEntity lub
StoreEntity ). |
Polecany klaster | Maksymalnie 1 | Maksymalnie 1 (ProductEntity , RecipeEntity lub
StoreEntity ). |
Klaster koszyka na zakupy spożywcze | Maksymalnie 1 | Maksymalnie 1 ShoppingCartEntity |
Klaster listy zakupów spożywczych | Maksymalnie 1 | Maksymalnie 1 ShoppingListEntity |
Zmiana kolejności jedzenia | Maksymalnie 1 | Maksymalnie 1 ReorderEntity |
Krok 1. Podaj dane encji
Pakiet SDK ma zdefiniowane różne jednostki reprezentujące każdy typ elementu. Wspieramy następujące podmioty w kategorii Jedzenie:
ProductEntity
StoreEntity
RecipeEntity
FoodShoppingCart
FoodShoppingList
FoodReorderCluster
Poniższe tabele przedstawiają dostępne atrybuty i wymagania dla każdego z nich.
ProductEntity
Obiekt ProductEntity
reprezentuje konkretny produkt (np. sklep spożywczy).
produkt, danie z restauracji lub promocję), które chcą partnerzy deweloperowi
Opublikuj.
![](https://cdn.statically.io/img/developer.android.com/static/images/guide/playcore/engage/food-product-entity.png?hl=pl)
ProductEntity
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Plakat | Wymagany | Musisz przesłać co najmniej 1 obraz. | Wskazówki znajdziesz w specyfikacjach obrazów. |
Identyfikator URI działania | Wymagany |
Precyzyjny link do strony w aplikacji, która zawiera szczegółowe informacje o usługi. Uwaga: na potrzeby atrybucji możesz używać precyzyjnych linków. Zapoznaj się z tymi odpowiedziami na najczęstsze pytania |
Identyfikator URI |
Tytuł | Opcjonalnie | Nazwa produktu. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 90 znaków (czyli za długi tekst może zawierać wielokropki) |
Cena - bieżąca | Wymagane warunkowo | Aktualna cena produktu. Jeśli podano przekreśloną cenę, ta wartość jest wymagana. |
Dowolny tekst |
Cena – przekreślenie | Opcjonalnie | Pierwotna cena produktu, przekreślona Interfejs. | Dowolny tekst |
Objaśnienie | Opcjonalnie | Objaśnienie, które powinno zawierać promocję, wydarzenie lub aktualizację produktu, jeśli i dostępności informacji. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Objaśnienie drobnym drukiem | Opcjonalnie | Drobny tekst objaśnienia. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Ocena (opcjonalnie) – uwaga: wyświetlane są wszystkie oceny na podstawie naszego standardowego systemu oceny. | |||
Ocena – wartość maksymalna | Opcjonalnie | Maksymalna wartość skali ocen. Ten atrybut musi być podany, jeśli bieżąca wartość oceny jest również |
Liczba >= 0.0 |
Ocena – bieżąca wartość | Opcjonalnie | Bieżąca wartość skali ocen. Ten atrybut musi być podany, jeśli maksymalna wartość oceny wynosi również |
Liczba >= 0.0 |
Ocena – liczba | Opcjonalnie | Liczba ocen produktu. Uwaga: wypełnij to pole, jeśli Twoja aplikacja określa sposób wyświetlania liczby użytkownikom. Używaj zwięzłego ciągu znaków. Jeśli np. liczba wynosi 1 000 000, możesz użyć skrótu np. 1 mln, aby w przypadku mniejszych wyświetlaczy liczba nie była obcinana. |
Ciąg znaków |
Ocena – wartość liczby | Opcjonalnie | Liczba ocen produktu. Uwaga: podaj to pole, jeśli nie zajmujesz się musisz samodzielnie stosować skróty klawiszowe. Jeśli zarówno liczba, jak i wartość liczby wartość jest wyświetlana użytkownikom. |
Długie |
DisplayTimeWindow (opcjonalnie) – ustawianie przedziału czasu aby treści były wyświetlane na platformie | |||
Sygnatura czasowa rozpoczęcia | Opcjonalnie |
Sygnatura czasowa epoki, po której treść powinna się wyświetlać w na różnych powierzchniach. Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie. |
Sygnatura czasowa epoki w milisekundach |
Sygnatura czasowa zakończenia | Opcjonalnie |
Sygnatura czasowa epoki, po której treść nie jest już wyświetlana na powierzchnię. Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie. |
Sygnatura czasowa epoki w milisekundach |
StoreEntity
Obiekt StoreEntity
reprezentuje konkretny sklep współpracujących z deweloperem.
które chcesz opublikować, np. w restauracji lub sklepie spożywczym.
![](https://cdn.statically.io/img/developer.android.com/static/images/guide/playcore/engage/food-store-entity.png?hl=pl)
StoreEntity
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Plakat | Wymagany | Musisz przesłać co najmniej 1 obraz. | Wskazówki znajdziesz w specyfikacjach obrazów. |
Identyfikator URI działania | Wymagany | Precyzyjny link do strony w aplikacji, która zawiera szczegółowe informacje o sklepu. Uwaga: na potrzeby atrybucji możesz używać precyzyjnych linków. Zapoznaj się z tymi odpowiedziami na najczęstsze pytania |
Identyfikator URI |
Tytuł | Opcjonalnie | Nazwa sklepu. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Lokalizacja | Opcjonalnie | Lokalizacja sklepu. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Objaśnienie | Opcjonalnie | Objaśnienie, które powinno zawierać promocję, wydarzenie lub aktualizację sklepu, jeśli i dostępności informacji. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Objaśnienie drobnym drukiem | Opcjonalnie | Drobny tekst objaśnienia. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Opis | Opcjonalnie | Opis sklepu. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 90 znaków (czyli za długi tekst może zawierać wielokropki) |
Uwaga: wszystkie oceny są wyświetlane za pomocą naszego standardowy system ocen. | |||
Ocena – wartość maksymalna | Opcjonalnie | Maksymalna wartość skali ocen. Ten atrybut musi być podany, jeśli bieżąca wartość oceny jest również |
Liczba >= 0.0 |
Ocena – bieżąca wartość | Opcjonalnie | Bieżąca wartość skali ocen. Ten atrybut musi być podany, jeśli maksymalna wartość oceny wynosi również |
Liczba >= 0.0 |
Ocena – liczba | Opcjonalnie | Liczba ocen sklepu. Uwaga: wypełnij to pole, jeśli aplikacja chce: kontrolować sposób wyświetlania informacji użytkownikom. Podaj zwięzły ciąg znaków które można wyświetlać użytkownikowi. Jeśli na przykład liczba to 1 000 000, rozważ użycie skrótów, takich jak 1M, aby nie zostały na mniejszych ekranach. |
Ciąg znaków |
Ocena – wartość liczby | Opcjonalnie | Liczba ocen sklepu. Uwaga: podaj to pole, jeśli nie chcesz przetwarzać musisz samodzielnie stosować skróty klawiszowe. Jeśli zarówno liczba, jak i wartość liczby użyjemy liczby, aby wyświetlić je użytkownikom |
Długie |
RecipeEntity
Obiekt RecipeEntity
reprezentuje element przepisu, którego deweloperzy chcą używać
do opublikowania.
![](https://cdn.statically.io/img/developer.android.com/static/images/guide/playcore/engage/food-recipe-entity.png?hl=pl)
RecipeEntity
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Plakat | Wymagany | Musisz przesłać co najmniej 1 obraz. | Wskazówki znajdziesz w specyfikacjach obrazów. |
Identyfikator URI działania | Wymagany | Precyzyjny link do strony w aplikacji, która zawiera szczegółowe informacje o z przepisem. Uwaga: na potrzeby atrybucji możesz używać precyzyjnych linków. Zapoznaj się z tymi odpowiedziami na najczęstsze pytania |
Identyfikator URI |
Tytuł | Opcjonalnie | Nazwa przepisu. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Autor | Opcjonalnie | Autor przepisu. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Czas przyrządzania | Opcjonalnie | Czas gotowania według przepisu. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Objaśnienie | Opcjonalnie | Objaśnienie, które powinno zawierać promocję, wydarzenie lub aktualizację przepisu, jeśli i dostępności informacji. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Kategoria | Opcjonalnie | Kategoria przepisu. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 45 znaków (tekst za długi tekst może zawierać wielokropki) |
Opis | Opcjonalnie | Opis przepisu. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 90 znaków (czyli za długi tekst może zawierać wielokropki) |
Uwaga: wszystkie oceny są wyświetlane za pomocą naszego standardowy system ocen. | |||
Ocena – wartość maksymalna | Opcjonalnie | Maksymalna wartość skali ocen. Ten atrybut musi być podany, jeśli bieżąca wartość oceny jest również |
Liczba >= 0.0 |
Ocena – bieżąca wartość | Opcjonalnie | Bieżąca wartość skali ocen. Ten atrybut musi być podany, jeśli maksymalna wartość oceny wynosi również |
Liczba >= 0.0 |
Ocena – liczba | Opcjonalnie | Liczba ocen przepisu. Uwaga: wypełnij to pole, jeśli aplikacja chce: kontrolować sposób wyświetlania informacji użytkownikom. Podaj zwięzły ciąg znaków które można wyświetlać użytkownikowi. Jeśli na przykład liczba to 1 000 000, rozważ użycie skrótów, takich jak 1M, aby nie zostały na mniejszych ekranach. |
Ciąg znaków |
Ocena – wartość liczby | Opcjonalnie | Liczba ocen przepisu. Uwaga: podaj to pole, jeśli nie chcesz przetwarzać musisz samodzielnie stosować skróty klawiszowe. Jeśli zarówno liczba, jak i wartość liczby użyjemy liczby, aby wyświetlić je użytkownikom |
Długie |
FoodShoppingCart
![](https://cdn.statically.io/img/developer.android.com/static/images/guide/playcore/engage/food-shopping-cart-attributes.png?hl=pl)
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Identyfikator URI działania | Wymagany |
Precyzyjny link do koszyka 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 (a nie tylko liczba produktów) w pakiecie koszyk. Na przykład: jeśli w w koszyku, powinna to być 4. |
Liczba całkowita >= 1 |
Tytuł | Opcjonalnie | Tytuł koszyka (np. Twój koszyk). Jeśli deweloper nie podał tytułu, Twój koszyk jest domyślna. |
Dowolny tekst Zalecany rozmiar tekstu: poniżej 25 znaków (tekst za długi tekst może zawierać wielokropki) |
Tekst działania | Opcjonalnie |
Tekst wezwania do działania na przycisku na koszyku (np. Twoja torba na zakupy). Jeśli deweloper nie przekaże tekstu działania, Domyślne ustawienie to Wyświetl koszyk. Ten atrybut jest obsługiwany od wersji 1.1.0. |
Ciąg znaków |
Obrazy koszyka | Opcjonalnie | Zdjęcia każdego produktu w koszyku. Można przesłać maksymalnie 10 obrazów w kolejności priorytetu; rzeczywista liczba wyświetlanych obrazów zależy od formy 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 dowolnego tekstu Zalecany rozmiar tekstu: poniżej 20 znaków (czyli za długi tekst może zawierać wielokropki) |
DisplayTimeWindow (opcjonalnie) – ustawianie przedziału czasu aby treści były wyświetlane na platformie | |||
Sygnatura czasowa rozpoczęcia | Opcjonalnie |
Sygnatura czasowa epoki, po której treść powinna się wyświetlać w na różnych powierzchniach. Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie. |
Sygnatura czasowa epoki w milisekundach |
Sygnatura czasowa zakończenia | Opcjonalnie |
Sygnatura czasowa epoki, po której treść nie jest już wyświetlana na powierzchnię. Jeśli zasada nie jest skonfigurowana, treści mogą być wyświetlane na platformie. |
Sygnatura czasowa epoki w milisekundach |
FoodShoppingList
![](https://cdn.statically.io/img/developer.android.com/static/images/guide/playcore/engage/food-shopping-list.png?hl=pl)
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 tymi 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 (na przykład Twoja lista zakupów). Jeśli deweloper nie poda tytułu, Domyślną opcją jest Lista zakupów. |
Dowolny tekst Zalecany rozmiar tekstu: poniżej 25 znaków (tekst za długi tekst może zawierać wielokropki) |
Etykiety elementów | Wymagany | Lista etykiet produktów na liście zakupów. Należy podać co najmniej 1 etykietę i można dodać maksymalnie 10 etykiet są udostępniane w kolejności według priorytetu; rzeczywista liczba wyświetlanych etykiet zależy od formatu urządzenia. |
Lista etykiet dowolnego tekstu Zalecany rozmiar tekstu: poniżej 20 znaków (czyli za długi tekst może zawierać wielokropki) |
FoodReorderCluster
![](https://cdn.statically.io/img/developer.android.com/static/images/guide/playcore/engage/food-reorder-cluster.png?hl=pl)
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Identyfikator URI działania | Wymagany |
Precyzyjny link do zmiany kolejności w aplikacji partnera. Uwaga: na potrzeby atrybucji możesz używać precyzyjnych linków. Zapoznaj się z tymi odpowiedziami na najczęstsze pytania |
Identyfikator URI |
Tekst działania | Opcjonalnie |
Tekst wezwania do działania na przycisku na karcie Zmień kolejność (np. Zamów ponownie). Jeśli deweloper nie przekaże tekstu działania, Domyślne ustawienie to Zmień kolejność. Ten atrybut jest obsługiwany od wersji 1.1.0. |
Ciąg znaków |
Liczba elementów | Wymagany |
Liczba produktów (a nie tylko liczba produktów) w poprzedniej wersji zamówienie. Na przykład: jeśli w sklepie były 3 małe kawę i 1 croissant w poprzednim zamówieniu powinna wynosić 4. |
Liczba całkowita >= 1 |
Tytuł | Wymagany | Tytuł produktu, którego dotyczy zmiana. | Dowolny tekst Zalecany rozmiar tekstu: poniżej 40 znaków (czyli za długi tekst może zawierać wielokropki) |
Etykiety elementów | Opcjonalnie (jeśli nie, należy przesłać obrazy plakatów) |
Lista etykiet produktów w poprzednim zamówieniu. Można podać maksymalnie 10 etykiet w kolejności priorytetu. rzeczywista liczba wyświetlanych etykiet zależy od formy urządzenia |
Lista dowolnego tekstu Zalecany rozmiar tekstu na etykietę: poniżej 20 znaków (Zbyt długi tekst może zawierać wielokropki) |
Plakat | Opcjonalnie (Jeśli nie podano tej wartości, należy podać etykiety produktów) |
Zdjęcia produktów z poprzedniego zamówienia. Można przesłać maksymalnie 10 obrazów w kolejności priorytetu; rzeczywista liczba wyświetlanych obrazów zależy od formy urządzenia |
Wskazówki znajdziesz w specyfikacjach obrazów. |
Specyfikacja obrazu
Poniżej znajdziesz wymagane specyfikacje komponentów z obrazem:
Format obrazu | Minimalny rozmiar w pikselach | Zalecany rozmiar w pikselach |
---|---|---|
Kwadrat (1 x 1) Preferowana |
300x300 | 1200x1200 |
Poziomy (1,91 x 1) | 600x314 | 1200x628 |
Orientacja pionowa (4 x 5) | 480 × 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% .
- Użyj przezroczystego tła, aby obraz był poprawnie wyświetlany Ustawienia ciemnego i jasnego motywu.
Krok 2. Podaj dane klastra
Zaleca się, aby zadanie publikowania treści było wykonywane w tle (na przykład WorkManager). i zaplanowano je regularnie lub według konkretnego wydarzenia (np. za każdym razem, użytkownik otwiera aplikację lub właśnie dodał coś do koszyka).
Organizacja AppEngageFoodClient
jest odpowiedzialna za publikowanie klastrów żywności.
Istnieją następujące interfejsy API do publikowania klastrów w kliencie:
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 oraz czy treść może być prezentowana 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 obiektów RecommendationCluster
na liście.
Obiekt RecommendationCluster
może mieć te atrybuty:
Atrybut | Wymaganie | Opis |
---|---|---|
Lista ProductEntity, StoreEntity lub RecipeEntity | Wymagany | Lista elementów tworzących rekomendacje dotyczące tego Klaster rekomendacji. Encje w jednym klastrze muszą być takie same typu. |
Tytuł | Wymagany | Tytuł klastra rekomendacji (np. Duży) zniżki na menu na Święto Dziękczynienia). Zalecany rozmiar tekstu: poniżej 25 znaków (tekst za długi tekst może zawierać wielokropki) |
Podtytuł | Opcjonalnie | Podtytuł klastra rekomendacji. |
Identyfikator URI działania | Opcjonalnie |
Precyzyjny link do strony w aplikacji partnerskiej, 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 jedna transakcja:
- Wszystkie dotychczasowe dane klastra rekomendacji zostaną usunięte.
- Dane z żądania są analizowane i przechowywane w nowych klastrach rekomendacji.
W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan to i utrzymywane informacje.
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 jedna transakcja:
- Dotychczasowe dane
FeaturedCluster
pochodzące od partnera dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym polecanym klastrze.
W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan to i utrzymywane informacje.
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 jedna transakcja:
- Dotychczasowe dane
FoodShoppingCart
pochodzące od partnera dewelopera zostaną usunięte. - Dane z żądania są przeanalizowane i przechowywane w zaktualizowanym koszyku na zakupy Klaster.
W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan to i utrzymywane informacje.
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 jedna transakcja:
- Dotychczasowe dane
FoodShoppingList
pochodzące od partnera dewelopera zostaną usunięte. - Dane z żądania są przeanalizowane i przechowywane na zaktualizowanej liście zakupów Klaster.
W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan to i utrzymywane informacje.
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 jedna transakcja:
- Dotychczasowe dane
FoodReorderCluster
pochodzące od partnera dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze Zmień kolejność.
W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan to i utrzymywane informacje.
publishUserAccountManagementRequest
Ten interfejs API służy do publikowania karty logowania . Działanie związane z logowaniem kieruje użytkowników do stronie logowania, tak by aplikacja mogła publikować treści (lub udostępniać treści spersonalizowanej)
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 podano tytułu, należy podać tytuł |
Obraz widoczny na karcie Obrazy o współczynniku proporcji 16 x 9 i rozdzielczości 1264 x 712 |
Tytuł | Opcjonalnie – jeśli nie podano, należy przesłać zdjęcie | Tytuł na karcie |
Tekst działania | Opcjonalnie | Tekst widoczny w wezwaniu do działania (np. „Zaloguj się”) |
Podtytuł | Opcjonalnie | Opcjonalny tytuł 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 jedna transakcja:
- Dotychczasowe dane
UserAccountManagementCluster
od partnera dewelopera są usunięto. - Dane z żądania są analizowane i przechowywane w zaktualizowanym Klaster zarządzania kontami użytkowników.
W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan to i utrzymywane informacje.
updatePublishStatus
Jeśli z jakiegoś wewnętrznego powodu biznesowego żaden z klastrów nie zostanie opublikowany, zdecydowanie zalecamy zaktualizowanie stanu publikacji za pomocą interfejsu API updatePublishStatus. To ważne, ponieważ :
- Podawanie stanu we wszystkich sytuacjach, nawet po opublikowaniu treści (STATUS == PUBLISHED) – ma kluczowe znaczenie przy wypełnianiu paneli, które używają jawny stan, który przekazuje informacje o stanie i inne wskaźniki integracji.
- Jeśli treści nie zostały opublikowane, ale stan integracji nie jest nieprawidłowy (STATUS == NOT_PUBLISHED), Google może uniknąć wywoływania alertów w aplikacji paneli stanu. Potwierdza ono, że treść nie została opublikowana z powodu jest oczekiwana z punktu widzenia dostawcy.
- Pomaga deweloperom określić, kiedy dane są publikowane, a kiedy Nie.
- Google może używać kodów stanu, aby skłonić użytkownika do wykonania określonych czynności aby wyświetlić jej zawartość lub ją pokonać.
Lista kodów stanu odpowiednich 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 zostały opublikowane z powodu niezalogowanego użytkownika, Zalecamy opublikowanie karty logowania. Jeśli z jakiegoś powodu dostawcy nie mogą opublikować karty logowania zalecamy wywoływanie 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();
Gdy usługa otrzyma żądanie, usuwa istniejące dane z Klastry rekomendacji. W przypadku błędu żądanie zostaje odrzucone w całości. a obecny stan zostaje zachowany.
deleteFeaturedCluster
Ten interfejs API służy do usuwania zawartości polecanego klastra.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Gdy usługa otrzyma żądanie, usuwa istniejące dane z Polecany klaster. W przypadku błędu żądanie zostaje odrzucone w całości. a obecny stan zostaje zachowany.
deleteFoodShoppingCartCluster
Ten interfejs API służy do usuwania zawartości klastra koszyków na zakupy spożywcze.
Kotlin
client.deleteFoodShoppingCartCluster()
Java
client.deleteFoodShoppingCartCluster();
Gdy usługa otrzyma żądanie, usuwa istniejące dane z Klaster koszyka na zakupy spożywcze. W przypadku błędu żądanie zostaje odrzucone w całości. a obecny stan zostaje zachowany.
deleteFoodShoppingListCluster
Ten interfejs API służy do usuwania zawartości klastra listy zakupów żywności.
Kotlin
client.deleteFoodShoppingListCluster()
Java
client.deleteFoodShoppingListCluster();
Gdy usługa otrzyma żądanie, usuwa istniejące dane z Klaster listy zakupów spożywczych. W przypadku błędu żądanie zostaje odrzucone w całości. a obecny stan zostaje zachowany.
deleteReorderCluster
Ten interfejs API służy do usuwania zawartości klastra FoodReorderCluster.
Kotlin
client.deleteReorderCluster()
Java
client.deleteReorderCluster();
Gdy usługa otrzyma żądanie, usuwa istniejące dane z Zmień kolejność klastrów. W przypadku błędu żądanie zostaje odrzucone w całości. a obecny stan zostaje 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, usuwa istniejące dane z Klaster zarządzania kontami użytkowników. W przypadku błędu całe żądanie jest odrzucono i zachowany zostanie obecny stan.
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());
Gdy usługa otrzyma żądanie, usuwa istniejące dane ze wszystkich klastrów pasujących do określonych typów klastrów. Klienci mogą wybrać, czy chcą pozytywnie ocenić dla wielu typów klastrów. W przypadku błędu całe żądanie jest odrzucane, obecny stan zostaje zachowany.
Obsługa błędów
Zdecydowanie zalecamy wsłuchiwanie się w wyniki zadania z interfejsów API do publikowania, takich jak że można podjąć działania, aby odzyskać i ponownie przesłać udane zadanie.
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
z przyczyną podaną w atrybucie
.
Kod błędu | Uwaga: |
---|---|
SERVICE_NOT_FOUND |
Usługa jest niedostępna na danym urządzeniu. |
SERVICE_NOT_AVAILABLE |
Usługa jest dostępna na danym urządzeniu, ale nie jest dostępna w momencie połączenia (np. funkcja jest wyraźnie wyłączona). |
SERVICE_CALL_EXECUTION_FAILURE |
Nie udało się wykonać zadania z powodu problemów z wątkami. W takim przypadku można spróbować ponownie. |
SERVICE_CALL_PERMISSION_DENIED |
Rozmówca nie może nawiązać połączenia z usługą. |
SERVICE_CALL_INVALID_ARGUMENT |
Żądanie zawiera nieprawidłowe dane (na przykład więcej niż dozwolone liczby klastrów). |
SERVICE_CALL_INTERNAL |
Po stronie usługi wystąpił błąd. |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Dzwonienie do zespołu pomocy jest wykonywane zbyt często. |
Krok 3. Obsługa intencji transmisji
Oprócz wykonywania wywołań interfejsu Content API w zadaniu
wymagane do skonfigurowania
BroadcastReceiver
do otrzymania
z prośbą o opublikowanie treści.
Celem intencji transmisji jest głównie ponowna aktywacja aplikacji i wymuszenie użycia danych synchronizację. Intencje związane z transmisją nie są przeznaczone do wysyłania zbyt często. Jest tylko uruchamianych, gdy usługa dla Agencji ustali, że zawartość może być nieaktualna (w przypadku np. tydzień). Dzięki temu będzie miała większą pewność, i otwierać nowe treści, nawet jeśli aplikacja nie była uruchamiana przez bardzo długi okres.
BroadcastReceiver
trzeba skonfigurować na 2 sposoby:
- Dynamicznie zarejestruj instancję klasy
BroadcastReceiver
za pomocąContext.registerReceiver()
Umożliwia to komunikację z aplikacji które wciąż są żywe 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));
}
- Statycznie deklaruj implementację z tagiem
<receiver>
w sekcjiAndroidManifest.xml
. Zezwala to aplikacji na odbieranie komunikatów intencje, gdy nie jest uruchomiona, oraz umożliwia publikowanie aplikacji 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>
Sprzedawca otrzyma te zamiary, usługa:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
Zalecane jest rozpoczęcie połączeniapublishRecommendationClusters
, gdy w odpowiedzi na żądania użytkowników.com.google.android.engage.action.PUBLISH_FEATURED
Zalecane jest rozpoczęcie połączeniapublishFeaturedCluster
po otrzymaniu tej wiadomości intencji.com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART
Zalecane jest rozpoczęcie połączeniapublishFoodShoppingCart
po otrzymaniu tę intencję.com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST
Zalecane jest rozpoczęcie połączeniapublishFoodShoppingList
po otrzymaniu tę intencję.com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER
Zalecane jest rozpoczęcie połączeniapublishReorderCluster
po otrzymaniu tej wiadomości intencji.
Proces integracji
Szczegółowy przewodnik dotyczący weryfikacji integracji po jej zakończeniu znajdziesz na stronie Przepływ pracy w zakresie integracji dla programistów
Najczęstsze pytania
Przeczytaj Najczęstsze pytania o pakiet SDK dla Agencji dotyczące: Najczęstsze pytania
Kontakt
Kontakt Engage-developers@google.com, jeśli są na ewentualne pytania w trakcie procesu integracji. Nasz zespół udzieli odpowiedzi jak to tylko możliwe.
Dalsze kroki
Po zakończeniu integracji należy wykonać następujące czynności:
- Wyślij e-maila do engagement-developers@google.com i załącz zintegrowany pakiet APK gotowy do testowania przez Google.
- Google przeprowadzi weryfikację i wewnętrznie sprawdzi, czy jej integracja działa zgodnie z oczekiwaniami. Jeśli zajdzie potrzeba wprowadzenia zmian, skontaktujemy się z Tobą z niezbędnymi informacjami.
- Jeśli testy zostaną zakończone i nie będą konieczne żadne zmiany, Google skontaktuje się z Tobą, aby: powiadomi Cię, że możesz rozpocząć publikowanie zaktualizowanego i zintegrowanego pliku APK w Sklep Play.
- Gdy Google potwierdzi, że zaktualizowany pakiet APK został opublikowany w Sklep Play, Twoja Rekomendacja, Polecane, Koszyk, Klastry Lista zakupów i Zmień kolejność zostaną opublikowane i będą widoczne dla użytkowników.