Przeczytaj pakiet SDK Engage: instrukcje integracji technicznej z usługami 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 do czytania (e-booków, audiobooków, komiksów i mang) na platformy treści Engage.

Szczegóły integracji

Terminologia

Ta integracja obejmuje 3 typy klastrów: Rekomendacje, KontynuacjaWyróżnione.

  • Rekomendacje to grupy zawierające spersonalizowane sugestie dotyczące treści do przeczytania od konkretnego partnera deweloperskiego.

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

    • Klaster rekomendacji: widok interfejsu, który zawiera grupę rekomendacji od jednego partnera deweloperskiego.

      Rysunek 1. Interfejs Entertainment Space z grupą rekomendacji od jednego partnera.
    • Jednostka: obiekt reprezentujący pojedynczy element w klastrze. Elementem może być e-book, audiobook, seria książek i nie tylko. Listę obsługiwanych typów encji znajdziesz w sekcji Podawanie danych o encjach.

      Rysunek 2. Interfejs Entertainment Space przedstawiający pojedynczy element w ramach klastra rekomendacji jednego z partnerów.
  • Grupa Kontynuacja zawiera niedokończone książki od wielu partnerów programistów w jednym układzie interfejsu. Każdy partner deweloper może transmitować maksymalnie 10 elementów w klastrze Kontynuacja.

    Rysunek 3. Interfejs przestrzeni rozrywki z grupą „Kontynuacja” zawierającą niedokończone rekomendacje od wielu partnerów (obecnie widoczna jest tylko jedna rekomendacja).
  • 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.

    Rysunek 4. Interfejs Entertainment Space z grupą Polecane zawierającą rekomendacje od wielu partnerów (obecnie widoczna jest tylko jedna rekomendacja).

Przygotowanie

Minimalny poziom interfejsu API: 19

Dodaj bibliotekę com.google.android.engage:engage-core do aplikacji:

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.5.2'
}

Podsumowanie

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

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

Typ klastra Limity klastra Maksymalne limity elementów w klastrze
Klastry rekomendacji Maksymalnie 7 Maksymalnie 50
Klaster kontynuacji Maksymalnie 1 Maksymalnie 20
Polecany klaster Maksymalnie 1 Maksymalnie 20

Krok 1. Podaj dane podmiotu

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

  1. EbookEntity
  2. AudiobookEntity
  3. BookSeriesEntity

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

EbookEntity

Obiekt EbookEntity reprezentuje e-booka (np. e-booka Becoming Michelle Obamy).

Atrybut Wymaganie Uwagi
Nazwa Wymagany
Obrazy plakatu Wymagany Musisz podać co najmniej 1 obraz. Więcej informacji znajdziesz w sekcji Specyfikacje obrazu.
Autor Wymagany Musisz podać co najmniej 1 imię i nazwisko autora.
Identyfikator URI linku do działania Wymagany

Precyzyjny link do aplikacji dostawcy e-booka.

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

Data publikacji Opcjonalny Jeśli podano wartość, jest ona wyrażona w milisekundach od początku epoki.
Opis Opcjonalny Jeśli podasz opis, nie może on przekraczać 200 znaków.
Cena Opcjonalny Dowolny tekst
Liczba stron Opcjonalny Jeśli wartość jest podana, musi być dodatnią liczbą całkowitą.
Gatunek Opcjonalny Lista gatunków powiązanych z książką.
Nazwa serii Opcjonalny Nazwa serii, do której należy e-book (np. Harry Potter).
Indeks jednostki serii Opcjonalny Indeks e-booka w serii, gdzie 1 oznacza pierwszego e-booka w serii. Jeśli np. Harry Potter i więzień Azkabanu to 3 książka w serii, wartość powinna wynosić 3.
Typ kontynuacji książki Opcjonalny

TYPE_CONTINUE – wznowienie czytania niedokończonej książki.

TYPE_NEXT – kontynuuj w ramach nowej serii.

TYPE_NEW – nowo wydane.

Czas ostatniego działania związanego z zaangażowaniem Wymagane warunkowo

Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji.

*Nowo* zakupione e-booki mogą być częścią klastra „Kontynuuj czytanie”.

W milisekundach od początku epoki.

Procent ukończenia Wymagane warunkowo

Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji.

Wartość musi być większa niż 0 i mniejsza niż 100.

DisplayTimeWindow – ustawianie przedziału czasu, w którym treści mają być wyświetlane na platformie
Sygnatura czasowa rozpoczęcia Opcjonalny

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

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

W milisekundach od początku epoki.

Sygnatura czasowa zakończenia Opcjonalny

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

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

W milisekundach od początku epoki.

AudiobookEntity

Obiekt AudiobookEntity reprezentuje audiobooka (np. audiobook Becoming Michelle Obamy).

Atrybut Wymaganie Uwagi
Nazwa Wymagany
Obrazy plakatu Wymagany Musisz podać co najmniej 1 obraz. Więcej informacji znajdziesz w sekcji Specyfikacje obrazu.
Autor Wymagany Musisz podać co najmniej 1 imię i nazwisko autora.
Identyfikator URI linku do działania Wymagany

Precyzyjny link do aplikacji dostawcy audiobooka.

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

Narrator Opcjonalny Musisz podać co najmniej 1 imię i nazwisko lektora.
Data publikacji Opcjonalny Jeśli podano wartość, jest ona wyrażona w milisekundach od początku epoki.
Opis Opcjonalny Jeśli podasz opis, nie może on przekraczać 200 znaków.
Cena Opcjonalny Dowolny tekst
Czas działania Opcjonalny Jeśli wartość jest podana, musi być dodatnia.
Gatunek Opcjonalny Lista gatunków powiązanych z książką.
Nazwa serii Opcjonalny Nazwa serii, do której należy audiobook (np. Harry Potter).
Indeks jednostki serii Opcjonalny Indeks audiobooka w serii, gdzie 1 oznacza pierwszy audiobook w serii. Jeśli np. Harry Potter i więzień Azkabanu to 3 książka w serii, wartość powinna wynosić 3.
Typ kontynuacji książki Opcjonalny

TYPE_CONTINUE – wznowienie czytania niedokończonej książki.

TYPE_NEXT – kontynuuj w ramach nowej serii.

TYPE_NEW – nowo wydane.

Czas ostatniego działania związanego z zaangażowaniem Wymagane warunkowo

Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji.

W milisekundach od początku epoki.

Procent ukończenia Wymagane warunkowo

Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji.

*Nowo* zakupione audiobooki mogą być częścią grupy „Kontynuuj czytanie”.

Wartość musi być większa niż 0 i mniejsza niż 100.

DisplayTimeWindow – ustawianie przedziału czasu, w którym treści mają być wyświetlane na platformie
Sygnatura czasowa rozpoczęcia Opcjonalny

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

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

W milisekundach od początku epoki.

Sygnatura czasowa zakończenia Opcjonalny

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

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

W milisekundach od początku epoki.

BookSeriesEntity

Obiekt BookSeriesEntity reprezentuje serię książek (np. serię Harry Potter, która składa się z 7 książek).

Atrybut Wymaganie Uwagi
Nazwa Wymagany
Obrazy plakatu Wymagany Musisz podać co najmniej 1 obraz. Więcej informacji znajdziesz w sekcji Specyfikacje obrazu.
Autor Wymagany Musi być podana co najmniej 1 nazwa autora.
Identyfikator URI linku do działania Wymagany

Precyzyjny link do aplikacji dostawcy audiobooka lub e-booka.

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

Liczba książek Wymagany Liczba książek w serii.
Opis Opcjonalny Jeśli podasz opis, nie może on przekraczać 200 znaków.
Gatunek Opcjonalny Lista gatunków powiązanych z książką.
Typ kontynuacji książki Opcjonalny

TYPE_CONTINUE – wznowienie czytania niedokończonej książki.

TYPE_NEXT – kontynuuj w ramach nowej serii.

TYPE_NEW – nowo wydane.

Czas ostatniego działania związanego z zaangażowaniem Wymagane warunkowo

Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji.

W milisekundach od początku epoki.

Procent ukończenia Wymagane warunkowo

Musisz podać tę wartość, jeśli produkt znajduje się w klastrze kontynuacji.

*Nowo* zakupione serie książek mogą być częścią klastra „Kontynuuj czytanie”.

Wartość musi być większa niż 0 i mniejsza niż 100.

DisplayTimeWindow – ustawianie przedziału czasu, w którym treści mają być wyświetlane na platformie
Sygnatura czasowa rozpoczęcia Opcjonalny

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

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

W milisekundach od początku epoki.

Sygnatura czasowa zakończenia Opcjonalny

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

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

W milisekundach od początku epoki.

Specyfikacja obrazu

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

Format obrazu Wymaganie Minimalny rozmiar w pikselach Zalecany rozmiar w pikselach
Kwadrat (1:1) Wymagany 300 x 300 1200 x 1200
Poziomy (1,91 x 1) Opcjonalny 600 x 314 1200 x 628
Orientacja pionowa (4x5) Opcjonalny 480 x 600 960 x 1200

Formaty plików

PNG, JPG, statyczny GIF, WebP

Maksymalny rozmiar pliku

5120 KB

Dodatkowe rekomendacje

  • Bezpieczny obszar obrazu: ważne treści umieść w środkowych 80% obrazu.

Przykład

AudiobookEntity audiobookEntity =
        new AudiobookEntity.Builder()
            .setName("Becoming")
            .addPosterImage(
                      new Image.Builder()
                          .setImageUri(Uri.parse("http://www.x.com/image.png"))
                          .setImageHeightInPixel(960)
                          .setImageWidthInPixel(408)
                          .build())
            .addAuthor("Michelle Obama")
            .addNarrator("Michelle Obama")
            .setActionLinkUri(Uri.parse("https://play.google/audiobooks/1"))
            .setDurationMillis(16335L)
            .setPublishDateEpochMillis(1633032895L)
            .setDescription("An intimate, powerful, and inspiring memoir")
            .setPrice("$16.95")
            .addGenre("biography")
            .build();

Krok 2. Podaj dane klastra

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

AppEngagePublishClient odpowiada za publikowanie klastrów. W kliencie dostępne są te interfejsy API:

  • 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ść może być wyświetlana na urządzeniu.

Kotlin

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content
          // publish calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

Java

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

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

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Reconnect with yourself")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Reconnect with yourself")
                        .build())
                .build());

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

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

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

publishFeaturedCluster

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

Kotlin

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

Java

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

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

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

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

publishContinuationCluster

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

Kotlin

client.publishContinuationCluster(
            PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    ContinuationCluster.Builder()
                        .addEntity(book_entity1)
                        .addEntity(book_entity2)
                        .build())
                .build())

Java

client.publishContinuationCluster(
            PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    ContinuationCluster.Builder()
                        .addEntity(book_entity1)
                        .addEntity(book_entity2)
                        .build())
                .build())

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

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

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

publishUserAccountManagementRequest

Ten interfejs API służy do publikowania karty logowania . Działanie logowania przekierowuje użytkowników na stronę logowania aplikacji, aby mogła ona publikować treści (lub udostępniać bardziej spersonalizowane treści).

Karta logowania zawiera te metadane:

Atrybut Wymaganie Opis
Identyfikator URI działania Wymagane Precyzyjny link do działania (np. przejście do strony logowania w aplikacji)
Obraz Opcjonalny – jeśli nie zostanie podany, należy podać tytuł

Obraz wyświetlany na karcie

Obrazy o formacie 16:9 i rozdzielczości 1264 x 712

Tytuł Opcjonalny – jeśli nie zostanie podany, należy podać obraz Tytuł na karcie
Tekst działania Opcjonalny Tekst wyświetlany w wezwaniu do działania (np. Zaloguj się)
Podtytuł Opcjonalny Opcjonalny podtytuł na karcie

Kotlin

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

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

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

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

updatePublishStatus

Jeśli z jakiegokolwiek powodu wewnętrznego żadna z grup nie jest opublikowana, zdecydowanie zalecamy zaktualizowanie stanu publikacji za pomocą interfejsu updatePublishStatus API. Jest to ważne, ponieważ :

  • Podawanie stanu we wszystkich scenariuszach, nawet gdy treść jest opublikowana (STATUS == PUBLISHED), jest kluczowe do wypełniania paneli, które używają tego jawnego stanu do przekazywania informacji o kondycji i innych danych integracji.
  • Jeśli żadne treści nie są publikowane, ale stan integracji nie jest 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 przewidywanej sytuacji z punktu widzenia dostawcy.
  • Pomaga deweloperom określać, kiedy dane są publikowane, a kiedy nie.
  • Google może używać kodów stanu, aby zachęcać użytkownika do podejmowania określonych działań w aplikacji, dzięki którym będzie mógł wyświetlić jej zawartość lub rozwiązać problem.

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

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

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

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

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

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

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

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

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

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

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

Kotlin

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

Java

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

deleteRecommendationClusters

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

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

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

deleteFeaturedCluster

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

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

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

deleteContinuationCluster

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

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

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

deleteUserManagementCluster

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

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

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

deleteClusters

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

Kotlin

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

Java

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

Gdy usługa otrzyma żądanie, usunie istniejące dane ze wszystkich klastrów pasujących do określonych typów klastrów. Klienci mogą przekazywać jeden lub wiele typów klastrów. W przypadku błędu całe żądanie jest odrzucane, a dotychczasowy stan pozostaje bez zmian.

Obsługa błędów

Zdecydowanie zalecamy odsłuchiwanie wyniku zadania z interfejsów API publikowania, aby można było podjąć działania następcze w celu odzyskania i ponownego przesłania zadania, które zakończyło się niepowodzeniem.

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

Błąd jest zwracany jako obiekt AppEngageException, a jego przyczyna jest podana jako kod błędu.

Kod błędu Nazwa błędu Uwaga
1 SERVICE_NOT_FOUND Usługa jest niedostępna na danym urządzeniu.
2 SERVICE_NOT_AVAILABLE Usługa jest dostępna na danym urządzeniu, ale w momencie połączenia jest niedostępna (np. jest wyraźnie wyłączona).
3 SERVICE_CALL_EXECUTION_FAILURE Nie udało się wykonać zadania z powodu problemów z wątkami. W takim przypadku można ponowić próbę.
4 SERVICE_CALL_PERMISSION_DENIED Element wywołujący nie ma uprawnień do wykonania wywołania usługi.
5 SERVICE_CALL_INVALID_ARGUMENT Żądanie zawiera nieprawidłowe dane (np. więcej klastrów niż dozwolona liczba).
6 SERVICE_CALL_INTERNAL Po stronie usługi wystąpił błąd.
7 SERVICE_CALL_RESOURCE_EXHAUSTED Wywołanie usługi jest wykonywane zbyt często.

Krok 3. Obsługa intencji transmisji

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

Celem intencji rozgłaszania jest głównie ponowna aktywacja aplikacji i wymuszenie synchronizacji danych. Intencje transmisji nie są przeznaczone do wysyłania zbyt często. Jest ona wywoływana tylko wtedy, gdy usługa Engage uzna, że treść może być nieaktualna (np. ma tydzień). Dzięki temu użytkownik może mieć pewność, że będzie korzystać z najnowszych treści, nawet jeśli aplikacja nie była uruchamiana przez dłuższy czas.

BroadcastReceiver musi być skonfigurowany na 2 sposoby:

  • Dynamiczne rejestrowanie instancji klasy BroadcastReceiver za pomocą Context.registerReceiver(). Umożliwia to komunikację z aplikacjami, które są nadal aktywne w pamięci.

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
  // Trigger 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)
}

Java

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

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger 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. 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.PUBLISH_CONTINUATION" />
      </intent-filter>
   </receiver>
</application>

Usługa będzie wysyłać te intencje:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Zalecamy rozpoczęcie połączenia publishRecommendationClusters po otrzymaniu tej intencji.
  • com.google.android.engage.action.PUBLISH_FEATURED Zalecamy rozpoczęcie publishFeaturedCluster połączenia po otrzymaniu tego zamiaru.
  • com.google.android.engage.action.PUBLISH_CONTINUATIONIt is recommended to start apublishContinuationCluster` po otrzymaniu tego intencji.

Przepływ pracy integracji

Szczegółowe instrukcje weryfikacji integracji po jej zakończeniu znajdziesz w artykule Przepływ pracy integracji z platformą Engage dla programistów.

Najczęstsze pytania

Odpowiedzi na najczęstsze pytania znajdziesz w sekcji Najczęstsze pytania dotyczące pakietu Engage SDK.

Kontakt

W razie pytań podczas 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 pakiet APK gotowy do testowania przez Google.
  • Google przeprowadzi weryfikację i sprawdzi wewnętrznie, czy integracja działa zgodnie z oczekiwaniami. Jeśli będą potrzebne zmiany, skontaktujemy się z Tobą i podamy niezbędne szczegóły.
  • 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 pakiet APK został opublikowany w Sklepie Play, klastry Rekomendacja, WyróżnioneKontynuacja będą opublikowane i widoczne dla użytkowników.