Engage SDK Social: Anleitung zur technischen Integration von Drittanbietern

Google entwickelt eine On-Device-Oberfläche, auf der die Apps der Nutzer nach Branchen organisiert werden. So können Nutzer personalisierte App-Inhalte noch besser entdecken und nutzen. Dieser Vollbildmodus bietet Entwicklerpartnern die Möglichkeit, ihre besten Inhalte in einem speziellen Kanal außerhalb ihrer App zu präsentieren.

In diesem Dokument finden Entwicklerpartner eine Anleitung, wie sie ihre sozialen Inhalte mit dem Engage SDK einbinden, um diese neue Oberfläche zu befüllen.

Integrationsdetails

Im folgenden Abschnitt werden die Integrationsdetails erfasst.

Terminologie

In Clustern vom Typ Empfehlung werden personalisierte Vorschläge von einem einzelnen Entwicklerpartner angezeigt.

Ihre Empfehlungen haben folgende Struktur:

Empfehlungscluster: UI-Ansicht mit einer Gruppe von Empfehlungen desselben Entwicklerpartners.

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

  • PortraitMediaEntity
  • SocialPostEntity

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

  • Beitrag

    • Bild im Porträtmodus und Zeitstempel oder
    • Bild im Hochformat + Textinhalt und Zeitstempel
  • Profil

    • Avatar, Name oder Alias, zusätzliches Bild
  • Interaktionen

    • Nur zählen und beschriften oder
    • Anzahl und visuelle Darstellung (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 oder
    • Rich Media (Bild- oder Rich-Media-URL) und Zeitstempel oder
    • Text und Rich Media (Bild oder Rich Media-URL) und Zeitstempel oder
    • Videovorschau (Miniaturansicht und Dauer) und Zeitstempel
  • Interaktionen

    • Nur zählen und labeln oder
    • Anzahl und visuelle Darstellung (Symbol)

Vorarbeit

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.

Die Daten, die ein Kunde veröffentlichen kann, unterliegen den folgenden Einschränkungen für verschiedene Clustertypen:

Clustertyp Cluster limits Mindestanzahl von Entitäten in einem Cluster Maximale Entitätslimits in einem Cluster
Empfehlungscluster Höchstens 7 Mindestens 1 (PortraitMediaEntity oder SocialPostEntity) Maximal 50 (PortraitMediaEntity oder SocialPostEntity)

Schritt 1: Entitätsdaten angeben

Im SDK sind verschiedene Entitäten für jeden Artikeltyp definiert. Das SDK unterstützt die folgenden Entitäten für die Kategorie „Soziale Netzwerke“:

  1. PortraitMediaEntity
  2. SocialPostEntity

In den folgenden Diagrammen sind die verfügbaren Attribute und Anforderungen für jeden Typ aufgeführt.

PortraitMediaEntity

Attribut Anforderung Beschreibung Formatieren
Aktions-URI Erforderlich

Deeplink zur Entität in der Anbieter-App.

Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.

URI
Metadaten zum Beitrag (erforderlich)
Bild(er) Erforderlich

Die Bilder sollten im Hochformat sein.

In der Benutzeroberfläche wird möglicherweise nur ein Bild angezeigt, wenn mehrere Bilder bereitgestellt werden. Die Benutzeroberfläche kann jedoch visuell darauf hinweisen, dass es in der App weitere Bilder gibt.

Wenn es sich bei dem Beitrag um ein Video handelt, muss der Anbieter eine Miniaturansicht des Videos zur Verfügung stellen, die als Bild angezeigt wird.

Weitere Informationen finden Sie unter Anforderungen an Bilder.
Textinhalt Optional Der Haupttext eines Beitrags, einer Aktualisierung usw. String (empfohlen max. 140 Zeichen)
Zeitstempel Optional Uhrzeit, zu der der Beitrag veröffentlicht wurde. Epochen-Zeitstempel in Millisekunden
Videoinhalte Optional Ist der Beitrag ein Video? Boolesch
Videodauer Optional Dauer des Videos in Millisekunden. Lang
Profilbezogene Metadaten (optional)
Name Erforderlich Profilname, -ID oder -Alias, z. B. „Max Mustermann“ oder „@TeamPixel“ String(empfohlene maximale Länge: 25 Zeichen)
Avatar Erforderlich

Profilbild oder Avatarbild des Nutzers.

Quadratisches Bild im Format 1:1

Weitere Informationen finden Sie unter Anforderungen an Bilder.
Zusätzliches Bild Optional

Profil-Badge, z. B. „Verifiziert“-Symbol

Quadratisches Bild im Format 1:1

Weitere Informationen finden Sie unter Anforderungen an Bilder.
Metadaten zu Interaktionen (optional)
Anzahl Optional

Geben Sie die Anzahl der Interaktionen an, z. B. „3,7 Mio.“.

Hinweis:Wenn sowohl „Anzahl“ als auch „Anzahl (Wert)“ angegeben sind, wird „Anzahl“ verwendet.

String

Empfohlene Textgröße: Maximal 20 Zeichen für Anzahl + Label

Zählwert Optional

Die Anzahl der Interaktionen als Wert.

Hinweis:Geben Sie „Anzahl (Wert)“ anstelle von „Anzahl“ an, wenn Ihre App keine Logik dafür enthält, wie eine große Zahl für unterschiedliche Bildschirmgrößen optimiert werden soll. Wenn sowohl „Anzahl“ als auch „Anzahl (Wert)“ angegeben sind, wird „Anzahl“ verwendet.

Lang
Label Optional Geben Sie an, wofür das Interaktionslabel verwendet wird. Beispiel: „Mag ich“

String

Empfohlene Textgröße: Maximal 20 Zeichen für Anzahl + Label

Bild Optional

Geben Sie an, wozu die Interaktion dient. Beispiel: Bild mit dem „Mag ich“-Symbol oder einem Emoji

Sie können mehrere Bilder angeben, die jedoch nicht bei allen Formfaktoren angezeigt werden.

Hinweis:Das Bild muss quadratisch (1:1) sein.

Weitere Informationen finden Sie unter Anforderungen an Bilder.
DisplayTimeWindow (optional): Legen Sie ein Zeitfenster fest, in dem Inhalte auf der Oberfläche angezeigt werden sollen.
Startzeitstempel Optional

Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen.

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

Epochen-Zeitstempel in Millisekunden
Endzeitstempel Optional

Der Epoch-Zeitstempel, nach dem die Inhalte nicht mehr angezeigt werden.

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

Epochen-Zeitstempel in Millisekunden

SocialPostEntity

Attribut Anforderung Beschreibung Formatieren
Aktions-URI Erforderlich

Deeplink zur Entität in der Anbieter-App.

Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.

URI

Metadaten zum Beitrag (erforderlich)

Es muss mindestens eine der folgenden Optionen angegeben werden: „TextContent“, „Image“ oder „WebContent“.

Bild(er) Optional

Die Bilder sollten im Hochformat sein.

In der Benutzeroberfläche wird möglicherweise nur ein Bild angezeigt, wenn mehrere Bilder bereitgestellt werden. Die Benutzeroberfläche kann jedoch visuell darauf hinweisen, dass es in der App weitere Bilder gibt.

Wenn es sich bei dem Beitrag um ein Video handelt, muss der Anbieter eine Miniaturansicht des Videos zur Verfügung stellen, die als Bild angezeigt wird.

Weitere Informationen finden Sie unter Anforderungen an Bilder.
Textinhalt Optional Der Haupttext eines Beitrags, einer Aktualisierung usw. String (empfohlen max. 140 Zeichen)
Videoinhalte (optional)
Dauer Erforderlich Dauer des Videos in Millisekunden. Lang
Bild Erforderlich Vorschaubild des Videocontents. Weitere Informationen finden Sie unter Anforderungen an Bilder.
Linkvorschau (optional)
Linkvorschau – Titel Erforderlich Text, der den Titel des Inhalts der Webseite angibt String
Linkvorschau – Hostname Erforderlich Text, der den Inhaber der Webseite angibt, z. B. „INSIDER“ String
Linkvorschau – Bild Optional Hero-Image für den Webcontent Weitere Informationen finden Sie unter Anforderungen an Bilder.
Zeitstempel Optional Uhrzeit, zu der der Beitrag veröffentlicht wurde. Epochen-Zeitstempel in Millisekunden
Profilbezogene Metadaten (optional)
Name Erforderlich Profilname, -ID oder -Alias, z. B. „Max Mustermann“ oder „@TeamPixel“ String(empfohlene maximale Länge: 25 Zeichen)
Zusätzlicher Text Optional

Kann als Profil-ID, Alias oder zusätzliche Metadaten verwendet werden

Beispiel: „@MaxMustermann“, „5 Mio. Follower“, „Empfehlungen“, „Angesagt“, „5 neue Beiträge“

String(empfohlene maximale Länge: 40 Zeichen)
Avatar Erforderlich

Profilbild oder Avatarbild des Nutzers.

Quadratisches Bild im Format 1:1

Weitere Informationen finden Sie unter Anforderungen an Bilder.
Zusätzliches Bild Optional

Profil-Badge, z. B. „Verifiziert“-Symbol

Quadratisches Bild im Format 1:1

Weitere Informationen finden Sie unter Anforderungen an Bilder.
Metadaten zu Interaktionen (optional)
Anzahl Erforderlich Geben Sie die Anzahl der Interaktionen an, z. B. „3,7 Mio.“ String (empfohlene maximale Länge: 20 Zeichen für Anzahl und Label zusammen)
Label

Optional

Wenn nicht angegeben, muss Visuell angegeben werden.

Geben Sie an, wozu die Interaktion dient. Beispiel: „Mag ich“ String (empfohlene maximale Länge: 20 Zeichen für Anzahl und Label zusammen)
Bild

Optional

Wenn nicht angegeben, muss Label angegeben werden.

Geben Sie an, wozu die Interaktion dient. Beispiel: Bild mit dem „Mag ich“-Symbol oder einem Emoji

Sie können mehrere Bilder angeben, die jedoch nicht bei allen Formfaktoren angezeigt werden.

Quadratisches Bild im Format 1:1

Weitere Informationen finden Sie unter Anforderungen an Bilder.
DisplayTimeWindow (optional): Legen Sie ein Zeitfenster fest, in dem Inhalte auf der Oberfläche angezeigt werden sollen.
Startzeitstempel Optional

Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen.

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

Epochen-Zeitstempel in Millisekunden
Endzeitstempel Optional

Der Epoch-Zeitstempel, nach dem die Inhalte nicht mehr angezeigt werden.

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

Epochen-Zeitstempel in Millisekunden

Bildspezifikationen

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

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.
  • Verwenden Sie einen transparenten Hintergrund, damit das Bild in den Einstellungen für dunkle und helle Designs richtig angezeigt werden kann.

Schritt 2: Clusterdaten angeben

Wir empfehlen, den Job zum Veröffentlichen von Inhalten im Hintergrund auszuführen (z. B. mit WorkManager) und regelmäßig oder auf Ereignisbasis zu planen (z. B. jedes Mal, wenn der Nutzer die App öffnet oder einem neuen Konto folgt).

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

Es gibt die folgenden APIs, um Cluster im Client zu veröffentlichen:

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

isServiceAvailable

Mit dieser API wird geprüft, ob der Dienst für die Einbindung 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 werden Listen von RecommendationCluster-Objekten veröffentlicht.

Ein RecommendationCluster-Objekt kann die folgenden Attribute haben:

Attribut Anforderung 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 Cluster müssen vom selben Typ sein.
Titel Erforderlich

Der Titel des Empfehlungsclusters (z. B. Neueste Inhalte von deinen Freunden).

Empfohlene Textgröße: weniger als 25 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.)

Untertitel Optional Der Untertitel für den Empfehlungscluster.
Aktions-URI Optional

Der Deeplink zur 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 finden Sie in dieser FAQ.

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 erhält, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:

  • Alle vorhandenen Daten zu Empfehlungsclustern werden entfernt.
  • Die Daten aus der Anfrage werden analysiert und in neuen Empfehlungsclustern gespeichert.

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.

publishUserAccountManagementRequest

Mit dieser API wird eine Anmeldekarte veröffentlicht . Die Anmeldeaktion leitet Nutzer zur Anmeldeseite der App weiter, damit die App Inhalte veröffentlichen oder personalisiertere 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 „Titel“ angegeben werden.

Auf der Karte angezeigtes Bild

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

Titel Optional. Wenn nicht angegeben, muss „Image“ angegeben werden. Titel auf der Karte
Aktionstext Optional Text im CTA (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 erhält, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:

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

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.

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 :

  • Der Status muss in allen Fällen angegeben werden, auch wenn die Inhalte veröffentlicht wurden (STATUS == PUBLISHED). Andernfalls können Dashboards nicht mit diesem expliziten Status gefüllt werden, um den Zustand und andere Messwerte deiner Integration zu vermitteln.
  • Wenn keine Inhalte veröffentlicht werden, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google Warnungen in den Dashboards zur App-Integrität vermeiden. Hiermit wird bestätigt, dass Inhalte aufgrund einer erwarteten Situation aus Sicht des Anbieters nicht veröffentlicht werden.
  • Sie hilft Entwicklern, Aufschluss darüber zu geben, 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 die App-Inhalte sehen oder überwinden können.

Folgende Veröffentlichungsstatuscodes sind zulässig :

// 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 aufgrund einer fehlenden Nutzeranmeldung nicht veröffentlicht werden, empfiehlt Google, die Anmeldekarte zu veröffentlichen. Wenn Anbieter die Anmeldekarte aus irgendeinem Grund nicht veröffentlichen können, empfehlen wir, die API updatePublishStatus 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 können Sie den Inhalt von Empfehlungsclustern löschen.

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 aktuelle Status beibehalten.

deleteUserManagementCluster

Mit dieser API können Sie den Inhalt des Clusters „UserAccountManagement“ löschen.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Wenn der Dienst die Anfrage erhält, entfernt er die vorhandenen Daten aus dem Cluster „UserAccountManagement“. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.

deleteClusters

Mit dieser API können Sie den Inhalt eines bestimmten Clustertyps löschen.

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 erhält, 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 Aufgabenergebnis aus den Veröffentlichungs-APIs abzuhören, damit eine Folgeaktion ausgeführt 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 zurückgegeben, wobei die Ursache als Fehlercode enthalten ist.

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 Problemen mit dem Thread fehlgeschlagen. In diesem Fall kann der Vorgang wiederholt werden.
4 SERVICE_CALL_PERMISSION_DENIED Der Anrufer ist nicht berechtigt, den Dienst anzurufen.
5 SERVICE_CALL_INVALID_ARGUMENT Die Anfrage enthält ungültige Daten (z. B. mehr als die zulässige Anzahl von Clustern).
6 SERVICE_CALL_INTERNAL Es ist ein Fehler auf Dienstebene aufgetreten.
7 SERVICE_CALL_RESOURCE_EXHAUSTED Der Dienstaufruf wird zu häufig ausgeführt.

Schritt 3: Broadcast-Intents verarbeiten

Zusätzlich zu API-Aufrufen für die Veröffentlichung von Inhalten über einen Job muss auch eine BroadcastReceiver eingerichtet werden, um die Anfrage für die Veröffentlichung von Inhalten zu erhalten.

Broadcast-Intents dienen hauptsächlich zur Reaktivierung von Apps und zum Erzwingen der Datensynchronisierung. Broadcast-Intents sind nicht für häufige Übermittlungen vorgesehen. Sie wird nur ausgelöst, wenn der Engage-Dienst feststellt, dass die Inhalte möglicherweise veraltet sind (z. B. eine Woche alt). So ist die Wahrscheinlichkeit höher, dass Nutzer aktuelle Inhalte sehen, auch wenn die Anwendung seit einiger Zeit nicht ausgeführt wurde.

Das BroadcastReceiver muss auf eine der folgenden beiden Arten eingerichtet werden:

  • Registrieren Sie eine Instanz der Klasse BroadcastReceiver dynamisch mit Context.registerReceiver(). So ist die Kommunikation von Anwendungen möglich, die sich noch im Arbeitsspeicher 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 statisch mit dem <receiver>-Tag in der Datei AndroidManifest.xml. So kann die Anwendung Broadcast-Intents empfangen, wenn sie nicht ausgeführt wird, und die Inhalte veröffentlichen.
<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>

Der Dienst sendet die folgenden Intents:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Wir empfehlen, bei Erhalt dieser Absicht einen publishRecommendationClusters-Aufruf zu starten.

Integrationsablauf

Eine detaillierte Anleitung zum Überprüfen Ihrer Integration nach Abschluss finden Sie unter Integrationsablauf für Entwickler.

Häufig gestellte Fragen

Häufig gestellte Fragen zum Engage SDK

Kontakt

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

Nächste Schritte

Nach Abschluss dieser Integration sind folgende Schritte erforderlich:

  • Senden Sie eine E-Mail an engage-developers@google.com und hängen Sie Ihr integriertes APK an, das für den Test durch Google bereit ist.
  • Google führt eine interne Überprüfung durch, um sicherzustellen, dass die Integration wie erwartet funktioniert. Wenn Änderungen erforderlich sind, kontaktiert Sie Google mit allen erforderlichen Details.
  • Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, benachrichtigt Sie Google, dass Sie mit der Veröffentlichung des aktualisierten und integrierten APK im Play Store beginnen können.
  • Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Play Store veröffentlicht wurde, werden Ihre Cluster veröffentlicht und für Nutzer sichtbar.