Engage SDK Health and Fitness: 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. Dieser Vollbildmodus bietet Entwicklerpartnern die Möglichkeit, ihre besten Inhalte in einem speziellen Kanal außerhalb ihrer App zu präsentieren. In diesem Leitfaden erfahren Entwicklerpartner, wie sie ihre Gesundheits- und Fitnessinhalte mit dem Engage SDK in diese neue Oberfläche einbinden.

Integrationsdetails

Terminologie

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

  • In Clustern vom Typ Empfehlung werden personalisierte Gesundheits- und Fitnessvorschläge von einem einzelnen Entwicklerpartner angezeigt. Diese Empfehlungen können für den Nutzer personalisiert oder allgemein gehalten werden (z. B. angesagte Fitness- und Gesundheitsthemen). So können Sie Artikel oder Personen finden, die sich mit Gesundheit und Fitness befassen.

    • Ein Empfehlungscluster kann aus ArticleEntity, PersonEntity oder EventEntity bestehen, aber nicht aus einer Mischung verschiedener 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“ ist eine Empfehlung für textbasierte Inhalte zu Gesundheit und Fitness. Sie kann für Artikel, Blogbeiträge, Marketinginhalte, Nachrichten-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 Personenentität im Cluster „Empfehlungen“.

      • EventEntity: „EventEntity“ steht für ein Ereignis in der Zukunft. Der Beginn eines Ereignisses ist eine wichtige Information, die den Nutzern mitgeteilt werden muss. Dieses Element kann verwendet werden, um Ereignisse wie Blutspendeaktionen, Trainingseinheiten, Fitnessstudios oder Yogakurse zu präsentieren, die mit Gesundheit und Fitness in Verbindung stehen.

        Abbildung 3: Benutzeroberfläche mit einer einzelnen EventEntity im Cluster „Empfehlungen“.

  • Der Cluster Fortsetzung enthält Inhalte, mit denen Nutzer vor Kurzem von mehreren Entwicklerpartnern interagiert haben. Diese werden in einer einzigen UI-Gruppierung angezeigt. Jeder Entwicklerpartner darf maximal 10 Entitäten im Fortsetzungscluster übertragen.

    Die Fortsetzungsinhalte können 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 dort fortsetzen möchte, wo er aufgehört hat. Beispiel: Nachrichten-Snippet, Blogpost-Snippet zu gesundheits- oder fitnessbezogenen Themen

      Abbildung 6: Benutzeroberfläche mit einer einzelnen ArticleEntity innerhalb eines Fortsetzungsclusters

    • EventReservationEntity: „EventReservationEntity“ steht für die Reservierung einer Veranstaltung und hilft Nutzern, Reservierungen für anstehende oder laufende Fitness- und Gesundheitsveranstaltungen im Blick zu behalten. Beispiel: Schulungen

      Abbildung 8. Benutzeroberfläche mit einer einzelnen EventReservationEntity in einem Continuation-Cluster.

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

    • GenericFeaturedEntity: „GenericFeaturedEntity“ unterscheidet sich von „RecommendationItem“ dadurch, dass „FeaturedItem“ für einen einzelnen Top-Inhalt von Entwicklern verwendet werden sollte und den wichtigsten Inhalt darstellen sollte, der für Nutzer interessant und relevant ist.

      Abbildung 12: Benutzeroberfläche mit einer einzelnen Hero-Karte vom Typ „GenericFeaturedEntity“ in einem „Empfohlen“-Cluster

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 Client veröffentlichen kann, unterliegen den folgenden Einschränkungen für verschiedene Clustertypen:

Clustertyp Cluster limits Minimale Entitätslimits in einem Cluster Maximale Entitätslimits in einem Cluster
Empfehlungscluster Maximal 5 Mindestens 5 Maximal 25 (ArticleEntity, PersonEntity oder EventEntity)
Fortsetzungscluster Maximal 1 Mindestens 1 Maximal 10 (ArticleEntity oder EventReservationEntity)
Empfohlener Cluster Höchstens 1 Mindestens 1 Maximal 10 (GenericFeaturedEntity)

Schritt 1: Entitätsdaten angeben

Im SDK sind verschiedene Entitäten für jeden Artikeltyp definiert. In der Kategorie „Gesundheit und Fitness“ werden die folgenden Entitäten unterstützt:

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

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

GenericFeaturedEntity

Attribut Anforderung Beschreibung Formatieren
Aktions-URI Erforderlich

Deeplink zur Entität in der Anbieter-App.

Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.

Uri
Posterbilder Erforderlich

Wenn mehrere Bilder zur Verfügung gestellt werden, wird nur ein Bild angezeigt. Empfohlenes Seitenverhältnis: 16:9

Hinweis: Wenn ein Logo verwendet wird, muss oben und unten im Bild ein sicherer Bereich von 24 dps vorhanden sein.

 Weitere Informationen finden Sie unter Anforderungen an Bilder.
Titel Optional Titel der Entität.

Freier Text

Empfohlene Textgröße: 50 Zeichen
Beschreibung Optional

Ein einzelner Textabschnitt zur Beschreibung der Entität.

Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel 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 jede Untertitelung: max. 50 Zeichen
Badges Optional

Jedes Kennzeichen besteht entweder aus freiem Text (max. 15 Zeichen) oder einem kleinen Bild.

Spezielle UX-Behandlung über dem Bild/Video, z. B. als Logo-Overlay auf dem Bild

  • „Liveaktualisierung“
  • Dauer der Artikellektüre
Badge – Text Optional

Titel für das Gütesiegel

Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich.

Freier Text

Empfohlene Textgröße: maximal 15 Zeichen
Logo – Bild Optional

Kleines Bild

Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail

Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich.

Weitere Informationen finden Sie unter Anforderungen an Bilder.
Inhaltskategorien Optional Beschreiben Sie die Kategorie der Inhalte in der Entität.

Liste der Enums

Weitere Informationen finden Sie im Abschnitt Inhaltskategorie.

ArticleEntity

Attribut Anforderung Beschreibung Formatieren
Aktions-URI Erforderlich

Deeplink zur Entität in der Anbieter-App.

Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.

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: Ein Bild wird dringend empfohlen. Wenn ein Logo verwendet wird, muss oben und unten ein sicherer Bereich von 24 dps vorhanden sein.

 Weitere Informationen finden Sie unter Bildspezifikationen.
Quelle – Titel Optional Der Name des Autors, der Organisation oder des Reporters

Freier Text

Empfohlene Textgröße: Weniger als 25 Zeichen
Quelle – Bild Optional Ein Bild der Quelle, z. B. des Autors, der Organisation oder des Reporters Weitere Informationen finden Sie unter Anforderungen an Bilder.
Beschreibung Optional

Ein einzelner Textabschnitt zur Beschreibung der Entität.

Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel 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 jede Untertitelung: max. 50 Zeichen
Badges Optional

Jedes Kennzeichen besteht entweder aus freiem Text (max. 15 Zeichen) oder einem kleinen Bild.

Spezielle UX-Behandlung über dem Bild/Video, z. B. als Logo-Overlay auf dem Bild

  • „Liveaktualisierung“
  • Dauer der Artikellektüre
Badge – Text Optional

Titel für das Gütesiegel

Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich.

Freier Text

Empfohlene Textgröße: maximal 15 Zeichen
Logo – Bild Optional

Kleines Bild

Spezielle UX-Optimierung, z. B. als Logo-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, zu dem die Inhalte in der App veröffentlicht oder aktualisiert wurden. Epochen-Zeitstempel in Millisekunden
Zeitpunkt der letzten Interaktion Bedingt erforderlich

Der Epochenzeitstempel in Millisekunden, zu dem der Nutzer zuletzt mit dieser Entität interagiert hat.

Hinweis: Dieses Feld ist erforderlich, wenn diese Entität Teil des Fortsetzungsclusters ist.

 Epochen-Zeitstempel in Millisekunden
Prozentsatz des Fortschritts Bedingt erforderlich

Der Prozentsatz des gesamten Inhalts, der vom Nutzer bisher angesehen wurde.

Hinweis:Dieses Feld ist erforderlich, wenn diese Entität Teil des Fortsetzungsclusters ist.

 Eine Ganzzahl zwischen 0 und 100.
Inhaltskategorien Optional Beschreiben Sie die Kategorie der Inhalte in der Entität.

Liste der Enums

Weitere Informationen finden Sie im Abschnitt Inhaltskategorie.

PersonEntity

Attribut Anforderung Beschreibung Formatieren
Aktions-URI Erforderlich

Deeplink zur Entität in der Anbieter-App.

Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.

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 Anforderungen an Bilder.
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, z. B. ein Bestätigungskennzeichen. Weitere Informationen finden Sie unter Anforderungen an Bilder.
Kopfzeilenbild Optional

Wenn mehrere Bilder zur Verfügung gestellt werden, wird nur ein Bild angezeigt. Empfohlenes Seitenverhältnis: 16:9

Hinweis: Ein Bild wird dringend empfohlen. Wenn ein Logo verwendet wird, muss oben und unten ein sicherer Bereich von 24 dps vorhanden sein.

 Weitere Informationen finden Sie unter Anforderungen an Bilder.
Beliebtheit – Anzahl Optional

Geben Sie die Anzahl der Follower oder den Beliebtheitswert an, z. B. „3,7 Mio.“.

Hinweis: Wenn sowohl „Anzahl“ als auch „Anzahl (Wert)“ angegeben sind, wird „Anzahl“ verwendet.

String

Empfohlene Textgröße: maximal 20 Zeichen für Anzahl + Label
Beliebtheit – Zählwert Optional

Die Anzahl der Follower oder der Beliebtheitswert.

Hinweis: Geben Sie den Zählwert an, wenn in Ihrer App keine Logik für die Optimierung einer großen Zahl für verschiedene Bildschirmgrößen verwendet werden soll. Wenn sowohl „Anzahl“ als auch „Anzahl (Wert)“ angegeben sind, wird „Anzahl“ verwendet.

Lang
Beliebtheit – Label Optional Gibt das Label für die Beliebtheit an, beispielsweise „Gefällt mir“.

String

Empfohlene Textgröße: Max. 20 Zeichen für Anzahl + Label zusammen
Beliebtheit – Visuell Optional

Geben Sie an, wozu die Interaktion dient. Beispiel: Bild mit dem „Mag ich“-Symbol und Emojis

Sie können mehrere Bilder angeben, die jedoch nicht bei allen Formfaktoren angezeigt werden.

Hinweis: Das Bild muss quadratisch (1:1) sein.

 Weitere Informationen finden Sie unter Anforderungen an Bilder.
Bewertung – Maximalwert Erforderlich

Der Maximalwert der Bewertungsskala.

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

 Zahl >= 0.0
Altersfreigabe – Aktueller Wert Erforderlich

Der aktuelle Wert der Bewertungsskala.

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

 Zahl >= 0.0
Altersfreigabe – Anzahl Optional

Die Anzahl der Bewertungen für die Entität.

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, sollten Sie eine Abkürzung wie 1M verwenden, damit die Anzahl bei kleineren Displays nicht gekürzt wird.

 String
Altersfreigabe – Wert für die Anzahl Optional

Die Anzahl der Bewertungen für die Entität.

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
Standort – Land Optional Das Land, in dem sich die Person befindet oder ihren Dienst leistet.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Ort Optional Die Stadt, in der sich die Person befindet oder ihren Dienst leistet.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Adresse anzeigen 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: maximal 20 Zeichen
Standort – Adresse Optional Die Adresse (falls zutreffend), an der sich die Person befindet oder die sie bedient.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Bundesland Optional Das Bundesland, in dem sich die Person befindet oder ihren Dienst leistet (falls zutreffend).

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Postleitzahl Optional Die Postleitzahl (falls zutreffend), an der sich die Person befindet oder an der sie tätig ist.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Umgebung Optional Der Stadtteil (falls zutreffend), in dem sich die Person befindet oder in dem sie tätig ist.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Badges Optional

Jedes Kennzeichen besteht entweder aus freiem Text (max. 15 Zeichen) oder einem kleinen Bild.
Logo – Text Optional

Titel für das Gütesiegel

Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich.

Freier Text

Empfohlene Textgröße: maximal 15 Zeichen
Logo – Bild Optional

Kleines Bild

Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail

Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich.

Weitere Informationen finden Sie unter Anforderungen an Bilder.
Beschreibung Optional

Ein einzelner Textabschnitt zur Beschreibung der Entität.

Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel 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 zulässigen „enum“-Strings

  • TYPE_HEALTH_AND_FITENESS (Beispiel – Yoga/Fitnesstrainer)
  • TYPE_HOME_AND_AUTO (Beispiel – Klempner)
  • TYPE_SPORTS (Beispiel: Spieler)
  • TYPE_DATING

Weitere Informationen finden Sie im Abschnitt Inhaltskategorie.

EventEntity

Attribut Anforderung Beschreibung Formatieren
Aktions-URI Erforderlich

Deeplink zur Entität in der Anbieter-App.

Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ.

Uri
Titel Erforderlich Titel der Entität.

String

Empfohlene Textgröße: max. 50 Zeichen
Beginn Erforderlich

Der Epochenzeitstempel, zu dem das Ereignis voraussichtlich beginnt.

Hinweis: Dieser Wert wird in Millisekunden angegeben.

 Epochen-Zeitstempel in Millisekunden
Ereignismodus Erforderlich

Ein Feld, in dem angegeben wird, ob die Veranstaltung virtuell, vor Ort oder beides ist.

 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: Ein Bild wird dringend empfohlen. Wenn ein Logo verwendet wird, muss oben und unten ein sicherer Bereich von 24 dps vorhanden sein.

 Weitere Informationen finden Sie unter Anforderungen an Bilder.
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: maximal 20 Zeichen
Standort – Ort Bedingt erforderlich

Die Stadt, in der das Ereignis stattfindet.

Hinweis: Dies ist für Ereignisse erforderlich, die „IN_PERSON“ oder „HYBRID“ sind.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – angezeigte Adresse Bedingt erforderlich

Die Adresse oder der Name des Veranstaltungsortes, an dem die Veranstaltung stattfindet, die dem Nutzer angezeigt werden soll.

Hinweis:Dies ist für Veranstaltungen erforderlich, die IN_PERSON oder HYBRID sind.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Adresse Optional Die (falls zutreffend) Straße und Hausnummer des Veranstaltungsortes.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Bundesland Optional Der Bundesstaat oder das Bundesland (falls zutreffend), in dem die Veranstaltung stattfindet.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Postleitzahl Optional Die Postleitzahl des Orts, an dem die Veranstaltung stattfindet, sofern zutreffend.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Umgebung Optional Der Stadtteil (falls zutreffend), in dem die Veranstaltung stattfindet.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Ende Optional

Der Epochenzeitstempel, an dem das Ereignis voraussichtlich enden wird.

Hinweis: Dieser Wert wird in Millisekunden angegeben.

 Epochen-Zeitstempel in Millisekunden
Beschreibung Optional

Ein einzelner Textabschnitt zur Beschreibung der Entität.

Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel 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 jede Untertitelung: max. 50 Zeichen
Badges Optional

Jedes Kennzeichen besteht entweder aus freiem Text (max. 15 Zeichen) oder einem kleinen Bild.
Logo – Text Optional

Titel für das Gütesiegel

Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich.

Freier Text

Empfohlene Textgröße: maximal 15 Zeichen
Logo – Bild Optional

Kleines Bild

Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail

Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich.

Weitere Informationen finden Sie unter Anforderungen an Bilder.
Preis – Aktueller Preis Bedingt erforderlich

Der aktuelle Preis des Tickets/Passes 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/Passes 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 (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt)
Inhaltskategorien Optional Beschreiben Sie die Kategorie des Inhalts in der Entität.

Liste der zulässigen „enum“-Strings

  • TYPE_MOVIES_AND_TV_SHOWS (Beispiel: Kino)
  • TYPE_DIGITAL_GAMES (Beispiel: eSports)
  • TYPE_MUSIC (Beispiel: Konzert)
  • TYPE_TRAVEL_AND_LOCAL (Beispiel: Tour, Festival)
  • TYPE_HEALTH_AND_FITENESS (Beispiel – Yoga-Kurs)
  • TYPE_EDUCATION (Beispiel: Kurs)
  • TYPE_SPORTS (Beispiel: Fußballspiel)
  • TYPE_DATING (Beispiel: „Meetup“)

Weitere Informationen finden Sie im Abschnitt Inhaltskategorie.

EventReservationEntity

Attribut Anforderung 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 dieser FAQ.

Uri
Titel Erforderlich Titel der Entität.

String

Empfohlene Textgröße: max. 50 Zeichen
Beginn Erforderlich

Der Epochenzeitstempel, zu dem das Ereignis voraussichtlich beginnt.

Hinweis: Dieser Wert wird in Millisekunden angegeben.

 Epochen-Zeitstempel in Millisekunden
Ereignismodus Erforderlich

Ein Feld, in dem angegeben wird, ob die Veranstaltung virtuell, vor Ort oder beides ist.

 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: maximal 20 Zeichen
Standort – Ort Bedingt erforderlich

Die Stadt, in der das Ereignis stattfindet.

Hinweis: Dies ist für Ereignisse erforderlich, die „IN_PERSON“ oder „HYBRID“ sind.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – angezeigte Adresse Bedingt erforderlich

Die Adresse oder der Name des Veranstaltungsortes, an dem die Veranstaltung stattfindet, die dem Nutzer angezeigt werden soll.

Hinweis:Dies ist für Veranstaltungen erforderlich, die IN_PERSON oder HYBRID sind.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Adresse Optional Die (falls zutreffend) Straße und Hausnummer des Veranstaltungsortes.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Bundesland Optional Der Bundesstaat oder das Bundesland (falls zutreffend), in dem die Veranstaltung stattfindet.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Postleitzahl Optional Die Postleitzahl des Orts, an dem die Veranstaltung stattfindet, sofern zutreffend.

Freier Text

Empfohlene Textgröße: maximal 20 Zeichen
Standort – Umgebung Optional Der Stadtteil (falls zutreffend), in dem die Veranstaltung stattfindet.

Freier Text

Empfohlene Textgröße: maximal 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: Dieser 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 Veranstalters/der Tour
Dienstanbieter – Bild Optional

Das Logo oder Bild des Dienstanbieters.

Hinweis: Für den Dienstanbieter ist entweder Text oder ein Bild erforderlich.

Weitere Informationen finden Sie unter Bildspezifikationen.
Beschreibung Optional

Ein einzelner Textabschnitt zur Beschreibung der Entität.

Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel 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 jede Untertitelung: max. 50 Zeichen
Badges Optional

Jedes Kennzeichen besteht entweder aus freiem Text (max. 15 Zeichen) oder einem kleinen Bild.
Logo – Text Optional

Titel für das Gütesiegel

Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich.

Freier Text

Empfohlene Textgröße: maximal 15 Zeichen
Logo – Bild Optional

Kleines Bild

Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail

Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich.

Weitere Informationen finden Sie unter Anforderungen an Bilder.
Reservierungs-ID Optional Die Reservierungs-ID für die Terminreservierung. Freier Text
Preis – Aktueller Preis Bedingt erforderlich

Der aktuelle Preis des Tickets/Passes 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/Passes 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)
Altersfreigabe – Höchstwert Optional

Der Höchstwert der Bewertungsskala.

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

 Zahl >= 0.0
Altersfreigabe – Aktueller Wert Optional

Der aktuelle Wert der 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 Ereignis.

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, sollten 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 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 (Wert)“ vorhanden sind, wird „Anzahl“ für Nutzer angezeigt.

 Lang
Inhaltskategorien Optional Beschreiben Sie die Kategorie des Inhalts in der Entität.

Liste der zulässigen „enum“-Strings

  • TYPE_MOVIES_AND_TV_SHOWS (Beispiel: Kino)
  • TYPE_DIGITAL_GAMES (Beispiel: eSports)
  • TYPE_MUSIC (Beispiel: Konzert)
  • TYPE_TRAVEL_AND_LOCAL (Beispiel: Tour, Festival)
  • TYPE_HEALTH_AND_FITENESS (Beispiel – Yoga-Kurs)
  • TYPE_EDUCATION (Beispiel: Kurs)
  • TYPE_SPORTS (Beispiel: Fußballspiel)
  • TYPE_DATING (Beispiel: „Meetup“)

Weitere Informationen finden Sie im Abschnitt Inhaltskategorie.

Bildspezifikationen

Die erforderlichen Spezifikationen für Bild-Assets sind in dieser Tabelle aufgeführt:

Seitenverhältnis Mindestanzahl Pixel Empfohlene Pixel

Quadratisch (1 × 1)

Bevorzugt

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

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

Dateiformate

PNG, JPG, statisches GIF, WebP

Maximale Dateigröße

5.120 KB

Weitere Empfehlungen

  • Bildbereich:Wichtige Inhalte sollten in den mittleren 80% des Bildes positioniert werden.
  • Verwenden Sie einen transparenten Hintergrund, damit das Bild in den Einstellungen für dunkle und helle Themen richtig angezeigt werden kann.

Content-Kategorie

Mit der Inhaltskategorie können Apps Inhalte veröffentlichen, die zu mehreren Kategorien gehö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 Bilder müssen auf öffentlichen CDNs gehostet werden, damit Google darauf zugreifen kann.

Richtlinien für die Verwendung der Inhaltskategorien

  1. Für einige Entitäten wie ArticleEntity und GenericFeaturedEntity kann eine beliebige Inhaltskategorie verwendet werden. Für andere Entitäten wie EventEntity, EventReservationEntity und PersonEntity ist nur eine Teilmenge dieser Kategorien zulässig. Sehen Sie sich die Liste der Kategorien an, die für einen Entitätstyp infrage kommen, bevor Sie die Liste füllen.

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

    • TYPE_MOVIES_AND_TV_SHOWS: Sehen Sie sich die Entitäten aus dem Leitfaden zur YouTube TV-Integration an, bevor Sie die generischen Entitäten verwenden.
    • TYPE_BOOKS: Schauen Sie sich die EbookEntity an, bevor Sie die generischen Entitäten verwenden.
    • TYPE_AUDIOBOOKS: Sehen Sie sich AudiobookEntity an, bevor Sie die generischen Entitäten verwenden.
    • TYPE_SHOPPING: Sehen Sie sich ShoppingEntity an, bevor Sie die generischen Entitäten verwenden.
    • TYPE_FOOD_AND_DRINK: Sehen Sie sich die Entitäten aus dem Leitfaden zur Lebensmittelintegration an, bevor Sie die generischen Entitäten verwenden.

  3. Das Feld „ContentCategory“ ist optional und sollte leer bleiben, wenn der Inhalt keiner der oben genannten Kategorien zugewiesen werden kann.

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

Schritt 2: Clusterdaten angeben

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

AppEngagePublishClient ist für die Veröffentlichung von Clustern verantwortlich.

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

Mit dieser API wird eine Liste von RecommendationCluster-Objekten veröffentlicht.

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

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

Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

publishFeaturedCluster

Mit dieser API wird eine Liste von FeaturedCluster-Objekten veröffentlicht.

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

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

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

publishContinuationCluster

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

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 analysiert und im aktualisierten Fortsetzungscluster 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 zu Aktion (z.B. Weiterleitung 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 x 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

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. Dies ist aus folgenden Gründen wichtig :

  • Es ist wichtig, den Status in allen Szenarien anzugeben, auch wenn die Inhalte veröffentlicht wurden (STATUS == PUBLISHED), um Dashboards zu erstellen, in denen dieser explizite Status verwendet wird, um den Zustand und andere Messwerte deiner Integration zu vermitteln.
  • Wenn keine Inhalte veröffentlicht werden, aber der Integrationsstatus nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google verhindern, dass Benachrichtigungen in den Dashboards zum Zustand der Anwendung ausgelöst werden. 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 überwinden 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 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 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

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. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.

deleteFeaturedCluster

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

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 vorhandene Status bleibt erhalten.

deleteContinuationCluster

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

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

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

deleteUserManagementCluster

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

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.

deleteClusters

Mit dieser API können Sie den Inhalt eines bestimmten Clustertyps 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 aus den Veröffentlichungs-APIs abzuhören, damit eine Folgeaktion ausgeführt werden kann, um eine erfolgreiche Aufgabe wiederherzustellen und noch einmal einzureichen.

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 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 zum Zeitpunkt des Anrufs nicht (z. B. weil er explizit deaktiviert ist).
3 SERVICE_CALL_EXECUTION_FAILURE Die Aufgabe konnte aufgrund von Threading-Problemen nicht ausgeführt werden. In diesem Fall kann es noch einmal versucht werden.
4 SERVICE_CALL_PERMISSION_DENIED Der Anrufer ist nicht berechtigt, den Dienst anzurufen.
5 SERVICE_CALL_INVALID_ARGUMENT Die Anfrage enthält ungültige Daten (z. B. mehr als die zulässige Anzahl von Clustern).
6 SERVICE_CALL_INTERNAL Es ist ein Fehler auf Dienstseite aufgetreten.
7 SERVICE_CALL_RESOURCE_EXHAUSTED Der Dienstaufruf erfolgt zu häufig.

Schritt 3: Broadcast-Intents verarbeiten

Zusätzlich zu 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äufiges Senden 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 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(). 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 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.PUBLISH_CONTINUATION" />
      </intent-filter>
   </receiver>
</application>

Der Dienst sendet die folgenden Intents:

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

Falls während des Integrationsprozesses Fragen auftauchen, wenden Sie sich bitte an Engage-developers@google.com.

Nächste Schritte

Nach Abschluss dieser Integration sind folgende Schritte erforderlich:

  • Senden Sie eine E-Mail an engage-developers@google.com und hängen Sie das integrierte 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. Wenn Änderungen erforderlich sind, kontaktiert Sie Google 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 werden.