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 na platformy treści Engage.

Obsługa kategorii i platform

Dostępność platformy Engage SDK zależy od kategorii treści aplikacji. W tabeli poniżej możesz sprawdzić, czy kwalifikujesz się do korzystania z określonych platform:

android skills add engage-sdk-integration

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 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, zachęcając użytkowników do sfinalizowania zakupów. Jeden klaster Koszyk 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 instancje ShoppingCart 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.

  • Koszyk na zakupy: obiekt reprezentujący podgląd koszyka na zakupy dla jednego partnera, który ma być wyświetlany w grupie Koszyk na zakupy. ShoppingCart musi zawierać łączną liczbę produktów w koszyku, a także może 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ęcając użytkowników do powrotu do odpowiedniej aplikacji w celu zaktualizowania i uzupełnienia list. 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 tylko jeden klaster Zmień kolejność.

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

    • Obrazy X produktów z poprzedniego zamówienia użytkownika.
    • Etykiety 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 zakupach dla jednego partnera programisty, który ma być wyświetlany w grupie Śledzenie zamówienia w zakupach. Obiekt ShoppingOrderTrackingEntity musi zawierać stan zamówienia i czas zamówienia. Zdecydowanie zalecamy wypełnienie pola oczekiwanego czasu dostawy w przypadku ShoppingOrderTrackingEntity, ponieważ jest ono wyświetlane użytkownikom, jeśli zostanie podane.

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 publikować, podlegają tym limitom w przypadku różnych typów klastrów:

Krok 1. Podaj dane podmiotu

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

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

Wykresy poniżej przedstawiają dostępne atrybuty i wymagania dotyczące każdego typu.

ShoppingEntity

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

ShoppingEntity

ShoppingCart

ShoppingList

ShoppingReorderCluster

ShoppingOrderTrackingCluster

Specyfikacja obrazu

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

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żywaj 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 otworzy aplikację lub 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
• deleteShoppingReorderCluster
• deleteShoppingOrderTrackingCluster
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

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

W przypadku pakietu Engage SDK w wersji 1.6.0 lub nowszej (zalecane)

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 isServiceAvailable API akceptuje obiekt żądania ServiceAvailabilityRequest, który zawiera typy klastrów, dla których należy sprawdzić dostępność usługi. W tabeli poniżej znajdziesz wartości wyliczeniowe ClusterType wymagane w przypadku ServiceAvailabilityRequest.

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 umożliwia okresowe włączanie i wyłączanie usługi Engage w celu zmniejszenia kosztów wyświetlania reklam. Ta strategia sporadycznego przetwarzania treści, choć możliwa, negatywnie wpływa na użytkownika i produkt – nie będą wyświetlane treści nieaktualne, a niektóre platformy nie będą w ogóle dostępne.

Od wersji 1.6.0 pakiet Engage SDK umożliwia sprawdzanie dostępności w przypadku określonych typów klastrów. Zapewnia to większą elastyczność, dzięki czemu w przypadku przyjęcia przez daną aplikację strategii dotyczącej treści przerywanego wyświetlania niektóre typy klastrów mogą stosować tę strategię, a inne typy klastrów mogą być zawsze włączone (np. klastry kontynuacji).

Jeśli usługa Engage nie powinna być „stale” włączona na wszystkich obsługiwanych urządzeniach z jakiegokolwiek powodu i jest skonfigurowana do przerywanego pozyskiwania danych na dowolnym zestawie urządzeń, wszystkie publikacje klastra kontynuacji (np. koszyk, lista zakupów, ponowne zamówienie i śledzenie zamówienia) będą domyślnie włączone, a pozostałe typy klastrów będą włączane i wyłączane przerywanie. Jeśli przerywane przesyłanie danych dotyczy Twojej firmy, ale ta domyślna konfiguracja nie odpowiada Twoim potrzebom, skontaktuj się z zespołem engage-developers@google.com.

W przypadku wersji pakietu SDK starszych niż 1.6.0 (wycofanych)

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 czynności:

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

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

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 czynności:

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

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

publishShoppingCarts

Ten interfejs API służy do publikowania listy obiektów ShoppingCart. Dotyczy to publikowania przez partnerów deweloperów osobnych koszyków dla każdego sprzedawcy. Podczas korzystania z tego interfejsu API w tytule należy podać 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 czynności:

• 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ła prośba jest odrzucana, a dotychczasowy stan jest zachowywany.

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 ShoppingListEntity.Builder()
                        ...
                        .build())
                .build());

Gdy usługa otrzyma żądanie, w ramach jednej transakcji zostaną wykonane te czynności:

• 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ła prośba jest odrzucana, a dotychczasowy stan jest zachowywany.

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 czynności:

• Dotychczasowe dane ShoppingReorderCluster od partnera dewelopera zostaną usunięte.
• Dane z prośby są analizowane i przechowywane w zaktualizowanym klastrze ponownego zamawiania.

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

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 czynności:

• 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 cała prośba jest odrzucana, a dotychczasowy stan jest zachowywany.

publishUserAccountManagementRequest

Ten interfejs API służy do publikowania karty logowania . Działanie logowania kieruje użytkowników na stronę logowania aplikacji, aby mogła ona publikować treści (lub dostarczać 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 czynności:

• 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 dotychczasowy stan jest zachowywany.

updatePublishStatus

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

• Podawanie stanu we wszystkich scenariuszach, nawet gdy treść jest opublikowana (STATUS == PUBLISHED), jest kluczowe do wypełniania paneli, które używają tego stanu do przekazywania informacji o kondycji i innych wskaźnikach integracji.
• Jeśli nie opublikowano żadnych treści, ale stan integracji nie jest przerwany (STATUS == NOT_PUBLISHED), Google może uniknąć wywoływania alertów na panelach stanu aplikacji. Potwierdza, że treści nie są publikowane z powodu oczekiwanej z punktu widzenia dostawcy sytuacji.
• Pomaga deweloperom dostarczać informacji o tym, 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ł 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());

deleteRecommendationClusters

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

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

Gdy usługa otrzyma prośbę, usunie dotychczasowe dane z klastrów rekomendacji. W przypadku błędu cała prośba jest odrzucana, a dotychczasowy stan pozostaje bez zmian.

deleteFeaturedCluster

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

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

Gdy usługa otrzyma prośbę, usunie dotychczasowe dane z wyróżnionego klastra. W przypadku błędu cała prośba jest odrzucana, a dotychczasowy stan pozostaje bez zmian.

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ła prośba jest odrzucana, a dotychczasowy stan pozostaje bez zmian.

deleteShoppingListCluster

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

client.deleteShoppingListCluster()

client.deleteShoppingListCluster();

Gdy usługa otrzyma prośbę, usunie dotychczasowe dane z klastra listy zakupów. W przypadku błędu cała prośba jest odrzucana, a dotychczasowy stan pozostaje bez zmian.

deleteShoppingReorderCluster

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

client.deleteShoppingReorderCluster()

client.deleteShoppingReorderCluster();

Gdy usługa otrzyma prośbę, usunie istniejące dane z klastra ponownego zamawiania w Zakupach Google. W przypadku błędu cała prośba jest odrzucana, a dotychczasowy stan pozostaje bez zmian.

deleteShoppingOrderTrackingCluster

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

client.deleteShoppingOrderTrackingCluster()

client.deleteShoppingOrderTrackingCluster();

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

deleteUserManagementCluster

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

client.deleteUserManagementCluster()

client.deleteUserManagementCluster();

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

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 prośbę, usunie dotychczasowe 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 zakończyło się powodzeniem.

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 obiekt AppEngageException, a jego przyczyna jest podana jako kod błędu.

Krok 3. Obsługa intencji transmisji

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

Celem intencji transmisji jest głównie ponowna aktywacja aplikacji i wymuszenie synchronizacji danych. Intencje rozgłaszania nie są przeznaczone do wysyłania z dużą częstotliwością. 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:

• Dynamicznie zarejestruj 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);

}

• Statycznie zadeklaruj implementację za pomocą tagu <receiver> w pliku AndroidManifest.xml. Umożliwia to aplikacji odbieranie intencji transmisji, gdy nie jest uruchomiona, a także publikowanie 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_RECOMMENDATIONZalecamy rozpoczęcie publishRecommendationClusters połączenia, gdy otrzymamy ten zamiar.
• com.google.android.engage.action.PUBLISH_FEATURED Zalecamy rozpoczęcie połączenia publishFeaturedCluster po otrzymaniu tego zamiaru.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART Zalecamy rozpoczęcie połączenia publishShoppingCarts po otrzymaniu tego zamiaru.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST Zalecamy rozpoczęcie połączenia publishShoppingLists po otrzymaniu tego zamiaru.
• com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER Zalecamy rozpoczęcie połączenia publishReorderCluster po otrzymaniu tego zamiaru.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTERZalecamy rozpoczęcie publishShoppingOrderTrackingCluster połączenia, gdy otrzymasz ten zamiar.

Przepływ pracy integracji

Szczegółowe instrukcje weryfikacji integracji po jej zakończeniu znajdziesz w artykule Proces integracji dla programistów w usłudze Engage.

Najczęstsze pytania

Odpowiedzi na najczęstsze pytania znajdziesz w Najczęstszych pytaniach dotyczących pakietu Engage SDK.

Kontakt

Jeśli podczas procesu integracji pojawią się pytania, skontaktuj się z zespołem 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 gotowy do testowania przez Google.
• Google przeprowadza weryfikację i sprawdza wewnętrznie, czy integracja działa zgodnie z oczekiwaniami. Jeśli konieczne będą zmiany, skontaktujemy się z Tobą, aby przekazać Ci niezbędne informacje.
• Gdy testy zostaną zakończone i nie będą potrzebne żadne zmiany, skontaktujemy się z Tobą, aby poinformować Cię, że możesz rozpocząć publikowanie zaktualizowanego i zintegrowanego pliku APK w Sklepie Play.
• Gdy potwierdzimy, że zaktualizowany plik 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.