Engage SDK Health and Fitness: Anleitung zur technischen Integration von Drittanbietern

Die App-Interaktionen steigern, indem Sie Nutzer dort erreichen, wo sie sich aufhalten Mit dem Engage SDK kannst du personalisierte Empfehlungen und Folgeinhalte 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 bei den meisten Apps etwa eine Woche. Weitere Informationen

Diese Anleitung enthält Informationen für Entwicklerpartner, die Gesundheits- und Fitnessinhalte auf Engage-Inhaltsplattformen bereitstellen möchten.

Unterstützung von Kategorien und Oberflächen

Die Eignung von Engage SDK-Oberflächen hängt von der Inhaltskategorie Ihrer App ab. Anhand der folgenden Tabelle können Sie feststellen, ob Sie die Voraussetzungen für bestimmte Oberflächen erfüllen:

android skills add engage-sdk-integration

Integrationsdetails

Terminologie

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

• In Empfehlungsclustern werden personalisierte Gesundheits- und Fitnessvorschläge von einem einzelnen Entwicklerpartner angezeigt. Diese Empfehlungen können personalisiert oder verallgemeinert werden (z. B. Fitness- und Gesundheitstrends). Damit können Sie Artikel oder Personen im Zusammenhang mit Gesundheit und Fitness präsentieren.

  • Ein Empfehlungscluster kann aus ArticleEntity, PersonEntity oder EventEntity bestehen, aber nicht aus einer Mischung verschiedener Entitätstypen.

  Ihre Empfehlungen haben die folgende Struktur:

  • Empfehlungscluster:Eine Benutzeroberflächenansicht, die eine Gruppe von Empfehlungen desselben Entwicklerpartners enthält.

  • Entität:Ein Objekt, das ein einzelnes Element in einem Cluster darstellt. Diese Integration bietet einige Einheiten, die über das Empfehlungscluster angezeigt werden:

    • ArticleEntity: ArticleEntity stellt eine Empfehlung für textbasierte Inhalte zu Gesundheit und Fitness dar. Es kann für Artikel, Blogbeiträge, Marketinginhalte, Nachrichten-Snippets usw. verwendet werden.

      

    • PersonEntity: PersonEntity steht für eine Person. Die Empfehlungen können sich auf einen Coach oder eine Person beziehen, die mit Gesundheit und Fitness in Verbindung steht.

      

    • EventEntity: EventEntity stellt ein zukünftiges Ereignis dar. Die Startzeit eines Ereignisses ist eine wichtige Information, die den Nutzern mitgeteilt werden muss. Diese Einheit kann verwendet werden, um Ereignisse wie Blutspendenaktionen, Trainingseinheiten, Fitnessstudio- oder Yogakurse usw. im Zusammenhang mit Gesundheit und Fitness zu präsentieren.

      

• Im Cluster Fortsetzung werden Inhalte angezeigt, mit denen Nutzer kürzlich interagiert haben. Die Inhalte stammen von mehreren Entwicklerpartnern und sind in einer einzigen Benutzeroberflächengruppe zusammengefasst. Jeder Entwicklerpartner darf maximal 10 Entitäten im Continuation-Cluster übertragen.

  Ihre Fortsetzungsinhalte können die folgende Struktur haben:

  • ArticleEntity: ArticleEntity stellt eine Empfehlung für textbasierte Inhalte dar, die sich auf Gesundheit und Fitness beziehen. Diese Einheit kann verwendet werden, um unfertige Nachrichtenartikel oder andere Inhalte darzustellen, die der Nutzer dort weiterlesen möchte, wo er aufgehört hat. Beispiel: News-Snippet, Blogbeitrags-Snippet zu gesundheits- oder fitnessbezogenen Themen.

    

  • EventReservationEntity: EventReservationEntity steht für eine Reservierung für ein Event und hilft Nutzern, Reservierungen für anstehende oder laufende Fitness- und Gesundheitsereignisse zu verfolgen. Beispiel: Schulungen

    

• Im Cluster Vorgestellt wird eine Auswahl von Unternehmen verschiedener Entwicklerpartner in einer Benutzeroberflächengruppe präsentiert. Es gibt nur noch einen Cluster mit Empfehlungen, der oben in der Benutzeroberfläche angezeigt wird und vor allen anderen Empfehlungsclustern platziert ist. Jeder Entwicklerpartner darf bis zu 10 Entitäten im Cluster „Empfohlen“ präsentieren.

  • GenericFeaturedEntity: GenericFeaturedEntity unterscheidet sich von RecommendationItem dadurch, dass FeaturedItem für einzelne Top-Inhalte von Entwicklern verwendet werden sollte. Es sollte sich um die wichtigsten Inhalte handeln, die für Nutzer interessant und relevant sind.

    

Vorarbeit

Mindest-API‑Level: 19

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

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

Zusammenfassung

Das Design basiert auf einer Implementierung eines gebundenen Dienstes.

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

Schritt 1: Rechtssubjektdaten angeben

Im SDK sind verschiedene Entitäten definiert, die die einzelnen Artikeltypen darstellen. Wir unterstützen die folgenden Einheiten für die Kategorie „Gesundheit und Fitness“:

1. GenericFeaturedEntity
2. ArticleEntity
3. PersonEntity
4. EventEntity
5. EventReservationEntity

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

GenericFeaturedEntity

ArticleEntity

PersonEntity

EventEntity

EventReservationEntity

Bildspezifikationen

In dieser Tabelle finden Sie die erforderlichen Spezifikationen für Bild-Assets:

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 das helle und das dunkle Design richtig angezeigt werden kann.

Inhaltskategorie

Mit der Inhaltskategorie können Apps Inhalte aus mehreren Kategorien veröffentlichen. Dadurch werden die Inhalte einigen der vordefinierten Kategorien zugeordnet, nämlich:

• TYPE_EDUCATION
• TYPE_SPORTS
• TYPE_MOVIES_AND_TV_SHOWS
• TYPE_BOOKS
• TYPE_AUDIOBOOKS
• TYPE_MUSIC
• TYPE_DIGITAL_GAMES
• TYPE_TRAVEL_AND_LOCAL
• TYPE_HOME_AND_AUTO
• TYPE_BUSINESS
• TYPE_NEWS
• TYPE_FOOD_AND_DRINK
• TYPE_SHOPPING
• TYPE_HEALTH_AND_FITENESS
• TYPE_MEDICAL
• TYPE_PARENTING
• TYPE_DATING

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

Richtlinien für die Verwendung der Inhaltskategorien

1. Für einige Einheiten wie ArticleEntity und GenericFeaturedEntity können alle Inhaltskategorien verwendet werden. Für andere Einheiten wie EventEntity, EventReservationEntity und PersonEntity ist nur eine Teilmenge dieser Kategorien zulässig. Prüfen Sie die Liste der Kategorien, die für einen Entitätstyp infrage kommen, bevor Sie die Liste ausfüllen.

2. Verwenden Sie für einige Inhaltskategorien den spezifischen Entitätstyp anstelle einer Kombination aus den generischen Entitäten und ContentCategory:

   • TYPE_MOVIES_AND_TV_SHOWS: Sehen Sie sich die Einheiten im Leitfaden zur Watch-Integration an, bevor Sie die generischen Einheiten verwenden.
   • TYPE_BOOKS: Sehen Sie sich vor der Verwendung der generischen Einheiten die EbookEntity an.
   • TYPE_AUDIOBOOKS: Sehen Sie sich vor der Verwendung der generischen Entitäten AudiobookEntity an.
   • TYPE_SHOPPING: Sehen Sie sich ShoppingEntity an, bevor Sie die generischen Einheiten verwenden.
   • TYPE_FOOD_AND_DRINK: Sehen Sie sich die Elemente aus der Anleitung zur Lebensmittelintegration an, bevor Sie die generischen Elemente verwenden.

3. Das Feld „ContentCategory“ ist optional und sollte leer gelassen werden, wenn die Inhalte keiner der oben genannten Kategorien angehören.

4. Wenn mehrere Inhaltskategorien angegeben werden, geben Sie sie in der Reihenfolge ihrer Relevanz für die Inhalte an. Die relevanteste Inhaltskategorie sollte dabei an erster Stelle in der Liste stehen.

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.

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

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

Für Engage SDK v1.6.0 und höher (empfohlen)

android skills add engage-sdk-integration

Use the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.

Sie können die Dienstverfügbarkeit für jeden Clustertyp prüfen, den Sie veröffentlichen möchten. Die isServiceAvailable API akzeptiert ein Anfrageobjekt, ServiceAvailabilityRequest, das die Clustertypen enthält, für die die Dienstverfügbarkeit geprüft werden muss. Die für ServiceAvailabilityRequest erforderlichen ClusterType-Enum-Werte finden Sie in der folgenden Tabelle.

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
});

Funktion für die bedingte Dienstverfügbarkeit

Einige integrierte Apps erfordern eine spezielle Konfiguration, mit der der Engage-Dienst zeitweise aktiviert und deaktiviert wird, um die Bereitstellungskosten zu senken. Diese Strategie zur zeitweiligen Contentaufnahme ist zwar möglich, wirkt sich jedoch negativ auf den Nutzer und das Produkt aus. Veraltete Inhalte werden nicht präsentiert und einige Oberflächen werden überhaupt nicht bereitgestellt.

Ab Version 1.6.0 können Sie mit dem Engage SDK die Verfügbarkeit für bestimmte Clustertypen prüfen. Das bietet mehr Flexibilität. Wenn die Strategie für intermittierende Inhalte für eine bestimmte Anwendung übernommen wurde, können einige Clustertypen dieser Strategie folgen, während andere Clustertypen immer aktiviert sind (z. B. Fortsetzungscluster).

Wenn der Engage-Dienst aus irgendeinem Grund nicht „kontinuierlich“ auf allen unterstützten Geräten aktiviert sein soll und für eine beliebige Gruppe von Geräten für die zeitweise Aufnahme konfiguriert ist, sind alle Publikationen von Fortsetzungsclustern (z. B. „Weiterlesen“ und „Eventreservierungen“) standardmäßig aktiviert. Die restlichen Clustertypen werden zeitweise aktiviert und deaktiviert. Wenn die zeitweise Aufnahme auf Sie zutrifft, diese Standardkonfiguration aber nicht Ihren Anforderungen entspricht, wenden Sie sich bitte an engage-developers@google.com.

Für SDK-Versionen vor v1.6.0 (eingestellt)

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

Diese API wird verwendet, um eine Liste von RecommendationCluster-Objekten zu veröffentlichen.

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .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

Diese API wird verwendet, um eine Liste von FeaturedCluster-Objekten zu veröffentlichen.

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .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 vorgestellten Cluster gespeichert.

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

publishContinuationCluster

Diese API wird zum Veröffentlichen eines ContinuationCluster-Objekts verwendet.

client.publishContinuationCluster(
    PublishContinuationClusterRequest.Builder()
      .setContinuationCluster(
        ContinuationCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(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:

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

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

• Vorhandene UserAccountManagementCluster-Daten des Entwicklerpartners werden entfernt.
• 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 API updatePublishStatus zu aktualisieren. Das ist wichtig, weil :

• 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 Warnungen in den App-Health-Dashboards ausgelöst werden. Es wird bestätigt, dass Inhalte aufgrund einer aus Sicht des Anbieters erwarteten Situation nicht veröffentlicht werden.
• So können Entwickler nachvollziehen, 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 Statuscodes für die Veröffentlichung 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.

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

Mit dieser API werden die Inhalte von Empfehlungsclustern gelöscht.

client.deleteRecommendationClusters()

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

Mit dieser API wird der Inhalt des vorgestellten Clusters gelöscht.

client.deleteFeaturedCluster()

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

Diese API wird verwendet, um den Inhalt von Fortsetzungsclustern zu löschen.

client.deleteContinuationCluster()

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.

client.deleteUserManagementCluster()

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.

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

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_CONTINUATION)
                .addClusterType(ClusterType.TYPE_FEATURED)
                .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 beibehalten.

Fehlerbehandlung

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

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

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.

Schritt 3: Broadcast-Intents verarbeiten

Neben dem Ausführen von 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 empfangen.

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 folgende zwei Arten eingerichtet werden:

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

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

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. Dadurch 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, bei Empfang dieses Intents einen publishRecommendationClusters-Aufruf zu starten.
• com.google.android.engage.action.PUBLISH_FEATURED Es wird empfohlen, bei Empfang dieses Intents einen publishFeaturedCluster-Anruf zu starten.
• com.google.android.engage.action.PUBLISH_CONTINUATION Es wird empfohlen, bei Empfang dieses Intents einen publishContinuationCluster-Anruf zu starten.

Integrationsablauf

Eine detaillierte Anleitung zum Überprüfen der Integration nach Abschluss finden Sie unter Workflow für die Entwicklerintegration von Engage.

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.

Nächste Schritte

Nachdem Sie die Integration abgeschlossen haben, gehen Sie so vor:

• 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 Überprüfung durch und prüft intern, ob die Integration wie erwartet funktioniert. Falls Änderungen erforderlich sind, setzt sich Google mit den erforderlichen Details mit Ihnen in Verbindung.
• Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, benachrichtigt Google Sie, dass Sie das aktualisierte und integrierte APK im Google Play Store veröffentlichen können.
• Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Google Play Store veröffentlicht wurde, werden Ihre Cluster Empfehlung, Vorgestellt und Fortsetzung möglicherweise veröffentlicht und für Nutzer sichtbar.