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

Google tworzy platformę na urządzeniu, która porządkuje aplikacje użytkowników według branż i zapewnia nowe, immersyjne środowisko do przeglądania i odkrywania treści z aplikacji. Tryb pełnoekranowy daje partnerom deweloperom możliwość zaprezentowania swoich najlepszych treści w ramach dedykowanego kanału poza aplikacją.

Ten przewodnik zawiera instrukcje dla deweloperów dotyczące integrowania treści umożliwiających zakupy za pomocą pakietu Engage SDK, aby wypełniać nowe i dotychczasowe platformy Google, np. Entertainment Space.

Szczegóły integracji

Terminologia

Ta integracja obejmuje 5 typów klastrów: Rekomendacja, Polecane, Koszyk, Lista zakupów, Ponowne zamówienie i Śledzenie zamówienia zakupów.

• Klastry rekomendacji pokazują spersonalizowane sugestie zakupów od konkretnego partnera deweloperów. Mogą być spersonalizowane pod kątem użytkownika lub uogólnione (np. dotyczące pozycji zyskujących popularność). Używaj ich do wyświetlania produktów, wydarzeń, wyprzedaży, promocji i subskrypcji.

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

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

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

• Klaster Polecane zawiera zbiór elementów od wielu partnerów programistów w jednym układzie interfejsu. Będzie jeden wyróżniony klaster, który będzie wyświetlany u góry interfejsu w priorytetowym miejscu nad wszystkimi innymi klastrami rekomendacji. Każdy partner programistów będzie mógł transmitować do 10 elementów w klastrze Polecany.

• Grupa Koszyk zawiera podgląd koszyków wielu partnerów deweloperów w jednym układzie interfejsu, zachęcając użytkowników do sfinalizowania otwartych koszyków. Jest jeden klaster koszyka, który jest wyświetlany u góry interfejsu i ma priorytet nad wszystkimi innymi klastrami rekomendacji. Każdy partner deweloper może transmitować maksymalnie 3 ShoppingCart instancje w klastrze koszyka zakupowego.

  Koszyk ma następującą strukturę:

  • Klaster koszyka zakupowego: widok interfejsu z grupą podglądów koszyka zakupowego od wielu partnerów programistów.

  • ShoppingCart: obiekt reprezentujący podgląd koszyka zakupowego dla pojedynczego partnera dewelopera, który ma być wyświetlany w klastrze ShoppingCart. Pole ShoppingCart musi pokazywać łączną liczbę produktów w koszyku. Może też zawierać obrazy niektórych produktów w koszyku użytkownika.

• Klaster Lista zakupów zawiera podgląd list zakupów od wielu partnerów deweloperów w jednym obszarze interfejsu, a także prośbę o powrót do odpowiedniej aplikacji w celu zaktualizowania i uzupełnienia list. Jest jeden klaster listy zakupów.

• Klaster Zmień kolejność pokazuje wcześniejsze zamówienia od kilku partnerów deweloperów w jednej grupie UI, co informuje użytkowników o zmianie kolejności. Jest 1 klaster „Zmien kolejność”.

  • Grupa ponownego zamówienia musi zawierać łączną liczbę produktów z poprzedniego zamówienia użytkownika. Musi też zawierać co najmniej jedną z tych informacji:

    • Obrazy X elementów z poprzedniego zamówienia użytkownika.
    • Etykiety X produktów w poprzednim zamówieniu użytkownika.

• Klaster Śledzenie zamówień daje Ci podgląd oczekujących lub niedawno zrealizowanych zamówień od wielu deweloperów w jednym pogrupowaniu w interfejsie, co pozwala użytkownikom śledzić swoje zamówienia.

  U góry interfejsu użytkownika znajduje się pojedynczy klaster ShoppingOrderTracking. Miejsce docelowe ma priorytet nad wszystkimi klastrami rekomendacji. Każdy partner programistów może transmitować wiele elementów ShoppingOrderTrackingEntity w klastrze śledzenia zamówień.

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

    • Klaster śledzenia zamówień zakupowych: 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 produktowego dla pojedynczego partnera deweloperskiego, który ma być wyświetlany w klastrze śledzenia zamówienia produktowego. ShoppingOrderTrackingEntity musi zawierać stan zamówienia i czas jego złożenia. Zdecydowanie zalecamy wypełnienie pola oczekiwany czas dostawy w przypadku ShoppingOrderTrackingEntity, ponieważ jest ono wyświetlane 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 w Androidzie 11.

Podsumowanie

Projekt jest oparty na implementacji usługi z ograniczeniami.

Dane, które klient może publikować, podlegają następującym ograniczeniom w przypadku różnych typów klastrów:

Krok 1. Podaj dane o podmiocie

Pakiet SDK definiuje różne elementy, które reprezentują poszczególne typy elementów. W przypadku kategorii Zakupy obsługiwane są te elementy:

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

W tabelach poniżej znajdziesz dostępne atrybuty i wymagania dotyczące poszczególnych typów.

ShoppingEntity

Obiekt ShoppingEntity reprezentuje produkt, promocję, umowę, subskrypcję lub zdarzenie, które partnerzy deweloperów chcą opublikować.

ShoppingEntity

ShoppingCart

ShoppingList

ShoppingReorderCluster

ShoppingOrderTrackingCluster

Specyfikacja obrazu

Wymagania dotyczące komponentów z obrazem:

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, by obraz wyświetlał się prawidłowo w ustawieniach ciemnego i jasnego motywu.

Krok 2. Podaj dane klastra

Zalecamy, aby zadanie publikowania treści było wykonywane w tle (np. za pomocą WorkManagera) i zaplanowane regularnie lub w reakcji na zdarzenie (np. za każdym razem, gdy użytkownik otworzy aplikację lub doda coś do koszyka).

AppEngageShoppingClient odpowiada za publikowanie klastrów produktowych.

Aby publikować klastry w kliencie, możesz korzystać z tych interfejsów 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 można wyświetlić treści na urządzeniu.

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

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:

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

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 wykona te działania:

• Wszystkie istniejące dane klastra rekomendacji zostaną usunięte.
• Dane z zapytania są analizowane i przechowywane w nowych klastrach rekomendacji.

W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.

publishFeaturedCluster

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

client.publishFeaturedCluster(
            PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    FeaturedCluster.Builder()
                        ...
                        .build())
                .build())

client.publishFeaturedCluster(
            new PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    new FeaturedCluster.Builder()
                        ...
                        .build())
                .build());

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

• Dotychczasowe dane FeaturedCluster pochodzące od partnera dewelopera zostaną usunięte.
• Dane z żądania są analizowane i przechowywane w zaktualizowanym polecanym klastrze.

W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.

publishShoppingCart

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

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

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

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

• Dotychczasowe dane ShoppingCart pochodzące od partnera dewelopera zostaną usunięte.
• Dane z zapytania są analizowane i przechowywane w zaktualizowanym klastrze koszyka z zakupami.

W przypadku błędu żądanie w całości jest odrzucane, a obecny stan zostaje zachowany.

publishShoppingCarts

Ten interfejs API służy do publikowania wielu obiektów ShoppingCart. Dotyczy to partnera deweloperskiego publikującego osobne koszyki dla każdego sprzedawcy. Jeśli używasz tego interfejsu API, podaj w tytule nazwę sprzedawcy.

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

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

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

• Dotychczasowe dane ShoppingCart pochodzące od partnera dewelopera zostaną usunięte.
• Dane z zapytania są analizowane i przechowywane w zaktualizowanym klastrze koszyka z zakupami.

W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.

publishShoppingList

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

client.publishFoodShoppingList(
            PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build())

client.publishFoodShoppingList(
            new PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    new FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build());

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

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

W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.

publishShoppingReorderCluster

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

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

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

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

• Dotychczasowe dane ShoppingReorderCluster pochodzące od partnera dewelopera zostaną usunięte.
• Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze Zmień kolejność.

W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.

publishShoppingOrderTrackingCluster

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

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

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

Gdy usługa otrzyma żądanie, w ramach jednej transakcji wykona 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 Google.

W przypadku błędu żądanie w całości jest odrzucane, a obecny stan zostaje zachowany.

publishUserAccountManagementRequest

Ten interfejs API służy do publikowania karty logowania. Logowanie kieruje użytkowników na stronę logowania w aplikacji, na której aplikacja może publikować treści (lub udostępniać treści bardziej spersonalizowane).

Te metadane są częścią karty logowania:

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());

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 wykona te działania:

• Dotychczasowe dane UserAccountManagementCluster od partnera dewelopera zostaną usunięte.
• Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze UserAccountManagementCluster.

W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.

updatePublishStatus

Jeśli z jakiegokolwiek wewnętrznego powodu biznesowego żaden z tych klastrów nie został opublikowany, zdecydowanie zalecamy zaktualizowanie stanu publikacji za pomocą interfejsu updatePublishStatus API. To ważne, ponieważ :

• Podanie stanu we wszystkich scenariuszach, nawet gdy treści są opublikowane (STATUS = PUBLISHED), jest kluczowe dla wypełniania paneli, które używają tego stanu do wyświetlania stanu i innych danych integracji.
• Jeśli nie ma opublikowanych treści, ale integracja nie jest uszkodzona (STATUS = NOT_PUBLISHED), Google może nie uruchamiać alertów na panelach danych dotyczących zdrowia w aplikacji. Potwierdza, że treści nie są publikowane z powodu oczekiwanej sytuacji z punktu widzenia dostawcy.
• Pomaga on deweloperom określić, kiedy dane są publikowane, a kiedy nie.
• Google może używać kodów stanu, aby skłonić użytkownika do wykonania określonych działań w aplikacji, aby mógł on wyświetlić zawartość aplikacji lub rozwiązać problem.

Lista kodów stanu publikacji, które kwalifikują się do opublikowania:

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

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

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

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

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

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

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

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

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

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

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

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

deleteRecommendationClusters

Ten interfejs API służy do usuwania zawartości klastrów rekomendacji.

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

Gdy usługa otrzyma prośbę, usunie istniejące dane z klastrów rekomendacji. W przypadku błędu cała prośba zostaje odrzucona, a obecny stan jest zachowany.

deleteFeaturedCluster

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

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

Po otrzymaniu żądania usługa usuwa istniejące dane z polecanego klastra. W przypadku błędu cała prośba zostaje odrzucona, a obecny stan jest zachowany.

deleteShoppingCartCluster

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

client.deleteShoppingCartCluster()

client.deleteShoppingCartCluster();

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

deleteShoppingListCluster

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

client.deleteShoppingListCluster()

client.deleteShoppingListCluster();

Po otrzymaniu żądania usługa usuwa istniejące dane z klastra listy zakupów. W przypadku błędu cała prośba zostaje odrzucona, a obecny stan jest zachowany.

deleteShoppingReorderCluster

Ten interfejs API służy do usuwania zawartości klastra zmiany kolejności w Zakupach Google.

client.deleteShoppingReorderCluster()

client.deleteShoppingReorderCluster();

Gdy usługa otrzyma żądanie, usuwa istniejące dane z grupy ponownego zamówienia w zakupach. W przypadku błędu cała prośba zostaje odrzucona, a obecny stan jest zachowany.

deleteShoppingOrderTrackingCluster

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

client.deleteShoppingOrderTrackingCluster()

client.deleteShoppingOrderTrackingCluster();

Po otrzymaniu żądania usługa usuwa istniejące dane z klastra śledzenia zamówień. W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.

deleteUserManagementCluster

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

client.deleteUserManagementCluster()

client.deleteUserManagementCluster();

Gdy usługa otrzyma żądanie, usuwa istniejące dane z klastra UserAccountManagement. W przypadku błędu cała prośba jest odrzucana, a obecny stan jest zachowany.

deleteClusters

Ten interfejs API służy do usuwania treści danego typu klastra.

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

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 żądanie w całości jest odrzucane, a obecny stan zostaje zachowany.

Obsługa błędów

Zdecydowanie zalecamy wsłuchiwanie się w wyniki zadania z interfejsów API do publikowania, aby móc podjąć dalsze działania w celu odzyskania i ponownego przesłania udanego zadania.

client.publishRecommendationClusters(
        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
            }
          }
        }
      }

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

Błąd jest zwracany jako AppEngageException, a jego przyczyna jest podana w postaci kodu błędu.

Krok 3. Obsługa intencji przesyłania

Oprócz wywoływania interfejsu Content API za pomocą zadania musisz też skonfigurować BroadcastReceiver, aby odbierać prośby o publikowanie treści.

Celem intencji transmisji jest głównie ponowna aktywacja aplikacji i wymuszenie synchronizacji danych. Intencje dotyczące transmisji nie są przeznaczone do wysyłania bardzo często. Jest ona wywoływana tylko wtedy, gdy usługa Engage stwierdzi, że treści mogą być nieaktualne (np. mają tydzień). Dzięki temu użytkownik ma pewność, że będzie mieć dostęp do aktualnych treści, nawet jeśli aplikacja nie była uruchamiana przez długi czas.

Element BroadcastReceiver musi być skonfigurowany w jednym z tych 2 sposobów:

• Dynamicznie zarejestruj instancję klasy BroadcastReceiver za pomocą funkcji Context.registerReceiver(). Umożliwia to komunikację z aplikacji, które są nadal aktywne w pamięci.

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

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))

// Register Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART))

// Register Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST))

// Register Reorder Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER))

// Register Shopping Order Tracking Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER))
}

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

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

// Register Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART));

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

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

// 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));

}

• Statycznie deklaruj implementację z tagiem <receiver> w pliku AndroidManifest.xml. Dzięki temu aplikacja może otrzymywać intencje transmisji, gdy nie jest uruchomiona, i może publikować treści.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.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 zamiary:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Zalecamy rozpoczęcie wywołania publishRecommendationClusters po otrzymaniu tej zamiaru.
• com.google.android.engage.action.PUBLISH_FEATUREDZalecamy rozpoczęcie wywołania publishFeaturedCluster po otrzymaniu tej intencji.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART Zaleca się rozpoczęcie wywołania publishShoppingCart po otrzymaniu tej intencji.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LISTZalecamy rozpoczęcie wywołania publishShoppingList po otrzymaniu tej intencji.
• com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTERZalecamy rozpoczęcie wywołania publishReorderCluster po otrzymaniu tej intencji.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER Gdy otrzymasz tę intencję, zalecamy nawiązanie połączenia publishShoppingOrderTrackingCluster.

Proces integracji

Szczegółowy przewodnik dotyczący weryfikacji integracji po jej zakończeniu znajdziesz w artykule Procedura integracji Engage z aplikacją dewelopera.

Najczęstsze pytania

Najczęstsze pytania dotyczące Engage SDK znajdziesz w artykule Najczęstsze pytania dotyczące Engage SDK.

Kontakt

Jeśli masz pytania dotyczące procesu integracji, wyślij e-maila na adres engage-developers@google.com. Nasz zespół odpowiada tak szybko, jak to możliwe.

Dalsze kroki

Po zakończeniu integracji należy wykonać następujące czynności:

• Wyślij e-maila na adres engage-developers@google.com i załącz zintegrowany pakiet APK, który jest gotowy do przetestowania przez Google.
• Google przeprowadza weryfikację i sprawdza integrację wewnętrznie, aby upewnić się, że działa ona zgodnie z oczekiwaniami. Jeśli zajdzie taka potrzeba, Google skontaktuje się z Tobą i przekaże Ci wszelkie niezbędne informacje.
• Gdy testy zostaną zakończone i nie trzeba będzie wprowadzać żadnych zmian, skontaktujemy się z Tobą, aby poinformować, że możesz rozpocząć publikowanie zaktualizowanego i zintegrowanego pliku APK w Sklepie Play.
• Gdy Google potwierdzi, że zaktualizowany plik APK został opublikowany w Sklepie Play, Twoje grupy Rekomendacja, Polecane, Koszyk, Lista zakupów, Klaster ponownego zamówienia i Klaster śledzenia zamówień mogą zostać opublikowane i widoczne dla użytkowników.