Engage-SDK lesen: Anleitung zur technischen Integration von Drittanbietern

Die Nutzerinteraktion mit Ihrer App steigern, indem Sie Nutzer dort erreichen, wo sie sich aufhalten Mit dem Engage SDK kannst du personalisierte Empfehlungen und Fortsetzungsinhalte direkt auf verschiedenen On-Device-Oberflächen wie Sammlungen, Entertainment Space und dem Google Play Store präsentieren. Die Integration vergrößert das APK im Durchschnitt um weniger als 50 KB (komprimiert) und dauert für die meisten Apps etwa eine Woche. Weitere Informationen

Dieser Leitfaden enthält Anleitungen für Entwicklerpartner, wie sie Leseinhalte (E‑Books, Hörbücher, Comics/Manga) auf Engage-Inhaltsplattformen bereitstellen können.

Integrationsdetails

Terminologie

Diese Integration umfasst die folgenden drei Clustertypen: Empfehlung, Fortsetzung und Vorgestellt.

  • In Empfehlungsclustern werden personalisierte Vorschläge für Inhalte angezeigt, die Sie von einem einzelnen Entwicklerpartner lesen können.

    Ihre Empfehlungen haben die folgende Struktur:

    • Empfehlungscluster:Eine Benutzeroberflächenansicht, die eine Gruppe von Empfehlungen von einem einzelnen Entwicklerpartner enthält.

      Abbildung 1. Die Benutzeroberfläche von Entertainment Space zeigt ein Empfehlungscluster von einem einzelnen Partner.
    • Entität:Ein Objekt, das ein einzelnes Element in einem Cluster darstellt. Eine Einheit kann ein E‑Book, ein Hörbuch, eine Buchreihe usw. sein. Eine Liste der unterstützten Entitätstypen finden Sie im Abschnitt Entitätsdaten bereitstellen.

      Abbildung 2. Benutzeroberfläche von Entertainment Space mit einer einzelnen Entität in einem Empfehlungscluster eines einzelnen Partners.
  • Im Cluster Fortsetzung werden unfertige Bücher von mehreren Entwicklerpartnern in einer einzigen Benutzeroberflächengruppe angezeigt. Jeder Entwicklerpartner darf maximal 10 Entitäten im Continuation-Cluster übertragen.

    Abbildung 3: Die Benutzeroberfläche von Entertainment Space zeigt einen Fortsetzungs-Cluster mit unfertigen Empfehlungen von mehreren Partnern (derzeit ist nur eine Empfehlung sichtbar).
  • Im Cluster Empfohlen werden ausgewählte Artikel von mehreren Entwicklerpartnern in einer einzigen UI-Gruppierung präsentiert. Es gibt einen einzelnen Cluster „Vorgestellt“, der oben in der Benutzeroberfläche angezeigt wird und eine höhere Priorität als alle Empfehlungscluster hat. Jeder Entwicklerpartner darf bis zu 10 Entitäten im Cluster „Empfohlen“ übertragen.

    Abbildung 4: Die Benutzeroberfläche von Entertainment Space mit einem Cluster vom Typ „Empfohlen“ mit Empfehlungen von mehreren Partnern (derzeit ist nur eine Empfehlung sichtbar).

Vorbereitung

Mindest-API-Level: 19

Fügen Sie Ihrer App die com.google.android.engage:engage-core-Bibliothek hinzu:

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

Zusammenfassung

Das Design basiert auf einer Implementierung eines gebundenen Dienstes.

Für die Daten, die ein Client veröffentlichen kann, gelten für die verschiedenen Clustertypen die folgenden Einschränkungen:

Clustertyp Cluster limits Maximale Entitätslimits in einem Cluster
Empfehlungscluster Höchstens 7 Höchstens 50
Fortsetzungscluster Höchstens 1 Höchstens 20
Empfohlener Cluster Höchstens 1 Höchstens 20

Schritt 1: Rechtssubjektdaten angeben

Im SDK sind verschiedene Entitäten definiert, um die einzelnen Elementtypen darzustellen. Wir unterstützen die folgenden Entitäten für die Kategorie „Lesen“:

  1. EbookEntity
  2. AudiobookEntity
  3. BookSeriesEntity

In den folgenden Tabellen sind die verfügbaren Attribute und Anforderungen für die einzelnen Typen aufgeführt.

EbookEntity

Das Objekt EbookEntity stellt ein E-Book dar, z. B. das E-Book von Becoming von Michelle Obama.

Attribut Anforderung Hinweise
Name Erforderlich
Posterbilder Erforderlich Es muss mindestens ein Bild angegeben werden. Weitere Informationen finden Sie unter Bildspezifikationen.
Autor Erforderlich Es muss mindestens ein Autorenname angegeben werden.
Aktionslink-URI Erforderlich

Der Deeplink zur Anbieter-App für das E-Book.

Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen

Veröffentlichungsdatum Optional In Epochen-Millisekunden, falls angegeben.
Beschreibung Optional Darf maximal 200 Zeichen lang sein, falls angegeben.
Preis Optional Freier Text
Seitenzahl Optional Muss eine positive Ganzzahl sein, falls angegeben.
Genre Optional Liste der Genres, die dem Buch zugeordnet sind.
Name der Reihe Optional Name der Reihe, zu der das E-Book gehört (z. B. Harry Potter).
Index der Reihen-Einheit Optional Der Index des E-Books in der Reihe, wobei 1 das erste E-Book in der Reihe ist. Wenn Harry Potter und der Gefangene von Askaban beispielsweise das dritte Buch der Reihe ist, sollte dieser Wert auf „3“ gesetzt werden.
Buchtyp fortsetzen Optional

TYPE_CONTINUE – Ein unfertiges Buch fortsetzen.

TYPE_NEXT – Mit einer neuen Folge einer Serie fortfahren.

TYPE_NEW: Neu veröffentlicht.

Zeitpunkt der letzten Interaktion Bedingt erforderlich

Muss angegeben werden, wenn sich der Artikel im Cluster „Fortsetzung“ befindet.

*Neu* erworbene E‑Books können Teil des Clusters „Weiterlesen“ sein.

In Epochen-Millisekunden.

Prozentsatz des Fortschritts Bedingt erforderlich

Muss angegeben werden, wenn sich der Artikel im Cluster „Fortsetzung“ befindet.

Der Wert muss größer als 0 und kleiner als 100 sein.

DisplayTimeWindow: Legen Sie ein Zeitfenster für die Anzeige von Inhalten auf der Oberfläche fest.
Startzeitstempel Optional

Der Epoch-Zeitstempel, nach dem die Inhalte auf der Plattform angezeigt werden sollen.

Wenn sie nicht festgelegt ist, können Inhalte auf der Plattform präsentiert werden.

In Epochen-Millisekunden.

Endzeitstempel Optional

Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird.

Wenn sie nicht festgelegt ist, können Inhalte auf der Plattform präsentiert werden.

In Epochen-Millisekunden.

AudiobookEntity

Das Objekt AudiobookEntity steht für ein Hörbuch, z. B. das Hörbuch von Becoming von Michelle Obama.

Attribut Anforderung Hinweise
Name Erforderlich
Posterbilder Erforderlich Es muss mindestens ein Bild angegeben werden. Weitere Informationen finden Sie unter Bildspezifikationen.
Autor Erforderlich Es muss mindestens ein Autorenname angegeben werden.
Aktionslink-URI Erforderlich

Der Deeplink zur Anbieter-App für das Hörbuch.

Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen

Narrator Optional Es muss mindestens ein Name des Erzählers angegeben werden.
Veröffentlichungsdatum Optional In Epochen-Millisekunden, falls angegeben.
Beschreibung Optional Darf maximal 200 Zeichen lang sein, falls angegeben.
Preis Optional Freier Text
Dauer Optional Muss ein positiver Wert sein, wenn er angegeben wird.
Genre Optional Liste der Genres, die dem Buch zugeordnet sind.
Name der Reihe Optional Name der Reihe, zu der das Hörbuch gehört (z. B. Harry Potter).
Index der Reihen-Einheit Optional Der Index des Hörbuchs in der Reihe, wobei 1 das erste Hörbuch in der Reihe ist. Wenn Harry Potter und der Gefangene von Askaban beispielsweise das dritte Buch der Reihe ist, sollte dieser Wert auf „3“ gesetzt werden.
Buchtyp fortsetzen Optional

TYPE_CONTINUE – Ein unfertiges Buch fortsetzen.

TYPE_NEXT – Mit einer neuen Folge einer Serie fortfahren.

TYPE_NEW: Neu veröffentlicht.

Zeitpunkt der letzten Interaktion Bedingt erforderlich

Muss angegeben werden, wenn sich der Artikel im Cluster „Fortsetzung“ befindet.

In Epochen-Millisekunden.

Prozentsatz des Fortschritts Bedingt erforderlich

Muss angegeben werden, wenn sich der Artikel im Cluster „Fortsetzung“ befindet.

*Neu* erworbene Hörbücher können Teil des Clusters „Weiterlesen“ sein.

Der Wert muss größer als 0 und kleiner als 100 sein.

DisplayTimeWindow: Legen Sie ein Zeitfenster für die Anzeige von Inhalten auf der Oberfläche fest.
Startzeitstempel Optional

Der Epoch-Zeitstempel, nach dem die Inhalte auf der Plattform angezeigt werden sollen.

Wenn sie nicht festgelegt ist, können Inhalte auf der Plattform präsentiert werden.

In Epochen-Millisekunden.

Endzeitstempel Optional

Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird.

Wenn sie nicht festgelegt ist, können Inhalte auf der Plattform präsentiert werden.

In Epochen-Millisekunden.

BookSeriesEntity

Das BookSeriesEntity-Objekt stellt eine Buchreihe dar, z. B. die Harry Potter-Reihe mit sieben Büchern.

Attribut Anforderung Hinweise
Name Erforderlich
Posterbilder Erforderlich Es muss mindestens ein Bild angegeben werden. Weitere Informationen finden Sie unter Bildspezifikationen.
Autor Erforderlich Mindestens ein Autorenname muss vorhanden sein.
Aktionslink-URI Erforderlich

Der Deeplink zur Anbieter-App für das Hörbuch oder E-Book.

Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen

Anzahl der Bücher Erforderlich Anzahl der Bücher in der Reihe.
Beschreibung Optional Darf maximal 200 Zeichen lang sein, falls angegeben.
Genre Optional Liste der Genres, die dem Buch zugeordnet sind.
Buchtyp fortsetzen Optional

TYPE_CONTINUE – Ein unfertiges Buch fortsetzen.

TYPE_NEXT – Mit einer neuen Folge einer Serie fortfahren.

TYPE_NEW: Neu veröffentlicht.

Zeitpunkt der letzten Interaktion Bedingt erforderlich

Muss angegeben werden, wenn sich der Artikel im Cluster „Fortsetzung“ befindet.

In Epochen-Millisekunden.

Prozentsatz des Fortschritts Bedingt erforderlich

Muss angegeben werden, wenn sich der Artikel im Cluster „Fortsetzung“ befindet.

*Neu* erworbene Buchreihen können Teil des Clusters „Weiterlesen“ sein.

Der Wert muss größer als 0 und kleiner als 100 sein.

DisplayTimeWindow: Legen Sie ein Zeitfenster für die Anzeige von Inhalten auf der Oberfläche fest.
Startzeitstempel Optional

Der Epoch-Zeitstempel, nach dem die Inhalte auf der Plattform angezeigt werden sollen.

Wenn sie nicht festgelegt ist, können Inhalte auf der Plattform präsentiert werden.

In Epochen-Millisekunden.

Endzeitstempel Optional

Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird.

Wenn sie nicht festgelegt ist, können Inhalte auf der Plattform präsentiert werden.

In Epochen-Millisekunden.

Bildspezifikationen

Unten finden Sie die erforderlichen Spezifikationen für Bild-Assets:

Seitenverhältnis Anforderung Mindestanzahl an Pixeln Empfohlene Pixel
Quadratisch (1 × 1) Erforderlich 300 × 300 1200 × 1200
Querformat (1,91 × 1) Optional 600 × 314 1200 × 628
Hochformat (4 : 5) Optional 480 × 600 960 × 1.200

Dateiformate

PNG, JPG, statisches GIF, WebP

Maximale Dateigröße

5.120 KB

Weitere Empfehlungen

  • Bildbereich:Platzieren Sie wichtige Inhalte in den mittleren 80% des Bildes.

Beispiel

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

Schritt 2: Clusterdaten angeben

Es wird empfohlen, den Job zum Veröffentlichen von Inhalten im Hintergrund auszuführen (z. B. mit WorkManager) und regelmäßig oder ereignisbasiert zu planen (z. B. jedes Mal, wenn der Nutzer die App öffnet oder gerade etwas in den Einkaufswagen gelegt hat).

AppEngagePublishClient ist für die Veröffentlichung von Clustern verantwortlich. Die folgenden APIs sind im Client verfügbar:

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

isServiceAvailable

Mit dieser API wird geprüft, ob der Dienst für die Integration verfügbar ist und ob die Inhalte auf dem Gerät präsentiert werden können.

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

Mit dieser API wird eine Liste von RecommendationCluster-Objekten veröffentlicht.

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

Wenn der Dienst die Anfrage empfängt, werden die folgenden Aktionen in einer Transaktion ausgeführt:

  • Vorhandene RecommendationCluster-Daten des Entwicklerpartners werden entfernt.
  • Die Daten aus der Anfrage werden geparst und im aktualisierten Empfehlungscluster gespeichert.

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

publishFeaturedCluster

Mit dieser API wird eine Liste von FeaturedCluster-Objekten veröffentlicht.

Kotlin

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

Java

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

Wenn der Dienst die Anfrage empfängt, werden die folgenden Aktionen in einer Transaktion ausgeführt:

  • Vorhandene FeaturedCluster-Daten des Entwicklerpartners werden entfernt.
  • Die Daten aus der Anfrage werden geparst und im aktualisierten Featured Cluster gespeichert.

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

publishContinuationCluster

Diese API wird verwendet, um ein ContinuationCluster-Objekt zu veröffentlichen.

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

Wenn der Dienst die Anfrage empfängt, werden die folgenden Aktionen in einer Transaktion ausgeführt:

  • Vorhandene ContinuationCluster-Daten des Entwicklerpartners werden entfernt.
  • Die Daten aus der Anfrage werden geparst und im aktualisierten Continuation-Cluster gespeichert.

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

publishUserAccountManagementRequest

Diese API wird verwendet, um eine Anmeldekarte zu veröffentlichen . Die Anmeldeaktion leitet Nutzer zur Anmeldeseite der App weiter, damit die App Inhalte veröffentlichen oder personalisierte Inhalte bereitstellen kann.

Die folgenden Metadaten sind Teil der Anmeldekarte:

Attribut Anforderung Beschreibung
Aktions-URI Erforderlich Deeplink zur Aktion (d.h. zur Anmeldeseite der App)
Bild Optional – Wenn nicht angegeben, muss „Title“ angegeben werden.

Auf der Karte angezeigtes Bild

Bilder mit einem Seitenverhältnis von 16:9 und einer Auflösung von 1264 × 712

Überschrift Optional – Wenn nicht angegeben, muss ein Bild angegeben werden Titel auf der Karte
Aktionstext Optional Text, der im CTA angezeigt wird (z.B. „Anmelden“)
Untertitel Optional Optionaler Untertitel auf der Karte

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

Wenn der Dienst die Anfrage empfängt, werden die folgenden Aktionen in einer Transaktion ausgeführt:

  • Vorhandene UserAccountManagementCluster-Daten des Entwicklerpartners werden entfernt.
  • Die Daten aus der Anfrage werden geparst und im aktualisierten Cluster „UserAccountManagementCluster“ gespeichert.

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

updatePublishStatus

Wenn aus internen geschäftlichen Gründen keiner der Cluster veröffentlicht wird, empfehlen wir dringend, den Veröffentlichungsstatus mit der updatePublishStatus API zu aktualisieren. Das ist aus folgenden Gründen wichtig :

  • Es ist wichtig, den Status in allen Szenarien anzugeben, auch wenn die Inhalte veröffentlicht sind (STATUS == PUBLISHED), damit Dashboards, in denen dieser explizite Status verwendet wird, mit Daten gefüllt werden können, um den Zustand und andere Messwerte Ihrer Integration zu vermitteln.
  • Wenn keine Inhalte veröffentlicht werden, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google vermeiden, dass in den App-Health-Dashboards Benachrichtigungen ausgelöst werden. Sie bestätigt, dass Inhalte aufgrund einer erwarteten Situation aus Sicht des Anbieters nicht veröffentlicht werden.
  • So können Entwickler angeben, wann die Daten veröffentlicht werden und wann nicht.
  • Google kann die Statuscodes verwenden, um den Nutzer zu bestimmten Aktionen in der App aufzufordern, damit er die App-Inhalte sehen oder das Problem beheben kann.

Die Liste der zulässigen Veröffentlichungsstatuscodes lautet :

// 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

Wenn die Inhalte nicht veröffentlicht werden, weil ein Nutzer nicht angemeldet ist, empfiehlt Google, die Anmeldekarte zu veröffentlichen. Wenn Anbieter die Anmeldekarte aus irgendeinem Grund nicht veröffentlichen können, empfehlen wir, die updatePublishStatus-API mit dem Statuscode NOT_PUBLISHED_REQUIRES_SIGN_IN aufzurufen.

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

Mit dieser API wird der Inhalt von Empfehlungsclustern gelöscht.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus den Empfehlungsclustern entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

deleteFeaturedCluster

Diese API wird verwendet, um den Inhalt des vorgestellten Clusters zu löschen.

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem vorgestellten Cluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

deleteContinuationCluster

Mit dieser API wird der Inhalt von Continuation-Clustern gelöscht.

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem Continuation Cluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

deleteUserManagementCluster

Diese API wird verwendet, um den Inhalt des UserAccountManagement-Clusters zu löschen.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem UserAccountManagement-Cluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

deleteClusters

Mit dieser API wird der Inhalt eines bestimmten Clustertyps gelöscht.

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

Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus allen Clustern entfernt, die den angegebenen Clustertypen entsprechen. Clients können einen oder mehrere Clustertypen übergeben. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status bleibt erhalten.

Fehlerbehandlung

Es wird dringend empfohlen, das Ergebnis des Tasks aus den Publish-APIs abzurufen, damit eine Folgemaßnahme ergriffen werden kann, um einen erfolgreichen Task wiederherzustellen und noch einmal einzureichen.

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

Der Fehler wird als AppEngageException zurückgegeben. Die Ursache ist als Fehlercode enthalten.

Fehlercode Fehlername Hinweis
1 SERVICE_NOT_FOUND Der Dienst ist auf dem angegebenen Gerät nicht verfügbar.
2 SERVICE_NOT_AVAILABLE Der Dienst ist auf dem angegebenen Gerät verfügbar, aber zum Zeitpunkt des Anrufs nicht (z. B. weil er explizit deaktiviert ist).
3 SERVICE_CALL_EXECUTION_FAILURE Die Ausführung der Aufgabe ist aufgrund von Threading-Problemen fehlgeschlagen. In diesem Fall kann der Vorgang wiederholt werden.
4 SERVICE_CALL_PERMISSION_DENIED Der Anrufer darf den Serviceanruf nicht tätigen.
5 SERVICE_CALL_INVALID_ARGUMENT Die Anfrage enthält ungültige Daten, z. B. mehr Cluster als zulässig.
6 SERVICE_CALL_INTERNAL Auf der Dienstseite ist ein Fehler aufgetreten.
7 SERVICE_CALL_RESOURCE_EXHAUSTED Der Dienstaufruf erfolgt zu häufig.

Schritt 3: Broadcast-Intents verarbeiten

Zusätzlich zu den API-Aufrufen zum Veröffentlichen von Inhalten über einen Job ist es auch erforderlich, eine BroadcastReceiver einzurichten, um die Anfrage zum Veröffentlichen von Inhalten zu erhalten.

Broadcast-Intents dienen hauptsächlich zur Reaktivierung von Apps und zum Erzwingen der Datensynchronisierung. Broadcast-Intents sind nicht dafür gedacht, sehr häufig gesendet zu werden. Sie wird nur ausgelöst, wenn der Engage-Dienst feststellt, dass die Inhalte möglicherweise veraltet sind (z. B. eine Woche alt). So ist es wahrscheinlicher, dass der Nutzer neue Inhalte sieht, auch wenn die Anwendung längere Zeit nicht ausgeführt wurde.

Das BroadcastReceiver muss auf zwei Arten eingerichtet werden:

  • Registrieren Sie eine Instanz der Klasse BroadcastReceiver dynamisch mit Context.registerReceiver(). Dadurch wird die Kommunikation von Anwendungen ermöglicht, die noch im Arbeitsspeicher aktiv sind.

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

}
  • Deklarieren Sie eine Implementierung statisch mit dem <receiver>-Tag in Ihrer AndroidManifest.xml-Datei. So kann die Anwendung Broadcast-Intents empfangen, wenn sie nicht ausgeführt wird, und auch Inhalte veröffentlichen.

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

Die folgenden Intents werden vom Dienst gesendet:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Es wird empfohlen, einen publishRecommendationClusters-Aufruf zu starten, wenn diese Absicht empfangen wird.
  • com.google.android.engage.action.PUBLISH_FEATURED Es wird empfohlen, einen publishFeaturedCluster-Anruf zu starten, wenn dieser Intent empfangen wird.
  • com.google.android.engage.action.PUBLISH_CONTINUATIONIt is recommended to start apublishContinuationCluster` call when receiving this intent.

Integrationsworkflow

Eine Schritt-für-Schritt-Anleitung zum Überprüfen Ihrer Integration nach Abschluss finden Sie unter Workflow für die Entwicklerintegration.

Häufig gestellte Fragen

Häufig gestellte Fragen zum Engage SDK

Kontakt

Wenden Sie sich bei Fragen während der Integration an engage-developers@google.com. Unser Team wird sich so schnell wie möglich bei Ihnen melden.

Nächste Schritte

Nachdem Sie diese Integration abgeschlossen haben, sind die nächsten Schritte folgende:

  • Senden Sie eine E-Mail an engage-developers@google.com und hängen Sie Ihr integriertes APK an, das für Tests durch Google bereit ist.
  • Google führt eine interne Überprüfung durch, um sicherzustellen, dass die Integration wie erwartet funktioniert. Falls Änderungen erforderlich sind, werden Sie von Google kontaktiert.
  • Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, werden Sie von Google benachrichtigt, dass Sie das aktualisierte und integrierte APK im Play Store veröffentlichen können.
  • Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Play Store veröffentlicht wurde, werden Ihre Cluster Empfehlung, Vorgestellt und Fortsetzung veröffentlicht und sind für Nutzer sichtbar.