Engage SDK Shopping: 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

In dieser Anleitung finden Entwicklerpartner Informationen dazu, wie sie Shopping-Inhalte für Engage-Inhaltsplattformen bereitstellen können.

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 fünf Clustertypen: Empfehlung, Vorgestellt, Einkaufswagen, Einkaufsliste, Neu bestellen und Tracking von Shopping-Bestellungen.

• In Empfehlungs-Clustern werden personalisierte Shopping-Vorschläge von einem einzelnen Entwicklerpartner angezeigt. Diese Empfehlungen können personalisiert oder verallgemeinert werden (z. B. Trendartikel). Sie können sie verwenden, um Produkte, Veranstaltungen, Verkäufe, Angebote und Abos nach Bedarf zu präsentieren.

  Ihre Empfehlungen haben die folgende Struktur:

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

  • ShoppingEntity:Ein Objekt, das einen einzelnen Artikel in einem Cluster darstellt.

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

• Der Cluster Einkaufswagen bietet einen Überblick über die Einkaufswagen vieler Entwicklerpartner in einer Benutzeroberflächengruppe und soll Nutzer dazu anregen, ihre ausstehenden Warenkörbe zu vervollständigen. Es gibt einen einzelnen Warenkorb-Cluster, der oben in der Benutzeroberfläche angezeigt wird und eine höhere Priorität als alle Empfehlungscluster hat. Jeder Entwicklerpartner darf bis zu drei ShoppingCart-Instanzen im Warenkorb-Cluster übertragen.

  Ihr Warenkorb hat die folgende Struktur:

  • Einkaufswagen-Cluster:Eine Benutzeroberflächenansicht, die eine Gruppe von Einkaufswagen-Vorschauen von vielen Entwicklerpartnern enthält.

  • ShoppingCart:Ein Objekt, das die Einkaufswagenvorschau für einen einzelnen Entwicklerpartner darstellt, die im Einkaufswagen-Cluster angezeigt werden soll. Die ShoppingCart muss die Gesamtzahl der Artikel im Warenkorb enthalten und kann auch Bilder für einige Artikel im Warenkorb des Nutzers enthalten.

• Im Cluster Einkaufsliste sehen Nutzer eine Vorschau der Einkaufslisten von mehreren Entwicklerpartnern in einer Benutzeroberflächengruppe. Sie werden aufgefordert, zur entsprechenden App zurückzukehren, um ihre Listen zu aktualisieren und zu vervollständigen. Es gibt einen einzelnen Cluster für die Einkaufsliste.

• Im Cluster Neu bestellen werden Nutzer aufgefordert, Produkte noch einmal zu bestellen. Dazu werden in einer Benutzeroberflächengruppe die vorherigen Bestellungen von mehreren Entwicklerpartnern angezeigt. Es gibt nur einen Cluster für die Funktion „Neu bestellen“.

  • Der Cluster für die erneute Bestellung muss die Gesamtzahl der Artikel in der vorherigen Bestellung des Nutzers enthalten und außerdem eines der folgenden Elemente:

    • Bilder für X Artikel in der vorherigen Bestellung des Nutzers.
    • Labels für X Artikel in der vorherigen Bestellung des Nutzers.

• Im Cluster Shopping-Bestellungen verfolgen werden ausstehende oder kürzlich abgeschlossene Shopping-Bestellungen von vielen Entwicklerpartnern in einer UI-Gruppierung angezeigt, damit Nutzer ihre Bestellungen verfolgen können.

  Es gibt einen einzelnen ShoppingOrderTracking-Cluster, der oben in der Benutzeroberfläche angezeigt wird und eine höhere Priorität als alle Recommendation-Cluster hat. Jeder Entwicklerpartner darf mehrere ShoppingOrderTrackingEntity-Elemente im Shopping Order Tracking-Cluster übertragen.

  • Ihr ShoppingOrderTrackingCluster hat die folgende Struktur:

    • ShoppingOrderTracking Cluster: Eine Benutzeroberflächenansicht, die eine Gruppe von Vorschauen zur Sendungsverfolgung von Bestellungen von vielen Entwicklerpartnern enthält.
    • ShoppingOrderTrackingEntity: Ein Objekt, das eine Vorschau für die Sendungsverfolgung einer Shopping-Bestellung für einen einzelnen Entwicklerpartner darstellt, die im Cluster „Sendungsverfolgung von Shopping-Bestellungen“ angezeigt werden soll. Die ShoppingOrderTrackingEntity muss den Status der Bestellung und die Bestellzeit enthalten. Wir empfehlen dringend, die erwartete Lieferzeit für ShoppingOrderTrackingEntity anzugeben, da sie Nutzern angezeigt wird, sofern sie verfügbar ist.

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

Weitere Informationen finden Sie unter Paketsichtbarkeit in Android 11.

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. Die folgenden Einheiten werden für die Shopping-Kategorie unterstützt:

1. ShoppingEntity
2. ShoppingCart
3. ShoppingList
4. Reorder
5. ShoppingOrderTracking

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

ShoppingEntity

Das ShoppingEntity-Objekt stellt ein Produkt, Angebot, Abo oder Event dar, das Entwicklerpartner veröffentlichen möchten.

ShoppingEntity

ShoppingCart

ShoppingList

ShoppingReorderCluster

ShoppingOrderTrackingCluster

Bildspezifikationen

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

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.

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

AppEngageShoppingClient ist für die Veröffentlichung von Shopping-Clustern verantwortlich.

Die folgenden APIs werden bereitgestellt, um Cluster im Client zu veröffentlichen:

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishShoppingCarts
• publishShoppingLists
• publishShoppingReorderCluster
• publishShoppingOrderTrackingCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteShoppingCartCluster
• deleteShoppingListCluster
• deleteShoppingReorderCluster
• deleteShoppingOrderTrackingCluster
• 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 zeitweise Erfassung für eine beliebige Gruppe von Geräten konfiguriert ist, sind alle Publikationen von Fortsetzungsclustern (z. B. Einkaufswagen, Einkaufsliste, Nachbestellung und Sendungsverfolgung) standardmäßig aktiviert. Die restlichen Clustertypen werden zeitweise aktiviert und deaktiviert. Wenn die zeitweise Erfassung 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.

Ein RecommendationCluster-Objekt kann die folgenden Attribute haben:

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build())

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build());

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

• Alle vorhandenen Daten zu Empfehlungsclustern 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.

publishFeaturedCluster

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

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

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 vorgestellten Cluster gespeichert.

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

publishShoppingCarts

Diese API wird verwendet, um eine Liste von ShoppingCart-Objekten zu veröffentlichen. Dies gilt für Entwicklerpartner, die separate Warenkörbe pro Händler veröffentlichen. Geben Sie bei Verwendung dieser API den Händlernamen im Titel an.

client.publishShoppingCarts(
            PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    ShoppingCart.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingCarts(
            new PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    new ShoppingCart.Builder()
                        ...
                        .build())
                .build())

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

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

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

publishShoppingLists

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

client.publishShoppingLists(
            PublishShoppingListsRequest.Builder()
                .addShoppingList(
                    ShoppingList.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingLists(
            new PublishShoppingListsRequest.Builder()
                .addShoppingList(
                    new ShoppingListEntity.Builder()
                        ...
                        .build())
                .build());

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

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

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

publishShoppingReorderCluster

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

client.publishShoppingReorderCluster(
            PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingReorderCluster(
            new PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    new ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build());

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

• Vorhandene ShoppingReorderCluster-Daten des Entwicklerpartners werden entfernt.
• Die Daten aus der Anfrage werden geparst und im aktualisierten Cluster für die erneute Bestellung gespeichert.

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

publishShoppingOrderTrackingCluster

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

client.publishShoppingOrderTrackingCluster(
            PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingOrderTrackingCluster(
            new PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    new ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build());

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

• Vorhandene ShoppingOrderTrackingCluster-Daten des Entwicklerpartners werden entfernt.
• Die Daten aus der Anfrage werden geparst und im aktualisierten Shopping Order Tracking-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 aus irgendeinem Grund die Anmeldekarte 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.

deleteShoppingCartCluster

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

client.deleteShoppingCartCluster()

client.deleteShoppingCartCluster();

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

deleteShoppingListCluster

Mit dieser API wird der Inhalt des Shopping List-Clusters gelöscht.

client.deleteShoppingListCluster()

client.deleteShoppingListCluster();

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

deleteShoppingReorderCluster

Mit dieser API wird der Inhalt des Shopping-Clusters für die erneute Bestellung gelöscht.

client.deleteShoppingReorderCluster()

client.deleteShoppingReorderCluster();

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

deleteShoppingOrderTrackingCluster

Mit dieser API wird der Inhalt des Shopping-Clusters für die Bestellverfolgung gelöscht.

client.deleteShoppingOrderTrackingCluster()

client.deleteShoppingOrderTrackingCluster();

Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem Shopping Order Tracking 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_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      ...
      .build())

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast
  // is received
  // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast
  // is received
  // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
  // received
  // Trigger shopping order tracking cluster publish when
  // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER 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 Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Reorder Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping Order Tracking Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                           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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast is
// received

// Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER
// 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 Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping Order Tracking Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                         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.shopping.PUBLISH_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER" />
      </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.
• com.google.android.engage.action.PUBLISH_FEATURED Es wird empfohlen, einen publishFeaturedCluster-Aufruf zu starten, wenn diese Absicht empfangen wird.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART Es wird empfohlen, einen publishShoppingCarts-Aufruf zu starten, wenn diese Absicht empfangen wird.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST Es wird empfohlen, einen publishShoppingLists-Aufruf zu starten, wenn diese Absicht empfangen wird.
• com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER Es wird empfohlen, einen publishReorderCluster-Aufruf zu starten, wenn diese Absicht empfangen wird.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER Es wird empfohlen, einen publishShoppingOrderTrackingCluster-Anruf zu starten, wenn diese Absicht empfangen wird.

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. Unser Team antwortet so schnell wie möglich.

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, können Ihre Cluster Empfehlung, Vorgestellt, Einkaufswagen, Einkaufsliste, Cluster für erneute Bestellung und Cluster für die Sendungsverfolgung von Einkäufen veröffentlicht und für Nutzer sichtbar sein.