Zwiększ zaangażowanie w aplikację, docierając do użytkowników tam, gdzie się znajdują. Zintegruj pakiet Engage SDK, aby wyświetlać spersonalizowane rekomendacje i treści kontynuacji bezpośrednio użytkownikom na różnych platformach na urządzeniu, takich jak Kolekcje, Entertainment Space i Sklep Play. Integracja zwiększa rozmiar średniego pliku APK (skompresowany) o mniej niż 50 KB i zajmuje deweloperom około tygodnia pracy. Więcej informacji znajdziesz na naszej stronie.
Ten przewodnik zawiera instrukcje dla partnerów deweloperów dotyczące dostarczania treści związanych ze zdrowiem i fitness do platformy treści Engage.
Szczegóły integracji
Terminologia
Ta integracja obejmuje 3 typy klastrów: Rekomendacje, Wyróżnione i Kontynuacja.
Rekomendacje to grupy zawierające spersonalizowane sugestie dotyczące zdrowia i sprawności fizycznej od konkretnego partnera deweloperskiego. Rekomendacje mogą być spersonalizowane dla danego użytkownika lub ogólne (np. popularne treści związane z fitness i zdrowiem). Używaj ich do wyświetlania artykułów lub osób związanych ze zdrowiem i kondycją.
- Klaster rekomendacji może składać się z elementów
ArticleEntity
,PersonEntity
lubEventEntity
, ale nie z różnych typów encji.
Rekomendacje mają następującą strukturę:
Grupa rekomendacji: widok interfejsu, który zawiera grupę rekomendacji od tego samego partnera deweloperskiego.
Jednostka: obiekt reprezentujący pojedynczy element w klastrze. Ta integracja udostępnia niektóre elementy, które byłyby wyświetlane w klastrze rekomendacji:
ArticleEntity: ArticleEntity reprezentuje rekomendację treści tekstowych związanych ze zdrowiem i aktywnością fizyczną. Można go używać w przypadku artykułów, postów na blogu, treści marketingowych, fragmentów wiadomości itp.
Ilustracja 1. Interfejs pokazujący pojedynczy element ArticleEntity w klastrze Rekomendacje. PersonEntity: PersonEntity reprezentuje osobę. Rekomendacje mogą dotyczyć trenera lub innej osoby związanej ze zdrowiem i fitness, itp.
Ilustracja 2. Interfejs pokazujący pojedynczy element PersonEntity w klastrze Rekomendacje. EventEntity: EventEntity reprezentuje wydarzenie, które odbędzie się w przyszłości. Godzina rozpoczęcia wydarzenia to kluczowa informacja, którą należy przekazać użytkownikom. Ta jednostka może być używana do wyświetlania wydarzeń związanych ze zdrowiem i kondycją fizyczną, takich jak obozy krwiodawstwa, sesje treningowe, zajęcia na siłowni lub zajęcia jogi.
Ilustracja 3. Interfejs pokazujący pojedynczy element EventEntity w klastrze Rekomendacje.
- Klaster rekomendacji może składać się z elementów
Grupa Kontynuacja zawiera treści, z którymi użytkownicy ostatnio wchodzili w interakcję, od wielu partnerów programistów w jednym układzie interfejsu. Każdy partner deweloper może transmitować maksymalnie 10 elementów w klastrze Kontynuacja.
Treści kontynuacyjne mogą mieć taką strukturę:
ArticleEntity: ArticleEntity to rekomendacja treści tekstowych związanych ze zdrowiem i aktywnością. Może ona reprezentować niedokończone artykuły lub inne treści, które użytkownik chce kontynuować od miejsca, w którym je przerwał. Przykład: fragment wiadomości, fragment wpisu na blogu dotyczący zdrowia lub fitnessu.
Rysunek 6. Interfejs pokazujący pojedynczy element ArticleEntity w grupie Continuation. EventReservationEntity: EventReservationEntity reprezentuje rezerwację wydarzenia i pomaga użytkownikom śledzić nadchodzące lub trwające rezerwacje wydarzeń związanych z fitness i zdrowiem. Przykład: sesje szkoleniowe
Rysunek 8. Interfejs pokazujący pojedynczy element EventReservationEntity w grupie Continuation.
Grupa Polecane zawiera wybrane elementy od wielu partnerów programistów w jednym układzie interfejsu. Jeden wyróżniony klaster 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.
GenericFeaturedEntity: GenericFeaturedEntity różni się od elementu rekomendacji tym, że element polecany powinien być używany w przypadku pojedynczych treści od deweloperów, które są najważniejsze i najbardziej interesujące dla użytkowników.
Ilustracja 12. Interfejs użytkownika z jedną kartą banera powitalnego GenericFeaturedEntity w wyróżnionym klastrze
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 powiązanej usługi.
Dane, które klient może publikować, podlegają tym limitom w przypadku różnych typów klastrów:
Typ klastra | Limity klastra | Minimalne limity jednostek w klastrze | Maksymalne limity elementów w klastrze |
---|---|---|---|
Klastry rekomendacji | Maksymalnie 7 | Co najmniej 1 | Maksymalnie 50 (ArticleEntity , PersonEntity lub EventEntity ) |
Klaster kontynuacji | Maksymalnie 1 | Co najmniej 1 | Maksymalnie 20 (ArticleEntity lub EventReservationEntity ) |
Polecany klaster | Maksymalnie 1 | Co najmniej 1 | Maksymalnie 20 (GenericFeaturedEntity ) |
Krok 1. Podaj dane podmiotu
Pakiet SDK ma zdefiniowane różne elementy reprezentujące każdy typ produktu. W przypadku kategorii Zdrowie i fitness obsługujemy te rodzaje danych:
GenericFeaturedEntity
ArticleEntity
PersonEntity
EventEntity
EventReservationEntity
W tabelach poniżej znajdziesz listę dostępnych atrybutów i wymagań dla każdego typu.
GenericFeaturedEntity
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Identyfikator URI działania | Wymagany |
Precyzyjny link do podmiotu w aplikacji dostawcy. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania. |
Identyfikator URI |
Obrazy plakatu | Wymagany | Jeśli podasz kilka obrazów, wyświetlimy tylko 1. Zalecany format obrazu to 16:9. Uwaga: jeśli podano plakietkę, upewnij się, że u góry i u dołu obrazu jest bezpieczna przestrzeń o wielkości 24 dps. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Tytuł | Opcjonalny | Nazwa elementu. | Dowolny tekst Zalecany rozmiar tekstu: 50 znaków |
Opis | Opcjonalny | Jeden akapit tekstu opisujący encję. Uwaga: użytkownikowi będzie wyświetlana lista opisów lub lista napisów, ale nie obie jednocześnie. |
Dowolny tekst Zalecany rozmiar tekstu: 180 znaków |
Lista podtytułów | Opcjonalny | Maksymalnie 3 napisy, każdy w jednym wierszu tekstu. Uwaga: użytkownikowi będzie wyświetlana lista opisów lub lista napisów, ale nie obie jednocześnie. |
Dowolny tekst Zalecana długość każdego podtytułu: maks. 50 znaków |
Odznaki | Opcjonalny | Każda plakietka to tekst (maksymalnie 15 znaków) lub mały obraz. Specjalne elementy interfejsu użytkownika na obrazie lub filmie, np. plakietka nakładana na obraz.
|
|
Plakietka – tekst | Opcjonalny | Tytuł plakietki Uwaga: w przypadku plakietki wymagany jest tekst lub obraz. |
Dowolny tekst Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Plakietka – obraz | Opcjonalny | Mały obraz Specjalne traktowanie pod względem UX, np. nakładka w postaci plakietki na miniaturę obrazu lub filmu. Uwaga: w przypadku plakietki wymagany jest tekst lub obraz. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Kategorie treści | Opcjonalny | Opisz kategorię treści w obiekcie. | Lista wartości w polu enum Wskazówki znajdziesz w sekcji Kategoria treści. |
ArticleEntity
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Identyfikator URI działania | Wymagany |
Precyzyjny link do podmiotu w aplikacji dostawcy. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania. |
Identyfikator URI |
Tytuł | Wymagany | Nazwa elementu. | Dowolny tekst Zalecany rozmiar tekstu: maksymalnie 50 znaków |
Obrazy plakatu | Opcjonalny | Jeśli podasz kilka obrazów, wyświetlimy tylko 1. Zalecany format obrazu to 16:9. Uwaga: zdecydowanie zalecamy dodanie obrazu. Jeśli podasz plakietkę, upewnij się, że u góry i u dołu obrazu znajduje się bezpieczna przestrzeń o wielkości 24 dp. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Źródło – tytuł | Opcjonalny | imię i nazwisko autora, nazwę organizacji lub imię i nazwisko reportera; | Dowolny tekst Zalecana długość tekstu: poniżej 25 znaków |
Źródło – obraz | Opcjonalny | zdjęcie źródła, np. autora, organizacji lub reportera; | Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący encję. Uwaga: użytkownikowi będzie wyświetlana lista opisów lub lista napisów, ale nie obie jednocześnie. |
Dowolny tekst Zalecany rozmiar tekstu: 180 znaków |
Lista podtytułów | Opcjonalny | Maksymalnie 3 napisy, każdy w jednym wierszu tekstu. Uwaga: użytkownikowi będzie wyświetlana lista opisów lub lista napisów, ale nie obie jednocześnie. |
Dowolny tekst Zalecana długość każdego podtytułu: maks. 50 znaków |
Odznaki | Opcjonalny | Każda plakietka to tekst (maksymalnie 15 znaków) lub mały obraz. Specjalne elementy interfejsu użytkownika na obrazie lub filmie, np. plakietka nakładana na obraz.
|
|
Plakietka – tekst | Opcjonalny | Tytuł plakietki Uwaga: w przypadku plakietki wymagany jest tekst lub obraz. |
Dowolny tekst Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Plakietka – obraz | Opcjonalny | Mały obraz Specjalne traktowanie pod względem UX, np. nakładka w postaci plakietki na miniaturę obrazu lub filmu. Uwaga: w przypadku plakietki wymagany jest tekst lub obraz. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Czas publikacji treści | Opcjonalny | Jest to sygnatura czasowa epoki w milisekundach, która określa, kiedy treści zostały opublikowane lub zaktualizowane w aplikacji. | Sygnatura czasowa epoki w milisekundach |
Czas ostatniego działania związanego z zaangażowaniem | Wymagane warunkowo | Sygnatura czasowa epoki w milisekundach, kiedy użytkownik ostatnio wchodził w interakcję z tym elementem. Uwaga: to pole jest wymagane, jeśli ten podmiot jest częścią klastra kontynuacji. |
Sygnatura czasowa epoki w milisekundach |
Procent postępu | Wymagane warunkowo | Procent pełnej treści, który użytkownik wykorzystał do tej pory. Uwaga: to pole jest wymagane, jeśli ten podmiot jest częścią klastra kontynuacji. |
Liczba całkowita z zakresu od 0 do 100 (włącznie). |
Kategorie treści | Opcjonalny | Opisz kategorię treści w obiekcie. | Lista wartości w polu enum Wskazówki znajdziesz w sekcji Kategoria treści. |
PersonEntity
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Identyfikator URI działania | Wymagany |
Precyzyjny link do podmiotu w aplikacji dostawcy. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania. |
Identyfikator URI |
Profil – nazwa | Wymagany | Nazwa profilu, identyfikator lub nick, np. „Jan Kowalski”, „@TeamPixel” itp. | Ciąg znaków Zalecany rozmiar tekstu: maksymalnie 50 znaków |
Profil – awatar | Wymagany |
Zdjęcie profilowe lub awatar użytkownika. Uwaga: musi to być obraz kwadratowy o proporcjach 1:1. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Profil – dodatkowy tekst | Opcjonalny | Dowolny tekst, np. nazwa profilu. | Dowolny tekst Zalecany rozmiar tekstu: maks. 15 znaków |
Profil – dodatkowe zdjęcie | Opcjonalny | Mały obraz, np. odznaka weryfikacyjna. | Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Obraz w nagłówku | Opcjonalny | Jeśli podasz kilka obrazów, wyświetlimy tylko 1. Zalecany format obrazu to 16:9. Uwaga: zdecydowanie zalecamy dodanie obrazu. Jeśli podasz plakietkę, upewnij się, że u góry i u dołu obrazu znajduje się bezpieczna przestrzeń o wielkości 24 dp. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Popularność – liczba | Opcjonalny |
Podaj liczbę obserwujących lub wartość popularności, np. „3,7 mln”. Uwaga: jeśli podasz zarówno liczbę, jak i wartość liczby, użyta zostanie liczba. |
Ciąg znaków Zalecany rozmiar tekstu: maksymalnie 20 znaków w przypadku połączonej liczby i etykiety |
Popularność – wartość liczbowa | Opcjonalny | Liczba obserwujących lub wartość popularności. Uwaga: podaj wartość Count Value, jeśli aplikacja nie ma obsługiwać logiki optymalizacji dużej liczby pod kątem różnych rozmiarów wyświetlacza. Jeśli podasz zarówno liczbę, jak i wartość liczby, zostanie użyta liczba. |
Długie |
Popularność – etykieta | Opcjonalny | Określ, co oznacza etykieta popularności. Na przykład „Polubienia”. | Ciąg znaków Zalecany rozmiar tekstu: maksymalnie 20 znaków w przypadku połączonej liczby i etykiety |
Popularność – wizualna | Opcjonalny |
Określ, do czego służy interakcja. Na przykład obraz przedstawiający ikonę polubienia i emotikony. Możesz podać więcej niż 1 obraz, ale nie wszystkie mogą być wyświetlane na wszystkich urządzeniach. Uwaga: musi to być obraz kwadratowy o formacie 1:1. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Ocena – wartość maksymalna | Wymagane | Maksymalna wartość skali ocen. Musisz podać tę wartość, jeśli podasz też aktualną ocenę. |
Liczba >= 0,0 |
Ocena – bieżąca wartość | Wymagane | Bieżąca wartość skali ocen. Musisz podać tę wartość, jeśli podasz też maksymalną wartość oceny. |
Liczba >= 0,0 |
Ocena – liczba | Opcjonalny | Liczba ocen encji. 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 przypadku mniejszych rozmiarów wyświetlanych elementów. |
Ciąg znaków |
Ocena – wartość liczby | Opcjonalny | Liczba ocen encji. Uwaga: wypełnij to pole, jeśli nie obsługujesz samodzielnie logiki skrótu wyświetlania. Jeśli występują zarówno parametr Liczba, jak i Wartość liczby, użytkownikom wyświetlana jest wartość parametru Liczba. |
Długie |
Lokalizacja – kraj | Opcjonalny | Kraj, w którym znajduje się dana osoba lub w którym pełni służbę. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – miasto | Opcjonalny | Miasto, w którym znajduje się dana osoba lub w którym świadczy ona usługi. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – wyświetlany adres | Opcjonalny | Użytkownik zobaczy adres, pod którym znajduje się osoba lub w którym świadczy ona usługi. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – adres | Opcjonalny | Adres (w stosownych przypadkach) miejsca, w którym znajduje się lub pracuje dana osoba. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – stan | Opcjonalny | Stan (jeśli ma zastosowanie), w którym znajduje się dana osoba lub w którym świadczy ona usługi. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli występuje) miejsca, w którym dana osoba się znajduje lub pracuje. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – okolica | Opcjonalny | Dzielnica (w stosownych przypadkach), w której znajduje się osoba lub w której świadczy usługi. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Odznaki | Opcjonalny |
Każda plakietka to tekst (maksymalnie 15 znaków) lub mały obraz. |
|
Plakietka – tekst | Opcjonalny | Tytuł plakietki Uwaga: w przypadku plakietki wymagany jest tekst lub obraz. |
Dowolny tekst Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Plakietka – obraz | Opcjonalny | Mały obraz Specjalne traktowanie pod względem UX, np. nakładka w postaci plakietki na miniaturę obrazu lub filmu. Uwaga: w przypadku plakietki wymagany jest tekst lub obraz. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący encję. Uwaga: użytkownikowi będzie wyświetlana lista opisów lub lista napisów, ale nie obie jednocześnie. |
Dowolny tekst Zalecany rozmiar tekstu: 180 znaków |
Lista podtytułów | Opcjonalny | Maksymalnie 3 napisy, każdy w jednym wierszu tekstu. Uwaga: użytkownikowi będzie wyświetlana lista opisów lub lista napisów, ale nie obie jednocześnie. |
Dowolny tekst Zalecana długość każdego podtytułu: maks. 50 znaków |
Kategorie treści | Opcjonalny | Opisz kategorię treści w obiekcie. | Lista kwalifikujących się typów wyliczeniowych
Wskazówki znajdziesz w sekcji Kategoria treści. |
EventEntity
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Identyfikator URI działania | Wymagany |
Precyzyjny link do podmiotu w aplikacji dostawcy. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania. |
Identyfikator URI |
Tytuł | Wymagany | Nazwa elementu. | Ciąg znaków Zalecany rozmiar tekstu: maksymalnie 50 znaków |
Godzina rozpoczęcia | Wymagany |
Sygnatura czasowa w formacie epoki, kiedy ma się rozpocząć wydarzenie. Uwaga: ta wartość będzie podana w milisekundach. |
Sygnatura czasowa epoki w milisekundach |
Tryb zdarzenia | Wymagany | Pole wskazujące, czy wydarzenie będzie wirtualne, stacjonarne czy w obu formach. |
Enum: VIRTUAL, IN_PERSON lub HYBRID |
Obrazy plakatu | Wymagany | Jeśli podasz kilka obrazów, wyświetlimy tylko 1. Zalecany format obrazu to 16:9. Uwaga: zdecydowanie zalecamy dodanie obrazu. Jeśli podasz plakietkę, upewnij się, że u góry i u dołu obrazu znajduje się bezpieczna przestrzeń o wielkości 24 dp. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Lokalizacja – kraj | Wymagane warunkowo | Kraj, w którym odbywa się wydarzenie. Uwaga: jest to wymagane w przypadku wydarzeń, które odbywają się OSOBIŚCIE lub HYBRYDOWO. |
Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – miasto | Wymagane warunkowo | Miasto, w którym odbywa się wydarzenie. Uwaga: jest to wymagane w przypadku wydarzeń, które odbywają się OSOBIŚCIE lub HYBRYDOWO. |
Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – wyświetlany adres | Wymagane warunkowo | Adres lub nazwa miejsca, w którym odbędzie się wydarzenie, które powinny być wyświetlane użytkownikowi. Uwaga: jest to wymagane w przypadku wydarzeń, które odbywają się OSOBIŚCIE lub HYBRYDOWO. |
Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – adres | Opcjonalny | Adres ulicy (w odpowiednich przypadkach) miejsca, w którym odbywa się wydarzenie. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – stan | Opcjonalny | Stan lub województwo (jeśli ma zastosowanie), w którym odbywa się wydarzenie. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli występuje) lokalizacji, w której odbywa się wydarzenie. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – okolica | Opcjonalny | Dzielnica (jeśli dotyczy), w której odbywa się wydarzenie. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Godzina zakończenia | Opcjonalny |
Sygnatura czasowa w formacie epoki, kiedy wydarzenie ma się zakończyć. Uwaga: ta wartość będzie podana w milisekundach. |
Sygnatura czasowa epoki w milisekundach |
Opis | Opcjonalny | Jeden akapit tekstu opisujący encję. Uwaga: użytkownikowi będzie wyświetlana lista opisów lub lista napisów, ale nie obie jednocześnie. |
Dowolny tekst Zalecany rozmiar tekstu: 180 znaków |
Lista podtytułów | Opcjonalny | Maksymalnie 3 napisy, każdy w jednym wierszu tekstu. Uwaga: użytkownikowi będzie wyświetlana lista opisów lub lista napisów, ale nie obie jednocześnie. |
Dowolny tekst Zalecana długość każdego podtytułu: maks. 50 znaków |
Odznaki | Opcjonalny |
Każda plakietka to tekst (maksymalnie 15 znaków) lub mały obraz. |
|
Plakietka – tekst | Opcjonalny | Tytuł plakietki Uwaga: w przypadku plakietki wymagany jest tekst lub obraz. |
Dowolny tekst Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Plakietka – obraz | Opcjonalny | Mały obraz Specjalne traktowanie pod względem UX, np. nakładka w postaci plakietki na miniaturę obrazu lub filmu. Uwaga: w przypadku plakietki wymagany jest tekst lub obraz. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Cena – CurrentPrice | Wymagane warunkowo |
Aktualna cena biletu na wydarzenie. Musisz podać cenę, jeśli podasz cenę przekreśloną. |
Dowolny tekst |
Cena – StrikethroughPrice | Opcjonalny | Pierwotna cena biletu na wydarzenie. | Dowolny tekst |
Objaśnienie dotyczące ceny | Opcjonalny | Wywołanie ceny, aby wyróżnić promocję, wydarzenie lub rabat dla uczestników programu (jeśli są dostępne). | Dowolny tekst Zalecana długość tekstu: mniej niż 45 znaków (za długi tekst może być wyświetlany z wielokropkiem) |
Kategorie treści | Opcjonalny | Opisz kategorię treści w obiekcie. | Lista kwalifikujących się typów wyliczeniowych
Wskazówki znajdziesz w sekcji Kategoria treści. |
EventReservationEntity
Atrybut | Wymaganie | Opis | Format |
---|---|---|---|
Identyfikator URI działania | Wymagany |
Precyzyjny link do podmiotu w aplikacji dostawcy. Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania. |
Identyfikator URI |
Tytuł | Wymagany | Nazwa elementu. | Ciąg znaków Zalecany rozmiar tekstu: maksymalnie 50 znaków |
Godzina rozpoczęcia | Wymagany |
Sygnatura czasowa w formacie epoki, kiedy ma się rozpocząć wydarzenie. Uwaga: ta wartość będzie podana w milisekundach. |
Sygnatura czasowa epoki w milisekundach |
Tryb zdarzenia | Wymagany | Pole wskazujące, czy wydarzenie będzie wirtualne, stacjonarne czy w obu formach. |
Enum: VIRTUAL, IN_PERSON lub HYBRID |
Lokalizacja – kraj | Wymagane warunkowo | Kraj, w którym odbywa się wydarzenie. Uwaga: jest to wymagane w przypadku wydarzeń, które odbywają się OSOBIŚCIE lub HYBRYDOWO. |
Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – miasto | Wymagane warunkowo | Miasto, w którym odbywa się wydarzenie. Uwaga: jest to wymagane w przypadku wydarzeń, które odbywają się OSOBIŚCIE lub HYBRYDOWO. |
Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – wyświetlany adres | Wymagane warunkowo | Adres lub nazwa miejsca, w którym odbędzie się wydarzenie, które powinny być wyświetlane użytkownikowi. Uwaga: jest to wymagane w przypadku wydarzeń, które odbywają się OSOBIŚCIE lub HYBRYDOWO. |
Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – adres | Opcjonalny | Adres ulicy (w odpowiednich przypadkach) miejsca, w którym odbywa się wydarzenie. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – stan | Opcjonalny | Stan lub województwo (jeśli ma zastosowanie), w którym odbywa się wydarzenie. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – kod pocztowy | Opcjonalny | Kod pocztowy (jeśli występuje) lokalizacji, w której odbywa się wydarzenie. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Lokalizacja – okolica | Opcjonalny | Dzielnica (jeśli dotyczy), w której odbywa się wydarzenie. | Dowolny tekst Zalecana długość tekstu: maks. ok. 20 znaków |
Obrazy plakatu | Opcjonalny | Jeśli podasz kilka obrazów, wyświetlimy tylko 1. Zalecany format obrazu to 16:9. Uwaga: zdecydowanie zalecamy dodanie obrazu. Jeśli podasz plakietkę, upewnij się, że u góry i u dołu obrazu znajduje się bezpieczna przestrzeń o wielkości 24 dp. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Godzina zakończenia | Opcjonalny |
Sygnatura czasowa w formacie epoki, kiedy wydarzenie ma się zakończyć. Uwaga: ta wartość będzie podana w milisekundach. |
Sygnatura czasowa epoki w milisekundach |
Dostawca usług – nazwa | Opcjonalny |
Nazwa dostawcy usługi. Uwaga: w przypadku usługodawcy wymagany jest tekst lub obraz. |
Dowolny tekst. np. nazwa organizatora wydarzenia lub wycieczki. |
Usługodawca – obraz | Opcjonalny |
Logo lub obraz usługodawcy. Uwaga: w przypadku usługodawcy wymagany jest tekst lub obraz. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Opis | Opcjonalny | Jeden akapit tekstu opisujący encję. Uwaga: użytkownikowi będzie wyświetlana lista opisów lub lista napisów, ale nie obie jednocześnie. |
Dowolny tekst Zalecany rozmiar tekstu: 180 znaków |
Lista podtytułów | Opcjonalny | Maksymalnie 3 napisy, każdy w jednym wierszu tekstu. Uwaga: użytkownikowi będzie wyświetlana lista opisów lub lista napisów, ale nie obie jednocześnie. |
Dowolny tekst Zalecana długość każdego podtytułu: maks. 50 znaków |
Odznaki | Opcjonalny |
Każda plakietka to tekst (maksymalnie 15 znaków) lub mały obraz. |
|
Plakietka – tekst | Opcjonalny | Tytuł plakietki Uwaga: w przypadku plakietki wymagany jest tekst lub obraz. |
Dowolny tekst Zalecany rozmiar tekstu: maksymalnie 15 znaków |
Plakietka – obraz | Opcjonalny | Mały obraz Specjalne traktowanie pod względem UX, np. nakładka w postaci plakietki na miniaturę obrazu lub filmu. Uwaga: w przypadku plakietki wymagany jest tekst lub obraz. |
Więcej informacji znajdziesz w sekcji Specyfikacja obrazu. |
Identyfikator rezerwacji | Opcjonalny | Identyfikator rezerwacji biletu na wydarzenie. | Dowolny tekst |
Cena – CurrentPrice | Wymagane warunkowo |
Aktualna cena biletu na wydarzenie. Musisz podać cenę, jeśli podasz cenę przekreśloną. |
Dowolny tekst |
Cena – StrikethroughPrice | Opcjonalny | Pierwotna cena biletu na wydarzenie. | Dowolny tekst |
Objaśnienie dotyczące ceny | Opcjonalny | Wywołanie ceny, aby wyróżnić promocję, wydarzenie lub rabat dla uczestników programu (jeśli są dostępne). | Dowolny tekst Zalecana długość tekstu: mniej niż 45 znaków (za długi tekst może być wyświetlany z wielokropkiem) |
Ocena – wartość maksymalna | Opcjonalny | Maksymalna wartość skali ocen. Musisz podać tę wartość, jeśli podasz też aktualną ocenę. |
Liczba >= 0,0 |
Ocena – bieżąca wartość | Opcjonalny | Bieżąca wartość skali ocen. Musisz podać tę wartość, jeśli podasz też maksymalną wartość oceny. |
Liczba >= 0,0 |
Ocena – liczba | Opcjonalny | Liczba ocen wydarzenia. 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 obcięta w przypadku mniejszych rozmiarów wyświetlanych elementów. |
Ciąg znaków |
Ocena – wartość liczby | Opcjonalny | Liczba ocen wydarzenia. Uwaga: wypełnij to pole, jeśli nie chcesz samodzielnie obsługiwać logiki skracania wyświetlania. Jeśli występują zarówno wartość Count, jak i Count Value, użytkownikom wyświetlimy wartość Count. |
Długie |
Kategorie treści | Opcjonalny | Opisz kategorię treści w obiekcie. | Lista kwalifikujących się typów wyliczeniowych
Wskazówki znajdziesz w sekcji Kategoria treści. |
Specyfikacja obrazu
Wymagane specyfikacje komponentów z obrazem są wymienione w tej tabeli:
Format obrazu | Minimalny rozmiar w pikselach | Zalecany rozmiar w pikselach |
---|---|---|
Kwadrat (1:1) Preferowane |
300 x 300 | 1200 x 1200 |
Poziomy (1,91 x 1) | 600 x 314 | 1200 x 628 |
Orientacja pionowa (4x5) | 480 x 600 | 960 x 1200 |
Obrazy muszą być hostowane w publicznych sieciach CDN, aby Google mógł do nich uzyskać dostęp.
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 mógł być prawidłowo wyświetlany w ustawieniach motywu ciemnego i jasnego.
Kategoria treści
Kategoria treści umożliwia aplikacjom publikowanie treści należących do wielu kategorii. Dzięki temu treści są przypisywane do niektórych wstępnie zdefiniowanych kategorii, takich jak:
TYPE_EDUCATION
TYPE_SPORTS
TYPE_MOVIES_AND_TV_SHOWS
TYPE_BOOKS
TYPE_AUDIOBOOKS
TYPE_MUSIC
TYPE_DIGITAL_GAMES
TYPE_TRAVEL_AND_LOCAL
TYPE_HOME_AND_AUTO
TYPE_BUSINESS
TYPE_NEWS
TYPE_FOOD_AND_DRINK
TYPE_SHOPPING
TYPE_HEALTH_AND_FITENESS
TYPE_MEDICAL
TYPE_PARENTING
TYPE_DATING
Obrazy muszą być hostowane w publicznych sieciach CDN, aby Google mógł do nich uzyskać dostęp.
Wskazówki dotyczące korzystania z kategorii treści
- Niektóre typy danych, takie jak ArticleEntity i GenericFeaturedEntity, mogą korzystać z dowolnej kategorii treści. W przypadku innych typów danych, takich jak EventEntity, EventReservationEntity czy PersonEntity, kwalifikuje się tylko podzbiór tych kategorii. Przed wypełnieniem listy sprawdź listę kategorii kwalifikujących się do typu podmiotu.
W przypadku niektórych kategorii treści używaj konkretnego typu elementu zamiast kombinacji elementów ogólnych i kategorii treści:
- TYPE_MOVIES_AND_TV_SHOWS – przed użyciem ogólnych elementów zapoznaj się z elementami z przewodnika po integracji funkcji Oglądaj.
- TYPE_BOOKS – przed użyciem ogólnych elementów sprawdź EbookEntity.
- TYPE_AUDIOBOOKS – sprawdź AudiobookEntity przed użyciem ogólnych elementów.
- TYPE_SHOPPING - Check out ShoppingEntity before using the generic entities.
- TYPE_FOOD_AND_DRINK – przed użyciem ogólnych elementów zapoznaj się z elementami z przewodnika po integracji z usługami związanymi z jedzeniem.
Pole ContentCategory jest opcjonalne i należy je pozostawić puste, jeśli treść nie należy do żadnej z wcześniej wymienionych kategorii.
Jeśli podasz kilka kategorii treści, podaj je w kolejności ich trafności w stosunku do treści. Najtrafniejsza kategoria treści powinna być pierwsza na liście.
Krok 2. Podaj dane klastra
Zalecamy wykonywanie zadania publikowania treści w tle (np. za pomocą WorkManager) i planowanie go regularnie lub na podstawie zdarzeń (np. za każdym razem, gdy użytkownik otwiera aplikację lub gdy właśnie dodał coś do koszyka).
AppEngagePublishClient
odpowiada za publikowanie klastrów.
Do publikowania klastrów w kliencie służą te interfejsy API:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Ten interfejs API służy do sprawdzania, czy usługa jest dostępna do integracji i czy treść może być wyświetlana 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("Top Picks For You")
.build()
)
.build()
)
Java
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
new RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Top Picks For You")
.build())
.build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:
- Istniejące dane
RecommendationCluster
od dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze rekomendacji.
W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.
publishFeaturedCluster
Ten interfejs API służy do publikowania listy obiektów FeaturedCluster
.
Kotlin
client.publishFeaturedCluster(
PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
FeaturedCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build())
Java
client.publishFeaturedCluster(
new PublishFeaturedClustersRequest.Builder()
.addFeaturedCluster(
new FeaturedCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:
- Istniejące dane
FeaturedCluster
od dewelopera zostaną usunięte. - Dane z żądania są analizowane i zapisywane w zaktualizowanym klastrze polecanych.
W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.
publishContinuationCluster
Ten interfejs API służy do publikowania obiektu ContinuationCluster
.
Kotlin
client.publishContinuationCluster(
PublishContinuationClusterRequest.Builder()
.setContinuationCluster(
ContinuationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build())
Java
client.publishContinuationCluster(
new PublishContinuationClusterRequest.Builder()
.setContinuationCluster(
new ContinuationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build());
Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:
- Istniejące dane
ContinuationCluster
od dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze kontynuacji.
W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.
publishUserAccountManagementRequest
Ten interfejs API służy do publikowania karty logowania . Działanie logowania przekierowuje użytkowników na stronę logowania aplikacji, aby mogła ona publikować treści (lub udostępniać bardziej spersonalizowane treści).
Karta logowania zawiera te metadane:
Atrybut | Wymaganie | Opis |
---|---|---|
Identyfikator URI działania | Wymagane | Precyzyjny link do działania (np. przejście do strony logowania w aplikacji) |
Obraz | Opcjonalny – jeśli nie zostanie podany, należy podać tytuł |
Obraz wyświetlany na karcie Obrazy o formacie 16:9 i rozdzielczości 1264 x 712 |
Tytuł | Opcjonalny – jeśli nie zostanie podany, należy podać obraz | Tytuł na karcie |
Tekst działania | Opcjonalny | Tekst wyświetlany w wezwaniu do działania (np. Zaloguj się) |
Podtytuł | Opcjonalny | Opcjonalny podtytuł 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 zostaną wykonane te działania:
- Dotychczasowe dane
UserAccountManagementCluster
od partnera dewelopera zostaną usunięte. - Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze UserAccountManagementCluster.
W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.
updatePublishStatus
Jeśli z jakiegokolwiek powodu wewnętrznego żadna z grup nie jest opublikowana, zdecydowanie zalecamy zaktualizowanie stanu publikacji za pomocą interfejsu API updatePublishStatus. Jest to ważne, ponieważ :
- Podawanie stanu we wszystkich scenariuszach, nawet gdy treść jest opublikowana (STATUS == PUBLISHED), jest kluczowe do wypełniania paneli, które używają tego jawnego stanu do przekazywania informacji o kondycji i innych danych integracji.
- Jeśli żadne treści nie są publikowane, ale stan integracji nie jest uszkodzony (STATUS == NOT_PUBLISHED), Google może uniknąć wywoływania alertów na panelach stanu aplikacji. Potwierdza, że treści nie są publikowane z powodu przewidywanej sytuacji z punktu widzenia dostawcy.
- Pomaga deweloperom określać, kiedy dane są publikowane, a kiedy nie.
- Google może używać kodów stanu, aby zachęcać użytkownika do podejmowania określonych działań w aplikacji, dzięki którym będzie mógł wyświetlać jej zawartość lub rozwiązywać problemy.
Lista kwalifikujących się kodów stanu publikacji :
// Content is published
AppEngagePublishStatusCode.PUBLISHED,
// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,
// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,
// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,
// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,
// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,
// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,
// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,
// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER
Jeśli treści nie są publikowane, ponieważ użytkownik nie jest zalogowany, Google zaleca opublikowanie karty logowania. Jeśli z jakiegokolwiek powodu dostawcy nie mogą opublikować karty logowania, zalecamy wywołanie interfejsu 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 dotychczasowe dane z klastrów rekomendacji. W przypadku błędu całe żądanie zostanie odrzucone, a dotychczasowy stan zostanie zachowany.
deleteFeaturedCluster
Ten interfejs API służy do usuwania treści z wyróżnionego klastra.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Gdy usługa otrzyma żądanie, usunie dotychczasowe dane z wyróżnionego klastra. W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan pozostaje bez zmian.
deleteContinuationCluster
Ten interfejs API służy do usuwania treści z klastra kontynuacji.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra kontynuacji. W przypadku błędu całe żądanie zostanie odrzucone, a dotychczasowy stan zostanie 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, usunie istniejące dane z klastra UserAccountManagement. W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.
deleteClusters
Ten interfejs API służy do usuwania treści danego typu klastra.
Kotlin
client.deleteClusters(
DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_CONTINUATION)
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
.build())
Java
client.deleteClusters(
new DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_CONTINUATION)
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
.build());
Gdy usługa otrzyma żądanie, usunie istniejące dane ze wszystkich klastrów pasujących do określonych typów klastrów. Klienci mogą przekazywać jeden lub wiele typów klastrów. W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan pozostaje bez zmian.
Obsługa błędów
Zdecydowanie zalecamy odsłuchiwanie wyniku zadania z interfejsów API publikowania, aby można było podjąć działania następcze w celu odzyskania i ponownego przesłania zadania, które zakończyło się niepowodzeniem.
Kotlin
client.publishRecommendationClusters(
PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(..)
.build())
.addOnCompleteListener { task ->
if (task.isSuccessful) {
// do something
} else {
val exception = task.exception
if (exception is AppEngageException) {
@AppEngageErrorCode val errorCode = exception.errorCode
if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
// do something
}
}
}
}
Java
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(...)
.build())
.addOnCompleteListener(
task -> {
if (task.isSuccessful()) {
// do something
} else {
Exception exception = task.getException();
if (exception instanceof AppEngageException) {
@AppEngageErrorCode
int errorCode = ((AppEngageException) exception).getErrorCode();
if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
// do something
}
}
}
});
Błąd jest zwracany jako obiekt AppEngageException
, a jego przyczyna jest podana jako kod błędu.
Kod błędu | Nazwa błędu | Uwaga |
---|---|---|
1 |
SERVICE_NOT_FOUND |
Usługa jest niedostępna na danym urządzeniu. |
2 |
SERVICE_NOT_AVAILABLE |
Usługa jest dostępna na danym urządzeniu, ale w momencie połączenia jest niedostępna (np. jest wyraźnie wyłączona). |
3 |
SERVICE_CALL_EXECUTION_FAILURE |
Nie udało się wykonać zadania z powodu problemów z wątkami. W takim przypadku można ponowić próbę. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Element wywołujący nie ma uprawnień do wykonania wywołania usługi. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
Żądanie zawiera nieprawidłowe dane (np. więcej klastrów niż dozwolona liczba). |
6 |
SERVICE_CALL_INTERNAL |
Po stronie usługi wystąpił błąd. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Wywołanie usługi jest wykonywane zbyt często. |
Krok 3. Obsługa intencji transmisji
Oprócz wykonywania wywołań interfejsu API publikowania treści za pomocą zadania musisz też skonfigurować BroadcastReceiver
, aby otrzymywać prośby o publikowanie treści.
Celem intencji rozgłaszania jest głównie ponowna aktywacja aplikacji i wymuszenie synchronizacji danych. Intencje transmisji nie są przeznaczone do wysyłania zbyt często. Jest ona wywoływana tylko wtedy, gdy usługa Engage uzna, że treść może być nieaktualna (np. ma tydzień). Dzięki temu użytkownik może mieć pewność, że będzie korzystać z najnowszych treści, nawet jeśli aplikacja nie była uruchamiana przez dłuższy czas.
BroadcastReceiver
musi być skonfigurowany na 2 sposoby:
Dynamiczne rejestrowanie instancji klasy
BroadcastReceiver
za pomocąContext.registerReceiver()
. Umożliwia to komunikację z aplikacjami, które są nadal aktywne w pamięci.
Kotlin
class AppEngageBroadcastReceiver : BroadcastReceiver(){
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
// received
}
fun registerBroadcastReceivers(context: Context){
var context = context
context = context.applicationContext
// Register Recommendation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Featured Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Continuation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
}
Java
class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
// received
}
public static void registerBroadcastReceivers(Context context) {
context = context.getApplicationContext();
// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
}
Statycznie zadeklaruj implementację za pomocą tagu
<receiver>
w plikuAndroidManifest.xml
. Dzięki temu aplikacja może odbierać intencje transmisji, gdy nie jest uruchomiona, a także publikować treści.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
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 wysyła te intencje:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
Zalecamy rozpoczęciepublishRecommendationClusters
połączenia po otrzymaniu tego zamiaru.com.google.android.engage.action.PUBLISH_FEATURED
Zalecamy rozpoczęcie połączeniapublishFeaturedCluster
po otrzymaniu tego zamiaru.com.google.android.engage.action.PUBLISH_CONTINUATION
Zalecamy rozpoczęcie połączeniapublishContinuationCluster
po otrzymaniu tego zamiaru.
Przepływ pracy integracji
Szczegółowe instrukcje weryfikacji integracji po jej zakończeniu znajdziesz w artykule Przepływ pracy integracji z platformą Engage dla programistów.
Najczęstsze pytania
Odpowiedzi na najczęstsze pytania znajdziesz w sekcji Najczęstsze pytania dotyczące pakietu Engage SDK.
Kontakt
Jeśli podczas procesu integracji pojawią się pytania, skontaktuj się z nami.engage-developers@google.com
Dalsze kroki
Po zakończeniu integracji wykonaj te czynności:
- Wyślij e-maila na adres
engage-developers@google.com
i dołącz zintegrowany pakiet APK gotowy do testowania przez Google. - Google przeprowadza weryfikację i sprawdza wewnętrznie, czy integracja działa zgodnie z oczekiwaniami. Jeśli zajdzie taka potrzeba, skontaktujemy się z Tobą, aby przekazać niezbędne informacje.
- Gdy testy zostaną zakończone i nie będą potrzebne żadne zmiany, skontaktujemy się z Tobą, aby poinformować Cię, że możesz rozpocząć publikowanie zaktualizowanego i zintegrowanego pliku APK w Sklepie Play.
- Gdy potwierdzimy, że zaktualizowany pakiet APK został opublikowany w Sklepie Play, klastry Rekomendacja, Wyróżnione i Kontynuacja mogą zostać opublikowane i będą widoczne dla użytkowników.