Engage SDK Social: Anleitung zur technischen Integration von Drittanbietern

Google entwickelt eine On-Device-Oberfläche, die die Apps der Nutzer nach Branchen sortiert und ein neues immersives Erlebnis für personalisierte App-Inhalte ermöglicht. Diese Vollbildfunktion bietet Entwicklerpartnern die Möglichkeit, ihre besten Rich-Content-Inhalte in einem eigenen Kanal außerhalb ihrer App zu präsentieren.

Dieses Dokument enthält eine Anleitung für Entwicklerpartner, wie sie ihre sozialen Inhalte mithilfe des Engage SDK integrieren können, um diesen neuen Bereich zu füllen.

Integrationsdetail

Im folgenden Abschnitt werden die Details zur Integration beschrieben.

Terminologie

Empfehlungscluster zeigen personalisierte Vorschläge eines einzelnen Entwicklerpartners an.

Ihre Empfehlungen haben die folgende Struktur:

Empfehlungscluster: UI-Ansicht, die eine Gruppe von Empfehlungen desselben Entwicklerpartners enthält.

Jeder Empfehlungscluster besteht aus einem der folgenden zwei Entitätstypen :

• PortraitMediaEntity
• SocialPostEntity

PortraitMediaEntity muss ein Bild im Hochformat für den Beitrag enthalten. Profil- und interaktionsbezogene Metadaten sind optional.

• Beitrag

  • Bild im Hochformat und Zeitstempel, oder
  • Bild im Hochformat + Textinhalt und Zeitstempel

• Profil

  • Avatar, Name oder Alias, zusätzliches Bild

• Interaktion

  • Nur zählen und mit Labels versehen oder
  • Anzahl und visuelle Elemente (Symbol)

SocialPostEntity enthält Metadaten zu Profilen, Beiträgen und Interaktionen.

• Profil

  • Avatar, Name oder Alias, zusätzlicher Text, zusätzliches Bild

• Beitrag

  • Text und Zeitstempel
  • Rich Media (Bild oder Rich-URL) und Zeitstempel
  • Text und Rich Media (Bild oder Rich-URL) und Zeitstempel

• Interaktionen

  • „Nur zählen und beschriften“ oder
  • Anzahl und Bilder (Symbol)

Vorbereitung

Mindest-API-Level: 19

Füge deiner App die com.google.android.play:engage-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.4.0'
}

Zusammenfassung

Das Design basiert auf der Implementierung eines gebundenen Dienstes.

Die Daten, die ein Client veröffentlichen kann, unterliegen den folgenden Limits für verschiedene Clustertypen:

Clustertyp	Cluster limits	Minimale Entitätslimits in einem Cluster	Maximale Entitätslimits in einem Cluster
Empfehlungscluster	Höchstens 5	Mindestens 5 (PortraitMediaEntity oder SocialPostEntity)	Höchstens 25 (PortraitMediaEntity oder SocialPostEntity)

Schritt 1: Entitätsdaten angeben

Im SDK wurden verschiedene Entitäten definiert, die die einzelnen Artikeltypen darstellen. Das SDK unterstützt die folgenden Entitäten für die Kategorie "Soziale Netzwerke":

1. PortraitMediaEntity
2. SocialPostEntity

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

PortraitMediaEntity

Attribut	Anforderungen	Beschreibung	Formatieren
Aktions-URI	Erforderlich	Sie erstellen einen Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.	URI
Beitragsbezogene Metadaten (erforderlich)
Bild(er)	Erforderlich	Bilder sollten im Hochformat vorliegen. Die Benutzeroberfläche zeigt möglicherweise nur ein Bild an, wenn mehrere Bilder bereitgestellt werden. Die Benutzeroberfläche kann jedoch einen visuellen Hinweis darauf geben, dass sich mehr Bilder in der App befinden. Wenn es sich bei dem Beitrag um ein Video handelt, muss der Dienstleister eine Miniaturansicht des Videos zur Verfügung stellen, die als Bild angezeigt werden soll.	Siehe Bildspezifikationen für eine Orientierungshilfe.
Textinhalt	Optional	Haupttext eines Beitrags, eines Updates usw.	String (max. 140 Zeichen empfohlen)
Zeitstempel	Optional	Zeitpunkt der Veröffentlichung des Beitrags.	Epochenzeitstempel in Millisekunden
Profilbezogene Metadaten (optional)
Name	Erforderlich	Profilname, -ID oder Alias, z. B. "Max Mustermann", "@TeamPixel"	String(max. 25 Zeichen empfohlen)
Avatar	Erforderlich	Profilbild oder Avatarbild des Nutzers Quadratisches Bild mit 1:1	Siehe Bildspezifikationen für eine Orientierungshilfe.
Zusätzliches Bild	Optional	Profillogo, zum Beispiel – verifiziertes Badge Quadratisches Bild mit 1:1	Siehe Bildspezifikationen für eine Orientierungshilfe.
Interaktionsbezogene Metadaten (optional)
Zähler	Erforderlich	Geben Sie die Anzahl der Interaktionen an, zum Beispiel - "3,7 Mio.".	String (max. 20 Zeichen für Anzahl und Label zusammen empfohlen)
Label	Optional Bei Nichtangabe muss ein Bild angegeben werden.	Geben Sie den Zweck der Interaktion an, z. B. "Gefällt mir"-Angaben.	String (max. 20 Zeichen für Anzahl und Label zusammen empfohlen)
Visuell	Optional Wenn nicht angegeben, muss Label angegeben werden.	Geben Sie an, wozu die Interaktion dient. Beispiel: Bild mit „Mag ich“-Symbol (Emojis). Es können mehrere Bilder zur Verfügung gestellt werden, auch wenn nicht alle für alle Formfaktoren angezeigt werden. Quadratisches Bild mit 1:1	Siehe Bildspezifikationen für eine Orientierungshilfe.
DisplayTimeWindow (optional): Legen Sie ein Zeitfenster fest, für das Inhalte auf der Oberfläche angezeigt werden sollen.
Startzeitstempel	Optional	Der Epochenzeitstempel, nach dem der Inhalt auf der Oberfläche angezeigt werden soll. Wenn die Richtlinie nicht konfiguriert ist, können die Inhalte auf der Oberfläche angezeigt werden.	Epochenzeitstempel in Millisekunden
Endzeitstempel	Optional	Der Epochenzeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn die Richtlinie nicht konfiguriert ist, können die Inhalte auf der Oberfläche angezeigt werden.	Epochenzeitstempel in Millisekunden

SocialPostEntity

Attribut	Anforderungen	Beschreibung	Formatieren
Aktions-URI	Erforderlich	Sie erstellen einen Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.	URI
Beitragsbezogene Metadaten (erforderlich) Mindestens einer der folgenden Werte ist erforderlich: TextContent, Image oder WebContent
Bild(er)	Optional	Bilder sollten im Hochformat vorliegen. Die Benutzeroberfläche zeigt möglicherweise nur ein Bild an, wenn mehrere Bilder bereitgestellt werden. Die Benutzeroberfläche kann jedoch einen visuellen Hinweis darauf geben, dass sich mehr Bilder in der App befinden. Wenn es sich bei dem Beitrag um ein Video handelt, muss der Dienstleister eine Miniaturansicht des Videos zur Verfügung stellen, die als Bild angezeigt werden soll.	Siehe Bildspezifikationen für eine Orientierungshilfe.
Textinhalt	Optional	Haupttext eines Beitrags, eines Updates usw.	String (max. 140 Zeichen empfohlen)
Linkvorschau (optional)
Linkvorschau – Titel	Erforderlich	Text zur Angabe des Titels des Webseiteninhalts	String
Linkvorschau - Hostname	Erforderlich	Text zur Angabe des Websiteinhabers, z. B. „INSIDER“	String
Linkvorschau – Bild	Optional	Hero-Image für den Webinhalt	Siehe Bildspezifikationen für eine Orientierungshilfe.
Zeitstempel	Optional	Zeitpunkt der Veröffentlichung des Beitrags.	Epochenzeitstempel in Millisekunden
Profilbezogene Metadaten (optional)
Name	Erforderlich	Profilname, -ID oder Alias, z. B. "Max Mustermann", "@TeamPixel."	String(max. 25 Zeichen empfohlen)
Zusätzlicher Text	Optional	Kann als Profil-ID, Alias oder zusätzliche Metadaten verwendet werden Beispiele: „@Max-Mustermann“, „5 Mio. Follower“, „Das könnte dir gefallen“, „Im Trend“, „5 neue Beiträge“	String(max. 40 Zeichen empfohlen)
Avatar	Erforderlich	Profilbild oder Avatarbild des Nutzers Quadratisches Bild mit 1:1	Siehe Bildspezifikationen für eine Orientierungshilfe.
Zusätzliches Bild	Optional	Profillogo, z. B. Bestätigungskennzeichen Quadratisches Bild mit 1:1	Siehe Bildspezifikationen für eine Orientierungshilfe.
Interaktionsbezogene Metadaten (optional)
Zähler	Erforderlich	Geben Sie die Anzahl der Interaktionen an, zum Beispiel - "3,7 Mio.".	String (max. 20 Zeichen für Anzahl und Label zusammen empfohlen)
Label	Optional Bei Nichtangabe muss ein Bild angegeben werden.	Geben Sie an, wozu die Interaktion dient. Beispiel: „Gefällt mir“-Angaben.	String (max. 20 Zeichen für Anzahl und Label zusammen empfohlen)
Visuell	Optional Wenn nicht angegeben, muss Label angegeben werden.	Geben Sie an, wozu die Interaktion dient. Beispiel: Bild mit „Gefällt mir“-Symbol, Emojis . Es können mehrere Bilder zur Verfügung gestellt werden, auch wenn nicht alle für alle Formfaktoren angezeigt werden. Quadratisches Bild mit 1:1	Siehe Bildspezifikationen für eine Orientierungshilfe.
DisplayTimeWindow (optional): Legen Sie ein Zeitfenster fest, für das Inhalte auf der Oberfläche angezeigt werden sollen.
Startzeitstempel	Optional	Der Epochenzeitstempel, nach dem der Inhalt auf der Oberfläche angezeigt werden soll. Wenn die Richtlinie nicht konfiguriert ist, können die Inhalte auf der Oberfläche angezeigt werden.	Epochenzeitstempel in Millisekunden
Endzeitstempel	Optional	Der Epochenzeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn die Richtlinie nicht konfiguriert ist, können die Inhalte auf der Oberfläche angezeigt werden.	Epochenzeitstempel in Millisekunden

Bildspezifikationen

Die Images müssen in öffentlichen CDNs gehostet werden, damit Google darauf zugreifen kann.

Dateiformate

PNG, JPG, statisches GIF, WebP

Maximale Dateigröße

5.120 KB

Weitere Empfehlungen

• Bildbereich:Wichtige Inhalte sollten in den mittleren 80% des Bilds positioniert werden.
• Verwenden Sie einen transparenten Hintergrund, damit das Bild im Modus „Dunkles und helles Design“ richtig angezeigt werden kann.

Schritt 2: Clusterdaten angeben

Es empfiehlt sich, den Job zur Inhaltsveröffentlichung 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 wenn er einem neuen Konto folgt).

AppEngageSocialClient ist für die Veröffentlichung von Clustern sozialer Netzwerke verantwortlich.

Es gibt die folgenden APIs zum Veröffentlichen von Clustern im Client:

• isServiceAvailable
• publishRecommendationClusters
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

Mit dieser API wird geprüft, ob der Dienst für die Integration verfügbar ist und ob der Inhalt auf dem Gerät angezeigt werden kann.

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

Hinweis: Wir empfehlen dringend, einen regelmäßigen Job auszuführen, um zu prüfen, ob der Dienst zu einem späteren Zeitpunkt verfügbar ist. Die Verfügbarkeit des Dienstes kann sich durch Upgrades der Android-Version, App-Upgrades, Installationen und Deinstallationen ändern. Durch regelmäßige Jobprüfungen in einem bestimmten Zeitintervall können Daten veröffentlicht werden, sobald der Dienst verfügbar ist.

publishRecommendationClusters

Diese API wird zum Veröffentlichen einer Liste von RecommendationCluster-Objekten verwendet.

Ein RecommendationCluster-Objekt kann die folgenden Attribute haben:

Attribut	Anforderungen	Beschreibung
Liste von SocialPostEntity oder PortraitMediaEntity	Erforderlich	Eine Liste der Entitäten, aus denen die Empfehlungen für diesen Empfehlungscluster bestehen. Entitäten in einem einzelnen Cluster müssen vom gleichen Typ sein.
Titel	Erforderlich	Der Titel des Empfehlungsclusters (z. B. Neueste von Ihren Freunden). Empfohlene Textgröße: unter 25 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.)
Aktions-URI	Optional	Der Deeplink zu der Seite in der Partner-App, auf der Nutzer die vollständige Liste der Empfehlungen sehen können. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.

Wichtig: Die Publish-APIs sind Upsert-APIs. Sie ersetzen die vorhandenen Inhalte. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, wie dies von Natur aus bei den Publish-APIs der Fall ist.

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Latest from your friends")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Latest from your friends")
                        .build())
                .build());

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

• Alle vorhandenen Daten des Empfehlungsclusters werden entfernt.
• Die Daten aus der Anfrage werden geparst und in neuen Empfehlungsclustern gespeichert.

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

publishUserAccountManagementRequest

Dieses API wird zum Veröffentlichen einer Anmeldekarte verwendet . Durch die Anmeldeaktion werden Nutzer zur Anmeldeseite der App weitergeleitet, wo sie Inhalte veröffentlichen oder personalisiertere Inhalte bereitstellen kann.

Die folgenden Metadaten sind Teil der Anmeldekarte:

Attribut	Anforderungen	Beschreibung
Aktions-URI	Erforderlich	Deeplink zur Aktion (d.h. Weiterleitung zur Anmeldeseite der App)
Bild	Optional – Wenn nicht angegeben, muss ein Titel angegeben werden.	Bild auf der Karte Bilder mit einem Seitenverhältnis von 16:9 und einer Auflösung von 1.264 x 712
Titel	Optional – Wenn nicht angegeben, muss das Bild zur Verfügung gestellt werden	Titel der Karte
Aktionstext	Optional	Text im CTA (z.B. „Anmeldung“)
Untertitel	Optional	Optionaler Untertitel auf der Karte

Wichtig: Die Publish-APIs sind Upsert-APIs. Sie ersetzen die vorhandenen Inhalte. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, wie dies von Natur aus bei den Publish-APIs der Fall ist.

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 innerhalb einer Transaktion die folgenden Aktionen ausgeführt:

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

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

updatePublishStatus

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

• Die Angabe des Status ist in allen Szenarien wichtig, selbst wenn der Inhalt veröffentlicht wird (STATUS = VERÖFFENTLICHT), um Dashboards mit diesem expliziten Status auszufüllen, um den Zustand und andere Messwerte Ihrer Integration zu vermitteln.
• Wenn kein Inhalt veröffentlicht ist, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google verhindern, dass Benachrichtigungen in den Dashboards zum Anwendungszustand ausgelöst werden. Damit wird bestätigt, dass Inhalte aufgrund einer aus Sicht des Anbieters erwarteten Situation nicht veröffentlicht werden.
• Es hilft Entwicklern, zu verstehen, wann die Daten veröffentlicht werden und wann nicht.
• Google kann die Statuscodes verwenden, um Nutzer zu bestimmten Aktionen in der App anzuregen, damit sie den App-Inhalt sehen oder überwinden können.

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

Diese API wird zum Löschen des Inhalts von Empfehlungsclustern verwendet.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte zum Veröffentlichen vorhanden sind. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, da dies von Natur aus bei den Publish-APIs der Fall ist. Wenden Sie sich vor der Verwendung von APIs zum Löschen an responsive-developers@.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

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

deleteUserManagementCluster

Diese API wird zum Löschen des Inhalts des UserAccountManagement-Clusters verwendet.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte zum Veröffentlichen vorhanden sind. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, da dies von Natur aus bei den Publish-APIs der Fall ist. Wenden Sie sich vor der Verwendung von APIs zum Löschen an responsive-developers@.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

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

deleteClusters

Diese API wird zum Löschen des Inhalts eines bestimmten Clustertyps verwendet.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte zum Veröffentlichen vorhanden sind. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, da dies von Natur aus bei den Publish-APIs der Fall ist. Wenden Sie sich vor der Verwendung von APIs zum Löschen an responsive-developers@.

Kotlin

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

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .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 bestehende Status beibehalten.

Fehlerbehandlung

Es wird dringend empfohlen, das Aufgabenergebnis der Publish-APIs zu beobachten, damit eine Folgeaktion ergriffen werden kann, um eine erfolgreiche Aufgabe 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 mit der Ursache als Fehlercode zurückgegeben.

Fehlercode	Hinweis
SERVICE_NOT_FOUND	Der Dienst ist auf dem angegebenen Gerät nicht verfügbar.
SERVICE_NOT_AVAILABLE	Der Dienst ist auf dem jeweiligen Gerät verfügbar, aber zum Zeitpunkt des Aufrufs nicht verfügbar (z. B. weil er explizit deaktiviert wurde).
SERVICE_CALL_EXECUTION_FAILURE	Die Taskausführung ist aufgrund von Threading-Problemen fehlgeschlagen. In diesem Fall kann ein neuer Versuch unternommen werden.
SERVICE_CALL_PERMISSION_DENIED	Der Aufrufer ist nicht berechtigt, den Dienstaufruf zu tätigen.
SERVICE_CALL_INVALID_ARGUMENT	Die Anfrage enthält ungültige Daten, z. B. mehr als die zulässige Anzahl von Clustern.
SERVICE_CALL_INTERNAL	Auf der Dienstseite ist ein Fehler aufgetreten.
SERVICE_CALL_RESOURCE_EXHAUSTED	Der Dienstaufruf erfolgt zu häufig.

Schritt 3: Broadcast-Intents verarbeiten

Neben Aufrufen der API zur Veröffentlichung von Inhalten über einen Job ist es auch erforderlich, eine BroadcastReceiver einzurichten, um die Anfrage für eine Inhaltsveröffentlichung zu empfangen.

Der Zweck von Broadcast-Intents besteht hauptsächlich darin, Apps zu reaktivieren und die Datensynchronisierung zu erzwingen. Broadcast-Intents sind nicht darauf ausgelegt, sehr häufig zu senden. Sie wird nur ausgelöst, wenn der Engage-Dienst feststellt, dass der Inhalt möglicherweise veraltet ist (z. B. eine Woche alt). Auf diese Weise wird dem Nutzer mehr Sicherheit bei der Nutzung neuer Inhalte geboten, auch wenn die Anwendung über einen längeren Zeitraum hinweg nicht ausgeführt wurde.

BroadcastReceiver muss auf zwei Arten eingerichtet werden:

• Registrieren Sie mit Context.registerReceiver() eine Instanz der BroadcastReceiver-Klasse dynamisch. Dies ermöglicht die Kommunikation von Anwendungen, die sich noch im Speicher befinden.

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION 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));

}

• Deklarieren Sie eine Implementierung mit dem Tag <receiver> in der Datei AndroidManifest.xml statisch. Die Anwendung kann dann Broadcast-Intents empfangen, wenn sie nicht ausgeführt wird, und die Inhalte können veröffentlicht werden.

<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>
   </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 dieser Intent empfangen wird.

Integrationsworkflow

Eine detaillierte Anleitung zum Prüfen der Einbindung nach Abschluss finden Sie unter Workflow für die Entwicklerintegration.

Häufig gestellte Fragen

Weitere Informationen findest du in den häufig gestellten Fragen zum Engage SDK.

Kontakt

Wenden Sie sich an [e-mail], wenn während des Integrationsprozesses Fragen auftreten. Unser Team wird sich so schnell wie möglich mit Ihnen in Verbindung setzen.

Nächste Schritte

Nach Abschluss dieser Integration sind deine nächsten Schritte:

• Senden Sie eine E-Mail an [e-mail] und hängen Sie Ihr integriertes APK an, das zum Testen 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 über die erforderlichen Details informiert.
• Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, werden Sie von Google darüber informiert, dass Sie mit der Veröffentlichung des aktualisierten und integrierten APKs im Play Store beginnen können.
• Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Play Store veröffentlicht wurde, werden die Empfehlung und die Cluster veröffentlicht und für Nutzer sichtbar.