Pakiet SDK dla kampanii produktowych: instrukcje integracji technicznej firm zewnętrznych

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 z zakupami do interfejsów treści Engage.

Szczegóły integracji

Terminologia

Integracja obejmuje te 5 rodzajów klastrów: Rekomendacja, Wyróżnione, Koszyk, Lista zakupów, Ponowne zamówienie i Śledzenie zamówienia.

  • Rekomendacje to grupy zawierające spersonalizowane sugestie dotyczące zakupów od konkretnego partnera deweloperskiego. Rekomendacje mogą być spersonalizowane dla danego użytkownika lub ogólne (np. popularne produkty). Używaj ich do wyświetlania produktów, wydarzeń, wyprzedaży, promocji i subskrypcji według własnego uznania.

    Rekomendacje mają następującą strukturę:

    • Grupa rekomendacji: widok interfejsu, który zawiera grupę rekomendacji od tego samego partnera deweloperskiego.

    • ShoppingEntity: obiekt reprezentujący pojedynczy produkt w klastrze.

  • 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.

  • Grupa Koszyk zawiera podgląd koszyków wielu partnerów programistów w jednym układzie interfejsu, zachęcając użytkowników do sfinalizowania zakupów. Jeden klaster koszyka będzie wyświetlany u góry interfejsu w priorytetowym miejscu nad wszystkimi innymi klastrami rekomendacji. Każdy partner deweloper może transmitować maksymalnie 3 ShoppingCart instancje w klastrze Koszyk.

    Koszyk ma następującą strukturę:

    • Klaster koszyka: widok interfejsu, który zawiera grupę podglądów koszyków od wielu partnerów programistów.

    • ShoppingCart: obiekt reprezentujący podgląd koszyka zakupowego dla jednego partnera, który ma być wyświetlany w grupie Koszyk. ShoppingCart musi wyświetlać łączną liczbę produktów w koszyku i może też zawierać obrazy niektórych produktów w koszyku użytkownika.

  • Grupa Lista zakupów zawiera podgląd list zakupów od wielu partnerów programistów w jednym układzie interfejsu. Zachęca użytkowników do powrotu do odpowiedniej aplikacji, aby zaktualizować i dokończyć listy. Jest tylko jedna grupa Lista zakupów.

  • Grupa Ponów zamówienie zawiera podgląd poprzednich zamówień od wielu partnerów programistów w jednym układzie interfejsu, zachęcając użytkowników do ponownego zamówienia. Jest jeden klaster ponownego zamówienia.

    • Klaster ponownego zamówienia musi zawierać łączną liczbę produktów z poprzedniego zamówienia użytkownika, a także jedną z tych informacji:

      • Obrazy X produktów z poprzedniego zamówienia użytkownika.
      • Etykiety dla X produktów z poprzedniego zamówienia użytkownika.

  • Grupa Śledzenie zamówień zawiera podgląd oczekujących lub niedawno zrealizowanych zamówień od wielu partnerów programistów w jednym układzie interfejsu, co umożliwia użytkownikom śledzenie zamówień.

    Jeden klaster ShoppingOrderTracking będzie wyświetlany u góry interfejsu w priorytetowym miejscu nad wszystkimi innymi klastrami rekomendacji. Każdy partner deweloper może transmitować wiele elementów ShoppingOrderTrackingEntity w klastrze Śledzenie zamówień w zakupach.

    • Element ShoppingOrderTrackingCluster ma następującą strukturę:

      • Klaster ShoppingOrderTracking: widok interfejsu zawierający grupę podglądów śledzenia zamówień od wielu partnerów programistów.
      • ShoppingOrderTrackingEntity: obiekt reprezentujący podgląd śledzenia zamówienia w sklepie dla jednego partnera programisty, który ma być wyświetlany w grupie Śledzenie zamówienia w sklepie. Obiekt ShoppingOrderTrackingEntity musi zawierać stan zamówienia i czas jego złożenia. Zdecydowanie zalecamy podawanie przewidywanego czasu dostawy w przypadku elementu ShoppingOrderTrackingEntity, ponieważ jest on wyświetlany użytkownikom.

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'
}

Więcej informacji znajdziesz w artykule Widoczność pakietów na Androidzie 11.

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 Maksymalne limity elementów w klastrze
Klastry rekomendacji Maksymalnie 7 Maksymalnie 50 ShoppingEntity
Polecany klaster Maksymalnie 1 Maksymalnie 20 ShoppingEntity
Grupa „Koszyk na zakupy” Maksymalnie 1 Maksymalnie 3 ShoppingCart

Wiele koszyków jest oczekiwane tylko w przypadku aplikacji z osobnymi koszykami dla każdego sprzedawcy.

Grupa „Lista zakupów” Maksymalnie 1 Maksymalnie 1 ShoppingListEntity
Grupa „Ponowne zamówienie w Zakupach” Maksymalnie 1 Maksymalnie 1 ReorderEntity
Grupa „Śledzenie zamówień” Maksymalnie 3 Maksymalnie 3 ShoppingOrderTrackingEntity

Krok 1. Podaj dane podmiotu

Pakiet SDK ma zdefiniowane różne elementy reprezentujące każdy typ produktu. W przypadku kategorii Zakupy obsługiwane są te jednostki:

  1. ShoppingEntity
  2. ShoppingCart
  3. ShoppingList
  4. Reorder
  5. ShoppingOrderTracking

W tabelach poniżej znajdziesz listę dostępnych atrybutów i wymagań dla każdego typu.

ShoppingEntity

Obiekt ShoppingEntity reprezentuje produkt, promocję, ofertę, subskrypcję lub wydarzenie, które partnerzy deweloperzy chcą opublikować.

ShoppingEntity
Atrybut Wymaganie Opis Format
Obrazy plakatu Wymagany Musisz podać co najmniej 1 obraz. Więcej informacji znajdziesz w sekcji Specyfikacja obrazu.
Identyfikator URI działania Wymagany

Precyzyjny link do strony w aplikacji, na której wyświetlane są szczegóły elementu.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Identyfikator URI
Tytuł Opcjonalny Nazwa elementu.

Dowolny tekst

Zalecana długość tekstu: mniej niż 90 znaków (za długi tekst może być wyświetlany z wielokropkiem)
Cena – bieżąca Wymagane warunkowo

Aktualna cena elementu.

Musisz podać tę wartość, jeśli podasz cenę przekreśloną.

Dowolny tekst
Cena – przekreślenie Opcjonalny Pierwotna cena jednostki, która będzie przekreślona w interfejsie. Dowolny tekst
Objaśnienie Opcjonalny Wywołanie funkcji, która umożliwia wyróżnienie promocji, wydarzenia lub aktualizacji dotyczących podmiotu, jeśli są dostępne.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)
Drobny druk objaśnienia Opcjonalny Tekst drobnego druku objaśnienia.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 45 znaków (tekst, który jest za długi, może zawierać wielokropek)
Ocena (opcjonalnie) – uwaga: wszystkie oceny są wyświetlane w standardowym systemie ocen za pomocą gwiazdek.
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 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
DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie skonfigurujesz tej zasady, treści będą mogły być wyświetlane na danej platformie.

 Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie skonfigurujesz tej zasady, treści będą mogły być wyświetlane na danej platformie.

 Sygnatura czasowa epoki w milisekundach

ShoppingCart

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 (nie tylko liczba rodzajów produktów) w koszyku.

Przykład: jeśli w koszyku znajdują się 3 identyczne koszulki i 1 czapka, ta liczba powinna wynosić 4.

Liczba całkowita >= 1
Tekst działania Opcjonalny

Tekst wezwania do działania na przycisku w koszyku (np. Twój koszyk).

Jeśli deweloper nie poda tekstu działania, domyślnie wyświetli się opcja Wyświetl koszyk.

Ten atrybut jest obsługiwany od wersji 1.1.0.

Ciąg znaków
Tytuł Opcjonalny

Tytuł koszyka (np. Twój koszyk).

Jeśli deweloper nie poda tytułu, domyślnie używany jest tytuł Twój koszyk.

Jeśli partner deweloper publikuje osobny koszyk dla każdego sprzedawcy, w tytule podaj nazwę sprzedawcy.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 25 znaków (tekst, który jest za długi, może zawierać wielokropek)
Obrazy koszyka Opcjonalny

zdjęcia każdego produktu w koszyku;

Możesz podać maksymalnie 10 obrazów w kolejności priorytetu. Rzeczywista liczba wyświetlanych obrazów zależy od formatu urządzenia.

 Więcej informacji znajdziesz w sekcji Specyfikacja obrazu.
Etykiety produktów Opcjonalny

Lista etykiet produktów na liście zakupów.

Rzeczywista liczba wyświetlanych etykiet zależy od rodzaju urządzenia.

Lista etykiet tekstowych

Zalecane rozmiary tekstu: poniżej 20 znaków (tekst, który jest za długi, może zawierać wielokropek)
Sygnatura czasowa ostatniej interakcji użytkownika Opcjonalny Liczba milisekund, które upłynęły od początku epoki, określająca ostatni moment, w którym użytkownik wszedł w interakcję z koszykiem.

Ten parametr będzie przekazywany jako dane wejściowe przez partnerów deweloperów publikujących osobne koszyki dla każdego sprzedawcy i może być używany do określania rankingu.

Sygnatura czasowa epoki w milisekundach
DisplayTimeWindow (opcjonalnie) – ustaw przedział czasu, w którym treści mają być wyświetlane na danej platformie.
Sygnatura czasowa rozpoczęcia Opcjonalny

Sygnatura czasowa epoki, po której treści powinny być wyświetlane na danej platformie.

Jeśli nie skonfigurujesz tej zasady, treści będą mogły być wyświetlane na danej platformie.

 Sygnatura czasowa epoki w milisekundach
Sygnatura czasowa zakończenia Opcjonalny

Sygnatura czasowa epoki, po której treści nie są już wyświetlane na danej platformie.

Jeśli nie skonfigurujesz tej zasady, treści będą mogły być wyświetlane na danej platformie.

 Sygnatura czasowa epoki w milisekundach

ShoppingList

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do listy zakupów 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 na liście zakupów. Liczba całkowita >= 1
Tytuł Opcjonalny

Tytuł listy (np. Twoja lista zakupów spożywczych).

Jeśli deweloper nie poda tytułu, domyślnie będzie to Lista zakupów.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 25 znaków (tekst, który jest za długi, może zawierać wielokropek)
Etykiety produktów Wymagany

Lista etykiet produktów na liście zakupów.

Musisz podać co najmniej 1 etykietę, a możesz podać maksymalnie 10 etykiet w kolejności priorytetu. Rzeczywista liczba wyświetlanych etykiet zależy od typu urządzenia.

Lista etykiet tekstowych

Zalecane rozmiary tekstu: poniżej 20 znaków (tekst, który jest za długi, może zawierać wielokropek)

ShoppingReorderCluster

Atrybut Wymaganie Opis Format
Identyfikator URI działania Wymagany

Precyzyjny link do ponownego zamówienia w aplikacji partnera.

Uwaga: do atrybucji możesz używać precyzyjnych linków. Zapoznaj się z odpowiedziami na najczęstsze pytania.

Identyfikator URI
Tekst działania Opcjonalny

Tekst wezwania do działania na przycisku ponownego zamówienia (np. Zamów ponownie).

Jeśli deweloper nie poda tekstu działania, domyślnie wyświetli się opcja Zamów ponownie.

Ten atrybut jest obsługiwany od wersji 1.1.0.

Ciąg znaków
Liczba elementów Wymagany

Liczba produktów (nie tylko liczba produktów) w poprzednim zamówieniu.

Przykład: jeśli w poprzednim zamówieniu były 3 małe kawy i 1 rogalik, ta liczba powinna wynosić 4.

Liczba całkowita >= 1
Tytuł Wymagany Tytuł ponownie zamówionego produktu.

Dowolny tekst

Zalecane rozmiary tekstu: poniżej 40 znaków (tekst, który jest za długi, może zawierać wielokropek)
Etykiety produktów

Opcjonalny

(Jeśli nie podasz obrazów plakatu, musisz podać obrazy podglądowe)

Lista etykiet produktów z poprzedniego zamówienia.

Można podać maksymalnie 10 etykiet w kolejności priorytetu. Rzeczywista liczba wyświetlanych etykiet zależy od formatu urządzenia.

Lista dowolnego tekstu

Zalecana długość tekstu na etykietę: mniej niż 20 znaków (za długi tekst może być wyświetlany z wielokropkiem)

Obrazy plakatu

Opcjonalny

(Jeśli nie podasz etykiet produktów, musisz podać etykiety elementów)

zdjęcia produktów z poprzedniego zamówienia;

Możesz podać maksymalnie 10 obrazów w kolejności priorytetu. Rzeczywista liczba wyświetlanych obrazów zależy od formatu urządzenia.

 Więcej informacji znajdziesz w sekcji Specyfikacja obrazu.

ShoppingOrderTrackingCluster

Atrybut Wymaganie Opis Format
Tytuł Wymagany

Krótki tytuł śledzonej przesyłki lub śledzonych produktów albo numer śledzenia.

Dowolny tekst

Zalecana długość tekstu: 50 znaków (za długi tekst będzie wyświetlany z wielokropkiem)

Typ zamówienia Wymagany

Krótki tytuł śledzonej przesyłki lub śledzonych produktów albo numer śledzenia.

Enum: IN_STORE_PICKUP, SAME_DAY_DELIVERY, MULTI_DAY_DELIVERY
Stan Wymagany

Obecny stan zamówienia.

Na przykład: „Spóźniony”, „W transporcie”, „Opóźniony”, „Wysłany”, „Dostarczony”, „Niedostępny”, „Zamówienie gotowe”

Dowolny tekst

Zalecana długość tekstu: 25 znaków (za długi tekst będzie wyświetlany z wielokropkiem)

Godzina zamówienia Wymagany

Sygnatura czasowa epoki w milisekundach, w której złożono zamówienie.

Czas zamówienia będzie wyświetlany, jeśli nie ma przewidywanego przedziału czasu dostawy

 Sygnatura czasowa epoki w milisekundach
Identyfikator URI działania Wymagany

Precyzyjny link do śledzenia zamówienia w aplikacji partnera.

 Identyfikator URI
OrderDeliveryTimeWindow (opcjonalny) – ustaw przedział czasu dla śledzonego zamówienia od momentu złożenia zamówienia do momentu oczekiwanej lub rzeczywistej dostawy.
OrderDeliveryTimeWindow - Start Time Opcjonalny

Sygnatura czasowa epoki w milisekundach, po której zamówienie zostanie dostarczone lub będzie gotowe do odbioru.

 Sygnatura czasowa epoki w milisekundach
OrderDeliveryTimeWindow - End Time Opcjonalny

Sygnatura czasowa w milisekundach, do której zamówienie zostanie dostarczone lub będzie gotowe do odbioru.

Sygnatura czasowa epoki w milisekundach
Obrazy plakatu Opcjonalny

Zdjęcie jednego produktu z zamówienia.

Zalecany format obrazu to 1:1.

 Więcej informacji znajdziesz w sekcji Specyfikacja obrazu.
Liczba elementów Opcjonalny Liczba produktów w zamówieniu. Liczba całkowita >= 1
Opis Opcjonalny

Pojedynczy akapit tekstu opisujący elementy w zamówieniu.

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
Wartość zamówienia – CurrentPrice Opcjonalny Bieżąca wartość zamówienia. Dowolny tekst
Numer zamówienia Opcjonalny Numer lub identyfikator zamówienia, który umożliwia jednoznaczną identyfikację zamówienia.

Dowolny tekst

Zalecany rozmiar tekstu: maks. 25 znaków
Numer śledzenia przesyłki Opcjonalny Numer śledzenia zamówienia lub przesyłki, jeśli zamówienie wymaga dostawy.

Dowolny tekst

Zalecany rozmiar tekstu: maks. 25 znaków

Specyfikacja obrazu

Wymagane specyfikacje komponentów z obrazem są wymienione poniżej:

Format obrazu Minimalny rozmiar w pikselach Zalecany rozmiar w pikselach

Kwadrat (1:1)

Preferowane w przypadku klastrów nieobjętych promocją

 300 x 300 1200 x 1200

Poziomy (1,91 x 1)

Preferowane w przypadku wyróżnionych klastrów

 600 x 314 1200 x 628
Orientacja pionowa (4x5) 480 x 600 960 x 1200

Formaty plików

PNG, JPG, statyczny GIF, WebP

Maksymalny rozmiar pliku

5120 KB

Dodatkowe rekomendacje

  • Bezpieczny obszar obrazu: ważne treści umieść w środkowych 80% obrazu.
  • Użyj przezroczystego tła, aby obraz mógł być prawidłowo wyświetlany w ustawieniach motywu ciemnego i jasnego.

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).

AppEngageShoppingClient odpowiada za publikowanie klastrów zakupowych.

Aby publikować klastry w kliencie, udostępniamy te interfejsy API:

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishShoppingCart
  • publishShoppingCarts
  • publishShoppingList
  • publishShoppingReorderCluster
  • publishShoppingOrderTrackingCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteShoppingCartCluster
  • deleteShoppingListCluster
  • deleteShoppingReorderCluster
  • deleteShoppingOrderTrackingCluster
  • 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.

Obiekt RecommendationCluster może mieć te atrybuty:

Atrybut Wymaganie Opis
Lista ShoppingEntity Wymagany Lista obiektów ShoppingEntity, które składają się na rekomendacje dla tego klastra rekomendacji.
Tytuł Wymagany

Tytuł klastra rekomendacji.

Zalecane rozmiary tekstu: poniżej 25 znaków (tekst, który jest za długi, może zawierać wielokropek)
Podtytuł Opcjonalny Podtytuł klastra rekomendacji.
Identyfikator URI działania Opcjonalny

Precyzyjny link do strony w aplikacji partnera, na której użytkownicy mogą zobaczyć pełną listę rekomendacji.

Uwaga: do 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("Black Friday Deals")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build());

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:

  • Wszystkie dotychczasowe dane klastra rekomendacji zostaną usunięte.
  • Dane z żądania są analizowane i zapisywane w nowych klastrach rekomendacji.

W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.

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 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.

publishShoppingCart

Ten interfejs API służy do publikowania obiektu ShoppingCartCluster.

Kotlin

client.publishShoppingCart(
            PublishShoppingCartRequest.Builder()
                .setShoppingCart(
                    ShoppingCart.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingCart(
            new PublishShoppingCartRequest.Builder()
                .setShoppingCart(
                    new ShoppingCart.Builder()
                        ...
                        .build())
                .build())

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:

  • Istniejące dane ShoppingCart od dewelopera zostaną usunięte.
  • Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze koszyka.

W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.

publishShoppingCarts

Ten interfejs API służy do publikowania wielu obiektów ShoppingCart. Dotyczy to partnerów deweloperów publikujących osobne koszyki dla każdego sprzedawcy. Podczas korzystania z tego interfejsu API w tytule należy podać nazwę sprzedawcy.

Kotlin

client.publishShoppingCarts(
            PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    ShoppingCart.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingCarts(
            new PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    new ShoppingCart.Builder()
                        ...
                        .build())
                .build())

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:

  • Istniejące dane ShoppingCart od dewelopera zostaną usunięte.
  • Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze koszyka.

W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.

publishShoppingList

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 zostaną wykonane te działania:

  • Istniejące dane FoodShoppingList od dewelopera zostaną usunięte.
  • Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze listy zakupów.

W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.

publishShoppingReorderCluster

Ten interfejs API służy do publikowania obiektu ShoppingReorderCluster.

Kotlin

client.publishShoppingReorderCluster(
            PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingReorderCluster(
            new PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    new ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build());

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:

  • Istniejące dane ShoppingReorderCluster od dewelopera zostaną usunięte.
  • Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze ponownego zamawiania.

W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.

publishShoppingOrderTrackingCluster

Ten interfejs API służy do publikowania obiektu ShoppingOrderTrackingCluster.

Kotlin

client.publishShoppingOrderTrackingCluster(
            PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingOrderTrackingCluster(
            new PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    new ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build());

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te działania:

  • Dotychczasowe dane ShoppingOrderTrackingCluster od partnera dewelopera zostaną usunięte.
  • Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze śledzenia zamówień w Zakupach.

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 updatePublishStatus API. Jest to ważne, ponieważ :

  • Podawanie stanu we wszystkich scenariuszach, nawet gdy treść jest opublikowana (STATUS == PUBLISHED), jest kluczowe do wypełniania paneli, które używają tego 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świetlić jej zawartość lub rozwiązać problem.

Lista kwalifikujących się kodów stanu publikacji :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

Jeśli treści nie są publikowane, ponieważ użytkownik nie jest zalogowany, Google zaleca opublikowanie karty logowania. Jeśli z jakiegoś powodu dostawcy nie mogą opublikować karty logowania, zalecamy wywołanie interfejsu API updatePublishStatus z kodem stanu NOT_PUBLISHED_REQUIRES_SIGN_IN.

Kotlin

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationClusters

Ten interfejs API służy do usuwania treści z grup rekomendacji.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

Gdy usługa otrzyma prośbę, usunie dotychczasowe dane z klastrów rekomendacji. W przypadku błędu cała prośba zostanie odrzucona, a dotychczasowy stan zostanie zachowany.

deleteFeaturedCluster

Ten interfejs API służy do usuwania treści z wyróżnionego klastra.

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

Gdy usługa otrzyma żądanie, usunie dotychczasowe dane z wyróżnionego klastra. W przypadku błędu cała prośba zostanie odrzucona, a dotychczasowy stan zostanie zachowany.

deleteShoppingCartCluster

Ten interfejs API służy do usuwania zawartości klastra koszyka.

Kotlin

client.deleteShoppingCartCluster()

Java

client.deleteShoppingCartCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra koszyka. W przypadku błędu cała prośba zostanie odrzucona, a dotychczasowy stan zostanie zachowany.

deleteShoppingListCluster

Ten interfejs API służy do usuwania zawartości klastra listy zakupów.

Kotlin

client.deleteShoppingListCluster()

Java

client.deleteShoppingListCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra listy zakupów. W przypadku błędu cała prośba jest odrzucana i zachowywany jest dotychczasowy stan.

deleteShoppingReorderCluster

Ten interfejs API służy do usuwania treści z klastra ponownego zamawiania w Zakupach Google.

Kotlin

client.deleteShoppingReorderCluster()

Java

client.deleteShoppingReorderCluster();

Gdy usługa otrzyma prośbę, usunie dotychczasowe dane z klastra ponownego zamawiania w Zakupach Google. W przypadku błędu cała prośba jest odrzucana i zachowywany jest dotychczasowy stan.

deleteShoppingOrderTrackingCluster

Ten interfejs API służy do usuwania treści z klastra śledzenia zamówień w Zakupach Google.

Kotlin

client.deleteShoppingOrderTrackingCluster()

Java

client.deleteShoppingOrderTrackingCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra śledzenia zamówień w Zakupach Google. W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan jest zachowywany.

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_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      ...
      .build())

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                ...
                .build());

Gdy usługa otrzyma żądanie, usunie istniejące dane ze wszystkich klastrów pasujących do określonych typów klastrów. Klienci mogą przekazywać jeden lub wiele typów klastrów. W przypadku błędu cał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 nie jest dostępna w momencie połączenia (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 rozgłaszania 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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast
  // is received
  // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast
  // is received
  // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
  // received
  // Trigger shopping order tracking cluster publish when
  // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER 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 Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Reorder Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping Order Tracking Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                           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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast is
// received

// Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_SHOPPING_ORDER_TRACKING_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),
                         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 Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping Order Tracking Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

}

  • Statycznie zadeklaruj implementację za pomocą tagu <receiver> w pliku AndroidManifest.xml. Dzięki temu aplikacja może odbierać intencje transmisji, gdy nie jest uruchomiona, a także publikować treści.

<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.shopping.PUBLISH_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER" />
      </intent-filter>
   </receiver>
</application>

Usługa wysyła te intencje:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Zalecamy rozpoczęcie publishRecommendationClusterspołączenia, gdy otrzymamy ten zamiar.
  • com.google.android.engage.action.PUBLISH_FEATURED Zalecamy rozpoczęcie połączenia publishFeaturedCluster po otrzymaniu tej intencji.
  • com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART Zalecamy rozpoczęcie połączenia publishShoppingCart po otrzymaniu tej intencji.
  • com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST Zalecamy rozpoczęcie połączenia publishShoppingList po otrzymaniu tej intencji.
  • com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER Zalecamy rozpoczęcie połączenia publishReorderCluster po otrzymaniu tej intencji.
  • com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER Zalecamy rozpoczęcie połączenia publishShoppingOrderTrackingCluster po otrzymaniu tej intencji.

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 Nasz zespół odpowie tak szybko, jak to możliwe.

Dalsze kroki

Po zakończeniu integracji wykonaj te czynności:

  • Wyślij e-maila na adres engage-developers@google.com i załącz zintegrowany pakiet APK gotowy do testowania przez Google.
  • Google przeprowadza weryfikację i sprawdza wewnętrznie, czy integracja działa zgodnie z oczekiwaniami. Jeśli zajdzie taka potrzeba, skontaktujemy się z Tobą, aby przekazać niezbędne informacje.
  • Gdy testy zostaną zakończone i nie będą potrzebne żadne zmiany, skontaktujemy się z Tobą, aby poinformować Cię, że możesz rozpocząć publikowanie zaktualizowanego i zintegrowanego pliku APK w Sklepie Play.
  • Gdy Google potwierdzi, że zaktualizowany pakiet APK został opublikowany w Sklepie Play, Twoje klastry Rekomendacja, Wyróżnione, Koszyk, Lista zakupów, Ponowne zamówienie i Śledzenie zamówienia mogą zostać opublikowane i będą widoczne dla użytkowników.