Engage SDK Food: Anleitung zur technischen Integration von Drittanbietern

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

Dieser Leitfaden enthält eine Anleitung für Entwicklerpartner, wie sie ihre Lebensmittelinhalte mit dem Engage SDK einbinden, um sowohl diese neue Oberfläche als auch bestehende Google-Oberflächen zu befüllen.

Integrationsdetails

Terminologie

Diese Integration umfasst die folgenden fünf Clustertypen: Empfehlung, Empfohlen, Einkaufswagen für Lebensmittel, Einkaufsliste für Lebensmittel und Noch einmal bestellen.

• In Clustern vom Typ Empfehlung werden personalisierte Vorschläge zu Lebensmitteln von einem einzelnen Entwicklerpartner angezeigt. Diese Empfehlungen können für den Nutzer personalisiert oder allgemein gehalten sein (z. B. „Neu im Angebot“). Du kannst sie verwenden, um Rezepte, Geschäfte, Gerichte, Lebensmittel usw. zu präsentieren.

  • Ein Empfehlungscluster kann aus Einträgen vom Typ ProductEntity, StoreEntity oder RecipeEntity bestehen, aber nicht aus einer Mischung verschiedener Entitätstypen.

  

  Abbildung: „ProductEntity“, „StoreEntity“ und „RecipeEntity“. (*UI nur zu Veranschaulichungszwecken)

• Im Cluster Empfohlen werden in einer UI-Gruppierung eine Auswahl von Entitäten verschiedener Entwicklerpartner präsentiert. Es gibt einen einzelnen „Empfohlen“-Cluster, der oben in der Benutzeroberfläche mit einer bevorzugten Platzierung über allen Empfehlungsclustern angezeigt wird. Jeder Entwicklerpartner kann bis zu zehn Entitäten im Cluster „Empfohlen“ übertragen.

  

  Abbildung :Vorgestellter Cluster mit der „RecipeEntity“. (*UI nur zu Veranschaulichungszwecken)

• Der Cluster Einkaufswagen für Lebensmittel zeigt einen Einblick in die Einkaufswagen verschiedener Entwicklerpartner in einer einzigen UI-Gruppierung, die Nutzer dazu auffordert, ihre offenen Einkaufswagen abzuschließen. Es gibt einen einzigen Cluster für Lebensmittel-Einkaufswagen.

  • Der Lebensmittel-Einkaufswagen-Cluster muss die Gesamtzahl der Artikel im Einkaufswagen enthalten und kann auch Bilder für X Artikel im Einkaufswagen des Nutzers enthalten.

    

    Abbildung:Lebensmittel-Einkaufswagen-Cluster von einem einzelnen Partner. (*Benutzeroberfläche nur zu Veranschaulichungszwecken)

• Der Cluster Einkaufsliste enthält einen Ausblick auf die Einkaufslisten verschiedener Entwicklerpartner in einer einzigen UI-Gruppierung. Nutzer werden aufgefordert, zur entsprechenden App zurückzukehren, um ihre Listen zu aktualisieren und zu vervollständigen. Es gibt einen einzelnen Cluster für Einkaufslisten für Lebensmittel.

  

  Abbildung:Cluster „Einkaufsliste für Lebensmittel“ von einem einzelnen Partner. (*Benutzeroberfläche nur zu Veranschaulichungszwecken)

• Der Cluster Neu anordnen zeigt einen Ausschnitt der vorherigen Bestellungen mehrerer Entwicklerpartner in einer UI-Gruppierung an und fordert Nutzer auf, die Bestellung neu anzuordnen. Es gibt einen einzelnen Cluster für die Neuanordnung.

  • Der Cluster „Neubestellen“ muss die Gesamtzahl der Artikel in der vorherigen Bestellung des Nutzers enthalten und außerdem eine der folgenden Angaben:

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

  

  Abbildung:Cluster für die Bestellung von Lebensmitteln von einem einzelnen Partner. (*Benutzeroberfläche nur zu Veranschaulichungszwecken)

Vorarbeit

Mindest-API-Level: 19

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

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

Zusammenfassung

Das Design basiert auf einer Implementierung eines gebundenen Dienstes.

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

Clustertyp	Cluster limits	Maximale Entitätslimits in einem Cluster
Empfehlungscluster	Maximal 5	Maximal 25 (ProductEntity, RecipeEntity oder StoreEntity)
Empfohlener Cluster	Höchstens 1	Maximal 10 (ProductEntity, RecipeEntity oder StoreEntity)
Lebensmittel-Einkaufswagen-Cluster	Höchstens 1	Höchstens 1 ShoppingCartEntity
Cluster „Einkaufsliste für Lebensmittel“	Höchstens 1	Höchstens 1 ShoppingListEntity
Cluster für die Nachbestellung von Lebensmitteln	Höchstens 1	Höchstens 1 ReorderEntity

Schritt 1: Entitätsdaten angeben

Im SDK sind verschiedene Entitäten für jeden Artikeltyp definiert. Für die Kategorie „Essen“ werden die folgenden Entitäten unterstützt:

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

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

ProductEntity

Das ProductEntity-Objekt steht für einen einzelnen Artikel (z. B. ein Lebensmittel, ein Gericht aus einem Restaurant oder ein Angebot), den 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 Anforderungen an Bilder.
Aktions-URI	Erforderlich	Der Deeplink zur Seite in der App mit Details zum Produkt. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.	Uri
Titel	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 ist.	Freier Text
Preis – durchgestrichen	Optional	Der Originalpreis der Entität, der in der Benutzeroberfläche durchgestrichen ist.	Freier Text
Zusatzinformationen	Optional	Zusatzinformation zu einem Angebot, einer Veranstaltung oder einem Update für das Produkt, sofern verfügbar.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Kleingedrucktes zu Zusatzinformationen	Optional	Kleingedruckter Text für die Zusatzinformation.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Bewertung (optional): Hinweis: Alle Bewertungen werden mit unserem standardmäßigen Bewertungssystem mit Sternen angezeigt.
Altersfreigabe – Höchstwert	Optional	Der Höchstwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Altersfreigabe angegeben wird.	Zahl >= 0.0
Altersfreigabe – Aktueller Wert	Optional	Der aktuelle Wert der Altersfreigabe. Muss angegeben werden, wenn auch der maximale Wert der Bewertung angegeben wird.	Zahl >= 0.0
Altersfreigabe – Anzahl	Optional	Die Anzahl der Bewertungen für das Produkt. Hinweis:Geben Sie dieses Feld an, wenn in Ihrer App festgelegt wird, wie die Anzahl den Nutzern angezeigt wird. Verwenden Sie einen prägnanten String. Wenn die Anzahl beispielsweise 1.000.000 beträgt, können Sie eine Abkürzung wie 1 Mio. verwenden, damit die Anzahl bei kleineren Bildschirmgrößen nicht abgeschnitten wird.	String
Altersfreigabe – Wert für die Anzahl	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 „Anzahl (Wert)“ vorhanden sind, wird „Anzahl“ den Nutzern angezeigt.	Lang
DisplayTimeWindow (optional): Legen Sie ein Zeitfenster fest, in dem Inhalte auf der Oberfläche angezeigt werden sollen.
Startzeitstempel	Optional	Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn sie nicht festgelegt ist, können Inhalte auf der Oberfläche angezeigt werden.	Epoch-Zeitstempel in Millisekunden
Endzeitstempel	Optional	Der Epochenzeitstempel, nach dem die Inhalte nicht mehr angezeigt werden. Wenn sie nicht festgelegt ist, können Inhalte auf der Oberfläche angezeigt werden.	Epoch-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 Anforderungen an Bilder.
Aktions-URI	Erforderlich	Der Deeplink zur Seite in der App mit Details zum Geschäft. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.	Uri
Titel	Optional	Der Name des Geschäfts.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Standort	Optional	Der Standort des Geschäfts.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Zusatzinformationen	Optional	Zusatzinformation zu einem Angebot, einer Veranstaltung oder einer Neuigkeit für den Shop, sofern verfügbar.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Kleingedrucktes zu Zusatzinformationen	Optional	Kleingedruckter Text für die Zusatzinformation.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Beschreibung	Optional	Eine Beschreibung des Geschäfts.	Freier Text Empfohlene Textgröße: weniger als 90 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Kategorie	Optional	Kategorie eines Geschäfts. Im Zusammenhang mit Restaurants kann es sich um eine Küche wie „französisch“, „neue amerikanische Küche“, „Ramen“ oder „gehobene Küche“ handeln.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Hinweis: Alle Bewertungen werden mit unserem standardmäßigen Bewertungssystem angezeigt.
Altersfreigabe – Höchstwert	Optional	Der Höchstwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Altersfreigabe angegeben wird.	Zahl >= 0.0
Altersfreigabe – Aktueller Wert	Optional	Der aktuelle Wert der Altersfreigabe. Muss angegeben werden, wenn auch der maximale Wert der Bewertung angegeben wird.	Zahl >= 0.0
Altersfreigabe – Anzahl	Optional	Die Anzahl der Bewertungen für das Geschäft. Hinweis:Geben Sie dieses Feld an, wenn Sie in Ihrer App festlegen möchten, wie diese Informationen den Nutzern angezeigt werden. Geben Sie einen kurzen String an, der dem Nutzer angezeigt werden kann. Wenn die Anzahl beispielsweise 1.000.000 beträgt, können Sie Abkürzungen wie 1 Mio. verwenden, damit sie bei kleineren Bildschirmgrößen nicht abgeschnitten wird.	String
Altersfreigabe – Wert für die Anzahl	Optional	Die Anzahl der Bewertungen für das Geschäft. 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 „Anzahl (Wert)“ vorhanden sind, wird „Anzahl“ für Nutzer angezeigt.	Lang

RecipeEntity

Das RecipeEntity-Objekt stellt ein Rezeptelement 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 Anforderungen an Bilder.
Aktions-URI	Erforderlich	Der Deeplink zur Seite in der App mit Details zum Rezept. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.	Uri
Titel	Optional	Der Name des Rezepts.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Autor	Optional	Der Autor des Rezepts.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Koch-/Zubereitungszeit	Optional	Die Kochzeit des Rezepts.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Zusatzinformationen	Optional	Zusatzinformation, um ein Angebot, eine Veranstaltung oder ein Update für das Rezept zu präsentieren, falls verfügbar.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Kategorie	Optional	Die Kategorie des Rezepts.	Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Beschreibung	Optional	Eine Beschreibung des Rezepts.	Freier Text Empfohlene Textgröße: weniger als 90 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Hinweis: Alle Bewertungen werden gemäß unserem standardmäßigen Bewertungssystem mit Sternen angezeigt.
Altersfreigabe – Höchstwert	Optional	Der Höchstwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Altersfreigabe angegeben wird.	Zahl >= 0.0
Altersfreigabe – Aktueller Wert	Optional	Der aktuelle Wert der Altersfreigabe. Muss angegeben werden, wenn auch der maximale Wert der Bewertung angegeben wird.	Zahl >= 0.0
Altersfreigabe – Anzahl	Optional	Die Anzahl der Bewertungen für das Rezept. Hinweis:Geben Sie dieses Feld an, wenn Sie in Ihrer App festlegen möchten, wie diese Informationen den Nutzern angezeigt werden. Geben Sie einen kurzen String an, der dem Nutzer angezeigt werden kann. Wenn die Anzahl beispielsweise 1.000.000 beträgt, können Sie Abkürzungen wie 1 Mio. verwenden, damit sie bei kleineren Bildschirmgrößen nicht abgeschnitten wird.	String
Altersfreigabe – Wert für die Anzahl	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 „Anzahl (Wert)“ vorhanden sind, wird „Anzahl“ für Nutzer angezeigt.	Lang

FoodShoppingCart

Abbildung:Clusterattribute für den Einkaufswagen für Lebensmittel.

Attribut	Anforderung	Beschreibung	Formatieren
Aktions-URI	Erforderlich	Der Deeplink zum Einkaufswagen in der App des Partners. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.	Uri
Anzahl der Elemente	Erforderlich	Die Anzahl der Artikel (nicht nur die Anzahl der Produkte) im Einkaufswagen. Beispiel: Wenn sich 3 Orangen und 1 Apfel im Einkaufswagen befinden, sollte diese Zahl 4 lauten.	Ganzzahl >= 1
Titel	Optional	Der Titel des Einkaufswagens (z. B. Mein Einkaufswagen). Wenn der Entwickler keinen Titel angibt, wird standardmäßig Ihr Einkaufswagen verwendet.	Freier Text Empfohlene Textgröße: weniger als 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. Einkaufswagen). Wenn der Entwickler keinen Aktionstext angibt, ist Einkaufswagen ansehen standardmäßig festgelegt. Dieses Attribut wird ab Version 1.1.0 unterstützt.	String
Bilder für den Einkaufswagen	Optional	Bilder der einzelnen Produkte im Einkaufswagen. Es können bis zu 10 Bilder in der Reihenfolge der Priorität angegeben werden. Die tatsächlich angezeigte Anzahl der Bilder hängt vom Formfaktor des Geräts ab.	Weitere Informationen finden Sie unter Anforderungen an Bilder.
Artikellabels	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: weniger als 20 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
DisplayTimeWindow (optional): Legen Sie ein Zeitfenster fest, in dem Inhalte auf der Oberfläche angezeigt werden sollen.
Startzeitstempel	Optional	Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn sie nicht festgelegt ist, können Inhalte auf der Oberfläche angezeigt werden.	Epoch-Zeitstempel in Millisekunden
Endzeitstempel	Optional	Der Epochenzeitstempel, nach dem die Inhalte nicht mehr angezeigt werden. Wenn sie nicht festgelegt ist, können Inhalte auf der Oberfläche angezeigt werden.	Epoch-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 Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.	Uri
Anzahl der Elemente	Erforderlich	Die Anzahl der Artikel auf der Einkaufsliste.	Ganzzahl >= 1
Titel	Optional	Der Titel der Liste (z. B. Einkaufsliste). Wenn der Entwickler keinen Titel angibt, ist Einkaufsliste der Standard.	Freier Text Empfohlene Textgröße: weniger als 25 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.)
Artikellabels	Erforderlich	Die Liste der Labels für Artikel auf der Einkaufsliste. Es muss mindestens ein Label angegeben werden und bis zu zehn Labels können nach Priorität angegeben werden. Die tatsächlich angezeigte Anzahl der Labels hängt vom Formfaktor des Geräts ab.	Liste der Labels mit freiem Text Empfohlene Textgröße: weniger als 20 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)

FoodReorderCluster

Abbildung:Cluster „Essen neu bestellen“.

Attribut	Anforderung	Beschreibung	Formatieren
Aktions-URI	Erforderlich	Der Deeplink, der in der App des Partners neu angeordnet werden soll. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.	Uri
Aktionstext	Optional	Der Call-to-Action-Text der Schaltfläche „Neu anordnen“ (z. B. Noch einmal bestellen) Wenn der Entwickler keinen Aktionstext angibt, ist Neu anordnen standardmäßig festgelegt. Dieses Attribut wird ab Version 1.1.0 unterstützt.	String
Anzahl der Elemente	Erforderlich	Die Anzahl der Artikel (nicht nur die Anzahl 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
Titel	Erforderlich	Der Titel des Artikels, der nachbestellt werden soll.	Freier Text Empfohlene Textgröße: weniger als 40 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Artikellabels	Optional (Falls nicht vorhanden, sollten Plakatbilder bereitgestellt werden.)	Die Liste der Artikellabels für die vorherige Bestellung. Es können bis zu 10 Labels in der Reihenfolge ihrer Priorität angegeben werden. Die tatsächlich angezeigte Anzahl der Labels hängt vom Formfaktor des Geräts ab.	Liste mit freiem Text Empfohlene Textgröße pro Label: weniger als 20 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Posterbilder	Optional (Falls nicht angegeben, sollten Artikellabels angegeben werden.)	Bilder der Artikel in der vorherigen Bestellung. Es können bis zu 10 Bilder in der Reihenfolge der Priorität angegeben werden. Die tatsächlich angezeigte Anzahl der Bilder hängt vom Formfaktor des Geräts ab.	Weitere Informationen finden Sie unter Anforderungen an Bilder.

Bildspezifikationen

Die erforderlichen Spezifikationen für Bild-Assets finden Sie unten:

Seitenverhältnis	Mindestanzahl Pixel	Empfohlene Pixel
Quadratisch (1 × 1) Bevorzugt	300 × 300	1200 × 1200
Querformat (1,91 × 1)	600 × 314	1.200 × 628
Hochformat (4 : 5)	480 x 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 dunkle und helle Themen richtig angezeigt werden kann.

Schritt 2: Clusterdaten bereitstellen

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

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

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

• 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 Einbindung verfügbar ist und ob die Inhalte auf dem Gerät präsentiert werden können.

Kotlin

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

Java

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

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

publishRecommendationClusters

Mit dieser API werden Listen von RecommendationCluster-Objekten veröffentlicht.

Ein RecommendationCluster-Objekt kann die folgenden Attribute haben:

Attribut	Anforderung	Beschreibung
Liste von ProductEntity, StoreEntity oder RecipeEntity	Erforderlich	Eine Liste der Entitäten, aus denen die Empfehlungen für diesen Empfehlungscluster bestehen. Entitäten in einem Cluster müssen vom selben Typ sein.
Titel	Erforderlich	Der Titel für den Empfehlungscluster (z. B. Große Rabatte auf das Thanksgiving-Menü). Empfohlene Textgröße: weniger als 25 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.)
Untertitel	Optional	Der Untertitel für den Empfehlungscluster.
Aktions-URI	Optional	Der Deeplink zur Seite in der Partner-App, auf der Nutzer die vollständige Liste der Empfehlungen sehen können. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.

Wichtig :Die Publish APIs sind Upsert-APIs, die die vorhandenen Inhalte ersetzen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da dies von den APIs „publish“ automatisch erledigt wird.

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

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

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

publishFeaturedCluster

Mit dieser API wird ein FeaturedCluster-Objekt veröffentlicht.

Wichtig :Die Publish APIs sind Upsert-APIs, die die vorhandenen Inhalte ersetzen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da dies von den APIs „publish“ automatisch erledigt wird.

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

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

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

publishFoodShoppingCart

Mit dieser API wird ein FoodShoppingCart-Objekt veröffentlicht.

Wichtig :Die Publish APIs sind Upsert-APIs, die die vorhandenen Inhalte ersetzen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da dies von den APIs „publish“ automatisch erledigt wird.

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

• Vorhandene FoodShoppingCart-Daten des Entwicklerpartners werden entfernt.
• Die Daten aus der Anfrage werden analysiert und im aktualisierten Einkaufswagencluster gespeichert.

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

publishFoodShoppingList

Mit dieser API wird ein FoodShoppingList-Objekt veröffentlicht.

Wichtig :Die Publish APIs sind Upsert-APIs, die die vorhandenen Inhalte ersetzen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da die APIs „publish“ dies automatisch tun.

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

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

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

publishReorderCluster

Mit dieser API wird ein FoodReorderCluster-Objekt veröffentlicht.

Wichtig :Die Publish APIs sind Upsert-APIs, die die vorhandenen Inhalte ersetzen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da die APIs „publish“ dies automatisch tun.

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

• Vorhandene FoodReorderCluster-Daten des Entwicklerpartners werden entfernt.
• Die Daten aus der Anfrage werden analysiert und im aktualisierten Cluster für die Neuanordnung gespeichert.

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

publishUserAccountManagementRequest

Mit dieser API wird eine Anmeldekarte veröffentlicht . Die Anmeldeaktion leitet Nutzer zur Anmeldeseite der App weiter, damit die App Inhalte veröffentlichen oder personalisiertere Inhalte bereitstellen kann.

Die folgenden Metadaten sind Teil der Anmeldekarte:

Attribut	Anforderung	Beschreibung
Aktions-URI	Erforderlich	Deeplink zur Aktion (d.h. zur Anmeldeseite der App)
Bild	Optional. Wenn nicht angegeben, muss „Titel“ angegeben werden.	Auf der Karte angezeigtes Bild Bilder mit einem Seitenverhältnis von 16:9 und einer Auflösung von 1.264 × 712
Titel	Optional. Wenn nicht angegeben, muss „Image“ angegeben werden.	Titel auf der Karte
Aktionstext	Optional	Text im CTA (z.B. „Anmelden“)
Untertitel	Optional	Optionaler Untertitel auf der Karte

Wichtig :Die Publish APIs sind Upsert-APIs, die die vorhandenen Inhalte ersetzen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da die APIs „publish“ dies automatisch tun.

Kotlin

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

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

Java

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

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

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

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

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

updatePublishStatus

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

• Der Status muss in allen Fällen angegeben werden, auch wenn die Inhalte veröffentlicht wurden (STATUS == PUBLISHED). Andernfalls können Dashboards nicht mit diesem expliziten Status gefüllt werden, um den Zustand und andere Messwerte Ihrer Integration zu vermitteln.
• Wenn keine Inhalte veröffentlicht werden, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google Warnungen in den Dashboards zur App-Integrität vermeiden. Hiermit wird bestätigt, dass Inhalte aufgrund einer erwarteten Situation aus Sicht des Anbieters nicht veröffentlicht werden.
• Sie hilft Entwicklern, Aufschluss darüber zu geben, wann die Daten veröffentlicht werden und wann nicht.
• Google kann die Statuscodes verwenden, um Nutzer zu bestimmten Aktionen in der App anzuregen, damit sie die App-Inhalte sehen oder das Problem beheben können.

Folgende Veröffentlichungsstatuscodes sind zulässig :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

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

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

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

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

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

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

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

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

Wenn die Inhalte aufgrund einer fehlenden Nutzeranmeldung nicht veröffentlicht werden, empfiehlt Google, die Anmeldekarte zu veröffentlichen. Wenn Anbieter die Anmeldekarte aus irgendeinem Grund nicht veröffentlichen können, empfehlen wir, die API updatePublishStatus mit dem Statuscode NOT_PUBLISHED_REQUIRES_SIGN_IN aufzurufen.

Kotlin

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

Java

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

deleteRecommendationClusters

Mit dieser API können Sie den Inhalt von Empfehlungsclustern löschen.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte veröffentlicht werden sollen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da dies von den APIs „publish“ automatisch erledigt wird. Wenden Sie sich an engage-developers@, bevor Sie APIs zum Löschen verwenden.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

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

Hinweis: Diese API ist ab Version 1.1.0 verfügbar.

deleteFeaturedCluster

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

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte veröffentlicht werden sollen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da dies von den APIs „publish“ automatisch erledigt wird. Wenden Sie sich an engage-developers@, bevor Sie APIs zum Löschen verwenden.

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

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

Hinweis: Diese API ist ab Version 1.1.0 verfügbar.

deleteFoodShoppingCartCluster

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

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte veröffentlicht werden sollen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da dies von den APIs „publish“ automatisch erledigt wird. Wenden Sie sich an engage-developers@, bevor Sie APIs zum Löschen verwenden.

Kotlin

client.deleteFoodShoppingCartCluster()

Java

client.deleteFoodShoppingCartCluster();

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

Hinweis: Diese API ist ab Version 1.1.0 verfügbar.

deleteFoodShoppingListCluster

Mit dieser API wird der Inhalt des Clusters „Einkaufsliste für Lebensmittel“ gelöscht.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte veröffentlicht werden sollen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da dies von den APIs „publish“ automatisch erledigt wird. Wenden Sie sich an engage-developers@, bevor Sie APIs zum Löschen verwenden.

Kotlin

client.deleteFoodShoppingListCluster()

Java

client.deleteFoodShoppingListCluster();

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

Hinweis: Diese API ist ab Version 1.1.0 verfügbar.

deleteReorderCluster

Mit dieser API können Sie den Inhalt von „FoodReorderCluster“ löschen.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte veröffentlicht werden sollen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da dies von den APIs „publish“ automatisch erledigt wird. Wenden Sie sich an engage-developers@, bevor Sie APIs zum Löschen verwenden.

Kotlin

client.deleteReorderCluster()

Java

client.deleteReorderCluster();

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

Hinweis: Diese API ist ab Version 1.1.0 verfügbar.

deleteUserManagementCluster

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

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte veröffentlicht werden sollen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da dies von den APIs „publish“ automatisch erledigt wird. Wenden Sie sich an engage-developers@, bevor Sie APIs zum Löschen verwenden.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

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

Hinweis: Diese API ist ab Version 1.1.0 verfügbar.

deleteClusters

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

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte veröffentlicht werden sollen. Rufen Sie die APIs „delete“ und „publish“ nicht nacheinander auf, um den Inhalt zu ersetzen, da dies von den APIs „publish“ automatisch erledigt wird. Wenden Sie sich an engage-developers@, bevor Sie APIs zum Löschen verwenden.

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

Fehlerbehandlung

Es wird dringend empfohlen, das Aufgabenergebnis aus den Veröffentlichungs-APIs abzuhören, damit eine Folgeaktion ausgeführt werden kann, um eine erfolgreiche Aufgabe wiederherzustellen und noch einmal einzureichen.

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

Der Fehler wird als AppEngageException zurückgegeben, wobei die Ursache als Fehlercode enthalten ist.

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

Schritt 3: Broadcast-Intents verarbeiten

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

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

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

• Registrieren Sie eine Instanz der Klasse BroadcastReceiver dynamisch mit Context.registerReceiver(). So ist die Kommunikation von Anwendungen möglich, die sich noch im Arbeitsspeicher befinden.

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

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

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

// Trigger 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));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

// Register Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART));

// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_LIST));

// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER));

}

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

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <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>

Der Dienst sendet die folgenden Intents:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Wir empfehlen, bei Erhalt dieses Intents einen publishRecommendationClusters-Aufruf zu starten.
• com.google.android.engage.action.PUBLISH_FEATURED Wir empfehlen, bei Erhalt dieser Absicht einen publishFeaturedCluster-Anruf zu starten.
• com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART Wir empfehlen, bei Erhalt dieser Absicht einen publishFoodShoppingCart-Aufruf zu starten.
• com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST Wir empfehlen, bei Erhalt dieser Absicht einen publishFoodShoppingList-Aufruf zu starten.
• com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER Wir empfehlen, bei Erhalt dieser Absicht einen publishReorderCluster-Anruf zu starten.

Integrationsablauf

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

Häufig gestellte Fragen

Häufig gestellte Fragen zum Engage SDK

Kontakt

Wenn Sie während der Integration Fragen haben, wenden Sie sich an [e-mail]. Unser Team wird sich so schnell wie möglich bei Ihnen melden.

Nächste Schritte

Nach Abschluss dieser Integration sind folgende Schritte erforderlich:

• Senden Sie eine E-Mail an [e-mail] und hängen Sie Ihr integriertes APK an, das für den Test durch Google bereit ist.
• Google führt eine interne Überprüfung durch, um sicherzustellen, dass die Integration wie erwartet funktioniert. Falls Änderungen erforderlich sind, wird Google Sie mit allen erforderlichen Details kontaktieren.
• Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, benachrichtigt Sie Google, dass Sie mit der Veröffentlichung des aktualisierten und integrierten APK im Play Store beginnen können.
• Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Play Store veröffentlicht wurde, werden die Cluster Empfehlung, Empfohlen, Einkaufswagen, Einkaufsliste und Neu anordnen veröffentlicht und für Nutzer sichtbar.