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 deweloperów dotyczące dostarczania treści promujących produkty na platformy Engage.

Obsługa kategorii i platformy

Kwalifikacja do korzystania z platformy Engage SDK zależy od kategorii treści aplikacji. W tabeli poniżej możesz sprawdzić, czy kwalifikujesz się do wyświetlania produktów na określonych platformach:

android skills add engage-sdk-integration

Szczegóły integracji

W tej sekcji opisujemy kroki, modele danych i terminologię wymagane do integracji z pakietem Engage SDK w przypadku treści promujących produkty.

Terminologia

Ta integracja obejmuje 5 typów klastrów: Rekomendacja, Polecane, 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 promowania produktów, wydarzeń, wyprzedaży, promocji i subskrypcji.

  Rekomendacje mają taką strukturę:

  • Grupa rekomendacji: widok interfejsu zawierający grupę rekomendacji od tego samego partnera deweloperskiego.

  • ShoppingEntity:obiekt reprezentujący pojedynczy element 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 od wielu partnerów programistów w jednym układzie interfejsu, co zachęca użytkowników do sfinalizowania zakupów. Dostępny jest jeden klaster koszyka, który jest wyświetlany u góry interfejsu w priorytetowym miejscu nad wszystkimi innymi klastrami rekomendacji. Każdy partner deweloper może transmitować maksymalnie 3 instancje ShoppingCart w klastrze Koszyk.

  Koszyk na zakupy ma następującą strukturę:

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

  • ShoppingCart:obiekt reprezentujący podgląd koszyka na zakupy jednego partnera dewelopera, który ma być wyświetlany w klastrze koszyka na zakupy. ShoppingCart musi wyświetlać łączną liczbę produktów w koszyku i może też zawierać zdjęcia 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ęcając użytkowników do powrotu do odpowiedniej aplikacji w celu zaktualizowania i uzupełnienia list. Istnieje jedna grupa „Lista zakupów”.

• Klaster Zamów ponownie pokazuje podgląd poprzednich zamówień od wielu partnerów deweloperów w jednej grupie interfejsu, zachęcając użytkowników do ponownego zamówienia. Istnieje tylko 1 klaster ponownego zamawiania.

  • Grupa „Zamów ponownie” musi zawierać łączną liczbę produktów w poprzednim zamówieniu użytkownika, a także jeden z tych elementów:

    • 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ń w Zakupach 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ń.

  U góry interfejsu wyświetlany jest 1 klaster ShoppingOrderTracking, który ma priorytetowe miejsce nad wszystkimi innymi klastrami rekomendacji. Każdy partner deweloper może transmitować wiele elementów ShoppingOrderTrackingEntity w klastrze śledzenia zamówień w Zakupach Google.

  • Struktura klastra ShoppingOrderTrackingCluster:

    • ShoppingOrderTracking Cluster: widok interfejsu, który zawiera grupę podglądów śledzenia zamówień od wielu partnerów programistów.
    • ShoppingOrderTrackingEntity: obiekt reprezentujący podgląd śledzenia zamówienia na zakupy dla jednego partnera dewelopera, który ma być wyświetlany w grupie śledzenia zamówień na zakupy. Element ShoppingOrderTrackingEntity musi zawierać stan zamówienia i czas jego złożenia. Zdecydowanie zalecamy wypełnienie pola oczekiwanego czasu dostawy w przypadku ShoppingOrderTrackingEntity, ponieważ jest on wyświetlany użytkownikom, gdy jest podany.

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

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

Podsumowanie

Projekt jest oparty na implementacji powiązanej usługi.

Dane, które klient może opublikować, podlegają tym limitom w przypadku różnych typów klastrów:

Krok 1. Podaj dane podmiotu

Pakiet SDK definiuje różne encje reprezentujące poszczególne typy produktów. W przypadku kategorii Zakupy obsługiwane są te encje:

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

Poniższe tabele zawierają dostępne atrybuty i wymagania dotyczące każdego typu.

ShoppingEntity

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

ShoppingEntity

ShoppingCart

ShoppingList

ShoppingReorderCluster

ShoppingOrderTrackingCluster

Specyfikacja obrazu

W tabeli poniżej znajdziesz wymagane specyfikacje komponentów z obrazem:

Formaty plików

PNG, JPG, statyczny GIF, WebP

Maksymalny rozmiar pliku

5120 KB

Dodatkowe zalecenia

• Zawsze widoczny obszar obrazu: ważne treści umieść w środkowych 80% obrazu.
• Użyj przezroczystego tła, aby obraz był prawidłowo wyświetlany w ustawieniach 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 było zaplanowane regularnie lub na podstawie zdarzenia (np. za każdym razem, gdy użytkownik otwiera aplikację lub gdy doda coś do koszyka).

AppEngageShoppingClient odpowiada za publikowanie klastrów zakupowych.

W kliencie są dostępne te interfejsy API do publikowania klastrów:

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishShoppingCarts
• publishShoppingLists
• publishShoppingReorderCluster
• publishShoppingOrderTrackingCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteShoppingCartCluster
• deleteShoppingListCluster
• deleteReorderCluster
• deleteShoppingOrderTrackingCluster
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

Ten interfejs API służy do sprawdzania, czy usługa jest dostępna do integracji i czy treści mogą być wyświetlane na urządzeniu.

Pakiet Engage SDK w wersji 1.6.0 lub nowszej (zalecany)

android skills add engage-sdk-integration

Use the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.

Możesz sprawdzić dostępność usługi dla każdego typu klastra, który chcesz opublikować. Interfejs API isServiceAvailable akceptuje obiekt żądania ServiceAvailabilityRequest, który zawiera typy klastrów, dla których należy sprawdzić dostępność usługi. Wartości typu wyliczeniowego ClusterType wymagane w przypadku ServiceAvailabilityRequest znajdziesz w tabeli poniżej.

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
});

Funkcja warunkowej dostępności usługi

Niektóre zintegrowane aplikacje wymagają specjalnej konfiguracji, która okresowo włącza i wyłącza usługę Engage, aby obniżyć koszty wyświetlania. Jednak ta strategia przerywanego przetwarzania treści negatywnie wpływa na wrażenia użytkowników: nieaktualne treści nie będą wyświetlane, a niektóre platformy nie będą obsługiwane.

Od wersji 1.6.0 pakiet Engage SDK umożliwia sprawdzanie dostępności określonych typów klastrów. Jeśli Twoja aplikacja korzysta z przetwarzania przerywanego:

• Klastry kontynuacji (takie jak koszyk, lista zakupów, ponowne zamówienie i śledzenie zamówienia) pozostają domyślnie włączone na wszystkich obsługiwanych urządzeniach.
• Inne typy klastrów (np. rekomendacje) są włączane i wyłączane okresowo.

Jeśli ta domyślna konfiguracja nie odpowiada Twoim potrzebom, skontaktuj się z nami pod adresem engage-developers@google.com.

Wersje pakietu SDK starsze niż 1.6.0 (wycofane)

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

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

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

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

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

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

publishShoppingCarts

Ten interfejs API służy do publikowania listy obiektów ShoppingCart. Dotyczy to partnera dewelopera, który publikuje osobne koszyki dla każdego sprzedawcy. Podczas korzystania z tego interfejsu API uwzględnij 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 zostaną wykonane te działania:

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

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

publishShoppingLists

Ten interfejs API służy do publikowania listy obiektów ShoppingList.

client.publishShoppingLists(
            PublishShoppingListsRequest.Builder()
                .addShoppingList(
                    ShoppingList.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingLists(
            new PublishShoppingListsRequest.Builder()
                .addShoppingList(
                    new ShoppingList.Builder()
                        ...
                        .build())
                .build());

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

• Dotychczasowe dane ShoppingList od partnera 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 i zachowywany jest dotychczasowy stan.

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

• Dotychczasowe dane ShoppingReorderCluster od partnera dewelopera zostaną usunięte.
• Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze ponownego zamówienia.

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

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

• Istniejące 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 całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

publishUserAccountManagementRequest

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

Karta logowania zawiera te metadane:

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

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

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

updatePublishStatus

Jeśli z jakiegoś powodu żaden z klastrów nie zostanie opublikowany, zdecydowanie zalecamy zaktualizowanie stanu publikacji za pomocą interfejsu API updatePublishStatus. To ważne, ponieważ :

• Podawanie stanu we wszystkich scenariuszach, nawet gdy treść jest opublikowana (STATUS == PUBLISHED), ma kluczowe znaczenie dla wypełniania paneli, które używają tego stanu do przekazywania informacji o stanie i innych danych dotyczących integracji.
• Jeśli nie opublikowano żadnych treści, ale stan integracji nie jest uszkodzony (STATUS == NOT_PUBLISHED), Google może uniknąć wywoływania alertów w panelach stanu aplikacji. Potwierdza, że treści nie zostały opublikowane z powodu oczekiwanej sytuacji z punktu widzenia dostawcy.
• Pomaga deweloperom dostarczać informacje o tym, kiedy dane są publikowane, a kiedy nie.
• Google może używać kodów stanu, aby zachęcić użytkownika do wykonania określonych działań w aplikacji, dzięki czemu będzie on mógł zobaczyć 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.

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

deleteRecommendationsClusters

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

client.deleteRecommendationsClusters()

client.deleteRecommendationsClusters();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastrów rekomendacji. W przypadku błędu całe żądanie zostanie odrzucone i zostanie zachowany dotychczasowy stan.

deleteFeaturedCluster

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

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra polecanych. W przypadku błędu całe żądanie zostanie odrzucone i zostanie zachowany dotychczasowy stan.

deleteShoppingCartCluster

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

client.deleteShoppingCartCluster()

client.deleteShoppingCartCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra koszyka. W przypadku błędu całe żądanie zostanie odrzucone i zostanie zachowany dotychczasowy stan.

deleteShoppingListCluster

Ten interfejs API służy do usuwania zawartości grupy „Lista zakupów”.

client.deleteShoppingListCluster()

client.deleteShoppingListCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra listy zakupów. W przypadku błędu całe żądanie zostanie odrzucone i zostanie zachowany dotychczasowy stan.

deleteReorderCluster

Ten interfejs API służy do usuwania zawartości klastra ponownego zamówienia w Zakupach Google.

client.deleteReorderCluster()

client.deleteReorderCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra ponownego zamawiania zakupów. W przypadku błędu całe żądanie zostanie odrzucone i zostanie zachowany dotychczasowy stan.

deleteShoppingOrderTrackingCluster

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

client.deleteShoppingOrderTrackingCluster()

client.deleteShoppingOrderTrackingCluster();

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

deleteUserManagementCluster

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

client.deleteUserManagementCluster()

client.deleteUserManagementCluster();

Gdy usługa otrzyma żądanie, usunie istniejące dane z klastra UserAccountManagement. W przypadku błędu całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

deleteClusters

Ten interfejs API służy do usuwania zawartoś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 całe żądanie jest odrzucane i zachowywany jest dotychczasowy stan.

Obsługa błędów

Zdecydowanie zalecamy nasł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 się nie powiodło.

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 jako kod błędu.

Krok 3. Obsługa intencji rozgłaszania

Oprócz wywoływania interfejsu API do publikowania treści za pomocą zadania musisz też skonfigurować BroadcastReceiver, aby otrzymywać żądania publikowania treści.

Celem intencji rozgłaszania jest głównie reaktywacja aplikacji i wymuszenie synchronizacji danych. Intencje rozgłaszania nie są przeznaczone do częstego wysyłania. Jest wywoływana tylko wtedy, gdy usługa Engage określi, że treści mogą być nieaktualne (np. mają tydzień). Dzięki temu użytkownik może mieć pewność, że zobaczy aktualne treści, nawet jeśli aplikacja nie była uruchamiana przez dłuższy czas.

BroadcastReceiver należy skonfigurować na 2 sposoby:

• Zarejestruj dynamicznie instancję klasy BroadcastReceiver za pomocą Context.registerReceiver(). Umożliwia to komunikację z aplikacjami, 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),
                           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)
}

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

}

• Zadeklaruj statycznie 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 Po otrzymaniu tej intencji zalecamy rozpoczęcie połączenia publishRecommendationClusters.
• com.google.android.engage.action.PUBLISH_FEATURED Zalecamy rozpoczęcie połączenia publishFeaturedCluster, gdy otrzymasz tę intencję.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART Zalecamy rozpoczęcie połączenia publishShoppingCarts, gdy otrzymasz tę intencję.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST Zalecamy rozpoczęcie połączenia publishShoppingLists, gdy otrzymasz tę intencję.
• com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER Zalecamy rozpoczęcie połączenia publishReorderCluster, gdy otrzymasz tę intencję.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER Po otrzymaniu tej intencji zalecamy rozpoczęcie połączenia publishShoppingOrderTrackingCluster.

Przepływ pracy integracji

Szczegółowe instrukcje dotyczące weryfikacji integracji po jej zakończeniu znajdziesz w artykule Proces integracji dla deweloperów Engage.

Najczęstsze pytania

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

Kontakt

Jeśli masz pytania dotyczące procesu integracji, skontaktuj się z 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 plik APK, który jest gotowy do przetestowania przez Google.
• Google przeprowadza weryfikację i sprawdza wewnętrznie, czy integracja działa zgodnie z oczekiwaniami. Jeśli konieczne będą zmiany, Google skontaktuje się z Tobą i poda niezbędne informacje.
• Jeśli testy zakończą się pomyślnie i nie będą potrzebne żadne zmiany, Google skontaktuje się z Tobą, aby poinformować, że możesz zacząć publikować zaktualizowany i zintegrowany pakiet APK w Sklepie Play.
• Gdy Google potwierdzi, że zaktualizowany pakiet APK został opublikowany w Sklepie Play, grupy Rekomendacja, Polecane, Koszyk, Lista zakupów, Grupa ponownego zamówienia i Grupa śledzenia zamówienia mogą zostać opublikowane i być widoczne dla użytkowników.