Google entwickelt eine On-Device-Oberfläche, die die Apps von Nutzern nach Branchen einordnet und eine neue immersive Umgebung für die Nutzung und Auffindbarkeit personalisierter App-Inhalte ermöglicht. Diese Vollbildansicht bietet Entwicklern die Möglichkeit, ihre besten Rich Contents in einem speziellen Kanal außerhalb ihrer App zu präsentieren.
In diesem Dokument finden Entwicklerpartner eine Anleitung zum Einbinden neuer Inhalte wie Reservierungen, Veranstaltungen, Unterkünfte, Sehenswürdigkeiten, Personen und anderer Inhalte, die keiner dieser Kategorien zugewiesen werden können. Dazu wird das Engage SDK verwendet.
Integrationsdetails
Terminologie
Diese Integration umfasst die folgenden drei Clustertypen: Empfehlung, Empfohlen und Fortsetzung.
Empfehlungscluster enthalten personalisierte Vorschläge von einem einzelnen Entwicklerpartner. Es ist eine UI-Ansicht, die eine Gruppe von Empfehlungen desselben Entwicklerpartners enthält.
ArticleEntity: „ArticleEntity“, die eine textbasierte Empfehlung für Inhalte darstellt, die für mehr als eine Inhaltskategorie relevant sind. Mit einem ArticleEntity-Element können Entwickler eine Vielzahl von Text- und Bildinhalten mit mehr Metadaten bereitstellen, um den Nutzern die Informationen im Vergleich zu GenericFeaturedEntity vorzustellen. Beispiel: Marketinginhalte, Nachrichten-Snippet
EventEntity: „EventEntity“ steht für ein Ereignis in der Zukunft. Der Beginn des Ereignisses ist eine wichtige Information, die den Nutzern mitgeteilt werden muss.
LodgingEntity: HotelEntity ist eine Unterkunft, z. B. ein Hotel, ein Apartment oder ein Ferienhaus für kurz- und langfristige Vermietung.
StoreEntity: StoreEntity repräsentiert ein Geschäft, ein Restaurant, ein Café usw. Es hebt Inhalte hervor, bei denen ein Speiselokal oder ein Geschäft die wichtige Information ist, die den Nutzern vermittelt werden muss.
PointOfInterestEntity: PointOfInterestEntity ist eine Sehenswürdigkeit wie eine Tankstelle, eine Veranstaltungsstätte, einen Themenpark, ein Museum, eine Touristenattraktion, einen Wanderweg usw. Damit werden Inhalte hervorgehoben, bei denen der Standort eine wichtige Information ist, die den Nutzern mitgeteilt werden muss. Sie sollte nicht für Unterkünfte, Geschäfte oder Restaurants verwendet werden.
PersonEntity: PersonEntity repräsentiert eine Person. Die Empfehlungen können beispielsweise eine Person in Kategorien wie Gesundheit und Fitness, Sport oder Dating hervorheben.
Der Cluster Fortsetzung enthält Inhalte, mit denen Nutzer vor Kurzem von mehreren Entwicklerpartnern interagiert haben. Diese werden in einer einzigen UI-Gruppierung angezeigt. Jeder Entwicklerpartner darf maximal 10 Entitäten im Continuation-Cluster senden.
Fortsetzungsinhalte können die folgende Struktur haben:
ArticleEntity: „ArticleEntity“, die eine textbasierte Empfehlung für Inhalte darstellt, die für mehr als eine Inhaltskategorie relevant sind. Diese Entität kann verwendet werden, um nicht fertig gelesene Nachrichtenartikel oder andere Inhalte zu repräsentieren, die der Nutzer an der Stelle fortsetzen möchte, an der er sie unterbrochen hat. Beispiel: Marketinginhalte, Nachrichten-Snippet
RestaurantReservationEntity: „RestaurantReservationEntity“ steht für eine Reservierung in einem Restaurant oder Café und hilft Nutzern, anstehende oder laufende Restaurantreservierungen im Blick zu behalten.
EventReservationEntity: „EventReservationEntity“ steht für eine Reservierung für eine Veranstaltung und hilft Nutzern, anstehende oder laufende Reservierungen für Veranstaltungen zu verfolgen. Beispiele für Ereignisse sind unter anderem:
- Sportveranstaltungen wie die Reservierung für ein Fußballspiel
- Gaming-Events wie Reservierungen für eSports
- Unterhaltungsereignisse wie Kinofilme, Konzerte, Theateraufführungen oder Buchpräsentationen
- Reservierungen für Reisen oder POIs wie Führungen, Museumstickets
- Reservierungen für Veranstaltungen, Seminare und Konferenzen
- Reservierungen für Schulungen
LodgingReservationEntity: „LodgingEntityReservation“ stellt eine Reservierung für eine Reiseunterkunft dar und hilft Nutzern, anstehende oder laufende Hotel- oder Ferienunterkunftsreservierungen im Blick zu behalten.
TransportationReservationEntity: „TransportationReservationEntity“ steht für eine Reservierung für beliebige Verkehrsmittel und hilft Nutzern, Reservierungen für anstehende oder laufende Flüge, Fähren, Züge, Busse, Fahrdienste oder Kreuzfahrten zu verfolgen.
VehicleRentalReservationEntity: „VehicleRentalReservationEntity“ steht für eine Mietwagenreservierung und hilft Nutzern, anstehende oder laufende Mietwagenreservierungen im Blick zu behalten.
Der Cluster Empfohlen ist eine UI-Ansicht, in der die ausgewählten Hero-
GenericFeaturedEntity
von vielen Entwicklerpartnern in einer UI-Gruppierung präsentiert werden. Es gibt einen einzelnen „Empfohlen“-Cluster, der oben in der Benutzeroberfläche angezeigt wird und über allen Empfehlungsclustern priorisiert ist. Jeder Entwicklerpartner darf eine einzelne Entität eines unterstützten Typs in „Empfohlen“ mit vielen Entitäten (möglicherweise unterschiedlicher Typen) von mehreren App-Entwicklern im „Empfohlen“-Cluster senden.GenericFeaturedEntity: GenericFeaturedEntity unterscheidet sich insofern von einem Empfehlungselement, dass ein empfohlenes Element für einen einzelnen Top-Inhalt von Entwicklern verwendet werden und den wichtigsten Inhalt darstellen sollte, der für die Nutzer interessant und relevant ist.
Vorarbeit
Mindest-API-Level: 19
Fügen Sie Ihrer App die com.google.android.engage:engage-core
-Bibliothek hinzu:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.5.2'
}
Zusammenfassung
Das Design basiert auf der Implementierung eines gebundenen Dienstes.
Die Daten, die ein Client veröffentlichen kann, unterliegen den folgenden Einschränkungen für verschiedene Clustertypen:
Clustertyp | Cluster limits | Mindestanzahl von Entitäten in einem Cluster | Maximale Entitätslimits in einem Cluster |
---|---|---|---|
Empfehlungscluster | Höchstens 5 | Mindestens 5 | Maximal 25 (ArticleEntity , EventEntity ,
LodgingEntity , StoreEntity ,
PointOfInterestEntity oder PersonEntity ) |
Fortsetzungscluster | Maximal 1 | Mindestens 1 | Höchstens 10 (ArticleEntity ,
EventReservationEntity ,
LodgingReservationEntity ,
TransportationReservationEntity oder
VehicleRentalReservationEntity ) |
Empfohlener Cluster | Maximal 1 | Mindestens 1 | Maximal 10 (GenericFeaturedEntity ) |
Schritt 1: Entitätsdaten angeben
Im SDK sind verschiedene Entitäten für jeden Artikeltyp definiert. Für die Kategorie „Sonstiges“ werden die folgenden Entitäten unterstützt:
GenericFeaturedEntity
ArticleEntity
EventEntity
LodgingEntity
StoreEntity
PointOfInterestEntity
PersonEntity
RestaurantReservationEntity
EventReservationEntity
LodgingReservationEntity
TransportationReservationEntity
VehicleRentalReservationEntity
In den folgenden Diagrammen sind die verfügbaren Attribute und Anforderungen für jeden Typ aufgeführt.
GenericFeaturedEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Posterbilder | Erforderlich | Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis:Wenn Sie ein Logo erhalten, achten Sie darauf, dass sowohl oben als auch unten im Bild ein Sicherheitsabstand von 24 dps vorhanden ist. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Titel | Optional | Titel der Entität. | Freier Text Empfohlene Textgröße: 50 Zeichen |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jede Untertitelung: max. 50 Zeichen |
Badges | Optional | Jedes Kennzeichen besteht entweder aus freiem Text (max. 15 Zeichen) oder einem kleinen Bild. Spezielle UX-Behandlung über dem Bild/Video, z. B. als Logo-Overlay auf dem Bild
|
|
Logo – Text | Optional | Titel für das Gütesiegel Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Logo – Bild | Optional | Kleines Bild Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie der Inhalte in der Entität. | Liste der Enums Weitere Informationen finden Sie im Abschnitt Inhaltskategorie. |
ArticleEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in diesen FAQs |
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. Empfohlenes Seitenverhältnis: 16:9 Hinweis: Ein Bild wird dringend empfohlen. Wenn Sie ein Logo erhalten, achten Sie darauf, dass sowohl oben als auch unten im Bild ein Mindestabstand von 24 dps vorhanden ist. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
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 Anforderungen an Bilder. |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jede Untertitelung: max. 50 Zeichen |
Badges | Optional | Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. Spezielle UX-Behandlung über dem Bild/Video, z. B. als Logo-Overlay auf dem Bild
|
|
Logo – Text | Optional | Titel für das Gütesiegel Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Logo – Bild | Optional | Kleines Bild Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Veröffentlichungszeitpunkt des Inhalts | Optional | Dies ist der Epochenzeitstempel in Millisekunden, zu dem die Inhalte in der App veröffentlicht oder aktualisiert wurden. | Epochen-Zeitstempel in Millisekunden |
Zeitpunkt der letzten Interaktion | Bedingt erforderlich | Der Epochenzeitstempel in Millisekunden, zu dem der Nutzer zuletzt mit dieser Entität interagiert hat. Hinweis:Dieses Feld ist erforderlich, wenn diese Entität Teil des Fortsetzungsclusters ist. |
Epochen-Zeitstempel in Millisekunden |
Fortschritt in Prozent | Bedingt erforderlich | Der Prozentsatz des gesamten Inhalts, der vom Nutzer bisher angesehen wurde. Hinweis:Dieses Feld ist erforderlich, wenn diese Entität Teil des Fortsetzungsclusters ist. |
Eine Ganzzahl zwischen 0 und 100. |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie der Inhalte in der Entität. | Liste der Enums Weitere Informationen finden Sie im Abschnitt "Inhaltskategorie". |
EventEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
Beginn | Erforderlich |
Der Epochenzeitstempel, an dem das Ereignis voraussichtlich beginnen wird. Hinweis: Dieser Wert wird in Millisekunden angegeben. |
Epochen-Zeitstempel in Millisekunden |
Ereignismodus | Erforderlich | Ein Feld, in dem angegeben wird, ob die Veranstaltung virtuell, vor Ort oder beides ist. |
Enum: VIRTUAL, IN_PERSON oder HYBRID |
Posterbilder | Erforderlich | Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis: Ein Bild wird dringend empfohlen. Wenn ein Logo verwendet wird, muss oben und unten im Bild ein sicherer Bereich von 24 dps vorhanden sein. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Standort – Land | Bedingt erforderlich | Das Land, in dem das Ereignis stattfindet. Hinweis: Dies ist für Ereignisse 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: maximal 20 Zeichen |
Standort – Adresse anzeigen | Bedingt erforderlich | Die Adresse oder der Name des Veranstaltungsortes, an dem die Veranstaltung stattfindet, die dem Nutzer angezeigt werden soll. Hinweis:Dies ist für Veranstaltungen erforderlich, die IN_PERSON oder HYBRID sind. |
Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse | Optional | Die (falls zutreffend) Straße und Hausnummer des Veranstaltungsortes. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend), in der die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Postleitzahl | Optional | Die Postleitzahl des Orts, an dem die Veranstaltung stattfindet, sofern zutreffend. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Umgebung | Optional | Der Stadtteil (falls zutreffend), in dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Ende | Optional |
Der Epochenzeitstempel, an dem das Ereignis voraussichtlich enden wird. Hinweis: Dieser Wert wird in Millisekunden angegeben. |
Epochen-Zeitstempel in Millisekunden |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jede Untertitelung: max. 50 Zeichen |
Badges | Optional |
Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. |
|
Logo – Text | Optional | Titel für das Gütesiegel Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Logo – Bild | Optional | Kleines Bild Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Preis – Aktueller Preis | Bedingt erforderlich |
Der aktuelle Preis des Tickets oder der Zeitkarte für die Veranstaltung. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben ist. |
Freier Text |
Preis – Durchgestrichener Preis | Optional | Der ursprüngliche Preis des Tickets/Passes für die Veranstaltung. | Freier Text |
Zusatzinformationen zum Preis | Optional | Preishinweis für ein Angebot, ein Ereignis oder einen Rabatt für Mitglieder, falls verfügbar. | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie der Inhalte in der Entität. | Liste der zulässigen „enum“-Strings
Weitere Informationen finden Sie im Abschnitt Inhaltskategorie. |
LodgingEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
Posterbilder | Erforderlich |
Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis: Wenn Sie ein Logo erhalten, achten Sie darauf, dass sowohl oben als auch unten im Bild ein Sicherheitsabstand von 24 dps vorhanden ist. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Standort – Land | Erforderlich | Das Land, in dem die Unterkunft liegt. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Ort | Erforderlich | Die Stadt, in der die Unterkunft gebucht wurde. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse anzeigen | Erforderlich | Die Adresse der Unterkunft, die dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse | Optional | Die Adresse der Unterkunft (falls zutreffend). | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend), in der sich die Unterkunft befindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) der Unterkunft. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Umgebung | Optional | Der Stadtteil (falls zutreffend) der Unterkunft. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Badges | Optional |
Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. |
|
Logo – Text | Optional | Titel für das Gütesiegel Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Logo – Bild | Optional | Kleines Bild Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
Verfügbarkeitszeitraum – Startzeit | Optional | Der Epochenzeitstempel in Millisekunden, zu dem die Unterkunft voraussichtlich geöffnet/verfügbar sein wird. | Epochen-Zeitstempel in Millisekunden |
AvailabilityTimeWindow – Endzeit | Optional | Der Epoch-Zeitstempel in Millisekunden, bis zu dem die Unterkunft voraussichtlich geöffnet/verfügbar sein wird. | Epochen-Zeitstempel in Millisekunden |
Bewertung – Maximalwert | Optional | Der Maximalwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird. |
Zahl >= 0,0 |
Bewertung – Aktueller Wert | Optional | Der aktuelle Wert der Altersfreigabe. Muss angegeben werden, wenn auch der maximale Wert der Bewertung angegeben wird. |
Zahl >= 0.0 |
Altersfreigabe – Anzahl | Optional | Die Anzahl der Bewertungen für die Unterkunft. Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuert, wie die Anzahl den Nutzern angezeigt wird. Verwenden Sie einen kurzen String. Wenn die Anzahl beispielsweise 1.000.000 beträgt, sollten Sie eine Abkürzung wie 1M verwenden, damit die Anzahl bei kleineren Displays nicht gekürzt wird. |
String |
Altersfreigabe – Wert für die Anzahl | Optional | Die Anzahl der Bewertungen für die Unterkunft. Hinweis: Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten. Wenn sowohl „Anzahl“ als auch „Anzahl (Wert)“ vorhanden sind, wird „Anzahl“ den Nutzern angezeigt. |
Lang |
Preis – Aktueller Preis | Bedingt erforderlich | Der aktuelle Preis der Unterkunft. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben ist. |
Freier Text |
Preis – Durchgestrichener Preis | Optional | Der ursprüngliche Preis der Unterkunft, der auf der Benutzeroberfläche durchgestrichen ist. | Freier Text |
Zusatzinformationen zum Preis | Optional | Preishinweis für ein Angebot, ein Ereignis oder einen Rabatt für Mitglieder, falls verfügbar. | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
StoreEntity
Das StoreEntity
-Objekt steht für ein einzelnes Geschäft, das Entwicklerpartner veröffentlichen möchten, z. B. ein Restaurant oder ein Lebensmittelgeschäft.
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Posterbilder | Erforderlich | Es muss mindestens ein Bild zur Verfügung gestellt werden. | Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Titel | Optional | Der Name des Geschäfts. | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
Standort | Optional | Der Standort des Geschäfts. | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Zu langer Text enthält möglicherweise Auslassungspunkte) |
Zusatzinformationen | Optional | Erweiterung mit Zusatzinformationen zum Präsentieren einer Werbeaktion, eines Ereignisses oder einer Aktualisierung für das Geschäft, falls verfügbar. | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
Kleingedrucktes zu Zusatzinformationen | Optional | Kleingedruckter Text für die Zusatzinformation. | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
Beschreibung | Optional | Eine Beschreibung des Geschäfts. | Freier Text Empfohlene Textgröße: weniger als 90 Zeichen (Bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
Bewertung – Maximalwert | Optional | Der Maximalwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird. |
Zahl >= 0,0 |
Bewertung – Aktueller Wert | Optional | Der aktuelle Wert der Altersfreigabe. Muss angegeben werden, wenn auch der maximale Wert der Bewertung angegeben wird. |
Zahl >= 0.0 |
Altersfreigabe – Anzahl | Optional | Die Anzahl der Bewertungen für die Unterkunft. Hinweis: Geben Sie dieses Feld an, wenn Sie in Ihrer App festlegen möchten, wie diese Informationen den Nutzern 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 Mio. verwenden, damit sie bei kleineren Bildschirmgrößen nicht abgeschnitten wird. |
String |
Altersfreigabe – Wert für die Anzahl | Optional | Die Anzahl der Bewertungen für 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 „Anzahl (Wert)“ vorhanden sind, wird „Anzahl“ für Nutzer angezeigt. |
Lang |
PointOfInterestEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
Posterbilder | Erforderlich | Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis: Ein Bild wird dringend empfohlen. Wenn ein Logo verwendet wird, muss oben und unten im Bild ein sicherer Bereich von 24 dps vorhanden sein. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Standort – Land | Erforderlich | Das Land, in dem sich der POI befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Ort | Erforderlich | Die Stadt, in der sich der POI befindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse anzeigen | Erforderlich | Die Adresse des POI, die dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse | Optional | Die Adresse (falls zutreffend) des POI. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Bundesland | Optional | Das Bundesland (falls zutreffend), in dem sich der POI befindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Postleitzahl | Optional | Die Postleitzahl des POI (falls zutreffend). | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Umgebung | Optional | Der Stadtteil (falls zutreffend) des POI. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Verfügbarkeitszeitraum – Startzeit | Optional | Der Epochenzeitstempel in Millisekunden, zu dem der POI voraussichtlich geöffnet/verfügbar sein wird. | Epochen-Zeitstempel in Millisekunden |
AvailabilityTimeWindow – Endzeit | Optional | Der Epoch-Zeitstempel in Millisekunden, bis zu dem der POI voraussichtlich geöffnet/verfügbar ist. | Epochen-Zeitstempel in Millisekunden |
Badges | Optional |
Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. |
|
Logo – Text | Optional | Titel für das Gütesiegel Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Logo – Bild | Optional | Kleines Bild Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
Altersfreigabe – Höchstwert | Optional | Der Maximalwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird. |
Zahl >= 0,0 |
Bewertung – Aktueller Wert | Optional | Der aktuelle Wert der Altersfreigabe. Muss angegeben werden, wenn auch der maximale Wert der Bewertung angegeben wird. |
Zahl >= 0.0 |
Altersfreigabe – Anzahl | Optional | Die Anzahl der Bewertungen für den POI. Hinweis:Geben Sie dieses Feld an, wenn Ihre App steuert, wie die Anzahl den Nutzern angezeigt wird. Verwenden Sie einen kurzen String. Wenn die Anzahl beispielsweise 1.000.000 beträgt, sollten Sie eine Abkürzung wie 1 Mio. verwenden, damit die Anzahl bei kleineren Bildschirmgrößen nicht abgeschnitten wird. |
String |
Altersfreigabe – Wert für die Anzahl | 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. Wenn sowohl „Anzahl“ als auch „Anzahl (Wert)“ vorhanden sind, wird „Anzahl“ für Nutzer angezeigt. |
Lang |
Preis – Aktueller Preis | Bedingt erforderlich |
Der aktuelle Preis der Tickets bzw. der Eintrittskarte für den POI. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben ist. |
Freier Text |
Preis – Durchgestrichener Preis | Optional | Der ursprüngliche Preis der Tickets/der Eintrittskarte für den POI. | Freier Text |
Zusatzinformationen zum Preis | Optional | Preishinweis für ein Angebot, ein Ereignis oder einen Rabatt für Mitglieder, falls verfügbar. |
Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie der Inhalte in der Entität. | Liste der möglichen Aufzählungen
Weitere Informationen finden Sie im Abschnitt Inhaltskategorie. |
PersonEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Profil – Name | Erforderlich | Profilname, -ID oder -Alias, z. B. „Max Mustermann“ oder „@TeamPixel“. | String Empfohlene Textgröße: max. 50 Zeichen |
Profil – Avatar | Erforderlich |
Profilbild oder Avatarbild des Nutzers. Hinweis: Das Bild muss quadratisch (1:1) sein. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Profil – Zusätzlicher Text | Optional | Freier Text wie der Profil-Alias. | Freier Text Empfohlene Textgröße: maximal 15 Zeichen |
Profil – zusätzliches Bild | Optional | Kleines Bild, z. B. ein Bestätigungskennzeichen. | Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Kopfzeilenbild | Optional | Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis:Bilder werden dringend empfohlen. Wenn ein Logo verwendet wird, muss oben und unten im Bild ein sicherer Bereich von 24 dps vorhanden sein. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Beliebtheit – Anzahl | Optional |
Geben Sie die Anzahl der Follower oder den Beliebtheitswert an, z. B. „3,7 Mio.“. Hinweis: Wenn sowohl „Anzahl“ als auch „Anzahl (Wert)“ angegeben sind, wird „Anzahl“ verwendet. |
String Empfohlene Textgröße: maximal 20 Zeichen für Anzahl + Label |
Beliebtheit – Anzahlwert | Optional | Die Anzahl der Follower oder der Beliebtheitswert. Hinweis: Geben Sie den Zählwert an, wenn in Ihrer App keine Logik für die Optimierung einer großen Zahl für verschiedene Bildschirmgrößen verwendet werden soll. Wenn sowohl „Anzahl“ als auch „Anzahl“ angegeben ist, wird „Anzahl“ verwendet. |
Lang |
Beliebtheit – Label | Optional | Gibt das Label für die Beliebtheit an, beispielsweise „Gefällt mir“. | String Empfohlene Textgröße: Maximal 20 Zeichen für Anzahl + Label |
Beliebtheit – Visuell | Optional |
Geben Sie an, wozu die Interaktion dient. Beispiel: Bild mit „Mag ich“-Symbol, Emojis. Sie können mehrere Bilder angeben, die jedoch nicht bei allen Formfaktoren angezeigt werden. Hinweis:Es muss sich um ein quadratisches Bild mit einem Seitenverhältnis von 1:1 handeln. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Altersfreigabe – Höchstwert | Erforderlich | Der Höchstwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird. |
Zahl >= 0,0 |
Altersfreigabe – Aktueller Wert | Erforderlich | Der aktuelle Wert der Altersfreigabe. Muss angegeben werden, wenn auch der maximale Wert der Bewertung angegeben wird. |
Zahl >= 0.0 |
Altersfreigabe – Anzahl | Optional | Die Anzahl der Bewertungen für die Entität. Hinweis: Geben Sie dieses Feld an, wenn Sie in Ihrer App festlegen möchten, wie diese Informationen den Nutzern angezeigt werden. Geben Sie einen kurzen String an, der dem Nutzer angezeigt werden kann. Wenn die Anzahl beispielsweise 1.000.000 beträgt, sollten Sie Abkürzungen wie 1 Mio. verwenden, damit sie bei kleineren Bildschirmgrößen nicht abgeschnitten wird. |
String |
Altersfreigabe – Wert für die Anzahl | Optional | Die Anzahl der Bewertungen für die Entität. Hinweis: Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahl (Wert)“ vorhanden sind, wird „Anzahl“ für Nutzer angezeigt. |
Lang |
Standort – Land | Optional | Das Land, in dem die Person ansässig ist oder in dem sie tätig ist. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Ort | Optional | Die Stadt, in der sich die Person befindet oder in der sie tätig ist. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse anzeigen | Optional | Die Adresse, an der sich die Person befindet oder an der sie tätig ist, wird dem Nutzer angezeigt. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse | Optional | Die Adresse (falls zutreffend), an der sich die Person befindet oder die sie bedient. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Bundesland | Optional | Das Bundesland, in dem sich die Person befindet oder ihren Dienst leistet (falls zutreffend). | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend), an der sich die Person befindet oder an der sie tätig ist. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Umgebung | Optional | Der Stadtteil (falls zutreffend), in dem sich die Person befindet oder in dem sie tätig ist. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Badges | Optional |
Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. |
|
Logo – Text | Optional | Titel für das Gütesiegel Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Logo – Bild | Optional | Kleines Bild Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail Hinweis: Für das Logo ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Bildspezifikationen. |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jede Untertitelung: max. 50 Zeichen |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie der Inhalte in der Entität. | Liste der zulässigen „enum“-Strings
Weitere Informationen finden Sie im Abschnitt Inhaltskategorie. |
RestaurantReservationEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
Reservierungsbeginn | Erforderlich | Der Epochenzeitstempel in Millisekunden für den voraussichtlichen Beginn der Reservierung. | Epochen-Zeitstempel in Millisekunden |
Standort – Land | Erforderlich | Das Land, in dem sich das Restaurant befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Ort | Erforderlich | Die Stadt, in der sich das Restaurant befindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse anzeigen | Erforderlich | Die Adresse des Restaurants, die dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse | Optional | Die Adresse des Restaurants (falls zutreffend). | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend), in dem bzw. der sich das Restaurant befindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) des Restaurants. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Umgebung | Optional | Der Stadtteil (falls zutreffend) des Restaurants. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Posterbilder | Optional | Wenn mehrere Bilder zur Verfügung gestellt werden, wird nur ein Bild angezeigt. Empfohlenes Seitenverhältnis: 16:9 | Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jede Untertitelung: max. 50 Zeichen |
Tabellengröße | Optional | Die Anzahl der Personen in der Reservierungsgruppe | Ganzzahl > 0 |
EventReservationEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Titel | Erforderlich | Titel der Entität. | String Empfohlene Textgröße: max. 50 Zeichen |
Beginn | Erforderlich |
Der Epochenzeitstempel, an dem das Ereignis voraussichtlich beginnen wird. Hinweis: Dieser Wert wird in Millisekunden angegeben. |
Epochen-Zeitstempel in Millisekunden |
Ereignismodus | Erforderlich | Ein Feld, in dem angegeben wird, ob die Veranstaltung virtuell, vor Ort oder beides ist. |
Enum: VIRTUAL, IN_PERSON oder HYBRID |
Standort – Land | Bedingt erforderlich | Das Land, in dem das Ereignis stattfindet. Hinweis: Dies ist für Ereignisse 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: maximal 20 Zeichen |
Standort – Adresse anzeigen | Bedingt erforderlich | Die Adresse oder der Name des Veranstaltungsortes, an dem die Veranstaltung stattfindet, die dem Nutzer angezeigt werden soll. Hinweis:Dies ist für Veranstaltungen erforderlich, die IN_PERSON oder HYBRID sind. |
Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse | Optional | Die (falls zutreffend) Straße und Hausnummer des Veranstaltungsortes. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend), in der die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Postleitzahl | Optional | Die Postleitzahl des Orts, an dem die Veranstaltung stattfindet, sofern zutreffend. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Umgebung | Optional | Der Stadtteil (falls zutreffend), in dem die Veranstaltung stattfindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Posterbilder | Optional | Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis:Bilder werden dringend empfohlen. Wenn ein Logo verwendet wird, muss oben und unten im Bild ein sicherer Bereich von 24 dps vorhanden sein. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Ende | Optional |
Der Epochenzeitstempel, an dem das Ereignis voraussichtlich enden wird. Hinweis: Dieser Wert wird in Millisekunden angegeben. |
Epochen-Zeitstempel in Millisekunden |
Dienstanbieter – Name | Optional |
Der Name des Dienstanbieters. Hinweis: Für den Dienstanbieter ist entweder Text oder ein Bild erforderlich. |
Freitext. Beispiel: Name des Veranstalters/der Tour |
Dienstanbieter – Bild | Optional |
Das Logo/Bild des Dienstanbieters. Hinweis:Für den Dienstanbieter sind entweder Text oder Bilder erforderlich. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jede Untertitelung: max. 50 Zeichen |
Badges | Optional |
Jedes Badge kann entweder aus freiem Text (max. 15 Zeichen) oder aus einem kleinen Bild bestehen. |
|
Logo – Text | Optional | Titel für das Gütesiegel Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Freier Text Empfohlene Textgröße: max. 15 Zeichen |
Logo – Bild | Optional | Kleines Bild Spezielle UX-Optimierung, z. B. als Logo-Overlay auf dem Bild-/Video-Thumbnail Hinweis: Für das Gütesiegel ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Reservierungs-ID | Optional | Die Reservierungs-ID für die Terminreservierung. | Freier Text |
Preis – Aktueller Preis | Bedingt erforderlich |
Der aktuelle Preis des Tickets oder der Zeitkarte für die Veranstaltung. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben ist. |
Freier Text |
Preis – Durchgestrichener Preis | Optional | Der ursprüngliche Preis des Tickets/Passes für die Veranstaltung. | Freier Text |
Zusatzinformationen zum Preis | Optional | Preishinweis für ein Angebot, ein Ereignis oder einen Rabatt für Mitglieder, falls verfügbar. | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
Altersfreigabe – Höchstwert | Optional | Der Maximalwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird. |
Zahl >= 0,0 |
Bewertung – Aktueller Wert | Optional | Der aktuelle Wert der Altersfreigabe. Muss angegeben werden, wenn auch der maximale Wert der Bewertung angegeben wird. |
Zahl >= 0.0 |
Altersfreigabe – Anzahl | Optional | Die Anzahl der Bewertungen für das Ereignis. Hinweis: Geben Sie dieses Feld an, wenn Sie in Ihrer App festlegen möchten, wie diese Informationen den Nutzern angezeigt werden. Geben Sie einen kurzen String an, der dem Nutzer angezeigt werden kann. Wenn die Anzahl beispielsweise 1.000.000 beträgt, sollten Sie Abkürzungen wie 1 Mio. verwenden, damit sie bei kleineren Bildschirmgrößen nicht abgeschnitten wird. |
String |
Altersfreigabe – Wert für die Anzahl | Optional | Die Anzahl der Bewertungen für das Ereignis. Hinweis: Geben Sie dieses Feld an, wenn Sie die Logik für die Anzeige von Abkürzungen nicht selbst verarbeiten möchten. Wenn sowohl „Anzahl“ als auch „Anzahl“ vorhanden sind, verwenden wir „Anzahl“, um Nutzern |
Lang |
Inhaltskategorien | Optional | Beschreiben Sie die Kategorie der Inhalte in der Entität. | Liste der zulässigen „enum“-Strings
Weitere Informationen finden Sie im Abschnitt Inhaltskategorie. |
LodgingReservationEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Titel | Erforderlich | Titel der Entität. | Freier Text. Beispiel: „Ihr Aufenthalt vom 12. Dezember“ Empfohlene Textgröße: max. 50 Zeichen |
Check-in-Zeit | Erforderlich | Der Epochenzeitstempel in Millisekunden, der die Check-in-Zeit für die Reservierung darstellt. | Epochen-Zeitstempel in Millisekunden |
Check-out-Zeit | Erforderlich | Der Epochenzeitstempel in Millisekunden, der die Check-out-Zeit für die Reservierung darstellt. | Epochen-Zeitstempel in Millisekunden |
Standort – Land | Erforderlich | Das Land, in dem sich die Unterkunft befindet. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Standort – Ort | Erforderlich | Die Stadt, in der sich die Unterkunft befindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse anzeigen | Erforderlich | Die Adresse der Unterkunft, die dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Adresse | Optional | Die Adresse der Unterkunft (falls zutreffend). | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend), in der sich die Unterkunft befindet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) der Unterkunft. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Standort – Umgebung | Optional | Der Stadtteil (falls zutreffend) der Unterkunft. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Posterbilder | Optional |
Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Empfohlenes Seitenverhältnis: 16:9 Hinweis:Wenn Sie ein Logo erhalten, achten Sie darauf, dass sowohl oben als auch unten im Bild ein Sicherheitsabstand von 24 dps vorhanden ist. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
Reservierungs-ID | Optional | Die Reservierungs-ID für die Hotelreservierung. | Freier Text |
Altersfreigabe – Höchstwert | Optional | Der Maximalwert der Bewertungsskala. Muss angegeben werden, wenn auch der aktuelle Wert der Bewertung angegeben wird. |
Zahl >= 0,0 |
Bewertung – Aktueller Wert | Optional | Der aktuelle Wert der Altersfreigabe. Muss angegeben werden, wenn auch der maximale Wert der Bewertung angegeben wird. |
Zahl >= 0.0 |
Altersfreigabe – Anzahl | Optional | Die Anzahl der Bewertungen für die Unterkunft. Hinweis: Geben Sie dieses Feld an, wenn Sie in Ihrer App festlegen möchten, wie diese Informationen den Nutzern 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 Mio. verwenden, damit sie bei kleineren Bildschirmgrößen nicht abgeschnitten wird. |
String |
Altersfreigabe – Wert für die Anzahl | Optional | Die Anzahl der Bewertungen für 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 „Anzahl (Wert)“ vorhanden sind, wird „Anzahl“ für Nutzer angezeigt. |
Lang |
Preis – Aktueller Preis | Bedingt erforderlich | Der aktuelle Preis der Unterkunft. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben ist. |
Freier Text |
Preis – Durchgestrichener Preis | Optional | Der ursprüngliche Preis der Unterkunft, der auf der Benutzeroberfläche durchgestrichen ist. | Freier Text |
Zusatzinformationen zum Preis | Optional | Preishinweis für ein Angebot, ein Ereignis oder einen Rabatt für Mitglieder, falls verfügbar. | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (zu langer Text enthält möglicherweise Auslassungspunkte) |
TransportationReservationEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Titel | Erforderlich | Titel der Entität. | Freitext. Beispiel: „SFO nach SAN“ Empfohlene Textgröße: max. 50 Zeichen |
Art des Verkehrsmittels | Erforderlich | Die Mobilitätsform/der Transportmitteltyp für die Reservierung. | Enum: FLUG, TRAIN, BUS oder FERRY |
Abflugzeit | Erforderlich | Der Zeitstempel der Epoche in Millisekunden, der die Abfahrtszeit angibt. | Epochen-Zeitstempel in Millisekunden |
Ankunft | Erforderlich | Der Zeitstempel der Epoche in Millisekunden, der die Ankunftszeit angibt. | Epochen-Zeitstempel in Millisekunden |
Abreiseort – Land | Optional | Das Abreiseland. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Abreiseort – Stadt | Optional | Der Abreiseort. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Abfahrtsort – Adresse anzeigen | Optional | Der Abfahrtsort, der dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Abreiseort – Adresse | Optional | Die Adresse des Abreiseorts (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Abreiseort – Bundesland | Optional | Das Bundesland (falls zutreffend) des Abreiseorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Abflugort – Postleitzahl | Optional | Die Postleitzahl des Abfahrtsorts (falls zutreffend). | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Abreiseort – Viertel | Optional | Der Stadtteil (falls zutreffend) des Abreiseorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Ankunftsort – Land | Optional | Das Land, in dem die Reise endet. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Ankunftsort – Stadt | Optional | Die Stadt der Ankunft. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Ankunftsort – Anzeigeadresse | Optional | Der Zielort, der dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Ankunftsort – Adresse | Optional | Die Adresse des Ankunftsorts (falls zutreffend). | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Ankunftsort – Bundesland | Optional | Das Bundesland (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: maximal 20 Zeichen |
Ankunftsort – Stadtteil | Optional | Der Stadtteil (falls zutreffend) des Zielorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Dienstanbieter – Name | Optional |
Der Name des Dienstanbieters. Hinweis: Für den Dienstanbieter ist entweder Text oder ein Bild erforderlich. |
Freitext. Beispiel: Name der Fluggesellschaft |
Dienstanbieter – Bild | Optional |
Das Logo/Bild des Dienstanbieters. Hinweis: Für den Dienstanbieter ist entweder Text oder ein Bild erforderlich. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Posterbilder | Optional |
Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Empfohlenes Seitenverhältnis: 16:9 |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jeden Untertitel: max. 50 Zeichen |
Reservierungs-ID | Optional | Die Reservierungs-ID für die Reservierung des Verkehrsmittels. | Freier Text |
Preis – Aktueller Preis | Bedingt erforderlich | Der aktuelle Preis der Reservierung. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben ist. |
Freier Text |
Preis – Durchgestrichener Preis | Optional | Der ursprüngliche Preis der Reservierung, der in der Benutzeroberfläche durchgestrichen ist. | Freier Text |
Zusatzinformationen zum Preis | Optional | Preishinweis für ein Angebot, ein Ereignis oder einen Rabatt für Mitglieder, falls verfügbar. | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (zu langer Text enthält möglicherweise Auslassungspunkte) |
Transportnummer | Erforderlich | Die Flug-, Bus-, Zug- oder Fähr-/Kreuzfahrtnummer. | Freier Text |
Boardingzeit | Erforderlich | Der Epochezeitstempel, der die Boardingzeit für die Reservierung darstellt (falls zutreffend) | Epochen-Zeitstempel in Millisekunden |
VehicleRentalReservationEntity
Attribut | Anforderung | Beschreibung | Formatieren |
---|---|---|---|
Aktions-URI | Erforderlich |
Deeplink zur Entität in der Anbieter-App. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Uri |
Titel | Erforderlich | Titel der Entität. | Freitext. Beispiel: „Avis Union Square SF“ Empfohlene Textgröße: max. 50 Zeichen |
Abholzeit | Erforderlich | Der Epoch-Zeitstempel, der die Abholzeit für die Reservierung darstellt. | Epochen-Zeitstempel in Millisekunden |
Rückflugzeit | Optional | Der Epochenzeitstempel, der die Abreisezeit für die Reservierung darstellt. | Epochen-Zeitstempel in Millisekunden |
Abholadresse – Land | Optional | Das Land des Abholorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Abholadresse – Ort | Optional | Die Stadt des Abholorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Abholadresse – Anzeigeadresse | Optional | Der Abholort, der dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Abholadresse – Straße | Optional | Die Adresse (falls zutreffend) des Abholorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Abholadresse – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend) des Abholorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Abholadresse – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) des Abholorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Abholadresse – Stadtteil | Optional | Der Stadtteil (falls zutreffend) des Abholorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Rücksendeadresse – Land | Optional | Das Land des Rückgabeorts. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Rücksendeadresse – Stadt | Optional | Die Stadt des Rücksendeorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Rücksendeadresse – Anzeigeadresse | Optional | Der Rückgabeort, der dem Nutzer angezeigt wird. | Freier Text Empfohlene Textgröße: max. 20 Zeichen |
Rücksendeadresse – Straße | Optional | Die Adresse (falls zutreffend) des Rücksendeorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Rücksendeadresse – Bundesland | Optional | Das Bundesland oder die Provinz (falls zutreffend) des Rücksendeorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Absenderadresse – Postleitzahl | Optional | Die Postleitzahl (falls zutreffend) des Rückgabeorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Rücksendeadresse – Wohnort | Optional | Der Stadtteil (falls zutreffend) des Rückgabeorts. | Freier Text Empfohlene Textgröße: maximal 20 Zeichen |
Dienstanbieter – Name | Optional |
Der Name des Dienstanbieters. Hinweis: Für den Dienstanbieter ist entweder Text oder ein Bild erforderlich. |
Freier Text. Beispiel: „Avis Autovermietung“ |
Dienstanbieter – Bild | Optional |
Das Logo/Bild des Dienstanbieters. Hinweis:Für den Dienstanbieter sind entweder Text oder Bilder erforderlich. |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Posterbilder | Optional |
Wenn mehrere Bilder angegeben werden, wird nur eines davon angezeigt. Empfohlenes Seitenverhältnis: 16:9 |
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Beschreibung | Optional | Ein einzelner Textabschnitt zur Beschreibung der Entität. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße: 180 Zeichen |
Untertitelliste | Optional | Bis zu drei Untertitel, wobei jeder Untertitel eine einzelne Textzeile ist. Hinweis: Den Nutzern wird entweder die Beschreibung oder die Liste der Untertitel angezeigt, nicht beides. |
Freier Text Empfohlene Textgröße für jede Untertitelung: max. 50 Zeichen |
Bestätigungs-ID | Optional | Die Bestätigungs-ID für die Reservierung des Mietwagens. | Freier Text |
Preis – Aktueller Preis | Bedingt erforderlich | Der aktuelle Preis der Reservierung. Muss angegeben werden, wenn ein durchgestrichener Preis angegeben ist. |
Freier Text |
Preis – Durchgestrichener Preis | Optional | Der ursprüngliche Preis der Reservierung, der in der Benutzeroberfläche durchgestrichen ist. | Freier Text |
Zusatzinformationen zum Preis | Optional | Preishinweis für ein Angebot, ein Ereignis oder einen Rabatt für Mitglieder, falls verfügbar. | Freier Text Empfohlene Textgröße: weniger als 45 Zeichen (bei zu langem Text werden möglicherweise Auslassungspunkte angezeigt) |
Bildspezifikationen
Die erforderlichen Spezifikationen für Bild-Assets sind in dieser Tabelle aufgeführt:
Seitenverhältnis | Mindestanzahl Pixel | Empfohlene Pixel |
---|---|---|
Quadrat (1 × 1) Bevorzugt |
300 × 300 | 1200 × 1200 |
Querformat (1,91 × 1) | 600 × 314 | 1200 × 628 |
Hochformat (4 : 5) | 480 x 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 dunkle und helle Design richtig angezeigt wird.
Content-Kategorie
Mit der Inhaltskategorie können Apps Inhalte veröffentlichen, die zu mehreren Kategorien gehören. Die Inhalte werden dabei einigen der vordefinierten Kategorien zugeordnet:
TYPE_EDUCATION
TYPE_SPORTS
TYPE_MOVIES_AND_TV_SHOWS
TYPE_BOOKS
TYPE_AUDIOBOOKS
TYPE_MUSIC
TYPE_DIGITAL_GAMES
TYPE_TRAVEL_AND_LOCAL
TYPE_HOME_AND_AUTO
TYPE_BUSINESS
TYPE_NEWS
TYPE_FOOD_AND_DRINK
TYPE_SHOPPING
TYPE_HEALTH_AND_FITENESS
TYPE_MEDICAL
TYPE_PARENTING
TYPE_DATING
Die Bilder müssen auf öffentlichen CDNs gehostet werden, damit Google darauf zugreifen kann.
Richtlinien für die Verwendung der Inhaltskategorien
- Für einige Entitäten wie ArticleEntity und GenericFeaturedEntity kann eine beliebige Inhaltskategorie verwendet werden. Bei anderen Entitäten wie EventEntity, EventReservationEntity und PointOfInterestEntity sind nur einige dieser Kategorien zulässig. Sehen Sie sich die Liste der Kategorien an, die für einen Entitätstyp infrage kommen, bevor Sie die Liste füllen.
Verwenden Sie für einige Inhaltskategorien den spezifischen Entitätstyp statt einer Kombination aus generischen Entitäten und ContentCategory:
- TYPE_MovieS_AND_TV_SHOWS: Sehen Sie sich die Entitäten im Integrationsleitfaden ansehen an, bevor Sie die generischen Entitäten verwenden.
- TYPE_BOOKS: Sehen Sie sich die EbookEntity an, bevor Sie die generischen Entitäten verwenden.
- TYPE_AUDIOBOOKS: Sehen Sie sich AudiobookEntity an, bevor Sie die generischen Entitäten verwenden.
- TYPE_SHOPPING: Prüfen Sie ShoppingEntity, bevor Sie allgemeine Entitäten verwenden.
- TYPE_FOOD_AND_DRINK: Sehen Sie sich die Entitäten aus dem Leitfaden zur Lebensmittelintegration an, bevor Sie die generischen Entitäten verwenden.
Das Feld „ContentCategory“ ist optional und sollte leer bleiben, wenn der Inhalt keiner der oben genannten Kategorien zugewiesen werden kann.
Wenn mehrere Inhaltskategorien angegeben werden, ordnen Sie sie in der Reihenfolge ihrer Relevanz für die Inhalte an. Die relevanteste Inhaltskategorie muss dabei an erster Stelle stehen.
Schritt 2: Clusterdaten angeben
Es empfiehlt sich, den Job zur Inhaltsveröffentlichung im Hintergrund (z. B. mit WorkManager) auszuführen und ihn regelmäßig oder auf Ereignisbasis zu planen (z. B. jedes Mal, wenn der Nutzer die App öffnet oder gerade etwas in seinen Einkaufswagen gelegt hat).
AppEngagePublishClient
ist für die Veröffentlichung von Clustern verantwortlich.
Es gibt die folgenden APIs, um Cluster im Client zu veröffentlichen:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Mit dieser API wird geprüft, ob der Dienst für die Integration verfügbar ist und ob die Inhalte auf dem Gerät dargestellt werden können.
Kotlin
client.isServiceAvailable.addOnCompleteListener { task -> if (task.isSuccessful) { // Handle IPC call success if(task.result) { // Service is available on the device, proceed with content publish // calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } }
Java
client.isServiceAvailable().addOnCompleteListener(task - > { if (task.isSuccessful()) { // Handle success if(task.getResult()) { // Service is available on the device, proceed with content publish // calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } });
publishRecommendationClusters
Mit dieser API wird eine Liste von RecommendationCluster
-Objekten veröffentlicht.
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build() ) .build() )
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build()) .build());
Wenn der Dienst die Anfrage erhält, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:
- Vorhandene
RecommendationCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden analysiert und im aktualisierten Empfehlungscluster gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.
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 erhält, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:
- Vorhandene
FeaturedCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden analysiert und im aktualisierten „Empfohlen“-Cluster gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.
publishContinuationCluster
Mit dieser API wird ein ContinuationCluster
-Objekt veröffentlicht.
Kotlin
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishContinuationCluster( new PublishContinuationClusterRequest.Builder() .setContinuationCluster( new ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Wenn der Dienst die Anfrage empfängt, finden innerhalb einer Transaktion die folgenden Aktionen statt:
- Vorhandene
ContinuationCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden analysiert und im aktualisierten Fortsetzungscluster gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.
publishUserAccountManagementRequest
Mit dieser API wird eine Anmeldekarte veröffentlicht. Die Anmeldeaktion leitet Nutzer zur Anmeldeseite der App weiter, damit die App Inhalte veröffentlichen oder personalisiertere Inhalte bereitstellen kann.
Die folgenden Metadaten sind Teil der Anmeldekarte:
Attribut | Anforderung | Beschreibung |
---|---|---|
Aktions-URI | Erforderlich | Deeplink zur Aktion (d. h. zur Anmeldeseite der App) |
Bild | Optional. Wenn nicht angegeben, muss „Titel“ angegeben werden. |
Auf der Karte angezeigtes Bild Bilder mit einem Seitenverhältnis von 16:9 und einer Auflösung von 1264 x 712 |
Titel | Optional. Wenn nicht angegeben, muss „Image“ angegeben werden. | Titel auf der Karte |
Aktionstext | Optional | Text im CTA (z. B. „Anmelden“) |
Untertitel | Optional | Optionaler Untertitel auf der Karte |
Kotlin
var SIGN_IN_CARD_ENTITY = SignInCardEntity.Builder() .addPosterImage( Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(500) .setImageWidthInPixel(500) .build()) .setActionText("Sign In") .setActionUri(Uri.parse("http://xx.com/signin")) .build() client.publishUserAccountManagementRequest( PublishUserAccountManagementRequest.Builder() .setSignInCardEntity(SIGN_IN_CARD_ENTITY) .build());
Java
SignInCardEntity SIGN_IN_CARD_ENTITY = new SignInCardEntity.Builder() .addPosterImage( new Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(500) .setImageWidthInPixel(500) .build()) .setActionText("Sign In") .setActionUri(Uri.parse("http://xx.com/signin")) .build(); client.publishUserAccountManagementRequest( new PublishUserAccountManagementRequest.Builder() .setSignInCardEntity(SIGN_IN_CARD_ENTITY) .build());
Wenn der Dienst die Anfrage erhält, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:
- Vorhandene
UserAccountManagementCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden analysiert und im aktualisierten Cluster „UserAccountManagementCluster“ gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.
updatePublishStatus
Wenn aus internen geschäftlichen Gründen keiner der Cluster veröffentlicht wird, empfehlen wir dringend, den Veröffentlichungsstatus mithilfe der updatePublishStatus API zu aktualisieren. Dies ist aus folgenden Gründen wichtig :
- Die Angabe des Status in allen Szenarien, selbst wenn der Inhalt veröffentlicht wurde (STATUS == VERÖFFENTLICHT), ist wichtig, um Dashboards mit diesem expliziten Status zu füllen, um den Zustand und andere Messwerte deiner Integration zu vermitteln.
- Wenn keine Inhalte veröffentlicht werden, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google Warnungen in den Dashboards zur App-Integrität vermeiden. Hiermit wird bestätigt, dass Inhalte aufgrund einer erwarteten Situation aus Sicht des Anbieters nicht veröffentlicht werden.
- Sie hilft Entwicklern, Aufschluss darüber zu geben, wann die Daten veröffentlicht werden und wann nicht.
- Google kann die Statuscodes verwenden, um Nutzer zu bestimmten Aktionen in der App anzuregen, damit sie die App-Inhalte sehen oder überwinden können.
Die Liste der zulässigen Veröffentlichungsstatuscodes sieht so aus :
// Content is published
AppEngagePublishStatusCode.PUBLISHED,
// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,
// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,
// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,
// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,
// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,
// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,
// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,
// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER
Wenn die Inhalte nicht veröffentlicht werden, weil ein Nutzer nicht angemeldet ist, empfiehlt Google, die Anmeldekarte zu veröffentlichen. Wenn Anbieter die Anmeldekarte aus irgendeinem Grund nicht veröffentlichen können, empfehlen wir, die API updatePublishStatus mit dem Statuscode NOT_PUBLISHED_REQUIRES_SIGN_IN aufzurufen.
Kotlin
client.updatePublishStatus( PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build())
Java
client.updatePublishStatus( new PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build());
deleteRecommendationClusters
Diese API wird verwendet, um den Inhalt von Empfehlungsclustern zu löschen.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus den Empfehlungsclustern entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.
deleteFeaturedCluster
Diese API wird verwendet, um den Inhalt von empfohlenen Clustern zu löschen.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Wenn der Dienst die Anfrage erhält, werden die vorhandenen Daten aus dem „Empfohlen“-Cluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status bleibt erhalten.
deleteContinuationCluster
Diese API wird verwendet, um den Inhalt des Fortsetzungsclusters zu löschen.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Wenn der Dienst die Anfrage erhält, entfernt er die vorhandenen Daten aus dem Fortsetzungscluster. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteUserManagementCluster
Mit dieser API können Sie den Inhalt des Clusters „UserAccountManagement“ löschen.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Wenn der Dienst die Anfrage erhält, entfernt er die vorhandenen Daten aus dem Cluster „UserAccountManagement“. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.
deleteClusters
Mit dieser API können Sie den Inhalt eines bestimmten Clustertyps löschen.
Kotlin
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build())
Java
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build());
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus allen Clustern entfernt, die den angegebenen Clustertypen entsprechen. Clients können einen oder mehrere Clustertypen übergeben. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
Fehlerbehandlung
Es wird dringend empfohlen, das Aufgabenergebnis von den Publish APIs zu überwachen, damit eine Folgeaktion zum Wiederherstellen und erneuten Senden einer erfolgreichen Aufgabe eingeleitet werden kann.
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(..) .build()) .addOnCompleteListener { task -> if (task.isSuccessful) { // do something } else { val exception = task.exception if (exception is AppEngageException) { @AppEngageErrorCode val errorCode = exception.errorCode if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } }
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(...) .build()) .addOnCompleteListener( task -> { if (task.isSuccessful()) { // do something } else { Exception exception = task.getException(); if (exception instanceof AppEngageException) { @AppEngageErrorCode int errorCode = ((AppEngageException) exception).getErrorCode(); if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } });
Der Fehler wird als AppEngageException
zurückgegeben, wobei die Ursache als Fehlercode enthalten ist.
Fehlercode | Fehlername | Hinweis |
---|---|---|
1 |
SERVICE_NOT_FOUND |
Der Dienst ist auf dem angegebenen Gerät nicht verfügbar. |
2 |
SERVICE_NOT_AVAILABLE |
Der Dienst ist auf dem angegebenen Gerät verfügbar, aber zum Zeitpunkt des Anrufs nicht (z. B. weil er explizit deaktiviert ist). |
3 |
SERVICE_CALL_EXECUTION_FAILURE |
Die Ausführung der Aufgabe ist aufgrund von Problemen mit dem Thread fehlgeschlagen. In diesem Fall kann der Vorgang wiederholt werden. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Der Anrufer ist nicht berechtigt, den Dienst anzurufen. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
Die Anfrage enthält ungültige Daten (z. B. mehr als die zulässige Anzahl von Clustern). |
6 |
SERVICE_CALL_INTERNAL |
Es ist ein Fehler auf Dienstseite aufgetreten. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Der Dienstaufruf erfolgt zu häufig. |
Schritt 3: Broadcast-Intents verarbeiten
Zusätzlich zu API-Aufrufen für die Veröffentlichung von Inhalten über einen Job muss auch eine BroadcastReceiver
eingerichtet werden, um die Anfrage für die Veröffentlichung von Inhalten zu erhalten.
Das Ziel von Broadcast-Intents besteht hauptsächlich darin, die App wieder zu aktivieren und die Datensynchronisierung zu erzwingen. Broadcast-Intents sind nicht für häufiges Senden vorgesehen. Sie wird nur ausgelöst, wenn der Engage-Dienst feststellt, dass die Inhalte möglicherweise veraltet sind (z. B. eine Woche alt). So ist die Wahrscheinlichkeit höher, dass Nutzer aktuelle Inhalte sehen, auch wenn die Anwendung seit einiger Zeit nicht ausgeführt wurde.
Das BroadcastReceiver
muss auf eine der folgenden beiden Arten eingerichtet werden:
- Registrieren Sie eine Instanz der Klasse
BroadcastReceiver
dynamisch mitContext.registerReceiver()
. So ist die Kommunikation von Anwendungen möglich, die sich noch im Arbeitsspeicher befinden.
Kotlin
class AppEngageBroadcastReceiver : BroadcastReceiver(){ // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } fun registerBroadcastReceivers(context: Context){ var context = context context = context.applicationContext // Register Recommendation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Continuation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION)) }
Java
class AppEngageBroadcastReceiver extends BroadcastReceiver { // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } public static void registerBroadcastReceivers(Context context) { context = context.getApplicationContext(); // Register Recommendation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Continuation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION)); }
- Deklarieren Sie eine Implementierung statisch mit dem
<receiver>
-Tag in IhrerAndroidManifest.xml
-Datei. So kann die Anwendung Broadcast-Intents empfangen, wenn sie nicht ausgeführt wird, und die Inhalte veröffentlichen.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
</intent-filter>
</receiver>
</application>
Der Dienst sendet die folgenden Intents:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
Es wird empfohlen, bei Erhalt dieses Intents einenpublishRecommendationClusters
-Aufruf zu starten.com.google.android.engage.action.PUBLISH_FEATURED
Es wird empfohlen, beim Empfang dieses Intents einenpublishFeaturedCluster
-Aufruf zu starten.com.google.android.engage.action.PUBLISH_CONTINUATION
Es wird empfohlen, beim Empfang dieses Intents einenpublishContinuationCluster
-Aufruf zu starten.
Integrationsablauf
Eine detaillierte Anleitung zur Überprüfung Ihrer Integration nach ihrer Fertigstellung finden Sie im Workflow für die Engage-Entwicklerintegration.
Häufig gestellte Fragen
Häufig gestellte Fragen zum Engage SDK
Kontakt
Wenn Sie während der Integration Fragen haben, wenden Sie sich an engage-developers@google.com.
Nächste Schritte
Nach Abschluss der Integration sind folgende Schritte erforderlich:
- Senden Sie eine E-Mail an engage-developers@google.com und hängen Sie das integrierte APK an, das für den Test durch Google bereit ist.
- Google führt eine interne Überprüfung durch, um sicherzustellen, dass die Integration wie erwartet funktioniert. Wenn Änderungen erforderlich sind, kontaktiert Sie Google mit allen erforderlichen Details.
- Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, teilt Google dir mit, dass du mit der Veröffentlichung des aktualisierten und integrierten APK im Play Store beginnen kannst.
- Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Play Store veröffentlicht wurde, können Ihre Cluster Empfehlung, Empfohlen und Fortsetzung veröffentlicht und für Nutzer sichtbar werden.