Die App-Interaktionen steigern, indem Sie Nutzer dort erreichen, wo sie sich aufhalten Mit dem Engage SDK kannst du personalisierte Empfehlungen und Folgeinhalte direkt auf verschiedenen On-Device-Oberflächen wie Sammlungen, Entertainment Space und dem Google Play Store präsentieren. Die Integration vergrößert das APK im Durchschnitt um weniger als 50 KB (komprimiert) und dauert bei den meisten Apps etwa eine Woche. Weitere Informationen
Diese Anleitung enthält Informationen für Entwicklerpartner, die Reise- und Eventinhalte für Engage-Inhaltsplattformen bereitstellen.
Unterstützung von Kategorien und Oberflächen
Die Eignung von Oberflächen für das Engage SDK hängt von der Inhaltskategorie Ihrer App ab. Anhand der folgenden Tabelle kannst du feststellen, ob du die Voraussetzungen für bestimmte Oberflächen erfüllst:
| Status | Inhaltskategorie oder Anwendungsfall | Unterstützte Oberflächen |
|---|---|---|
|
Unterstützt (Auf allen Oberflächen verfügbar) |
|
|
| Nicht unterstützt |
|
Android-Kenntnisse
Auf GitHub ansehenEngage SDK einbinden
android skills add engage-sdk-integrationIntegrationsdetails
Terminologie
Diese Integration umfasst die folgenden Clustertypen: Empfehlung, Vorgestellt, Reservierung und Suche fortsetzen.
In Empfehlungsclustern werden personalisierte Reise- und Veranstaltungsvorschläge eines einzelnen Entwicklerpartners angezeigt. Diese Empfehlungen können personalisiert oder verallgemeinert werden (z. B. Trendartikel). Damit können Sie Empfehlungen für Artikel, Veranstaltungen, Unterkünfte oder Sehenswürdigkeiten anzeigen.
- Ein Empfehlungscluster kann aus
ArticleEntity-,EventEntity-,LodgingEntity-,PointOfInterestEntity- oderStoreEntity-Einträgen bestehen, aber nicht aus einer Mischung verschiedener Entitätstypen.
Ihre Empfehlungen haben die folgende Struktur:
Empfehlungscluster:Eine Benutzeroberflächenansicht, 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 Einheiten, die über das Empfehlungscluster angezeigt werden:
ArticleEntity: ArticleEntity steht für eine Empfehlung für textbasierte Inhalte zu Reisen und Veranstaltungen. Es kann für Artikel, Blogbeiträge, Marketinginhalte, Nachrichten-Snippets usw. verwendet werden.
Abbildung 1:Benutzeroberfläche mit einer einzelnen ArticleEntity im Empfehlungscluster. EventEntity: EventEntity stellt ein zukünftiges Ereignis dar. Die Startzeit des Ereignisses ist eine wichtige Information, die den Nutzern mitgeteilt werden muss.
Abbildung 2:Benutzeroberfläche mit einer einzelnen EventEntity im Empfehlungscluster. LodgingEntity: LodgingEntity steht für eine Unterkunft wie ein Hotel, ein Apartment oder ein Ferienhaus für Kurz- und Langzeitmiete.
Abbildung 3:Benutzeroberfläche mit einer einzelnen LodgingEntity im Empfehlungscluster. StoreEntity: StoreEntity steht für ein Geschäft, ein Restaurant, ein Café usw. Sie hebt Inhalte hervor, in denen ein Gastronomiebetrieb oder ein Geschäft die wichtigsten Informationen sind, die den Nutzern vermittelt werden müssen.
Abbildung 4:Benutzeroberfläche mit einer einzelnen StoreEntity im Empfehlungscluster. PointOfInterestEntity: PointOfInterestEntity steht für einen Ort von Interesse wie eine Tankstelle, einen Veranstaltungsort, einen Freizeitpark, ein Museum, eine Touristenattraktion oder einen Wanderweg. Sie hebt Inhalte hervor, bei denen der Standort eine wichtige Information ist, die den Nutzern vermittelt werden muss. Sie sollte nicht für Unterkünfte, Geschäfte oder Restaurants verwendet werden.
Abbildung 5:Benutzeroberfläche mit einer einzelnen PointOfInterestEntity im Empfehlungscluster.
- Ein Empfehlungscluster kann aus
Im Cluster Reservierung werden Inhalte angezeigt, mit denen Nutzer kürzlich interagiert haben. Die Inhalte stammen von mehreren Entwicklerpartnern und sind in einer einzelnen Benutzeroberflächengruppe zusammengefasst. Jeder Entwicklerpartner darf maximal 10 Einheiten im Reservierungscluster übertragen.
Die Inhalte Ihrer Reservierung können folgende Struktur haben:
RestaurantReservationEntity: RestaurantReservationEntity stellt eine Reservierung für ein Restaurant oder Café dar und hilft Nutzern, anstehende oder laufende Restaurantreservierungen im Blick zu behalten.
Abbildung 6: Benutzeroberfläche mit einer einzelnen RestaurantReservationEntity in einem Reservierungscluster. EventReservationEntity: EventReservationEntity steht für eine Reservierung für ein Event und hilft Nutzern, anstehende oder laufende Eventreservierungen im Blick zu behalten. Dazu gehören unter anderem:
- Sportveranstaltungen wie Reservierungen für ein Fußballspiel
- Gaming-Events wie Reservierungen für E‑Sports
- Unterhaltungsveranstaltungen wie Reservierungen für Kinofilme, Konzerte, Theateraufführungen oder Buchsignierungen
- Reservierungen für Reisen oder POIs wie Führungen oder Museumstickets
- Reservierungen für soziale Veranstaltungen / Seminare / Konferenzen
- Reservierungen für Bildungs- und Schulungssitzungen
Abbildung 7. Benutzeroberfläche mit einer einzelnen EventReservationEntity in einem Reservierungscluster. LodgingReservationEntity: LodgingEntityReservation stellt eine Reservierung für eine Reiseunterkunft dar und hilft Nutzern, anstehende oder laufende Hotel- oder Ferienunterkunftsreservierungen im Blick zu behalten.
Abbildung 8. Benutzeroberfläche mit einer einzelnen LodgingReservationEntity in einem Reservierungscluster. TransportationReservationEntity: TransportationReservationEntity steht für Reservierungen für Transportmittel jeglicher Art und hilft Nutzern, Reservierungen für bevorstehende oder laufende Flüge, Fähr-, Zug-, Bus-, Fahrdienst-, oder Kreuzfahrten zu verfolgen.
Abbildung 9. Benutzeroberfläche mit einer einzelnen TransportationReservationEntity in einem Reservierungscluster. VehicleRentalReservationEntity: VehicleRentalReservationEntity stellt eine Mietwagenreservierung dar und hilft Nutzern, anstehende oder laufende Mietwagenreservierungen zu verfolgen.
Abbildung 10. Benutzeroberfläche mit einer einzelnen VehicleRentalReservationEntity in einem Reservierungscluster.
Im Cluster Vorgestellt wird eine Auswahl von Unternehmen verschiedener Entwicklerpartner in einer Benutzeroberflächengruppe präsentiert. Es gibt nur noch einen Cluster mit Empfehlungen, der oben in der Benutzeroberfläche angezeigt wird und vor allen anderen Empfehlungsclustern platziert ist. Jeder Entwicklerpartner darf bis zu 10 Entitäten im Cluster „Empfohlen“ präsentieren.
GenericFeaturedEntity: GenericFeaturedEntity unterscheidet sich von RecommendationItem dadurch, dass FeaturedItem für einzelne Top-Inhalte von Entwicklern verwendet werden sollte. Es sollte sich um die wichtigsten Inhalte handeln, die für Nutzer interessant und relevant sind.
Abbildung 11:Benutzeroberfläche mit einem FeaturedCluster mit einer Liste von GenericFeaturedEntity
Mit dem Cluster Suche fortsetzen können Nutzer ihre vorherige Reisesuche fortsetzen. Dazu wird eine Liste mit Suchanfragen angezeigt, nach denen der Nutzer kürzlich in allen seinen Reise-Apps gesucht hat. Der Cluster wird an zweiter Stelle platziert, nach Reservierungen und vor Clustern mit Empfehlungen und vorgestellten Inhalten. Jeder Entwicklerpartner darf bis zu drei Entitäten im Cluster „Suche fortsetzen“ übertragen.
- PointOfInterestEntity:PointOfInterestEntity steht für einen Ort von Interesse wie eine Tankstelle, einen Veranstaltungsort, einen Freizeitpark, ein Museum, eine Touristenattraktion oder einen Wanderweg. Es werden Inhalte hervorgehoben, nach denen der Nutzer zuvor gesucht hat.
Vorarbeit
Mindest-API‑Level: 19
Fügen Sie die Bibliothek com.google.android.engage:engage-core zu Ihrer App hinzu:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.6.0'
}
Zusammenfassung
Das Design basiert auf einer Implementierung eines gebundenen Dienstes.
Die Daten, die ein Client veröffentlichen kann, unterliegen den folgenden Limits für verschiedene Clustertypen:
| Clustertyp | Cluster limits | Mindestlimits für Entitäten in einem Cluster | Maximale Entitätslimits in einem Cluster |
|---|---|---|---|
| Cluster mit Empfehlungen | Höchstens 7 | Mindestens 1 | Höchstens 50 (ArticleEntity, EventEntity,
LodgingEntity, StoreEntity oder
PointOfInterestEntity) |
| Reservierungscluster | Maximal 1 | Mindestens 1 | Höchstens 20 (RestaurantReservationEntity,
EventReservationEntity,
LodgingReservationEntity,
TransportationReservationEntity oder
VehicleRentalReservationEntity) |
| Empfohlener Cluster | Maximal 1 | Mindestens 1 | Höchstens 20 (GenericFeaturedEntity) |
| Cluster „Suche fortsetzen“ | Maximal 1 | Mindestens 1 | Höchstens 3 (PointOfInterestEntity) |
Schritt 1: Rechtssubjektdaten angeben
Im SDK sind verschiedene Entitäten definiert, die die einzelnen Artikeltypen darstellen. Wir unterstützen die folgenden Einheiten für die Kategorie „Reisen und Events“:
GenericFeaturedEntityArticleEntityEventEntityLodgingEntityStoreEntityPointOfInterestEntityRestaurantReservationEntityEventReservationEntityLodgingReservationEntityTransportationReservationEntityVehicleRentalReservationEntity
In den folgenden Tabellen sind die verfügbaren Attribute und Anforderungen für die einzelnen Typen aufgeführt.
GenericFeaturedEntity
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Posterbilder | Erforderlich | Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Das empfohlene Seitenverhältnis ist 16:9. Hinweis:Wenn ein Logo bereitgestellt wird, muss oben und unten im Bild ein Mindestabstand von 24 dp eingehalten werden. |
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, aber nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
| Untertitel-Liste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile umfasst. Hinweis:Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, aber nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
| Abzeichen | Optional | Jedes Badge besteht entweder aus Freitext (max. 15 Zeichen) oder einem kleinen Bild. Spezielle UX-Behandlung über dem Bild/Video, z. B. als Badge-Overlay auf dem Bild
|
|
| Badge – Text | Optional | Titel für das Badge Hinweis:Für das Badge ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
| Badge – Bild | Optional | Kleines Bild Besondere UX-Behandlung, z. B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis:Für das Badge ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
| Inhaltskategorien | Optional | Beschreibt die Kategorie des Inhalts in der Entität. | Liste der Enums Weitere Informationen finden Sie im Abschnitt „Inhaltskategorie“. |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
ArticleEntity
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Titel | Erforderlich | Titel der Entität. | Freier Text Empfohlene Textgröße: max. 50 Zeichen |
| Posterbilder | Optional | Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Das empfohlene Seitenverhältnis ist 16:9. Hinweis:Ein Bild wird dringend empfohlen. Wenn ein Logo bereitgestellt wird, muss oben und unten im Bild ein Mindestabstand von 24 dp eingehalten werden. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
| Quelle – Titel | Optional | Der Name des Autors, der Organisation oder des Reporters | Freier Text Empfohlene Textgröße: unter 25 Zeichen |
| Quelle – Bild | Optional | Ein Bild der Quelle, z. B. des Autors, der Organisation oder des Reporters | 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, aber nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
| Untertitel-Liste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile umfasst. Hinweis:Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, aber nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
| Abzeichen | Optional | Jedes Badge besteht entweder aus Freitext (max. 15 Zeichen) oder einem kleinen Bild. Spezielle UX-Darstellung über dem Bild/Video, z. B. als Badge-Overlay auf dem Bild
|
|
| Badge – Text | Optional | Titel für das Badge Hinweis:Für das Badge ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
| Badge – Bild | Optional | Kleines Bild Besondere UX-Behandlung, z. B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis:Für das Badge ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
| Zeitpunkt der Content-Veröffentlichung | Optional | Dies ist der Epoch-Zeitstempel in Millisekunden, der angibt, wann die Inhalte in der App veröffentlicht bzw. aktualisiert wurden. | Epochen-Zeitstempel in Millisekunden |
| Letzte Interaktion | Optional | Der Epoch-Zeitstempel in Millisekunden, als der Nutzer zuletzt mit dieser Einheit interagiert hat. |
Epochen-Zeitstempel in Millisekunden |
| Fortschritt in Prozent | Optional | Der Prozentsatz der vollständigen Inhalte, die der Nutzer bisher angesehen hat. |
Ein Ganzzahlwert zwischen 0 und 100 (einschließlich). |
| Inhaltskategorien | Optional | Beschreibt die Kategorie des Inhalts in der Entität. | Liste der Enums Weitere Informationen finden Sie im Abschnitt „Inhaltskategorie“. |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
EventEntity
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
| Lokalisierte Startzeit – Zeitstempel | Erforderlich |
Der Epoch-Zeitstempel für den voraussichtlichen Beginn des Ereignisses. |
Joda-Time Instant |
| Lokalisierte Startzeit – Zeitzone | Erforderlich |
Die Zeitzone, in der das Ereignis voraussichtlich beginnt. |
Joda-Time DateTimeZone |
| Ereignismodus | Erforderlich | Ein Feld, in dem angegeben wird, ob die Veranstaltung virtuell, vor Ort oder beides stattfindet. |
Enum: VIRTUAL, IN_PERSON oder HYBRID |
| Posterbilder | Erforderlich | Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Das empfohlene Seitenverhältnis ist 16:9. Hinweis:Ein Bild wird dringend empfohlen. Wenn ein Logo bereitgestellt wird, muss oben und unten im Bild ein Mindestabstand von 24 dp eingehalten werden. |
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 – Adresse anzeigen | Bedingt erforderlich | Die Adresse oder der Name des Veranstaltungsorts, 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 Straßenadresse (falls zutreffend) des Veranstaltungsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Bundesland | Optional | Das Bundesland oder der Bundesstaat (falls zutreffend), in dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) des Orts, an dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Stadtteil | Optional | Das Viertel (falls zutreffend), in dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Ende | Optional |
Der Epoch-Zeitstempel, zu dem das Ereignis voraussichtlich endet. Hinweis:Dieser 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, aber nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
| Untertitel-Liste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile umfasst. Hinweis:Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, aber nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
| Abzeichen | Optional |
Jedes Badge besteht entweder aus Freitext (max. 15 Zeichen) oder einem kleinen Bild. |
|
| Badge – Text | Optional | Titel für das Badge Hinweis:Für das Badge ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
| Badge – Bild | Optional | Kleines Bild Besondere UX-Behandlung, z. B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis:Für das Badge ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
| Preis – CurrentPrice | Bedingt erforderlich |
Der aktuelle Preis des Tickets/Passes für die Veranstaltung. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben wird. |
Freier Text |
| Preis – StrikethroughPrice | Optional | Der ursprüngliche Preis des Tickets/der Eintrittskarte für die Veranstaltung. | Freier Text |
| Preishinweis | Optional | Preisangabe für eine Promotion, ein Event oder einen Mitgliederrabatt, falls verfügbar. | Freier Text Empfohlene Textgröße: unter 45 Zeichen (zu langer Text wird möglicherweise mit Auslassungspunkten dargestellt) |
| Inhaltskategorien | Optional | Beschreibt die Kategorie des Inhalts in der Entität. | Liste der zulässigen Enums
Weitere Informationen finden Sie im Abschnitt „Inhaltskategorie“. |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
LodgingEntity
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
| Posterbilder | Erforderlich |
Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Das empfohlene Seitenverhältnis ist 16:9. Hinweis:Wenn ein Logo bereitgestellt wird, muss oben und unten im Bild ein Mindestabstand von 24 dp eingehalten werden. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
| Standort – Land | Erforderlich | Das Land, in dem die Unterkunft erfolgt. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Stadt | Erforderlich | Die Stadt, in der die Unterkunft liegt. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Adresse anzeigen | Erforderlich | Die Adresse, die dem Nutzer angezeigt wird. Wir empfehlen, für die meisten Anwendungsfälle den Namen der Stadt und möglicherweise des Bundesstaats oder Landes anzugeben. Geben Sie nur die Adresse oder das Viertel an, wenn sich der Nutzer in der Nähe des Orts befindet, der Nutzer mit dem Ort vertraut ist oder die Stadt im Clustertitel enthalten ist. Wenn Sie die Adresse angeben, verwenden Sie eine kurze Adresse und kürzen Sie Wörter nach Möglichkeit ab (z. B. „Str.“ für „Straße“, „Allee“ für „Allee“). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Adresse | Optional | Die Adresse der Unterkunft (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend), in der sich die Unterkunft befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Postleitzahl | Optional | Die Postleitzahl der Unterkunft (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Stadtteil | Optional | Das Viertel (falls zutreffend) der Unterkunft. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abzeichen | Optional |
Jedes Badge besteht entweder aus Freitext (max. 15 Zeichen) oder einem kleinen Bild. |
|
| Badge – Text | Optional | Titel für das Badge Hinweis:Für das Badge ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
| Badge – Bild | Optional | Kleines Bild Besondere UX-Behandlung, z. B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis:Für das Badge 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, aber nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
| Untertitel-Liste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile umfasst. Hinweis:Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, aber nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
| AvailabilityTimeWindow – Lokalisierte Startzeit – Zeitstempel | Optional | Der Epoch-Zeitstempel, der angibt, wann die Unterkunft voraussichtlich geöffnet/verfügbar ist. | Joda-Time Instant |
| AvailabilityTimeWindow – Lokalisierte Startzeit – Zeitzone | Optional | Die Zeitzone, in der die Unterkunft voraussichtlich geöffnet/verfügbar ist. |
Joda-Time DateTimeZone |
| AvailabilityTimeWindow – Localized End Time – Timestamp | Optional | Der Epoch-Zeitstempel, bis zu dem die Unterkunft voraussichtlich geöffnet/verfügbar ist. | Joda-Time Instant |
| AvailabilityTimeWindow – Localized End Time – Timezone | Optional | Die Zeitzone, in der die Unterkunft voraussichtlich geöffnet/verfügbar ist. |
Joda-Time DateTimeZone |
| Altersfreigabe – Höchstwert | Optional | Der Höchstwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Altersfreigabe angegeben wird. |
Zahl >= 0,0 |
| Altersfreigabe – Aktueller Wert | Optional | Der aktuelle Wert der Bewertungsskala. Muss angegeben werden, wenn auch der Höchstwert der Bewertung angegeben wird. |
Zahl >= 0,0 |
| Bewertung – Anzahl | Optional | Die Anzahl der Bewertungen für die Unterkunft. Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuern möchte, wie die Informationen für Nutzer angezeigt werden. 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 1 M verwenden, damit sie auf kleineren Displays nicht abgeschnitten wird. |
String |
| Bewertung – Zählwert | Optional | Die Anzahl der Bewertungen für die Unterkunft. Hinweis:Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahlswert“ vorhanden sind, wird die Anzahl für die Nutzer angezeigt. |
Lang |
| Preis – CurrentPrice | Bedingt erforderlich | Der aktuelle Preis der Unterkunft. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben wird. |
Freier Text |
| Preis – StrikethroughPrice | Optional | Der ursprüngliche Preis der Unterkunft, der in der Benutzeroberfläche durchgestrichen wird. | Freier Text |
| Preishinweis | Optional | Preisangabe für eine Promotion, ein Event oder einen Mitgliederrabatt, falls verfügbar. | Freier Text Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
StoreEntity
Das StoreEntity-Objekt stellt ein einzelnes Geschäft dar, das Entwicklerpartner veröffentlichen möchten, z. B. ein beliebtes Restaurant oder Lokal, das für die Reiseplanung relevant ist.
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Posterbilder | Erforderlich | Es muss mindestens ein Bild angegeben werden. | Weitere Informationen finden Sie unter Bildspezifikationen. |
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Titel | Optional | Der Name des Geschäfts. | Freier Text Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
| Standort | Optional | Der Standort des Geschäfts. | Freier Text Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
| Zusatzinformationen | Optional | Hinweis, um eine Werbeaktion, ein Event oder ein Update für den Store zu präsentieren, sofern verfügbar. | Freier Text Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
| Kleingedrucktes für Zusatzinformationen | Optional | Kleingedruckter Text für die Zusatzinformationen. | Freier Text Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
| Beschreibung | Optional | Eine Beschreibung des Geschäfts. | Freier Text Empfohlene Textgröße: unter 90 Zeichen (zu langer Text wird möglicherweise mit Auslassungspunkten angezeigt) |
| Kategorie | Optional | Kategorie eines Geschäfts. Im Zusammenhang mit Gastronomiebetrieben kann dies eine Küche wie „Französisch“, „New American“, „Ramen“ oder „Fine Dining“ sein. |
Freier Text Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
| Bewertung – Maximalwert | Optional | Der Höchstwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Altersfreigabe angegeben wird. |
Zahl >= 0,0 |
| Altersfreigabe – Aktueller Wert | Optional | Der aktuelle Wert der Bewertungsskala. Muss angegeben werden, wenn auch der Höchstwert der Bewertung angegeben wird. |
Zahl >= 0,0 |
| Bewertung – Anzahl | Optional | Die Anzahl der Bewertungen für die Unterkunft. Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuern möchte, wie die Informationen für Nutzer angezeigt werden. 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 1 M verwenden, damit sie auf kleineren Displays nicht abgeschnitten wird. |
String |
| Bewertung – Zählwert | Optional | Die Anzahl der Bewertungen für die Unterkunft. Hinweis:Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahlswert“ vorhanden sind, wird die Anzahl für die Nutzer angezeigt. |
Lang |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
PointOfInterestEntity
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
| Posterbilder | Bedingt erforderlich |
Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Das empfohlene Seitenverhältnis ist 16:9. Hinweis:Ein Bild ist erforderlich, wenn die Einheit Teil eines Empfehlungsclusters ist. Wenn ein Logo bereitgestellt wird, muss oben und unten im Bild ein Sicherheitsabstand von 24 dp eingehalten werden. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
| Letzte Interaktion | Bedingt erforderlich |
Der Epoch-Zeitstempel, als der Nutzer zuletzt mit dieser Einheit interagiert hat. Hinweis:Dieses Feld ist erforderlich, wenn die Einheit Teil des Clusters „Suche fortsetzen“ ist. |
Joda-Time Instant |
| Standort – Land | Bedingt erforderlich |
Das Land, in dem der POI stattfindet. Hinweis:Dieses Feld ist erforderlich, wenn die Einheit Teil eines Empfehlungsclusters ist. |
Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Stadt | Bedingt erforderlich |
Die Stadt, in der sich der POI befindet. Hinweis:Dieses Feld ist erforderlich, wenn die Einheit Teil eines Empfehlungsclusters ist. |
Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Adresse anzeigen | Bedingt erforderlich |
Die Adresse, die dem Nutzer angezeigt wird. Geben Sie eine kurze Adresse an und verwenden Sie nach Möglichkeit Abkürzungen (z. B. „Str.“ für „Straße“, „Allee“ für „Allee“). Dieser String wird je nach Gerät und Einstellungen des Nutzers möglicherweise gekürzt. Geben Sie den Namen der Stadt an, damit die Identifizierung eindeutig ist. Hinweis:Dieses Feld ist erforderlich, wenn die Einheit Teil eines Empfehlungsclusters ist. |
Freier Text Empfohlene Textgröße: max. ca. 35 Zeichen |
| Standort – Adresse | Optional | Die Adresse des POI, falls zutreffend. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend), in der sich der POI befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Postleitzahl | Optional | Die Postleitzahl des POI, falls zutreffend. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Stadtteil | Optional | Das Viertel (falls zutreffend) des POI. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| AvailabilityTimeWindow – Lokalisierte Startzeit – Zeitstempel | Optional | Der Epoch-Zeitstempel, der angibt, wann der Point of Interest voraussichtlich geöffnet/verfügbar ist. | Joda-Time Instant |
| AvailabilityTimeWindow – Lokalisierte Startzeit – Zeitzone | Optional | Die Zeitzone, in der der POI voraussichtlich geöffnet/verfügbar ist. |
Joda-Time DateTimeZone |
| AvailabilityTimeWindow – Localized End Time – Timestamp | Optional | Der Epoch-Zeitstempel, bis zu dem der Point of Interest voraussichtlich geöffnet/verfügbar ist. | Joda-Time Instant |
| AvailabilityTimeWindow – Localized End Time – Timezone | Optional | Die Zeitzone, in der der POI voraussichtlich geöffnet/verfügbar ist. |
Joda-Time DateTimeZone |
| Abzeichen | Optional |
Jedes Badge besteht entweder aus Freitext (max. 15 Zeichen) oder einem kleinen Bild. |
|
| Badge – Text | Optional | Titel für das Badge Hinweis:Für das Badge ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
| Badge – Bild | Optional | Kleines Bild Besondere UX-Behandlung, z. B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis:Für das Badge 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, aber nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
| Untertitel-Liste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile umfasst. Hinweis:Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, aber nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
| Bewertung – Maximalwert | Optional | Der Höchstwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Altersfreigabe angegeben wird. |
Zahl >= 0,0 |
| Altersfreigabe – Aktueller Wert | Optional | Der aktuelle Wert der Bewertungsskala. Muss angegeben werden, wenn auch der Höchstwert der Bewertung angegeben wird. |
Zahl >= 0,0 |
| Bewertung – Anzahl | Optional | Die Anzahl der Bewertungen für den POI. Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuern möchte, wie die Informationen für Nutzer angezeigt werden. 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 1 M verwenden, damit sie auf kleineren Displays nicht abgeschnitten wird. |
String |
| Bewertung – Zählwert | Optional | Die Anzahl der Bewertungen für den POI. Hinweis:Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahlswert“ vorhanden sind, wird die Anzahl für die Nutzer angezeigt. |
Lang |
| Preis – CurrentPrice | Bedingt erforderlich |
Der aktuelle Preis der Tickets/Eintrittskarten für den POI. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben wird. |
Freier Text |
| Preis – StrikethroughPrice | Optional | Der ursprüngliche Preis der Tickets/Eintrittskarten für den POI. | Freier Text |
| Preishinweis | Optional | Preisangabe für eine Promotion, ein Event oder einen Mitgliederrabatt, falls verfügbar. |
Freier Text Empfohlene Textgröße: unter 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt.) |
| Inhaltskategorien | Optional | Beschreibt die Kategorie des Inhalts in der Entität. | Liste der zulässigen Enums
Weitere Informationen finden Sie im Abschnitt „Inhaltskategorie“. |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
RestaurantReservationEntity
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
| Lokalisierte Reservierungsstartzeit – Zeitstempel | Erforderlich | Der Epoch-Zeitstempel für den voraussichtlichen Beginn der Reservierung. | Joda-Time Instant |
| Lokalisierte Reservierungsstartzeit – Zeitzone | Erforderlich | Die Zeitzone, in der die Reservierung voraussichtlich beginnt. |
Joda-Time DateTimeZone |
| Standort – Land | Erforderlich | Das Land, in dem sich das Restaurant befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Stadt | Erforderlich | Die Stadt, in der sich das Restaurant befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Adresse anzeigen | Erforderlich | Die Adresse des Restaurants, die dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Adresse | Optional | Die Adresse des Restaurants (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Bundesland | Optional | Das Bundesland (falls zutreffend), in dem sich das Restaurant befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Postleitzahl | Optional | Die Postleitzahl des Restaurants (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Stadtteil | Optional | Das Viertel (falls zutreffend), in dem sich das Restaurant befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Posterbilder | Optional | Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Das empfohlene Seitenverhältnis ist 16:9. | 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, aber nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
| Untertitel-Liste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile umfasst. Hinweis:Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, aber nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
| Tabellengröße | Optional | Die Anzahl der Personen in der Reservierungsgruppe | Ganzzahl > 0 |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
EventReservationEntity
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
| Lokalisierte Startzeit – Zeitstempel | Erforderlich |
Der Epoch-Zeitstempel für den voraussichtlichen Beginn des Ereignisses. |
Joda-Time Instant |
| Lokalisierte Startzeit – Zeitzone | Erforderlich |
Die Zeitzone, in der das Ereignis voraussichtlich beginnt. |
Joda-Time DateTimeZone |
| Ereignismodus | Erforderlich | Ein Feld, in dem angegeben wird, 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 – Adresse anzeigen | Bedingt erforderlich | Die Adresse oder der Name des Veranstaltungsorts, 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 Straßenadresse (falls zutreffend) des Veranstaltungsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Bundesland | Optional | Das Bundesland oder der Bundesstaat (falls zutreffend), in dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) des Orts, an dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Stadtteil | Optional | Das Viertel (falls zutreffend), in dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Posterbilder | Optional | Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Das empfohlene Seitenverhältnis ist 16:9. Hinweis:Ein Bild wird dringend empfohlen. Wenn ein Logo bereitgestellt wird, muss oben und unten im Bild ein Mindestabstand von 24 dp eingehalten werden. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
| Lokalisierte Endzeit – Zeitstempel | Optional |
Der Epoch-Zeitstempel, zu dem das Ereignis voraussichtlich endet. |
Joda-Time Instant |
| Lokalisierte Endzeit – Zeitzone | Optional |
Die Zeitzone, in der das Ereignis voraussichtlich endet. |
Joda-Time DateTimeZone |
| Dienstanbieter – Name | Optional |
Der Name des Dienstanbieters. Hinweis:Für den Dienstleister ist entweder Text oder ein Bild erforderlich. |
Freitext. z. B. Name des Veranstalters/der Tour |
| Dienstanbieter – Bild | Optional |
Das Logo/Bild des Dienstanbieters. Hinweis:Für den Dienstleister 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, aber nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
| Untertitel-Liste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile umfasst. Hinweis:Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, aber nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
| Abzeichen | Optional |
Jedes Badge besteht entweder aus Freitext (max. 15 Zeichen) oder einem kleinen Bild. |
|
| Badge – Text | Optional | Titel für das Badge Hinweis:Für das Badge ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
| Badge – Bild | Optional | Kleines Bild Besondere UX-Behandlung, z. B. als Badge-Overlay auf dem Bild-/Video-Thumbnail. Hinweis:Für das Badge ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
| Reservierungs-ID | Optional | Die Reservierungs-ID für die Eventreservierung. | Freier Text |
| Preis – CurrentPrice | Bedingt erforderlich |
Der aktuelle Preis des Tickets/Passes für die Veranstaltung. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben wird. |
Freier Text |
| Preis – StrikethroughPrice | Optional | Der ursprüngliche Preis des Tickets/der Eintrittskarte für die Veranstaltung. | Freier Text |
| Preishinweis | Optional | Preisangabe für eine Promotion, ein Event oder einen Mitgliederrabatt, falls verfügbar. | Freier Text Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
| Bewertung – Maximalwert | Optional | Der Höchstwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Altersfreigabe angegeben wird. |
Zahl >= 0,0 |
| Altersfreigabe – Aktueller Wert | Optional | Der aktuelle Wert der Bewertungsskala. Muss angegeben werden, wenn auch der Höchstwert der Bewertung angegeben wird. |
Zahl >= 0,0 |
| Bewertung – Anzahl | Optional | Die Anzahl der Bewertungen für das Ereignis. Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuern möchte, wie die Informationen für Nutzer angezeigt werden. 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 1 M verwenden, damit sie auf kleineren Displays nicht abgeschnitten wird. |
String |
| Bewertung – Zählwert | Optional | Die Anzahl der Bewertungen für das Ereignis. Hinweis:Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahlswert“ vorhanden sind, wird die Anzahl für die Nutzer angezeigt. |
Lang |
| Inhaltskategorien | Optional | Beschreibt die Kategorie des Inhalts in der Entität. | Liste der zulässigen Enums
Weitere Informationen finden Sie im Abschnitt „Inhaltskategorie“. |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
LodgingReservationEntity
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Titel | Erforderlich | Titel der Entität. | Freitext. Beispiel: „Ihr Aufenthalt ab 12. Dezember“ Empfohlene Textgröße: max. 50 Zeichen |
| Lokalisierte Check‑in-Zeit – Zeitstempel | Erforderlich | Der Epochenzeitstempel, der die Check-in-Zeit für die Reservierung darstellt. | Joda-Time Instant |
| Lokalisierte Check-in-Zeit – Zeitzone | Erforderlich | Die Zeitzone, in der die Check-in-Zeit für die Reservierung angegeben ist. |
Joda-Time DateTimeZone |
| Lokalisierte Check-out-Zeit – Zeitstempel | Erforderlich | Der Epoch-Zeitstempel, der die Check-out-Zeit für die Reservierung darstellt. | Joda-Time Instant |
| Lokalisierte Check-out-Zeit – Zeitzone | Erforderlich | Die Zeitzone, in der die Check-out-Zeit für die Reservierung angegeben ist. |
Joda-Time DateTimeZone |
| Standort – Land | Erforderlich | Das Land, in dem sich die Unterkunft befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Stadt | Erforderlich | Die Stadt, in der sich die Unterkunft befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Adresse anzeigen | Erforderlich | Die Adresse, die dem Nutzer angezeigt wird. Geben Sie eine kurze Adresse an und verwenden Sie nach Möglichkeit Abkürzungen (z. B. „Str.“ für „Straße“, „Allee“ für „Allee“). Dieser String wird je nach Gerät und Einstellungen des Nutzers möglicherweise gekürzt. Geben Sie den Namen der Stadt an, damit die Identifizierung eindeutig ist. | Freier Text Empfohlene Textgröße: max. ca. 35 Zeichen |
| Standort – Adresse | Optional | Die Adresse der Unterkunft (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend), in der sich die Unterkunft befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Postleitzahl | Optional | Die Postleitzahl der Unterkunft (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Standort – Stadtteil | Optional | Das Viertel (falls zutreffend) der Unterkunft. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Posterbilder | Optional |
Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Das empfohlene Seitenverhältnis ist 16:9. Hinweis:Wenn ein Badge bereitgestellt wird, muss oben und unten im Bild ein Mindestabstand von 24 dp eingehalten werden. |
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, aber nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
| Untertitel-Liste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile umfasst. Hinweis:Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, aber nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
| Reservierungs-ID | Optional | Die Reservierungs-ID für die Unterkunftsreservierung. | Freier Text |
| Bewertung – Maximalwert | Optional | Der Höchstwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Altersfreigabe angegeben wird. |
Zahl >= 0,0 |
| Altersfreigabe – Aktueller Wert | Optional | Der aktuelle Wert der Bewertungsskala. Muss angegeben werden, wenn auch der Höchstwert der Bewertung angegeben wird. |
Zahl >= 0,0 |
| Bewertung – Anzahl | Optional | Die Anzahl der Bewertungen für die Unterkunft. Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuern möchte, wie die Informationen für Nutzer angezeigt werden. 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 1 M verwenden, damit sie auf kleineren Displays nicht abgeschnitten wird. |
String |
| Bewertung – Zählwert | Optional | Die Anzahl der Bewertungen für die Unterkunft. Hinweis:Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahlswert“ vorhanden sind, wird die Anzahl für die Nutzer angezeigt. |
Lang |
| Preis – CurrentPrice | Bedingt erforderlich | Der aktuelle Preis der Unterkunft. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben wird. |
Freier Text |
| Preis – StrikethroughPrice | Optional | Der ursprüngliche Preis der Unterkunft, der in der Benutzeroberfläche durchgestrichen wird. | Freier Text |
| Preishinweis | Optional | Preisangabe für eine Promotion, ein Event oder einen Mitgliederrabatt, falls verfügbar. | Freier Text Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
TransportationReservationEntity
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Titel | Erforderlich | Titel der Entität. | Freitext. Beispiel: „SFO nach SAN“ Empfohlene Textgröße: max. 50 Zeichen |
| Art des Verkehrsmittels | Erforderlich | Das Transportmittel für die Reservierung. | Enum: FLIGHT, TRAIN, BUS oder FERRY |
| Lokalisierte Abfahrtszeit – Zeitstempel | Erforderlich | Der Epoch-Zeitstempel, der die Abfahrtszeit darstellt. | Joda-Time Instant |
| Lokalisierte Abfahrtszeit – Zeitzone | Erforderlich | Die Zeitzone der Abfahrtszeit. |
Joda-Time DateTimeZone |
| Lokalisierte Ankunftszeit – Zeitstempel | Erforderlich | Der Epoch-Zeitstempel, der die Ankunftszeit darstellt. | Joda-Time Instant |
| Lokalisierte Ankunftszeit – Zeitzone | Erforderlich | Die Zeitzone der Ankunftszeit. |
Joda-Time DateTimeZone |
| Transportnummer | Erforderlich | Die Flug-, Bus-, Zug- oder Fähr-/Kreuzfahrtnummer. | Freier Text |
| Lokalisierte Boardingzeit – Zeitstempel | Erforderlich | Der Epoch-Zeitstempel, der die Boardingzeit für die Reservierung darstellt (falls zutreffend) | Joda-Time Instant |
| Lokalisierte Boardingzeit – Zeitzone | Erforderlich | Die Zeitzone der Boardingzeit für die Reservierung (falls zutreffend) |
Joda-Time DateTimeZone |
| Abreiseort – Land | Optional | Das Abreiseland. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abfahrtsort – Stadt | Optional | Der Abreiseort. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abfahrtsort – Adresse anzeigen | Optional | Der Abfahrtsort, der dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abfahrtsort – Adresse | Optional | Die Adresse des Abfahrtsorts (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abfahrtsort – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend) des Abfahrtsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abfahrtsort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) des Abfahrtsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abfahrtsort – Stadtteil | Optional | Das Viertel (falls zutreffend) des Abfahrtsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Ankunftsort – Land | Optional | Das Ankunftsland. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Ankunftsort – Stadt | Optional | Der Ankunftsort. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Ankunftsort – Adresse anzeigen | Optional | Der Ankunftsort, der dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Ankunftsort – Adresse | Optional | Die Adresse des Ankunftsorts (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Ankunftsort – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend) des Ankunftsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Zielort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) des Ankunftsorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Ankunftsort – Stadtteil | Optional | Das Viertel (falls zutreffend) des Zielorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Dienstanbieter – Name | Optional |
Der Name des Dienstanbieters. Hinweis:Für den Dienstleister ist entweder Text oder ein Bild erforderlich. |
Freitext. Beispiel: Name der Fluggesellschaft |
| Dienstanbieter – Bild | Optional |
Das Logo/Bild des Dienstanbieters. Hinweis:Für den Dienstleister ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
| Posterbilder | Optional |
Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Das empfohlene Seitenverhältnis ist 16:9. |
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, aber nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
| Untertitel-Liste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile umfasst. Hinweis:Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, aber nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
| Reservierungs-ID | Optional | Die Reservierungs-ID für die Transportreservierung. | Freier Text |
| Preis – CurrentPrice | Bedingt erforderlich | Der aktuelle Preis der Reservierung. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben wird. |
Freier Text |
| Preis – StrikethroughPrice | Optional | Der ursprüngliche Preis der Reservierung, der in der Benutzeroberfläche durchgestrichen wird. | Freier Text |
| Preishinweis | Optional | Preisangabe für eine Promotion, ein Event oder einen Mitgliederrabatt, falls verfügbar. | Freier Text Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
VehicleRentalReservationEntity
| Attribut | Anforderung | Beschreibung | Format |
|---|---|---|---|
| Aktions-URI | Erforderlich |
Deeplink zur Einheit in der Dienstleister-App. Hinweis: Sie können Deeplinks für die Zuordnung verwenden. Häufig gestellte Fragen |
Uri |
| Titel | Erforderlich | Titel der Entität. | Freitext. Beispiel: „Avis Union Square SF“ Empfohlene Textgröße: max. 50 Zeichen |
| Lokalisierte Abholzeit – Zeitstempel | Erforderlich | Der Epoch-Zeitstempel, der die Abholzeit für die Reservierung darstellt. | Joda-Time Instant |
| Lokalisierte Abholzeit – Zeitzone | Erforderlich | Die Zeitzone der Abholzeit für die Reservierung. |
Joda-Time DateTimeZone |
| Lokalisierte Rückgabezeit – Zeitstempel | Optional | Der Epoch-Zeitstempel, der die Check-out-Zeit für die Reservierung angibt. | Joda-Time Instant |
| Lokalisierte Rückgabezeit – Zeitzone | Optional | Die Zeitzone der Check-out-Zeit für die Reservierung. |
Joda-Time DateTimeZone |
| Abholadresse – Land | Optional | Das Land des Abholorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abholadresse – Stadt | Optional | Die Stadt des Abholorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abholadresse – Adresse anzeigen | Optional | Der Abholort, der dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abholadresse – Adresse | Optional | Die Adresse des Abholorts (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abholadresse – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend) des Abholorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abholadresse – Postleitzahl | Optional | Die Postleitzahl des Abholorts (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Abholadresse – Stadtteil | Optional | Der Stadtteil des Abholorts (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Rücksendeadresse – Land | Optional | Das Land der Rücksendeadresse. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Rücksendeadresse – Stadt | Optional | Die Stadt der Rücksendeadresse. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Rücksendeadresse – Adresse anzeigen | Optional | Die Rücksendeadresse, die dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Rücksendeadresse – Adresse | Optional | Die Rücksendeadresse (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Rücksendeadresse – Bundesstaat | Optional | Das Bundesland oder die Provinz (falls zutreffend) der Rücksendeadresse. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Rücksendeadresse – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) der Rücksendeadresse. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Rücksendeadresse – Stadtteil | Optional | Das Viertel (falls zutreffend) des Rückgabeorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
| Dienstanbieter – Name | Optional |
Der Name des Dienstanbieters. Hinweis:Für den Dienstleister ist entweder Text oder ein Bild erforderlich. |
Freitext. Beispiel: „Avis Car Rental“ |
| Dienstanbieter – Bild | Optional |
Das Logo/Bild des Dienstanbieters. Hinweis:Für den Dienstleister ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
| Posterbilder | Optional |
Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Das empfohlene Seitenverhältnis ist 16:9. |
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, aber nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
| Untertitel-Liste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile umfasst. Hinweis:Dem Nutzer wird entweder die Beschreibung oder die Untertitelliste angezeigt, aber nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
| Bestätigungs-ID | Optional | Die Bestätigungs-ID für die Reservierung des Mietwagens. | Freier Text |
| Preis – CurrentPrice | Bedingt erforderlich | Der aktuelle Preis der Reservierung. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben wird. |
Freier Text |
| Preis – StrikethroughPrice | Optional | Der ursprüngliche Preis der Reservierung, der in der Benutzeroberfläche durchgestrichen wird. | Freier Text |
| Preishinweis | Optional | Preisangabe für eine Promotion, ein Event oder einen Mitgliederrabatt, falls verfügbar. | Freier Text Empfohlene Textgröße: unter 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
| DisplayTimeWindow (Optional) – Zeitfenster für die Anzeige von Inhalten auf der Oberfläche festlegen | |||
| Startzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem die Inhalte auf der Oberfläche angezeigt werden sollen. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
| Endzeitstempel | Optional |
Der Epoch-Zeitstempel, nach dem der Inhalt nicht mehr auf der Oberfläche angezeigt wird. Wenn nicht festgelegt, können Inhalte auf der Plattform präsentiert werden. |
Epochen-Zeitstempel in Millisekunden |
Bildspezifikationen
In dieser Tabelle finden Sie die erforderlichen Spezifikationen für Bild-Assets:
| Seitenverhältnis | Mindestanzahl Pixel | Empfohlene Pixel |
|---|---|---|
Quadratisch (1 × 1) Bevorzugt |
300 x 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:Platzieren Sie wichtige Inhalte in den mittleren 80% des Bildes.
- Verwenden Sie einen transparenten Hintergrund, damit das Bild in den Einstellungen für das helle und das dunkle Design richtig angezeigt werden kann.
Zeitzonenspezifikationen
Bevorzugen Sie die ID (z. B. „America/Los_Angeles“) gegenüber dem Offset (z. B. „-07:00“).
Beispiel für die Verwendung: DateTimeZone.forID("America/Los_Angeles")
Inhaltskategorie
Mit der Inhaltskategorie können Apps Inhalte aus mehreren Kategorien veröffentlichen. Dadurch werden die Inhalte einigen der vordefinierten Kategorien zugeordnet, nämlich:
TYPE_EDUCATIONTYPE_SPORTSTYPE_MOVIES_AND_TV_SHOWSTYPE_BOOKSTYPE_AUDIOBOOKSTYPE_MUSICTYPE_DIGITAL_GAMESTYPE_TRAVEL_AND_LOCALTYPE_HOME_AND_AUTOTYPE_BUSINESSTYPE_NEWSTYPE_FOOD_AND_DRINKTYPE_SHOPPINGTYPE_HEALTH_AND_FITENESSTYPE_MEDICALTYPE_PARENTINGTYPE_DATING
Die Bilder müssen auf öffentlichen CDNs gehostet werden, damit Google darauf zugreifen kann.
Richtlinien für die Verwendung der Inhaltskategorien
- Für einige Einheiten wie ArticleEntity und GenericFeaturedEntity können alle Inhaltskategorien verwendet werden. Für andere Rechtspersönlichkeiten wie EventEntity, EventReservationEntity und PointOfInterestEntity 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 anstelle einer Kombination aus den generischen Entitäten und ContentCategory:
- TYPE_MOVIES_AND_TV_SHOWS: Sehen Sie sich die Einheiten im Leitfaden zur Watch-Integration an, bevor Sie die generischen Einheiten verwenden.
- TYPE_BOOKS: Sehen Sie sich vor der Verwendung der generischen Einheiten die EbookEntity an.
- TYPE_AUDIOBOOKS: Sehen Sie sich vor der Verwendung der generischen Entitäten AudiobookEntity an.
- TYPE_SHOPPING: Sehen Sie sich ShoppingEntity an, bevor Sie die generischen Einheiten verwenden.
- TYPE_FOOD_AND_DRINK: Sehen Sie sich die Elemente aus der Anleitung zur Lebensmittelintegration an, bevor Sie die generischen Elemente verwenden.
Das Feld „ContentCategory“ ist optional und sollte leer gelassen werden, wenn die Inhalte keiner der oben genannten Kategorien angehören.
Wenn mehrere Inhaltskategorien angegeben werden, geben Sie sie in der Reihenfolge ihrer Relevanz für die Inhalte an. Die relevanteste Inhaltskategorie sollte dabei an erster Stelle in der Liste stehen.
Schritt 2: Clusterdaten angeben
Es wird empfohlen, den Job zum Veröffentlichen von Inhalten im Hintergrund auszuführen (z. B. mit WorkManager) und regelmäßig oder ereignisbasiert zu planen (z. B. jedes Mal, wenn der Nutzer die App öffnet oder gerade etwas in den Einkaufswagen gelegt hat).
AppEngageTravelClient ist für die Veröffentlichung von Clustern verantwortlich.
Es gibt die folgenden APIs zum Veröffentlichen von Clustern im Client:
isServiceAvailablepublishRecommendationClusterspublishFeaturedClusterpublishReservationClusterpublishContinueSearchClusterpublishUserAccountManagementRequestupdatePublishStatusdeleteRecommendationsClustersdeleteFeaturedClusterdeleteReservationClusterdeleteContinueSearchClusterdeleteUserManagementClusterdeleteClusters
isServiceAvailable
Mit dieser API wird geprüft, ob der Dienst für die Integration verfügbar ist und ob die Inhalte auf dem Gerät präsentiert werden können.
Für Engage SDK v1.6.0 und höher (empfohlen)
Android-Kenntnisse
Auf GitHub ansehenIntegration des Engage SDK
android skills add engage-sdk-integrationUse the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.Sie können die Dienstverfügbarkeit für jeden Clustertyp prüfen, den Sie veröffentlichen möchten. Die isServiceAvailable API akzeptiert ein Anfrageobjekt, ServiceAvailabilityRequest, das die Clustertypen enthält, für die die Dienstverfügbarkeit geprüft werden muss. Die für ServiceAvailabilityRequest erforderlichen ClusterType-Enum-Werte finden Sie in der folgenden Tabelle.
| Clustertyp | Konstante für Clustertyp | Ganzzahlwert |
|---|---|---|
| Unbekannt | TYPE_UNKNOWN |
0 |
| Cluster mit Empfehlungen | TYPE_RECOMMENDATION |
1 |
| Empfohlener Cluster | TYPE_FEATURED |
2 |
| Fortsetzungscluster | TYPE_CONTINUATION |
3 |
| Nutzerverwaltungscluster | TYPE_ENGAGEMENT |
8 |
| Abo-Cluster | TYPE_SUBSCRIPTION |
12 |
| Cluster „Suche fortsetzen“ | TYPE_CONTINUE_SEARCH |
13 |
| Reservierungscluster | TYPE_RESERVATION |
14 |
Kotlin
val request = ServiceAvailabilityRequest.Builder()
.addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
.addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
.build()
client.isServiceAvailable(request).addOnCompleteListener { task ->
if (task.isSuccessful) {
val availabilityMap = task.result
if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
// Proceed with publishing continuation content
}
if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
// Proceed with publishing recommendation content
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
}
Java
ServiceAvailabilityRequest request =
new ServiceAvailabilityRequest.Builder()
.addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
.addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
.build();
client.isServiceAvailable(request).addOnCompleteListener(task -> {
if (task.isSuccessful()) {
Map<Integer, Boolean> availabilityMap = task.getResult();
if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
// Proceed with publishing continuation content
}
if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
// Proceed with publishing recommendation content
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
});
Funktion für die bedingte Dienstverfügbarkeit
Einige integrierte Apps erfordern eine spezielle Konfiguration, mit der der Engage-Dienst zeitweise aktiviert und deaktiviert wird, um die Bereitstellungskosten zu senken. Diese Strategie zur zeitweiligen Contentaufnahme ist zwar möglich, wirkt sich jedoch negativ auf den Nutzer und das Produkt aus. Veraltete Inhalte werden nicht präsentiert und einige Oberflächen werden überhaupt nicht bereitgestellt.
Ab Version 1.6.0 können Sie mit dem Engage SDK die Verfügbarkeit für bestimmte Clustertypen prüfen. Das bietet mehr Flexibilität. Wenn die Strategie für intermittierende Inhalte für eine bestimmte Anwendung übernommen wurde, können einige Clustertypen dieser Strategie folgen, während andere Clustertypen immer aktiviert sind (z. B. Fortsetzungscluster).
Wenn der Engage-Dienst aus irgendeinem Grund nicht „kontinuierlich“ auf allen unterstützten Geräten aktiviert sein soll und für eine beliebige Gruppe von Geräten für die zeitweise Aufnahme konfiguriert ist, sind alle Publikationen von Fortsetzungsclustern (z. B. Reservierung und Suche fortsetzen) standardmäßig aktiviert. Die restlichen Clustertypen werden zeitweise aktiviert und deaktiviert. Wenn die zeitweise Aufnahme auf Sie zutrifft, diese Standardkonfiguration aber nicht Ihren Anforderungen entspricht, wenden Sie sich bitte an engage-developers@google.com.
Für SDK-Versionen vor v1.6.0 (eingestellt)
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, werden die folgenden Aktionen in einer Transaktion ausgeführt:
- Vorhandene
RecommendationCluster-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten Empfehlungscluster gespeichert.
Bei einem Fehler 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, werden die folgenden Aktionen in einer Transaktion ausgeführt:
- Vorhandene
FeaturedCluster-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten vorgestellten Cluster gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishReservationCluster
Diese API wird zum Veröffentlichen eines ReservationCluster-Objekts verwendet.
Kotlin
client.publishReservationCluster(
PublishReservationClusterRequest.Builder()
.setReservationCluster(
ReservationCluster.Builder()
.addLodgingReservationEntity(lodgingReservationEntity)
.addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
.addTransportationReservationEntity(transportationReservationEntity)
.addEventReservationEntity(eventReservationEntity)
.addRestaurantReservationEntity(restaurantReservationEntity)
.build())
.build())
Java
client.publishReservationCluster(
new PublishReservationClusterRequest.Builder()
.setReservationCluster(
new ReservationCluster.Builder()
.addLodgingReservationEntity(lodgingReservationEntity)
.addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
.addTransportationReservationEntity(transportationReservationEntity)
.addEventReservationEntity(eventReservationEntity)
.addRestaurantReservationEntity(restaurantReservationEntity)
.build())
.build());
Wenn der Dienst die Anfrage empfängt, werden die folgenden Aktionen in einer Transaktion ausgeführt:
- Vorhandene
ReservationCluster-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten Reservierungscluster gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishContinueSearchCluster
Diese API wird verwendet, um eine Liste von ContinueSearchCluster-Objekten zu veröffentlichen.
Kotlin
client.publishContinueSearchCluster(
PublishContinueSearchClusterRequest.Builder()
.setContinueSearchCluster(
ContinueSearchCluster.Builder()
.addPointOfInterestEntity(entity1)
.addPointOfInterestEntity(entity2)
.build())
.build())
Java
client.publishContinueSearchCluster(
new PublishContinueSearchClusterRequest.Builder()
.setContinueSearchCluster(
new ContinueSearchCluster.Builder()
.addPointOfInterestEntity(entity1)
.addPointOfInterestEntity(entity2)
.build())
.build());
Wenn der Dienst die Anfrage empfängt, werden die folgenden Aktionen in einer Transaktion ausgeführt:
- Vorhandene
ContinueSearchCluster-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten Cluster „Suche fortsetzen“ gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishUserAccountManagementRequest
Diese API wird verwendet, um eine Anmeldekarte zu veröffentlichen . Die Anmeldeaktion leitet Nutzer zur Anmeldeseite der App weiter, damit die App Inhalte veröffentlichen oder personalisierte Inhalte bereitstellen kann.
Die folgenden Metadaten sind Teil der Anmeldekarte:
| Attribut | Anforderung | Beschreibung |
|---|---|---|
| Aktions-URI | Erforderlich | Deeplink zur Aktion (d.h. zur Anmeldeseite der App) |
| Bild | Optional – Wenn nicht angegeben, muss „Title“ angegeben werden. |
Auf der Karte angezeigtes Bild Bilder mit einem Seitenverhältnis von 16:9 und einer Auflösung von 1264 × 712 |
| Titel | Optional – Wenn nicht angegeben, muss ein Bild angegeben werden. | Titel auf der Karte |
| Text für erforderliche Aktionen | Optional | Text, der im CTA angezeigt wird (z.B. „Anmelden“) |
| Untertitel | Optional | Optionaler Untertitel auf der Karte |
Kotlin
var SIGN_IN_CARD_ENTITY =
SignInCardEntity.Builder()
.addPosterImage(
Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(500)
.setImageWidthInPixel(500)
.build())
.setActionText("Sign In")
.setActionUri(Uri.parse("http://xx.com/signin"))
.build()
client.publishUserAccountManagementRequest(
PublishUserAccountManagementRequest.Builder()
.setSignInCardEntity(SIGN_IN_CARD_ENTITY)
.build());
Java
SignInCardEntity SIGN_IN_CARD_ENTITY =
new SignInCardEntity.Builder()
.addPosterImage(
new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(500)
.setImageWidthInPixel(500)
.build())
.setActionText("Sign In")
.setActionUri(Uri.parse("http://xx.com/signin"))
.build();
client.publishUserAccountManagementRequest(
new PublishUserAccountManagementRequest.Builder()
.setSignInCardEntity(SIGN_IN_CARD_ENTITY)
.build());
Wenn der Dienst die Anfrage empfängt, werden die folgenden Aktionen in einer Transaktion ausgeführt:
- Vorhandene
UserAccountManagementCluster-Daten des Entwicklerpartners werden entfernt. - Daten aus der Anfrage werden geparst und im aktualisierten Cluster „UserAccountManagementCluster“ gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
updatePublishStatus
Wenn aus internen geschäftlichen Gründen keiner der Cluster veröffentlicht wird, empfehlen wir dringend, den Veröffentlichungsstatus mit der API updatePublishStatus zu aktualisieren. Das ist wichtig, weil :
- Es ist wichtig, den Status in allen Szenarien anzugeben, auch wenn die Inhalte veröffentlicht sind (STATUS == PUBLISHED), damit Dashboards, in denen dieser explizite Status verwendet wird, mit Daten gefüllt werden können, um den Zustand und andere Messwerte Ihrer Integration zu vermitteln.
- Wenn keine Inhalte veröffentlicht werden, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google vermeiden, dass Warnungen in den App-Health-Dashboards ausgelöst werden. Es wird bestätigt, dass Inhalte aufgrund einer aus Sicht des Anbieters erwarteten Situation nicht veröffentlicht werden.
- So können Entwickler nachvollziehen, wann die Daten veröffentlicht werden und wann nicht.
- Google kann die Statuscodes verwenden, um den Nutzer zu bestimmten Aktionen in der App aufzufordern, damit er die App-Inhalte sehen oder das Problem beheben kann.
Die Liste der zulässigen Statuscodes für die Veröffentlichung lautet :
// Content is published
AppEngagePublishStatusCode.PUBLISHED,
// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,
// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,
// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,
// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,
// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,
// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,
// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,
// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER
Wenn die Inhalte nicht veröffentlicht werden, weil ein Nutzer nicht angemeldet ist, empfiehlt Google, die Anmeldekarte zu veröffentlichen. Wenn Anbieter die Anmeldekarte aus irgendeinem Grund nicht veröffentlichen können, empfehlen wir, die updatePublishStatus API mit dem Statuscode NOT_PUBLISHED_REQUIRES_SIGN_IN aufzurufen.
Kotlin
client.updatePublishStatus(
PublishStatusRequest.Builder()
.setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
.build())
Java
client.updatePublishStatus(
new PublishStatusRequest.Builder()
.setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
.build());
deleteRecommendationClusters
Mit dieser API werden die Inhalte von Empfehlungsclustern gelöscht.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus den Empfehlungsclustern entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteFeaturedCluster
Mit dieser API wird der Inhalt des vorgestellten Clusters gelöscht.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem vorgestellten Cluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteReservationCluster
Mit dieser API wird der Inhalt des Reservierungsclusters gelöscht.
Kotlin
client.deleteReservationCluster()
Java
client.deleteReservationCluster();
Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem Reservierungscluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteUserManagementCluster
Diese API wird verwendet, um den Inhalt des UserAccountManagement-Clusters zu löschen.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem UserAccountManagement-Cluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteContinueSearchCluster
Mit dieser API wird der Inhalt des Clusters „Suche fortsetzen“ gelöscht.
Kotlin
client.deleteContinueSearchCluster()
Java
client.deleteContinueSearchCluster();
Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem Cluster „Suche fortsetzen“ entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteClusters
Mit dieser API wird der Inhalt eines bestimmten Clustertyps gelöscht.
Kotlin
client.deleteClusters(
DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_RESERVATION)
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
.addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
.build())
Java
client.deleteClusters(
new DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_RESERVATION)
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
.addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
.build());
Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus allen Clustern entfernt, die den angegebenen Clustertypen entsprechen. Clients können einen oder mehrere Clustertypen übergeben. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
Fehlerbehandlung
Es wird dringend empfohlen, das Ergebnis des Tasks über die Publish-APIs abzurufen, damit eine Folgemaßnahme ergriffen werden kann, um einen erfolgreichen Task wiederherzustellen und noch einmal einzureichen.
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. Die Ursache ist als Fehlercode enthalten.
| Fehlercode | Fehlername | Hinweis |
|---|---|---|
1 |
SERVICE_NOT_FOUND |
Der Dienst ist auf dem angegebenen Gerät nicht verfügbar. |
2 |
SERVICE_NOT_AVAILABLE |
Der Dienst ist auf dem angegebenen Gerät verfügbar, aber zum Zeitpunkt des Anrufs nicht (z. B. weil er explizit deaktiviert ist). |
3 |
SERVICE_CALL_EXECUTION_FAILURE |
Die Ausführung der Aufgabe ist aufgrund von Threading-Problemen fehlgeschlagen. In diesem Fall kann der Vorgang wiederholt werden. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Der Anrufer ist nicht berechtigt, den Dienstaufruf zu starten. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
Die Anfrage enthält ungültige Daten, z. B. mehr Cluster als zulässig. |
6 |
SERVICE_CALL_INTERNAL |
Auf der Dienstseite ist ein Fehler aufgetreten. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Der Dienstaufruf erfolgt zu häufig. |
Schritt 3: Broadcast-Intents verarbeiten
Neben dem Ausführen von API-Aufrufen zum Veröffentlichen von Inhalten über einen Job ist es auch erforderlich, eine BroadcastReceiver einzurichten, um die Anfrage zum Veröffentlichen von Inhalten zu empfangen.
Der Zweck von Broadcast-Intents besteht hauptsächlich in der Reaktivierung von Apps und der Erzwingung der Datensynchronisierung. Broadcast-Intents sind nicht dafür gedacht, sehr häufig gesendet zu werden. Sie wird nur ausgelöst, wenn der Engage-Dienst feststellt, dass die Inhalte möglicherweise veraltet sind (z. B. eine Woche alt). So ist es wahrscheinlicher, dass der Nutzer neue Inhalte sieht, auch wenn die Anwendung längere Zeit nicht ausgeführt wurde.
Das BroadcastReceiver muss auf folgende zwei Arten eingerichtet werden:
Registrieren Sie dynamisch eine Instanz der Klasse
BroadcastReceivermitContext.registerReceiver(). Dadurch wird die Kommunikation von Anwendungen ermöglicht, die noch im Arbeitsspeicher aktiv sind.
Kotlin
class AppEngageBroadcastReceiver : BroadcastReceiver(){
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger continue search cluster publish when PUBLISH_CONTINUE_SEARCH
// broadcast is received
// Trigger reservation cluster publish when PUBLISH_RESERVATION broadcast is
// received
}
fun registerBroadcastReceivers(context: Context){
var context = context
context = context.applicationContext
// Register Recommendation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Featured Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Continue Search Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_CONTINUE_SEARCH),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Reservation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_RESERVATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
}
Java
class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger continue search cluster publish when PUBLISH_CONTINUE_SEARCH
// broadcast is received
// Trigger reservation cluster publish when PUBLISH_RESERVATION broadcast is
// received
}
public static void registerBroadcastReceivers(Context context) {
context = context.getApplicationContext();
// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Continue Search Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_CONTINUE_SEARCH),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Reservation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_RESERVATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
}
Deklarieren Sie eine Implementierung statisch mit dem
<receiver>-Tag in IhrerAndroidManifest.xml-Datei. Dadurch kann die Anwendung Broadcast-Intents empfangen, wenn sie nicht ausgeführt wird, und auch Inhalte veröffentlichen.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.travel.PUBLISH_CONTINUE_SEARCH" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.travel.PUBLISH_RESERVATION" />
</intent-filter>
</receiver>
</application>
Die folgenden Intents werden vom Dienst gesendet:
com.google.android.engage.action.PUBLISH_RECOMMENDATIONEs wird empfohlen, bei Empfang dieses Intents einenpublishRecommendationClusters-Aufruf zu starten.com.google.android.engage.action.PUBLISH_FEATUREDEs wird empfohlen, bei Empfang dieses Intents einenpublishFeaturedCluster-Anruf zu starten.com.google.android.engage.action.travel.PUBLISH_CONTINUE_SEARCHEs wird empfohlen, einenpublishContinueSearchCluster-Aufruf zu starten, wenn dieser Intent empfangen wird.com.google.android.engage.action.travel.PUBLISH_RESERVATIONEs wird empfohlen, einenpublishReservationCluster-Aufruf zu starten, wenn dieser Intent empfangen wird.
Integrationsablauf
Eine detaillierte Anleitung zum Überprüfen der Integration nach Abschluss finden Sie unter Workflow für die Entwicklerintegration von Engage.
Häufig gestellte Fragen
Häufig gestellte Fragen zum Engage SDK
Kontakt
Wenden Sie sich bei Fragen während der Integration an engage-developers@google.com.
Nächste Schritte
Nachdem Sie die Integration abgeschlossen haben, gehen Sie so vor:
- Senden Sie eine E‑Mail an
engage-developers@google.comund hängen Sie Ihr integriertes APK an, das für Tests durch Google bereit ist. - Google führt eine Überprüfung durch und prüft intern, ob die Integration wie erwartet funktioniert. Falls Änderungen erforderlich sind, setzt sich Google mit den erforderlichen Details mit Ihnen in Verbindung.
- Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, benachrichtigt Google Sie, dass Sie das aktualisierte und integrierte APK im Google Play Store veröffentlichen können.
- Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Google Play Store veröffentlicht wurde, können Ihre Cluster Empfehlung, Vorgestellt, Reservierung und Suche fortsetzen veröffentlicht und für Nutzer sichtbar sein.