Engage SDK Food: Anleitung zur technischen Integration von Drittanbietern

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

In dieser Anleitung finden Entwicklerpartner Informationen dazu, wie sie Inhalte zu Lebensmitteln (Essensbestellungen, Rezensionen von Lebensmitteln oder Restaurants, Abos für Mahlzeiten, Rezepte) auf Engage-Inhaltsplattformen bereitstellen können.

Integrationsdetails

Terminologie

Diese Integration umfasst die folgenden fünf Clustertypen: Empfehlung, Vorgestellt, Einkaufswagen für Lebensmittel, Einkaufsliste für Lebensmittel und Neu bestellen.

  • In Empfehlungsgruppen werden personalisierte Vorschläge zu Lebensmitteln von einem einzelnen Entwicklerpartner angezeigt. Diese Empfehlungen können für den Nutzer personalisiert oder verallgemeinert werden (z. B. „Neu im Angebot“). Sie können sie verwenden, um Rezepte, Geschäfte, Gerichte, Lebensmittel usw. nach Bedarf zu präsentieren.

    • Ein Empfehlungscluster kann aus ProductEntity-, StoreEntity- oder RecipeEntity-Einträgen bestehen, aber nicht aus einer Mischung verschiedener Entitätstypen.
    Abbildung :`ProductEntity`, `StoreEntity` und `RecipeEntity`. (*UI nur zu Illustrationszwecken)
  • Im Cluster Vorgestellt werden ausgewählte Entitäten von mehreren Entwicklerpartnern in einer UI-Gruppierung präsentiert. Es gibt einen einzelnen Cluster „Vorgestellt“, der oben in der Benutzeroberfläche angezeigt wird und eine höhere Priorität als alle Empfehlungscluster hat. Jeder Entwicklerpartner darf bis zu 10 Entitäten im Cluster „Empfohlen“ übertragen.

    Abbildung :Vorgestellter Cluster mit der `RecipeEntity`. (*UI nur zu Illustrationszwecken)
  • Der Cluster Einkaufswagen für Lebensmittel bietet einen Überblick über Einkaufswagen für Lebensmittel von mehreren Entwicklerpartnern in einer Benutzeroberfläche. Nutzer werden aufgefordert, ihre ausstehenden Einkaufswagen zu vervollständigen. Es gibt nur ein Cluster für den Lebensmittel-Einkaufswagen.

    • Im Food Shopping Cart Cluster muss die Gesamtzahl der Artikel im Einkaufswagen angezeigt werden. Es können auch Bilder für X Artikel im Einkaufswagen des Nutzers enthalten sein.

      Abbildung:Cluster für Einkaufswagen für Lebensmittel von einem einzelnen Partner. (*Die Benutzeroberfläche dient nur zur Veranschaulichung)
  • 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 nur einen Cluster für Einkaufslisten für Lebensmittel.

    Abbildung:Cluster „Einkaufsliste für Lebensmittel“ von einem einzelnen Partner. (*Die Benutzeroberfläche dient nur zur Veranschaulichung.)
  • Im Cluster Neu bestellen werden Nutzer aufgefordert, Produkte neu 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 anordnen“.

    • Das Cluster „Neu bestellen“ muss die Gesamtzahl der Artikel in der vorherigen Bestellung des Nutzers enthalten und außerdem eines der folgenden Elemente:

      • Bilder für X Artikel aus der vorherigen Bestellung des Nutzers.
      • Labels für X Artikel in der vorherigen Bestellung des Nutzers.
    Abbildung:Cluster für die erneute Bestellung von Lebensmitteln von einem einzelnen Partner. (*Die Benutzeroberfläche dient nur zur Veranschaulichung.)

Vorbereitung

Mindest-API-Level: 19

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

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

Zusammenfassung

Das Design basiert auf einer Implementierung eines gebundenen Dienstes.

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

Clustertyp Cluster limits Maximale Entitätslimits in einem Cluster
Empfehlungscluster Höchstens 7 Maximal 50 (ProductEntity, RecipeEntity oder StoreEntity)
Empfohlener Cluster Höchstens 1 Höchstens 20 (ProductEntity, RecipeEntity oder StoreEntity)
Cluster „Einkaufswagen für Lebensmittel“ Höchstens 1 Höchstens 1 ShoppingCartEntity
Cluster „Einkaufsliste für Lebensmittel“ Höchstens 1 Höchstens 1 ShoppingListEntity
Cluster für erneute Lebensmittelbestellung Höchstens 1 Höchstens 1 ReorderEntity

Schritt 1: Rechtssubjektdaten angeben

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

  1. ProductEntity
  2. StoreEntity
  3. RecipeEntity
  4. FoodShoppingCart
  5. FoodShoppingList
  6. FoodReorderCluster

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

ProductEntity

Das ProductEntity-Objekt stellt einen einzelnen Artikel dar, z. B. einen Lebensmittelartikel, ein Gericht aus einem Restaurant oder ein Angebot, das Entwicklerpartner veröffentlichen möchten.

Abbildung : Attribute von ProductEntity

Attribut Anforderung Beschreibung Formatieren
Posterbilder Erforderlich Es muss mindestens ein Bild angegeben werden. Weitere Informationen finden Sie unter Bildspezifikationen.
Aktions-URI Erforderlich

Der Deeplink zur Seite in der App, auf der Details zum Produkt angezeigt werden.

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

Uri
Überschrift Optional Der Name des Produkts.

Freier Text

Empfohlene Textgröße: unter 90 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.)

Preis – aktuell Bedingt erforderlich

Der aktuelle Preis des Produkts.

Muss angegeben werden, wenn ein durchgestrichener Preis angegeben wird.

Freier Text
Preis – durchgestrichen Optional Der ursprüngliche Preis der Einheit, der in der Benutzeroberfläche durchgestrichen ist. Freier Text
Zusatzinformationen Optional Hinweis, um eine Werbeaktion, ein Event oder ein Update für das Produkt zu präsentieren, sofern verfügbar.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Kleingedrucktes für Zusatzinformationen Optional Kleingedruckter Text für die Zusatzinformation.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Bewertung (optional): Alle Bewertungen werden mit unserem standardmäßigen Sternesystem angezeigt.
Altersfreigabe – Höchstwert Optional

Der Höchstwert der Bewertungsskala.

Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird.

Zahl >= 0,0
Altersfreigabe – Aktueller Wert Optional

Der aktuelle Wert der Bewertungsskala.

Muss angegeben werden, wenn auch der Höchstwert der Bewertung angegeben wird.

Zahl >= 0,0
Bewertung – Anzahl Optional

Die Anzahl der Bewertungen für das Produkt.

Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuert, wie die Anzahl den Nutzern angezeigt wird. Verwenden Sie einen kurzen String. Wenn die Anzahl beispielsweise 1.000.000 beträgt, sollten Sie eine Abkürzung wie „1 Mio.“ verwenden, damit die Zahl auf kleineren Displays nicht abgeschnitten wird.

String
Bewertung – Zählwert Optional

Die Anzahl der Bewertungen für das Produkt.

Hinweis:Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten. Wenn sowohl „Anzahl“ als auch „Anzahlswert“ vorhanden sind, wird Nutzern „Anzahl“ angezeigt.

Lang
DisplayTimeWindow (Optional): Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen
Startzeitstempel Optional

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

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

Epochen-Zeitstempel in Millisekunden
Endzeitstempel Optional

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

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

Epochen-Zeitstempel in Millisekunden

StoreEntity

Das StoreEntity-Objekt steht für ein einzelnes Geschäft, das Entwicklerpartner veröffentlichen möchten, z. B. ein Restaurant oder ein Lebensmittelgeschäft.

Abbildung : Attribute von StoreEntity

Attribut Anforderung Beschreibung Formatieren
Posterbilder Erforderlich Es muss mindestens ein Bild angegeben werden. Weitere Informationen finden Sie unter Bildspezifikationen.
Aktions-URI Erforderlich

Der Deeplink zur Seite in der App, auf der Details zum Geschäft angezeigt werden.

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

Uri
Überschrift Optional Der Name des Geschäfts.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Standort Optional Der Standort des Geschäfts.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Zusatzinformationen Optional Hinweis, um eine Werbeaktion, ein Event oder ein Update für den Store zu präsentieren, sofern verfügbar.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Kleingedrucktes für Zusatzinformationen Optional Kleingedruckter Text für die Zusatzinformation.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Beschreibung Optional Eine Beschreibung des Geschäfts.

Freier Text

Empfohlene Textgröße: unter 90 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.)

Kategorie Optional

Kategorie eines Geschäfts. Im Zusammenhang mit Gastronomiebetrieben kann dies eine Küche wie „französisch“, „neuamerikanisch“, „Ramen“ oder „Gourmet“ sein.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Hinweis: Alle Bewertungen werden mit unserem Standard-Sternesystem angezeigt.
Altersfreigabe – Höchstwert Optional

Der Höchstwert der Bewertungsskala.

Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird.

Zahl >= 0,0
Altersfreigabe – Aktueller Wert Optional

Der aktuelle Wert der Bewertungsskala.

Muss angegeben werden, wenn auch der Höchstwert der Bewertung angegeben wird.

Zahl >= 0,0
Bewertung – Anzahl Optional

Die Anzahl der Bewertungen für den Händler.

Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuern möchte, wie die Informationen für Nutzer angezeigt werden. Geben Sie den prägnanten String an, der dem Nutzer angezeigt werden kann. Wenn die Anzahl beispielsweise 1.000.000 beträgt, sollten Sie Abkürzungen wie 1 M verwenden, damit sie auf kleineren Displays nicht abgeschnitten wird.

String
Bewertung – Zählwert Optional

Die Anzahl der Bewertungen für den Händler.

Hinweis:Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahlswert“ vorhanden sind, verwenden wir die Anzahl für die Anzeige für Nutzer.

Lang

RecipeEntity

Das RecipeEntity-Objekt stellt ein Rezept-Element dar, das Entwicklerpartner veröffentlichen möchten.

Abbildung : Attribute von RecipeEntity

Attribut Anforderung Beschreibung Formatieren
Posterbilder Erforderlich Es muss mindestens ein Bild angegeben werden. Weitere Informationen finden Sie unter Bildspezifikationen.
Aktions-URI Erforderlich

Der Deeplink zur Seite in der App, auf der Details zum Rezept angezeigt werden.

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

Uri
Überschrift Optional Der Name des Rezepts.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Autor Optional Der Autor des Rezepts.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Koch-/Zubereitungszeit Optional Die Kochzeit des Rezepts.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Zusatzinformationen Optional Callout, um eine Werbeaktion, ein Event oder ein Update für das Rezept zu präsentieren, falls verfügbar.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Kategorie Optional Die Kategorie des Rezepts.

Freier Text

Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Beschreibung Optional Eine Beschreibung des Rezepts.

Freier Text

Empfohlene Textgröße: unter 90 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.)

Hinweis: Alle Bewertungen werden mit unserem Standard-Sternesystem angezeigt.
Altersfreigabe – Höchstwert Optional

Der Höchstwert der Bewertungsskala.

Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird.

Zahl >= 0,0
Altersfreigabe – Aktueller Wert Optional

Der aktuelle Wert der Bewertungsskala.

Muss angegeben werden, wenn auch der Höchstwert der Bewertung angegeben wird.

Zahl >= 0,0
Bewertung – Anzahl Optional

Die Anzahl der Bewertungen für das Rezept.

Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuern möchte, wie die Informationen für Nutzer angezeigt werden. Geben Sie den prägnanten String an, der dem Nutzer angezeigt werden kann. Wenn die Anzahl beispielsweise 1.000.000 beträgt, sollten Sie Abkürzungen wie 1 M verwenden, damit sie auf kleineren Displays nicht abgeschnitten wird.

String
Bewertung – Zählwert Optional

Die Anzahl der Bewertungen für das Rezept.

Hinweis:Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahlswert“ vorhanden sind, verwenden wir die Anzahl für die Anzeige für Nutzer.

Lang

FoodShoppingCart

Abbildung:Clusterattribute für den Lebensmittel-Einkaufswagen.

Attribut Anforderung Beschreibung Formatieren
Aktions-URI Erforderlich

Der Deeplink zum Einkaufswagen in der App des Partnerunternehmens.

Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Weitere Informationen

Uri
Anzahl der Elemente Erforderlich

Die Anzahl der Artikel (nicht nur die Anzahl der Produkte) im Einkaufswagen.

Beispiel: Wenn sich im Einkaufswagen 3 Orangen und 1 Apfel befinden, sollte diese Zahl 4 sein.

Ganzzahl >= 1
Überschrift Optional

Der Titel des Einkaufswagens, z. B. Ihr Einkaufswagen.

Wenn der Entwickler keinen Titel angibt, wird standardmäßig Mein Warenkorb verwendet.

Freier Text

Empfohlene Textgröße: unter 25 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Aktionstext Optional

Der Call-to-Action-Text der Schaltfläche im Einkaufswagen (z. B. Mein Einkaufswagen).

Wenn der Entwickler keinen Aktionstext angibt, ist Warenkorb ansehen der Standardtext.

Dieses Attribut wird ab Version 1.1.0 unterstützt.

String
Einkaufswagenbilder Optional

Bilder der einzelnen Produkte im Einkaufswagen.

Es können bis zu 10 Bilder in der Reihenfolge ihrer Priorität bereitgestellt werden. Die tatsächliche Anzahl der angezeigten Bilder hängt vom Formfaktor des Geräts ab.

Weitere Informationen finden Sie unter Bildspezifikationen.
Elementlabels Optional

Die Liste der Labels für Artikel auf der Einkaufsliste.

Die tatsächliche Anzahl der angezeigten Labels hängt vom Formfaktor des Geräts ab.

Liste der Labels mit freiem Text

Empfohlene Textgröße: unter 20 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.)

DisplayTimeWindow (Optional): Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen
Startzeitstempel Optional

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

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

Epochen-Zeitstempel in Millisekunden
Endzeitstempel Optional

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

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

Epochen-Zeitstempel in Millisekunden

FoodShoppingList

Abbildung:Cluster „Einkaufsliste für Lebensmittel“.

Attribut Anforderung Beschreibung Formatieren
Aktions-URI Erforderlich

Der Deeplink zur Einkaufsliste in der App des Partners.

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

Uri
Anzahl der Elemente Erforderlich Die Anzahl der Artikel auf der Einkaufsliste. Ganzzahl >= 1
Überschrift Optional

Der Titel der Liste, z. B. Ihre Einkaufsliste.

Wenn der Entwickler keinen Titel angibt, wird standardmäßig Einkaufsliste verwendet.

Freier Text

Empfohlene Textgröße: unter 25 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Elementlabels Erforderlich

Die Liste der Labels für Artikel auf der Einkaufsliste.

Es muss mindestens ein Label angegeben werden. Es können bis zu zehn Labels in der Reihenfolge ihrer Priorität angegeben werden. Die tatsächliche Anzahl der angezeigten Labels hängt vom Formfaktor des Geräts ab.

Liste der Labels mit freiem Text

Empfohlene Textgröße: unter 20 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.)

FoodReorderCluster

Abbildung:Cluster für die erneute Bestellung von Lebensmitteln.

Attribut Anforderung Beschreibung Formatieren
Aktions-URI Erforderlich

Der Deeplink zum erneuten Bestellen in der App des Partners.

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

Uri
Aktionstext Optional

Der Call-to-Action-Text der Schaltfläche zum erneuten Bestellen, z. B. Nochmal bestellen.

Wenn kein Aktionstext vom Entwickler angegeben wird, ist Neu bestellen die Standardeinstellung.

Dieses Attribut wird ab Version 1.1.0 unterstützt.

String
Anzahl der Elemente Erforderlich

Die Anzahl der Artikel (nicht nur der Produkte) in der vorherigen Bestellung.

Beispiel: Wenn die vorherige Bestellung 3 kleine Kaffees und 1 Croissant enthielt, sollte diese Zahl 4 sein.

Ganzzahl >= 1
Überschrift Erforderlich Der Titel des nachzubestellenden Artikels.

Freier Text

Empfohlene Textgröße: unter 40 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Elementlabels

Optional

(Wenn nicht angegeben, sollten Plakatbilder bereitgestellt werden.)

Die Liste der Artikel-Labels für die vorherige Bestellung.

Es können bis zu 10 Labels in der Reihenfolge ihrer Priorität angegeben werden. Die tatsächliche Anzahl der angezeigten Labels hängt vom Formfaktor des Geräts ab.

Liste mit Freitext

Empfohlene Textgröße pro Label: unter 20 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.)

Posterbilder

Optional

(Falls nicht angegeben, sollten Artikel-Labels angegeben werden.)

Bilder der Artikel in der vorherigen Bestellung.

Es können bis zu 10 Bilder in der Reihenfolge ihrer Priorität bereitgestellt werden. Die tatsächliche Anzahl der angezeigten Bilder hängt vom Formfaktor des Geräts ab.

Weitere Informationen finden Sie unter Bildspezifikationen.

Bildspezifikationen

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

Seitenverhältnis Mindestanzahl an Pixeln Empfohlene Pixel

Quadratisch (1 × 1)

Bevorzugt

300 × 300 1200 × 1200
Querformat (1,91 × 1) 600 × 314 1200 × 628
Hochformat (4 : 5) 480 × 600 960 × 1.200

Dateiformate

PNG, JPG, statisches GIF, WebP

Maximale Dateigröße

5.120 KB

Weitere Empfehlungen

  • Bildbereich:Platzieren Sie wichtige Inhalte in den mittleren 80% des Bildes.
  • 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).

AppEngageFoodClient ist für die Veröffentlichung von Lebensmittelclustern verantwortlich.

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

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishFoodShoppingCart
  • publishFoodShoppingList
  • publishReorderCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteFoodShoppingCartCluster
  • deleteFoodShoppingListCluster
  • deleteReorderCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

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

Kotlin

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

Java

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

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

Ein RecommendationCluster-Objekt kann die folgenden Attribute haben:

Attribut Anforderung Beschreibung
Liste von ProductEntity, StoreEntity oder RecipeEntity Erforderlich Eine Liste der Einheiten, aus denen die Empfehlungen für dieses Empfehlungscluster bestehen. Entitäten in einem einzelnen Cluster müssen denselben Typ haben.
Überschrift Erforderlich

Der Titel für den Empfehlungscluster, z. B. Große Rabatte auf das Thanksgiving-Menü.

Empfohlene Textgröße: unter 25 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

Untertitel Optional Der Untertitel für das 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 Zuordnung verwenden. Weitere Informationen

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .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 verwendet, um ein FeaturedCluster-Objekt zu veröffentlichen.

Kotlin

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

Java

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

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

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

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

publishFoodShoppingCart

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

Kotlin

client.publishFoodShoppingCart(
            PublishFoodShoppingCartClusterRequest.Builder()
                .setShoppingCart(
                    FoodShoppingCart.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFoodShoppingCart(
            new PublishFoodShoppingCartClusterRequest.Builder()
                .setShoppingCart(
                    new FoodShoppingCart.Builder()
                        ...
                        .build())
                .build());

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

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

publishFoodShoppingList

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

Kotlin

client.publishFoodShoppingList(
            PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFoodShoppingList(
            new PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    new FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build());

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

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

publishReorderCluster

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

Kotlin

client.publishReorderCluster(
            PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    FoodReorderCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishReorderCluster(
            new PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    new FoodReorderCluster.Builder()
                        ...
                        .build())
                .build());

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

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

publishUserAccountManagementRequest

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

Die folgenden Metadaten sind Teil der Anmeldekarte:

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

Auf der Karte angezeigtes Bild

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

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

Kotlin

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

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

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

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

updatePublishStatus

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

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

Die Liste der infrage kommenden Veröffentlichungsstatuscodes lautet :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

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

Kotlin

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationClusters

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

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

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

deleteFeaturedCluster

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

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

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

deleteFoodShoppingCartCluster

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

Kotlin

client.deleteFoodShoppingCartCluster()

Java

client.deleteFoodShoppingCartCluster();

Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem Cluster „Einkaufswagen für Lebensmittel“ entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

deleteFoodShoppingListCluster

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

Kotlin

client.deleteFoodShoppingListCluster()

Java

client.deleteFoodShoppingListCluster();

Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem Cluster „Einkaufsliste für Lebensmittel“ entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

deleteReorderCluster

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

Kotlin

client.deleteReorderCluster()

Java

client.deleteReorderCluster();

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

deleteUserManagementCluster

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

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

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

deleteClusters

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

Kotlin

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

Java

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

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

Fehlerbehandlung

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

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

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

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

Schritt 3: Broadcast-Intents verarbeiten

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

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

Das BroadcastReceiver muss auf zwei Arten eingerichtet werden:

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

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION
  // broadcast is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is
  // received
  // Trigger food shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART broadcast
  // is received
  // Trigger food shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST broadcast
  // is received
  // Trigger reorder cluster publish when PUBLISH_REORDER_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 food Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register food Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FOOD_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)
}

Java

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger food shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART broadcast is
// received

// Trigger food shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST broadcast is
// received

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

// Register food Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_FOOD_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);

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

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_REORDER_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 diese Absicht empfangen wird.
  • com.google.android.engage.action.PUBLISH_FEATURED Es wird empfohlen, einen publishFeaturedCluster-Anruf zu starten, wenn dieser Intent empfangen wird.
  • com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART Es wird empfohlen, einen publishFoodShoppingCart-Anruf zu starten, wenn dieser Intent empfangen wird.
  • com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST Es wird empfohlen, einen publishFoodShoppingList-Anruf zu starten, wenn dieser Intent empfangen wird.
  • com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER Es wird empfohlen, einen publishReorderCluster-Anruf zu starten, wenn dieser Intent empfangen wird.

Integrationsworkflow

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

Häufig gestellte Fragen

Häufig gestellte Fragen zum Engage SDK

Kontakt

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

Nächste Schritte

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

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