Przeczytaj pakiet SDK Engage: instrukcje integracji technicznej z usługami innych firm

Google tworzy na urządzeniu platformę, która porządkuje aplikacje według branż i umożliwia korzystanie ze spersonalizowanych treści w aplikacji. i odkrywania. Dzięki temu partnerzy mogą mają możliwość zaprezentowania swoich najlepszych, bogatych materiałów na specjalnym kanale do aplikacji.

W tym przewodniku znajdziesz instrukcje dla deweloperów dotyczące integrowania czytelną treść, używając pakietu SDK dla Agencji do wypełniania i dotychczasowych platform Google.

Szczegóły integracji

Terminologia

Ta integracja obejmuje te 3 typy klastrów: Recommendation, Kontynuacja i Polecane.

• Klastry rekomendacji pokazują spersonalizowane sugestie treści do przeczytania z konkretnego partnera programistów.

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

  • Klaster rekomendacji: widok interfejsu zawierający grupę rekomendacje od jednego partnera programistów.

    

  • Encja: obiekt reprezentujący pojedynczy element w klastrze. Encja np. e-book, audiobook, seria książek. Zapoznaj się z tymi materiałami danych encji, w których znajdziesz listę obsługiwanych encji. .

    

• Grupa Continuation zawiera niedokończone książki od wielu deweloperów partnerów w ramach jednej grupy w interfejsie. Każdy partner deweloperów będzie mógł: przesyłać maksymalnie 10 encji w klastrze kontynuacji.

  

• Klaster Polecane zawiera elementy z wielu partnerów programistów w jednym grupowaniu UI. Będzie już tylko jedna sekcja Polecane, Klaster, który znajduje się w górnej części interfejsu z priorytetem przede wszystkim klastrów rekomendacji. Każdy partner deweloperów będzie mógł: prześlij do 10 encji w klastrze Polecany.

  

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 opiera się na implementacji powiązanego usługi.

Dane, które klient może publikować, podlegają następującym limitom dla różnych typy klastrów:

Krok 1. Podaj dane encji

Pakiet SDK ma zdefiniowane różne jednostki reprezentujące każdy typ elementu. Wspieramy następujące elementy w kategorii Odczyt:

1. EbookEntity
2. AudiobookEntity
3. BookSeriesEntity

Poniższe tabele przedstawiają dostępne atrybuty i wymagania dla każdego typu.

EbookEntity

Obiekt EbookEntity reprezentuje e-booka (np. Becoming (Imię i nazwisko) Michelle Obamy).

AudiobookEntity

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

BookSeriesEntity

Obiekt BookSeriesEntity reprezentuje serię książek (np. Harry serii książek Potter, która obejmuje 7 książek).

Specyfikacja obrazu

Poniżej znajdziesz wymagane specyfikacje komponentów z obrazem:

Formaty plików

PNG, JPG, statyczny GIF, WebP

Maksymalny rozmiar pliku

5120 KB

Dodatkowe rekomendacje

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

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

Zaleca się, aby zadanie publikowania treści było wykonywane w tle (na przykład WorkManager). i zaplanowano je regularnie lub według konkretnego wydarzenia (np. za każdym razem, użytkownik otwiera aplikację lub właśnie dodał coś do koszyka).

Za publikowanie klastrów odpowiada AppEngagePublishClient. Obserwujesz Interfejsy API są dostępne w kliencie:

• 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 oraz czy treść może być prezentowana na urządzeniu.

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

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

publishRecommendationClusters

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

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

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 jedna transakcja:

• Dotychczasowe dane RecommendationCluster pochodzące od partnera dewelopera zostaną usunięte.
• Dane z żądania są analizowane i przechowywane w zaktualizowanej rekomendacji Klaster.

W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan to i utrzymywane informacje.

publishFeaturedCluster

Ten interfejs API służy do publikowania listy obiektów 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 jedna transakcja:

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

W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan to i utrzymywane informacje.

publishContinuationCluster

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

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

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

Gdy usługa otrzyma żądanie, w ramach jedna transakcja:

• Dotychczasowe dane ContinuationCluster pochodzące od partnera dewelopera zostaną usunięte.
• Dane z żądania są analizowane i przechowywane w zaktualizowanej wersji kontynuacji Klaster.

W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan to i utrzymywane informacje.

publishUserAccountManagementRequest

Ten interfejs API służy do publikowania karty logowania . Działanie związane z logowaniem kieruje użytkowników do stronie logowania, tak by aplikacja mogła publikować treści (lub udostępniać treści spersonalizowanej)

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

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

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

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

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

Gdy usługa otrzyma żądanie, w ramach jedna transakcja:

• Dotychczasowe dane UserAccountManagementCluster od partnera dewelopera są usunięto.
• Dane z żądania są analizowane i przechowywane w zaktualizowanym Klaster zarządzania kontami użytkowników.

W przypadku błędu całe żądanie zostaje odrzucone, a obecny stan to i utrzymywane informacje.

updatePublishStatus

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

• Podawanie stanu we wszystkich sytuacjach, nawet po opublikowaniu treści (STATUS == PUBLISHED) – ma kluczowe znaczenie przy wypełnianiu paneli, które używają jawny stan, który przekazuje informacje o stanie i inne wskaźniki integracji.
• Jeśli treści nie zostały opublikowane, ale stan integracji nie jest nieprawidłowy (STATUS == NOT_PUBLISHED), Google może uniknąć wywoływania alertów w aplikacji paneli stanu. Potwierdza ono, że treść nie została opublikowana z powodu jest oczekiwana z punktu widzenia dostawcy.
• Pomaga deweloperom określić, kiedy dane są publikowane, a kiedy Nie.
• Google może używać kodów stanu, aby skłonić użytkownika do wykonania określonych czynności aby wyświetlić jej zawartość lub ją pokonać.

Lista kodów stanu odpowiednich 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 zostały opublikowane z powodu niezalogowanego użytkownika, Zalecamy opublikowanie karty logowania. Jeśli z jakiegoś powodu dostawcy nie mogą opublikować karty logowania zalecamy wywoływanie interfejsu API updatePublishStatus z kodem stanu NOT_PUBLISHED_REQUIRES_SIGN_IN

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

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

deleteRecommendationClusters

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

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

Gdy usługa otrzyma żądanie, usuwa istniejące dane z Klastry rekomendacji. W przypadku błędu żądanie zostaje odrzucone w całości. a obecny stan zostaje zachowany.

deleteFeaturedCluster

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

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

Gdy usługa otrzyma żądanie, usuwa istniejące dane z Polecany klaster. W przypadku błędu żądanie zostaje odrzucone w całości. a obecny stan zostaje zachowany.

deleteContinuationCluster

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

client.deleteContinuationCluster()

client.deleteContinuationCluster();

Gdy usługa otrzyma żądanie, usuwa istniejące dane z Klaster kontynuacji. W przypadku błędu żądanie zostaje odrzucone w całości. a obecny stan zostaje zachowany.

deleteUserManagementCluster

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

client.deleteUserManagementCluster()

client.deleteUserManagementCluster();

Gdy usługa otrzyma żądanie, usuwa istniejące dane z Klaster zarządzania kontami użytkowników. W przypadku błędu całe żądanie jest odrzucono i zachowany zostanie obecny stan.

deleteClusters

Ten interfejs API służy do usuwania zawartości klastra określonego typu.

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

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

Gdy usługa otrzyma żądanie, usuwa istniejące dane ze wszystkich klastrów pasujących do określonych typów klastrów. Klienci mogą wybrać, czy chcą pozytywnie ocenić dla wielu typów klastrów. W przypadku błędu całe żądanie jest odrzucane, obecny stan zostaje zachowany.

Obsługa błędów

Zdecydowanie zalecamy wsłuchiwanie się w wyniki zadania z interfejsów API do publikowania, takich jak że można podjąć działania, aby odzyskać i ponownie przesłać udane zadanie.

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

Błąd jest zwracany jako AppEngageException z przyczyną podaną w atrybucie .

Krok 3. Obsługa intencji transmisji

Oprócz wykonywania wywołań interfejsu Content API w zadaniu wymagane do skonfigurowania BroadcastReceiver do otrzymania z prośbą o opublikowanie treści.

Celem intencji transmisji jest głównie ponowna aktywacja aplikacji i wymuszenie użycia danych synchronizację. Intencje związane z transmisją nie są przeznaczone do wysyłania zbyt często. Jest tylko uruchamianych, gdy usługa dla Agencji ustali, że zawartość może być nieaktualna (w przypadku np. tydzień). Dzięki temu będzie miała większą pewność, i otwierać nowe treści, nawet jeśli aplikacja nie była uruchamiana przez bardzo długi okres.

BroadcastReceiver trzeba skonfigurować na 2 sposoby:

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

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

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

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

}

• Statycznie deklaruj implementację z tagiem <receiver> w sekcji AndroidManifest.xml. Umożliwia to odbieranie komunikatów intencje, gdy nie jest uruchomiona, oraz umożliwia publikowanie aplikacji treści.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
      </intent-filter>
   </receiver>
</application>

Sprzedawca otrzyma te zamiary, usługa:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Zalecane jest rozpoczęcie połączenia publishRecommendationClusters, gdy w odpowiedzi na żądania użytkowników.
• com.google.android.engage.action.PUBLISH_FEATURED Zalecane jest rozpoczęcie połączenia publishFeaturedCluster po otrzymaniu tej wiadomości intencji.
• com.google.android.engagement.action.PUBLISH_CONTINUATIONIt is recommended to start apublishContinuationCluster` podczas odbierania wywołania tę intencję.

Proces integracji

Szczegółowy przewodnik dotyczący weryfikacji integracji po jej zakończeniu znajdziesz na stronie Przepływ pracy w zakresie integracji dla programistów

Najczęstsze pytania

Zapoznaj się z najczęstszymi pytaniami o pakiet SDK dla Agencji, które dotyczą Najczęstsze pytania

Kontakt

Kontakt Engage-developers@google.com, jeśli są na ewentualne pytania w trakcie procesu integracji. Nasz zespół udzieli odpowiedzi jak to tylko możliwe.

Dalsze kroki

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

• Wyślij e-maila do engagement-developers@google.com i załącz zintegrowany pakiet APK gotowy do testowania przez Google.
• Google przeprowadzi weryfikację i wewnętrznie sprawdzi, czy jej integracja działa zgodnie z oczekiwaniami. Jeśli zajdzie potrzeba wprowadzenia zmian, skontaktujemy się z Tobą z niezbędnymi informacjami.
• Jeśli testy zostaną zakończone i nie będą konieczne żadne zmiany, Google skontaktuje się z Tobą, aby: powiadomi Cię, że możesz rozpocząć publikowanie zaktualizowanego i zintegrowanego pliku APK w Sklep Play.
• Gdy Google potwierdzi, że zaktualizowany pakiet APK został opublikowany w Sklep Play, Twoje Rekomendacje, Polecane i Kontynuacja klastry zostaną opublikowane i będą widoczne dla użytkowników.