Google entwickelt eine On-Device-Oberfläche, die die Apps von Nutzern nach Branchen einordnet und eine neue immersive Umgebung für die Nutzung und Auffindbarkeit personalisierter App-Inhalte ermöglicht. Diese Vollbildansicht bietet Entwicklern die Möglichkeit, ihre besten Rich Contents in einem speziellen Kanal außerhalb ihrer App zu präsentieren.Dieser Leitfaden enthält eine Anleitung für Entwicklerpartner, wie sie ihre Gesundheits- und Fitnessinhalte mithilfe des Engage SDK einbinden können.
Integrationsdetails
Terminologie
Diese Integration umfasst die folgenden drei Clustertypen: Empfehlung, Empfohlen und Fortsetzung.
Empfehlungscluster zeigen personalisierte Gesundheits- und Fitnessvorschläge von einem einzelnen Entwicklerpartner an. Diese Empfehlungen können für den Nutzer personalisiert oder generalisiert werden (z. B. Trends zu Fitness und Gesundheit). Hiermit können Sie Artikel oder Personen aus dem Bereich Gesundheit und Fitness anzeigen.
- Ein Empfehlungscluster kann aus
ArticleEntity
,PersonEntity
oderEventEntity
erstellt werden, aber nicht mit einer Mischung aus verschiedenen Entitätstypen.
Ihre Empfehlungen haben folgende Struktur:
Empfehlungscluster:Eine UI-Ansicht, die eine Gruppe von Empfehlungen desselben Entwicklerpartners enthält.
Entität:Ein Objekt, das ein einzelnes Element in einem Cluster darstellt. Diese Integration bietet einige Entitäten, die im Empfehlungscluster angezeigt werden würden:
ArticleEntity: ArticleEntity steht für eine Empfehlung für textbasierte Inhalte im Zusammenhang mit Gesundheit und Fitness. Sie können für Artikel, Blogposts, Marketinginhalte, News-Snippets usw. verwendet werden.
Abbildung 1:Benutzeroberfläche mit einer einzelnen ArticleEntity im Empfehlungscluster. PersonEntity: PersonEntity repräsentiert eine Person. Die Empfehlungen könnten sein, einen Coach oder eine andere Person in Bezug auf Gesundheit und Fitness usw. hervorzuheben.
Abbildung 2:Benutzeroberfläche mit einer einzelnen PersonEntity im Empfehlungscluster. EventEntity: EventEntity repräsentiert ein Ereignis, das in der Zukunft stattfindet. Die Startzeit des Ereignisses ist eine wichtige Information, die den Nutzern vermittelt werden muss. Diese Entität könnte für die Anzeige von Veranstaltungen wie Blutspenden-Camp, Trainings, Fitnessstudio- oder Yoga-Kursen in Bezug auf Gesundheit und Fitness verwendet werden.
Abbildung 3:Benutzeroberfläche mit einer einzelnen EventEntity im Empfehlungscluster.
- Ein Empfehlungscluster kann aus
Der Cluster Continuation zeigt Inhalte, die kürzlich von Nutzern mehrerer Entwicklerpartner in einer einzelnen UI-Gruppierung interagiert haben. Jeder Entwicklerpartner darf maximal 10 Entitäten im Continuation-Cluster senden.
Fortsetzungsinhalte können die folgende Struktur haben:
ArticleEntity: ArticleEntity steht für eine Empfehlung für textbasierte Inhalte in den Bereichen Gesundheit und Fitness. Diese Entität kann verwendet werden, um unvollständige Nachrichtenartikel oder andere Inhalte darzustellen, die der Nutzer an der Stelle weiter ansehen möchte, an der er sie verlassen hat. Beispiel: Nachrichten-Snippet, Blogpost-Snippet zu Themen rund um Gesundheit oder Fitness.
Abbildung 6. Benutzeroberfläche mit einer einzelnen ArticleEntity in einem Continuation-Cluster. EventReservationEntity: EventReservationEntity steht für die Reservierung eines Termins und hilft Nutzern, anstehende oder laufende Reservierungen für Fitness- und Gesundheitsveranstaltungen zu verfolgen. Beispiel: Schulungen
Abbildung 8. Benutzeroberfläche mit einer einzelnen EventReservationEntity in einem Continuation-Cluster.
Der Cluster Empfohlen ist eine UI-Ansicht, in der das ausgewählte Hero-
GenericFeaturedEntity
von vielen Entwicklerpartnern in einer UI-Gruppierung präsentiert wird. Oben auf der Benutzeroberfläche wird ein einzelner „Empfohlen“-Cluster angezeigt, dessen Priorität über allen Empfehlungsclustern liegt. Jeder Entwicklerpartner darf eine einzelne Entität eines unterstützten Typs in „Empfohlen“ mit vielen Entitäten (möglicherweise unterschiedlicher Typen) von mehreren App-Entwicklern im „Empfohlen“-Cluster senden.GenericFeaturedEntity: GenericFeaturedEntity unterscheidet sich insofern von einem Empfehlungselement, dass ein empfohlenes Element für einen einzelnen Top-Inhalt von Entwicklern verwendet werden und den wichtigsten Inhalt darstellen sollte, der für die Nutzer interessant und relevant ist.
Abbildung 12: Benutzeroberfläche mit einer einzelnen Hero-Karte vom Typ GenericFeaturedEntity in einem hervorgehobenen Cluster
Vorarbeiten
Mindest-API-Level: 19
Fügen Sie Ihrer App die com.google.android.play:engage
-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.4.1'
}
Zusammenfassung
Das Design basiert auf der Implementierung eines gebundenen Dienstes.
Die Daten, die ein Client veröffentlichen kann, unterliegen den folgenden Limits für verschiedene Clustertypen:
Clustertyp | Cluster limits | Minimale Entitätslimits in einem Cluster | Maximale Entitätslimits in einem Cluster |
---|---|---|---|
Empfehlungscluster | Höchstens 5 | Mindestens 5 | Höchstens 25 (ArticleEntity , PersonEntity oder EventEntity ) |
Fortsetzungscluster | Höchstens 1 | Mindestens 1 | Höchstens 10 (ArticleEntity oder EventReservationEntity ) |
Ausgewählter Cluster | Höchstens 1 | Mindestens 1 | Höchstens 10 (GenericFeaturedEntity ) |
Schritt 1: Entitätsdaten angeben
Im SDK sind verschiedene Entitäten für jeden Elementtyp definiert. In der Kategorie „Gesundheit und Fitness“ werden die folgenden Entitäten unterstützt:
GenericFeaturedEntity
ArticleEntity
PersonEntity
EventEntity
EventReservationEntity
In den folgenden Tabellen sind die verfügbaren Attribute und Anforderungen für die einzelnen Typen aufgeführt.
GenericFeaturedEntity
Attribut | Anforderungen | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
URI |
Posterbilder | Erforderlich | Wenn mehrere Bilder zur Verfügung gestellt werden, wird nur ein Bild angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis: Wenn Sie ein Logo erhalten, achten Sie darauf, dass sowohl oben als auch unten im Bild 24 dps vorhanden sind. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Titel | Optional | Titel der Entität. | Freier Text Empfohlene Textgröße: 50 Zeichen |
Beschreibung | Optional | Ein einzelner Textabsatz zur Beschreibung der Entität. Hinweis: Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel mit jeweils einer Textzeile. Hinweis: Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
Badges | Optional | Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. Spezielle UX-Bedienung über dem Bild/Video, z.B. als Badge-Overlay auf dem Bild
|
|
Badge – Text | Optional | Titel für das Logo Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Badge – Bild | Optional | Kleines Bild Spezielle Nutzerfreundlichkeit, z.B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie des Inhalts in der Entität. | Liste der Enums Weitere Informationen findest du im Abschnitt "Inhaltskategorie". |
ArticleEntity
Attribut | Anforderungen | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
URI |
Titel | Erforderlich | Titel der Entität. | Freier Text Empfohlene Textgröße: max. 50 Zeichen |
Posterbilder | Optional | Wenn mehrere Bilder zur Verfügung gestellt werden, wird nur ein Bild angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis:Bilder werden dringend empfohlen. Wenn Sie ein Logo erhalten, achten Sie darauf, dass oben und unten im Bild mindestens 24 dps vorhanden sind. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Quelle – Titel | Optional | Name des Autors, der Organisation oder des Melders | Freier Text Empfohlene Textgröße: unter 25 Zeichen |
Quelle – Bild | Optional | Ein Bild der Quelle, z. B. Autor, Organisation oder Reporter | Weitere Informationen finden Sie unter Bildspezifikationen. |
Beschreibung | Optional | Ein einzelner Textabsatz zur Beschreibung der Entität. Hinweis: Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel mit jeweils einer Textzeile. Hinweis: Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
Badges | Optional | Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. Spezielle UX-Bedienung über dem Bild/Video, z.B. als Badge-Overlay auf dem Bild
|
|
Badge – Text | Optional | Titel für das Logo Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Badge – Bild | Optional | Kleines Bild Spezielle Nutzerfreundlichkeit, z.B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Veröffentlichungszeitpunkt des Inhalts | Optional | Dies ist der Epochenzeitstempel in Millisekunden ab dem Zeitpunkt, zu dem der Inhalt in der App veröffentlicht / aktualisiert wurde. | Epochen-Zeitstempel in Millisekunden |
Letzte Interaktionsdauer | Bedingt erforderlich | Der Epochenzeitstempel in Millisekunden für den Zeitpunkt, zu dem der Nutzer das letzte Mal mit dieser Entität interagiert hat. Hinweis:Dieses Feld ist erforderlich, wenn diese Entität Teil des Fortsetzungsclusters ist. |
Epochen-Zeitstempel in Millisekunden |
Fortschritt in Prozent | Bedingt erforderlich | Der Prozentsatz des gesamten Inhalts, den der Nutzer bisher genutzt hat. Hinweis:Dieses Feld ist erforderlich, wenn diese Entität Teil des Fortsetzungsclusters ist. |
Ein Ganzzahlwert zwischen 0 und 100 (einschließlich). |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie des Inhalts in der Entität. | Liste der Enums Weitere Informationen findest du im Abschnitt "Inhaltskategorie". |
PersonEntity
Attribut | Anforderungen | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
URI |
Profil – Name | Erforderlich | Profilname, ID oder Alias, z. B. „Max Mustermann“, „@TeamPixel“ usw. | String Empfohlene Textgröße: max. 50 Zeichen |
Profil – Avatar | Erforderlich |
Profilbild oder Avatarbild des Nutzers. Hinweis:Es muss sich um ein quadratisches 1:1-Bild handeln. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Profil – Zusätzlicher Text | Optional | Freier Text wie der Profil-Alias. | Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Profil – Zusätzliches Bild | Optional | Kleines Bild wie ein verifiziertes Logo | Weitere Informationen finden Sie unter Bildspezifikationen. |
Kopfzeilenbild | Optional | Wenn mehrere Bilder zur Verfügung gestellt werden, wird nur ein Bild angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis:Bilder werden dringend empfohlen. Wenn Sie ein Logo erhalten, achten Sie darauf, dass oben und unten im Bild mindestens 24 dps vorhanden sind. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Beliebtheit – Anzahl | Optional |
Stellt das Kopfzeilenbild dar. Sollte sich vom Profilbild unterscheiden. Dies kann verwendet werden, wenn es ein zusätzliches Bild gibt, um die Person, die ihre Arbeit mag, hervorzuheben. Hinweis:Es muss sich um ein Bild im 16:9-Format handeln. Wenn Sie ein Badge erhalten, achten Sie darauf, dass sowohl oben als auch unten im Bild ein Mindestabstand von 24 dps vorhanden ist. |
String Empfohlene Textgröße: Max. 20 Zeichen für Anzahl + Label zusammen |
Beliebtheit – Anzahlwert | Optional | Die Anzahl der Follower oder der Beliebtheitswert. Hinweis:Gib den Wert für die Anzahl an, wenn deine App keine Logik verarbeiten möchte, wie eine große Anzahl für unterschiedliche Anzeigegrößen optimiert werden soll. Wenn sowohl „Anzahl“ als auch „Anzahl“ angegeben ist, wird „Anzahl“ verwendet. |
Lang |
Beliebtheit – Label | Optional | Gibt das Label für die Beliebtheit an, zum Beispiel „Gefällt mir“. | String Empfohlene Textgröße: Max. 20 Zeichen für Anzahl + Label zusammen |
Beliebtheit – Visuell | Optional |
Geben Sie an, wofür die Interaktion gedacht ist. Beispiel: Bild mit „Mag ich“-Symbol, Emojis. Es können mehr als ein Bild bereitgestellt werden, wobei aber möglicherweise nicht alle Bilder für alle Formfaktoren angezeigt werden. Hinweis:Es muss sich um ein quadratisches Bild mit einem Seitenverhältnis von 1:1 handeln. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Bewertung – Maximalwert | Erforderlich | Der Maximalwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird. |
Zahl >= 0,0 |
Bewertung – Aktueller Wert | Erforderlich | Der aktuelle Wert der Bewertungsskala. Muss angegeben werden, wenn auch der Höchstwert für die Bewertung angegeben wird. |
Zahl >= 0,0 |
Bewertung – Anzahl | Optional | Die Anzahl der Bewertungen für die Entität. Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuern möchte, wie dies den Nutzern angezeigt wird. Geben Sie den kurzen String an, der dem Nutzer angezeigt werden kann. Wenn die Anzahl beispielsweise 1.000.000 beträgt, sollten Sie Abkürzungen wie 1M verwenden, damit die Anzeige bei kleineren Displays nicht gekürzt wird. |
String |
Bewertung – Anzahl | Optional | Die Anzahl der Bewertungen für die Entität. Hinweis:Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeigeabkürzung nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahl“ vorhanden sind, verwenden wir „Anzahl“, um Nutzern |
Lang |
Standort – Land | Optional | Das Land, in dem die Person ansässig ist oder in dem sie tätig ist. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Stadt | Optional | Die Stadt, in der sich die Person befindet oder in der sie tätig ist. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – angezeigte Adresse | Optional | Die Adresse, an der sich die Person befindet oder an der sie tätig ist, wird dem Nutzer angezeigt. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Adresse | Optional | Die Straße (falls zutreffend), an der sich die Person befindet oder an der sie tätig ist. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Bundesland | Optional | Der Bundesstaat (falls zutreffend), in dem sich die Person befindet oder in dem sie tätig ist. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend), an der sich die Person befindet oder tätig ist. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Stadtteil | Optional | Das Viertel (falls zutreffend), in dem sich die Person befindet oder in der sie tätig ist. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Badges | Optional |
Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. |
|
Badge – Text | Optional | Titel für das Logo Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Badge – Bild | Optional | Kleines Bild Spezielle Nutzerfreundlichkeit, z.B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Beschreibung | Optional | Ein einzelner Textabsatz zur Beschreibung der Entität. Hinweis: Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel mit jeweils einer Textzeile. Hinweis: Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie des Inhalts in der Entität. | Liste der möglichen Aufzählungen
Weitere Informationen findest du im Abschnitt "Inhaltskategorie". |
EventEntity
Attribut | Anforderungen | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
URI |
Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
Beginn | Erforderlich |
Der Epochenzeitstempel, an dem das Ereignis voraussichtlich beginnen wird. Hinweis: Der Wert wird in Millisekunden angegeben. |
Epochen-Zeitstempel in Millisekunden |
Ereignismodus | Erforderlich | Ein Feld, das angibt, ob die Veranstaltung virtuell, vor Ort oder beides stattfindet. |
Enum: VIRTUAL, IN_PERSON oder HYBRID |
Posterbilder | Erforderlich | Wenn mehrere Bilder zur Verfügung gestellt werden, wird nur ein Bild angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis:Bilder werden dringend empfohlen. Wenn Sie ein Logo erhalten, achten Sie darauf, dass oben und unten im Bild mindestens 24 dps vorhanden sind. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Standort – Land | Bedingt erforderlich | Das Land, in dem das Ereignis stattfindet. Hinweis:Dies ist für Veranstaltungen erforderlich, die IN_PERSON oder HYBRID sind. |
Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Stadt | Bedingt erforderlich | Die Stadt, in der das Ereignis stattfindet. Hinweis:Dies ist für Veranstaltungen erforderlich, die IN_PERSON oder HYBRID sind. |
Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – angezeigte Adresse | Bedingt erforderlich | Die Adresse oder der Name des Veranstaltungsorts, der bzw. der dem Nutzer angezeigt werden soll. Hinweis:Dies ist für Veranstaltungen erforderlich, die IN_PERSON oder HYBRID sind. |
Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Adresse | Optional | Die Adresse (falls zutreffend) des Veranstaltungsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Bundesland | Optional | Der Bundesstaat oder das Bundesland (falls zutreffend), in dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) des Veranstaltungsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Stadtteil | Optional | Der Stadtteil (falls zutreffend), in dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Ende | Optional |
Der Epochenzeitstempel, an dem das Ereignis voraussichtlich enden wird. Hinweis: Der Wert wird in Millisekunden angegeben. |
Epochen-Zeitstempel in Millisekunden |
Beschreibung | Optional | Ein einzelner Textabsatz zur Beschreibung der Entität. Hinweis: Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel mit jeweils einer Textzeile. Hinweis: Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
Badges | Optional |
Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. |
|
Badge – Text | Optional | Titel für das Logo Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Badge – Bild | Optional | Kleines Bild Spezielle Nutzerfreundlichkeit, z.B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Price - CurrentPrice | Bedingt erforderlich |
Der aktuelle Preis des Tickets oder der Zeitkarte für die Veranstaltung. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben ist. |
Freier Text |
Preis – durchgestrichener Preis | Optional | Der ursprüngliche Preis des Tickets oder der Zeitkarte für die Veranstaltung. | Freier Text |
Preis-Callout | Optional | Preiserweiterung mit Zusatzinformationen zu Werbeaktionen, Veranstaltungen oder Rabatten für Mitglieder (falls verfügbar). | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (zu langer Text enthält möglicherweise Auslassungspunkte) |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie des Inhalts in der Entität. | Liste der möglichen Aufzählungen
Weitere Informationen findest du im Abschnitt "Inhaltskategorie". |
EventReservationEntity
Attribut | Anforderungen | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
URI |
Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
Beginn | Erforderlich |
Der Epochenzeitstempel, an dem das Ereignis voraussichtlich beginnen wird. Hinweis: Der Wert wird in Millisekunden angegeben. |
Epochen-Zeitstempel in Millisekunden |
Ereignismodus | Erforderlich | Ein Feld, das angibt, ob die Veranstaltung virtuell, vor Ort oder beides stattfindet. |
Enum: VIRTUAL, IN_PERSON oder HYBRID |
Standort – Land | Bedingt erforderlich | Das Land, in dem das Ereignis stattfindet. Hinweis:Dies ist für Veranstaltungen erforderlich, die IN_PERSON oder HYBRID sind. |
Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Stadt | Bedingt erforderlich | Die Stadt, in der das Ereignis stattfindet. Hinweis:Dies ist für Veranstaltungen erforderlich, die IN_PERSON oder HYBRID sind. |
Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – angezeigte Adresse | Bedingt erforderlich | Die Adresse oder der Name des Veranstaltungsorts, der bzw. der dem Nutzer angezeigt werden soll. Hinweis:Dies ist für Veranstaltungen erforderlich, die IN_PERSON oder HYBRID sind. |
Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Adresse | Optional | Die Adresse (falls zutreffend) des Veranstaltungsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Bundesland | Optional | Der Bundesstaat oder das Bundesland (falls zutreffend), in dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) des Veranstaltungsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Stadtteil | Optional | Der Stadtteil (falls zutreffend), in dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Posterbilder | Optional | Wenn mehrere Bilder zur Verfügung gestellt werden, wird nur ein Bild angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis:Bilder werden dringend empfohlen. Wenn Sie ein Logo erhalten, achten Sie darauf, dass oben und unten im Bild mindestens 24 dps vorhanden sind. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Ende | Optional |
Der Epochenzeitstempel, an dem das Ereignis voraussichtlich enden wird. Hinweis: Der Wert wird in Millisekunden angegeben. |
Epochen-Zeitstempel in Millisekunden |
Dienstanbieter – Name | Optional |
Der Name des Dienstanbieters. Hinweis:Für den Dienstanbieter sind entweder Text oder Bilder erforderlich. |
Freier Text. Beispiel: Name des Organisators/der Tour |
Dienstanbieter – Bild | Optional |
Das Logo oder Bild des Dienstanbieters. Hinweis:Für den Dienstanbieter sind entweder Text oder Bilder erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Beschreibung | Optional | Ein einzelner Textabsatz zur Beschreibung der Entität. Hinweis: Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel mit jeweils einer Textzeile. Hinweis: Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
Badges | Optional |
Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. |
|
Badge – Text | Optional | Titel für das Logo Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Badge – Bild | Optional | Kleines Bild Spezielle Nutzerfreundlichkeit, z.B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Reservierungs-ID | Optional | Die Reservierungs-ID für die Terminreservierung. | Freier Text |
Price - CurrentPrice | Bedingt erforderlich |
Der aktuelle Preis des Tickets oder der Zeitkarte für die Veranstaltung. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben ist. |
Freier Text |
Preis – durchgestrichener Preis | Optional | Der ursprüngliche Preis des Tickets oder der Zeitkarte für die Veranstaltung. | Freier Text |
Preis-Callout | Optional | Preiserweiterung mit Zusatzinformationen zu Werbeaktionen, Veranstaltungen oder Rabatten für Mitglieder (falls verfügbar). | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (zu langer Text enthält möglicherweise Auslassungspunkte) |
Bewertung – Maximalwert | Optional | Der Maximalwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird. |
Zahl >= 0,0 |
Bewertung – Aktueller Wert | Optional | Der aktuelle Wert der Bewertungsskala. Muss angegeben werden, wenn auch der Höchstwert für die Bewertung angegeben wird. |
Zahl >= 0,0 |
Bewertung – Anzahl | Optional | Die Anzahl der Bewertungen für das Ereignis. Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuern möchte, wie dies den Nutzern angezeigt wird. Geben Sie den kurzen String an, der dem Nutzer angezeigt werden kann. Wenn die Anzahl beispielsweise 1.000.000 beträgt, sollten Sie Abkürzungen wie 1M verwenden, damit die Anzeige bei kleineren Displays nicht gekürzt wird. |
String |
Bewertung – Anzahl | Optional | Die Anzahl der Bewertungen für das Ereignis. Hinweis:Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeigeabkürzung nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahl“ vorhanden sind, verwenden wir „Anzahl“, um Nutzern |
Lang |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie des Inhalts in der Entität. | Liste der möglichen Aufzählungen
Weitere Informationen findest du im Abschnitt "Inhaltskategorie". |
Bildspezifikationen
Die erforderlichen Spezifikationen für Bild-Assets sind in der folgenden Tabelle aufgeführt:
Seitenverhältnis | Mindestanzahl Pixel | Empfohlene Pixel |
---|---|---|
Quadrat (1 × 1) Bevorzugt |
300 × 300 | 1200 × 1200 |
Querformat (1,91 x 1) | 600 × 314 | 1200 × 628 |
Hochformat (4:5) | 480 × 600 | 960 × 1200 |
Die Images müssen auf öffentlichen CDNs gehostet werden, damit Google darauf zugreifen kann.
Dateiformate
PNG, JPG, statisches GIF, WebP
Maximale Dateigröße
5.120 KB
Weitere Empfehlungen
- Bildbereich:Wichtige Inhalte sollten in den mittleren 80% des Bildes positioniert werden.
- Verwenden Sie einen transparenten Hintergrund, damit das Bild in den Einstellungen für das dunkle und helle Design richtig angezeigt wird.
Content-Kategorie
Mit der Inhaltskategorie können Apps Inhalte veröffentlichen, die mehreren Kategorien angehören. Dadurch wird der Inhalt einigen der vordefinierten Kategorien zugeordnet, nämlich:
TYPE_EDUCATION
TYPE_SPORTS
TYPE_MOVIES_AND_TV_SHOWS
TYPE_BOOKS
TYPE_AUDIOBOOKS
TYPE_MUSIC
TYPE_DIGITAL_GAMES
TYPE_TRAVEL_AND_LOCAL
TYPE_HOME_AND_AUTO
TYPE_BUSINESS
TYPE_NEWS
TYPE_FOOD_AND_DRINK
TYPE_SHOPPING
TYPE_HEALTH_AND_FITENESS
TYPE_MEDICAL
TYPE_PARENTING
TYPE_DATING
Die Images müssen auf öffentlichen CDNs gehostet werden, damit Google darauf zugreifen kann.
Richtlinien für die Verwendung der Inhaltskategorien
- Einige Entitäten wie ArticleEntity und GenericFeaturedEntity können jede der Inhaltskategorien verwenden. Für andere Entitäten wie EventEntity, EventReservationEntity und PersonEntity ist nur eine Teilmenge dieser Kategorien zulässig. Prüfen Sie die Liste der Kategorien, die für einen Entitätstyp infrage kommen, bevor Sie die Liste ausfüllen.
Verwenden Sie für einige Inhaltskategorien den spezifischen Entitätstyp statt einer Kombination aus generischen Entitäten und ContentCategory:
- TYPE_MovieS_AND_TV_SHOWS: Sehen Sie sich die Entitäten im Integrationsleitfaden ansehen an, bevor Sie die generischen Entitäten verwenden.
- TYPE_BOOKS: Sehen Sie sich die EbookEntity an, bevor Sie die generischen Entitäten verwenden.
- TYPE_AUDIOBOOKS: Schauen Sie sich Hörbuchentität an, bevor Sie die generischen Entitäten verwenden.
- TYPE_SHOPPING: Prüfen Sie ShoppingEntity, bevor Sie allgemeine Entitäten verwenden.
- TYPE_FOOD_AND_DRINK: Prüfen Sie die Entitäten im Food Integration Guide, bevor Sie die generischen Entitäten verwenden.
Das Feld „ContentCategory“ ist optional und sollte leer bleiben, wenn der Inhalt zu keiner der oben genannten Kategorien gehört.
Falls mehrere Inhaltskategorien angegeben werden, geben Sie diese in der Reihenfolge ihrer Relevanz für den Inhalt an, wobei die relevanteste Inhaltskategorie an erster Stelle in der Liste steht.
Schritt 2: Clusterdaten bereitstellen
Es empfiehlt sich, den Job zur Veröffentlichung von Inhalten im Hintergrund (z. B. mit WorkManager) auszuführen und ihn regelmäßig oder auf Ereignisbasis zu planen (z. B. jedes Mal, wenn der Nutzer die App öffnet oder gerade etwas in seinen Einkaufswagen gelegt hat).
AppEngagePublishClient
ist für das Veröffentlichen von Clustern zuständig.
Es gibt die folgenden APIs, um Cluster im Client zu veröffentlichen:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Mit dieser API wird geprüft, ob der Dienst für die Integration verfügbar ist und ob die Inhalte auf dem Gerät dargestellt 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.
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build() ) .build() )
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build()) .build());
Wenn der Dienst die Anfrage empfängt, finden innerhalb einer Transaktion die folgenden Aktionen statt:
- Vorhandene
RecommendationCluster
-Daten des Entwicklerpartners werden entfernt. - Daten aus der Anfrage werden geparst und im aktualisierten Empfehlungscluster gespeichert.
Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishFeaturedCluster
Diese API wird verwendet, um eine Liste von FeaturedCluster
-Objekten zu veröffentlichen.
Kotlin
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishFeaturedCluster( new PublishFeaturedClustersRequest.Builder() .addFeaturedCluster( new FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Wenn der Dienst die Anfrage empfängt, finden innerhalb einer Transaktion die folgenden Aktionen statt:
- Vorhandene
FeaturedCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten „Featured Cluster“ gespeichert.
Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishContinuationCluster
Diese API wird zum Veröffentlichen eines ContinuationCluster
-Objekts verwendet.
Kotlin
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishContinuationCluster( new PublishContinuationClusterRequest.Builder() .setContinuationCluster( new ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Wenn der Dienst die Anfrage empfängt, finden innerhalb einer Transaktion die folgenden Aktionen statt:
- Vorhandene
ContinuationCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten Continuation-Cluster gespeichert.
Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishUserAccountManagementRequest
Dieses API wird verwendet, um eine Anmeldekarte zu veröffentlichen . Über die Anmeldeaktion werden Nutzer zur Anmeldeseite der App weitergeleitet, damit sie Inhalte veröffentlichen (oder stärker personalisierte Inhalte) bereitstellen kann.
Die folgenden Metadaten sind Teil der Anmeldekarte:
Attribut | Anforderungen | Beschreibung |
---|---|---|
Aktions-URI | Erforderlich | Deeplink zu Aktion (z.B. Weiterleitung zur Anmeldeseite der App) |
Bild | Optional – falls nicht angegeben, muss ein Titel angegeben werden |
Bild auf der Karte Bilder mit einem Seitenverhältnis von 16:9 und einer Auflösung von 1264 x 712 |
Titel | Optional – falls nicht angegeben, muss ein Bild angegeben werden | Titel auf der Karte |
Aktionstext | Optional | Text, der im CTA angezeigt wird (z.B. „Anmelden“) |
Untertitel | Optional | Optionale 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, finden innerhalb einer Transaktion die folgenden Aktionen statt:
- Vorhandene
UserAccountManagementCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten UserAccountManagementCluster-Cluster gespeichert.
Tritt ein Fehler auf, 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 mithilfe der updatePublishStatus API zu aktualisieren. Dies ist aus folgenden Gründen wichtig :
- Die Angabe des Status in allen Szenarien, selbst wenn der Inhalt veröffentlicht wurde (STATUS == VERÖFFENTLICHT), ist wichtig, um Dashboards mit diesem expliziten Status zu füllen, um den Zustand und andere Messwerte deiner Integration zu vermitteln.
- Wenn keine Inhalte veröffentlicht werden, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google verhindern, dass Benachrichtigungen in den Dashboards zum Zustand der Anwendung ausgelöst werden. Er bestätigt, dass Inhalte aufgrund einer erwarteten Situation aus Sicht des Anbieters nicht veröffentlicht wurden.
- Entwickler können so herausfinden, wann die Daten veröffentlicht werden und wann nicht.
- Google kann die Statuscodes verwenden, um Nutzer zu bestimmten Aktionen in der App zu bewegen, damit sie den App-Inhalt sehen oder überwinden können.
Die Liste der zulässigen Veröffentlichungsstatuscodes sieht so aus :
// 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
Diese API wird verwendet, um den Inhalt von Empfehlungsclustern zu löschen.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus den Empfehlungsclustern entfernt. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteFeaturedCluster
Diese API wird verwendet, um den Inhalt von empfohlenen Clustern zu löschen.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem hervorgehobenen Cluster entfernt. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteContinuationCluster
Diese API wird verwendet, um den Inhalt des Fortsetzungsclusters zu löschen.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem Continuation-Cluster entfernt. Tritt ein Fehler auf, 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 empfängt, werden die vorhandenen Daten aus dem UserAccountManagement-Cluster entfernt. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteClusters
Diese API wird verwendet, um den Inhalt eines bestimmten Clustertyps zu löschen.
Kotlin
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build())
Java
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .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. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
Fehlerbehandlung
Es wird dringend empfohlen, das Aufgabenergebnis der Publish APIs zu überwachen, damit eine Folgeaktion zum Wiederherstellen und erneuten Senden einer erfolgreichen Aufgabe eingeleitet werden kann.
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(..) .build()) .addOnCompleteListener { task -> if (task.isSuccessful) { // do something } else { val exception = task.exception if (exception is AppEngageException) { @AppEngageErrorCode val errorCode = exception.errorCode if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } }
Java
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 angegeben wird.
Fehlercode | Hinweis |
---|---|
SERVICE_NOT_FOUND |
Der Dienst ist auf dem betreffenden Gerät nicht verfügbar. |
SERVICE_NOT_AVAILABLE |
Der Dienst ist auf dem jeweiligen Gerät verfügbar, aber zum Zeitpunkt des Aufrufs nicht (z. B. explizit deaktiviert). |
SERVICE_CALL_EXECUTION_FAILURE |
Die Aufgabe konnte aufgrund von Threading-Problemen nicht ausgeführt werden. In diesem Fall kann es noch einmal versucht werden. |
SERVICE_CALL_PERMISSION_DENIED |
Der Aufrufer ist nicht berechtigt, den Dienstaufruf durchzuführen. |
SERVICE_CALL_INVALID_ARGUMENT |
Die Anfrage enthält ungültige Daten (z. B. mehr als die zulässige Anzahl von Clustern). |
SERVICE_CALL_INTERNAL |
Dienstseitig ist ein Fehler aufgetreten. |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Der Dienstaufruf erfolgt zu häufig. |
Schritt 3: Mit Broadcast-Intents umgehen
Neben den Aufrufen der Content API zur Veröffentlichung über einen Job muss auch ein BroadcastReceiver
eingerichtet werden, um die Anfrage für eine Inhaltsveröffentlichung zu erhalten.
Das Ziel von Broadcast-Intents besteht hauptsächlich darin, die App wieder zu aktivieren und die Datensynchronisierung zu erzwingen. Broadcast-Intents sind nicht für das häufige Senden konzipiert. Sie wird nur ausgelöst, wenn Google Engage für Agenturen feststellt, dass der Inhalt möglicherweise veraltet ist (z. B. eine Woche alt). So lässt sich die Sicherheit des Nutzers erhöhen, auch wenn die App längere Zeit nicht ausgeführt wurde.
BroadcastReceiver
muss auf zwei Arten eingerichtet werden:
- Registriert eine Instanz der
BroadcastReceiver
-Klasse dynamisch mitContext.registerReceiver()
. Dies ermöglicht die Kommunikation von Anwendungen, die sich noch im Arbeitsspeicher befinden.
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 continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } fun registerBroadcastReceivers(context: Context){ var context = context context = context.applicationContext // Register Recommendation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Continuation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION)) }
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 continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } public static void registerBroadcastReceivers(Context context) { context = context.getApplicationContext(); // Register Recommendation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Continuation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION)); }
- Deklariere eine Implementierung statisch mit dem
<receiver>
-Tag in der DateiAndroidManifest.xml
. Dadurch kann die Anwendung Übertragungs-Intents empfangen, wenn sie nicht ausgeführt wird, und 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.PUBLISH_CONTINUATION" />
</intent-filter>
</receiver>
</application>
Die folgenden Intents werden vom Dienst gesendet:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
Es wird empfohlen, beim Empfang dieses Intents einenpublishRecommendationClusters
-Aufruf zu starten.com.google.android.engage.action.PUBLISH_FEATURED
Es wird empfohlen, beim Empfang dieses Intents einenpublishFeaturedCluster
-Aufruf zu starten.com.google.android.engage.action.PUBLISH_CONTINUATION
Es wird empfohlen, beim Empfang dieses Intents einenpublishContinuationCluster
-Aufruf zu starten.
Integrationsablauf
Eine detaillierte Anleitung zur Überprüfung Ihrer Integration nach ihrer Fertigstellung finden Sie im Workflow für die Engage-Entwicklerintegration.
Häufig gestellte Fragen
FAQs finden Sie unter Häufig gestellte Fragen zum Engage SDK.
Kontakt
Bitte wenden Sie sich an Engage-developers@google.com, wenn während des Integrationsprozesses Fragen auftreten sollten.
Nächste Schritte
Nach Abschluss der Integration sind folgende Schritte erforderlich:
- Sende eine E-Mail an Engage-developers@google.com und hänge dein integriertes APK an, das von Google getestet werden kann.
- Google führt eine Überprüfung durch und überprüft intern, ob die Integration wie erwartet funktioniert. Wenn Änderungen erforderlich sind, kontaktiert Google Sie mit allen erforderlichen Details.
- Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, teilt Google dir mit, dass du mit der Veröffentlichung des aktualisierten und integrierten APK im Play Store beginnen kannst.
- Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Play Store veröffentlicht wurde, können Ihre Cluster Empfehlung, Empfohlen und Fortsetzung veröffentlicht und für Nutzer sichtbar sein.