Engage SDK Health and Fitness: instrukcje integracji technicznej z aplikacjami innych firm

Zwiększ zaangażowanie w aplikację, docierając do użytkowników tam, gdzie się znajdują. Zintegruj pakiet Engage SDK, aby wyświetlać spersonalizowane rekomendacje i treści kontynuacji bezpośrednio użytkownikom na różnych platformach na urządzeniu, takich jak Kolekcje, Entertainment Space i Sklep Play. Integracja zwiększa rozmiar średniego pliku APK (skompresowany) o mniej niż 50 KB i zajmuje deweloperom około tygodnia pracy. Więcej informacji znajdziesz na naszej stronie.

Ten przewodnik zawiera instrukcje dla partnerów deweloperów dotyczące dostarczania treści związanych ze zdrowiem i kondycją 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

Ta integracja obejmuje 3 typy klastrów: Rekomendacje, Wyróżnione i Kontynuacja.

• Rekomendacje to grupy zawierające spersonalizowane sugestie dotyczące zdrowia i sprawności fizycznej od konkretnego partnera deweloperskiego. Rekomendacje mogą być spersonalizowane dla danego użytkownika lub ogólne (np. popularne treści związane z aktywnością fizyczną i zdrowiem). Używaj ich do wyświetlania artykułów lub osób związanych ze zdrowiem i kondycją.

  • Klaster rekomendacji może składać się z ArticleEntity, PersonEntity lub EventEntity, ale nie z różnych typów jednostek.

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

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

  • Element:obiekt reprezentujący pojedynczy element w klastrze. Ta integracja udostępnia niektóre elementy, które byłyby wyświetlane w klastrze rekomendacji:

    • ArticleEntity: ArticleEntity reprezentuje rekomendację treści tekstowych związanych ze zdrowiem i aktywnością fizyczną. Można go używać do tworzenia artykułów, postów na blogu, treści marketingowych, fragmentów wiadomości itp.

      

    • PersonEntity: PersonEntity reprezentuje osobę. Rekomendacje mogą dotyczyć trenera lub innej osoby związanej ze zdrowiem i fitness, itp.

      

    • EventEntity: EventEntity reprezentuje wydarzenie, które odbędzie się w przyszłości. Czas rozpoczęcia wydarzenia to kluczowa informacja, którą należy przekazać użytkownikom. Ta jednostka może być używana do wyświetlania wydarzeń związanych ze zdrowiem i kondycją fizyczną, takich jak obozy krwiodawstwa, sesje treningowe, zajęcia na siłowni lub zajęcia jogi.

      

• Grupa Kontynuacja zawiera treści, z którymi użytkownicy ostatnio wchodzili w interakcję, od wielu partnerów deweloperskich w jednym układzie interfejsu. Każdy partner deweloper może transmitować maksymalnie 10 elementów w klastrze Kontynuacja.

  Treści kontynuacyjne mogą mieć następującą strukturę:

  • ArticleEntity: ArticleEntity reprezentuje rekomendację treści tekstowych związanych ze zdrowiem i aktywnością fizyczną. Może ona reprezentować niedokończone artykuły lub inne treści, które użytkownik chce kontynuować od miejsca, w którym je przerwał. Przykład: fragment artykułu z wiadomości, fragment wpisu na blogu dotyczący zdrowia lub fitnessu.

    

  • EventReservationEntity: EventReservationEntity reprezentuje rezerwację wydarzenia i pomaga użytkownikom śledzić nadchodzące lub trwające rezerwacje wydarzeń związanych z fitness i zdrowiem. Przykład: sesje szkoleniowe

    

• Grupa Polecane zawiera wybrane elementy od wielu partnerów programistów w jednym układzie interfejsu. Jeden wyróżniony klaster będzie wyświetlany u góry interfejsu w priorytetowym miejscu nad wszystkimi innymi klastrami rekomendacji. Każdy partner deweloper może transmitować maksymalnie 10 elementów w klastrze Polecane.

  • GenericFeaturedEntity: GenericFeaturedEntity różni się od elementu rekomendacji tym, że element polecany powinien być używany w przypadku pojedynczych najlepszych treści od deweloperów i powinien reprezentować najważniejsze treści, które będą interesujące i odpowiednie dla użytkowników.

    

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

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 Zdrowie i fitness obsługujemy te typy danych:

1. GenericFeaturedEntity
2. ArticleEntity
3. PersonEntity
4. EventEntity
5. EventReservationEntity

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

GenericFeaturedEntity

ArticleEntity

PersonEntity

EventEntity

EventReservationEntity

Specyfikacja obrazu

Wymagane specyfikacje komponentów z obrazem są wymienione w tej tabeli:

Obrazy muszą być hostowane w publicznych sieciach CDN, aby Google mógł uzyskać do nich dostęp.

Formaty plików

PNG, JPG, statyczny GIF, WebP

Maksymalny rozmiar pliku

5120 KB

Dodatkowe rekomendacje

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

Kategoria treści

Kategoria treści umożliwia aplikacjom publikowanie treści należących do wielu kategorii. Dzięki temu treści są przypisywane do niektórych wstępnie zdefiniowanych kategorii, takich jak:

• TYPE_EDUCATION
• TYPE_SPORTS
• TYPE_MOVIES_AND_TV_SHOWS
• TYPE_BOOKS
• TYPE_AUDIOBOOKS
• TYPE_MUSIC
• TYPE_DIGITAL_GAMES
• TYPE_TRAVEL_AND_LOCAL
• TYPE_HOME_AND_AUTO
• TYPE_BUSINESS
• TYPE_NEWS
• TYPE_FOOD_AND_DRINK
• TYPE_SHOPPING
• TYPE_HEALTH_AND_FITENESS
• TYPE_MEDICAL
• TYPE_PARENTING
• TYPE_DATING

Obrazy muszą być hostowane w publicznych sieciach CDN, aby Google mógł uzyskać do nich dostęp.

Wskazówki dotyczące korzystania z kategorii treści

1. Niektóre typy, takie jak ArticleEntity i GenericFeaturedEntity, mogą używać dowolnej kategorii treści. W przypadku innych typów obiektów, takich jak EventEntity, EventReservationEntity czy PersonEntity, kwalifikuje się tylko podzbiór tych kategorii. Przed wypełnieniem listy sprawdź listę kategorii kwalifikujących się do typu podmiotu.

2. W przypadku niektórych kategorii treści używaj konkretnego typu elementu zamiast kombinacji elementów ogólnych i kategorii treści:

   • TYPE_MOVIES_AND_TV_SHOWS – przed użyciem ogólnych elementów sprawdź elementy z przewodnika po integracji z zegarkiem.
   • TYPE_BOOKS – przed użyciem ogólnych elementów sprawdź EbookEntity.
   • TYPE_AUDIOBOOKS – przed użyciem ogólnych elementów sprawdź AudiobookEntity.
   • TYPE_SHOPPING – sprawdź ShoppingEntity przed użyciem ogólnych elementów.
   • TYPE_FOOD_AND_DRINK – przed użyciem ogólnych elementów zapoznaj się z elementami z przewodnika po integracji z usługami związanymi z jedzeniem.

3. Pole ContentCategory jest opcjonalne i należy je pozostawić puste, jeśli treść nie należy do żadnej z wcześniej wymienionych kategorii.

4. Jeśli podasz kilka kategorii treści, podaj je w kolejności ich trafności w stosunku do treści. Najbardziej trafna kategoria treści powinna być pierwsza na liście.

Krok 2. Podaj dane klastra

Zalecamy wykonywanie zadania publikowania treści w tle (np. za pomocą WorkManager) i planowanie go regularnie lub na podstawie zdarzeń (np. za każdym razem, gdy użytkownik otworzy aplikację lub doda coś do koszyka).

AppEngagePublishClient odpowiada za publikowanie klastrów.

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

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishContinuationCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteContinuationCluster
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

Ten interfejs API służy do sprawdzania, czy usługa jest dostępna do integracji i czy treś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 przesyłania danych na dowolnym zestawie urządzeń, wszystkie publikacje klastra kontynuacji (np. Kontynuuj czytanie i Rezerwacje wydarzeń) 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 ma zastosowanie w Twoim przypadku, ale ta domyślna konfiguracja nie odpowiada Twoim potrzebom, skontaktuj się z nami pod adresem 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.

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

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

• Dotychczasowe dane RecommendationCluster od partnera dewelopera zostaną usunięte.
• Dane z żądania są analizowane i przechowywane w zaktualizowanym klastrze 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 listy obiektów FeaturedCluster.

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

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

publishContinuationCluster

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

client.publishContinuationCluster(
    PublishContinuationClusterRequest.Builder()
      .setContinuationCluster(
        ContinuationCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

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

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

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

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

deleteContinuationCluster

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

client.deleteContinuationCluster()

client.deleteContinuationCluster();

Gdy usługa otrzyma żądanie, usunie dotychczasowe dane z klastra kontynuacji. W przypadku błędu cała prośba jest odrzucana i zachowywany 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_CONTINUATION)
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      .build())

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_CONTINUATION)
                .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 continuation cluster publish when PUBLISH_CONTINUATION broadcast is
  // received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

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

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

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

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
// received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

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

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

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

}

• Statycznie zadeklaruj implementację za pomocą tagu <receiver> w 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.PUBLISH_CONTINUATION" />
      </intent-filter>
   </receiver>
</application>

Usługa wysyła te intencje:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Zalecamy rozpoczęcie publishRecommendationClusters połączenia po otrzymaniu tego zamiaru.
• com.google.android.engage.action.PUBLISH_FEATURED Zalecamy rozpoczęcie publishFeaturedCluster połączenia po otrzymaniu tego zamiaru.
• com.google.android.engage.action.PUBLISH_CONTINUATION Zalecamy rozpoczęcie publishContinuationCluster połączenia po otrzymaniu tego zamiaru.

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.

Dalsze kroki

Po zakończeniu integracji wykonaj te czynności:

• Wyślij e-maila na adres engage-developers@google.com i dołą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 testowanie zostanie 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, klastry Rekomendacja, Wyróżnione i Kontynuacja mogą zostać opublikowane i będą widoczne dla użytkowników.