Google entwickelt eine On-Device-Oberfläche, die die Apps von Nutzern nach Branchen einordnet und eine neue immersive Umgebung für die Nutzung und Auffindbarkeit personalisierter App-Inhalte ermöglicht. Diese Vollbildansicht bietet Entwicklern die Möglichkeit, ihre besten Rich Contents in einem speziellen Kanal außerhalb ihrer App zu präsentieren.
Dieser Leitfaden enthält eine Anleitung für Entwicklerpartner, wie sie ihre Videoinhalte einbinden und sowohl die neue Oberfläche als auch die bestehenden Google-Plattformen mit dem Engage SDK erstellen können.
Integrationsdetails
Terminologie
Diese Integration umfasst die folgenden drei Clustertypen: Empfehlung, Fortsetzung und Empfohlen.
Empfehlungscluster zeigen personalisierte Vorschläge für interessante Inhalte von einem einzelnen Entwicklerpartner an.
Ihre Empfehlungen haben folgende Struktur:
Empfehlungscluster:Eine UI-Ansicht, die eine Gruppe von Empfehlungen desselben Entwicklerpartners enthält.
Entität:Ein Objekt, das ein einzelnes Element in einem Cluster darstellt. Eine Entität kann ein Film, eine TV-Sendung, eine TV-Serie, ein Live-Video und mehr sein. Eine Liste der unterstützten Entitätstypen finden Sie im Abschnitt Entitätsdaten bereitstellen.
Der Cluster Continuation zeigt unfertige Videos und relevante neu veröffentlichte Folgen von mehreren Entwicklerpartnern in einer UI-Gruppierung. Jeder Entwicklerpartner darf maximal zehn Entitäten im Continuation-Cluster senden. Studien haben gezeigt, dass personalisierte Empfehlungen in Kombination mit personalisierten Continuation-Inhalten das beste Nutzer-Engagement erzielen.
Im Cluster Empfohlen wird eine Auswahl von Entitäten von mehreren Entwicklerpartnern in einer UI-Gruppierung präsentiert. Es wird einen einzelnen empfohlenen Cluster geben, der oben in der UI angezeigt wird und über allen Empfehlungsclustern platziert wird. Jeder Entwicklerpartner darf bis zu zehn Entitäten im Cluster „Empfohlen“ senden.
Vorarbeiten
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'
}
Weitere Informationen findest du unter Paketsichtbarkeit in Android 11.
Zusammenfassung
Das Design basiert auf der Implementierung eines gebundenen Dienstes.
Die Daten, die ein Client veröffentlichen kann, unterliegen den folgenden Limits für verschiedene Clustertypen:
Clustertyp | Cluster limits | Maximale Entitätslimits in einem Cluster |
---|---|---|
Empfehlungscluster | Höchstens 5 | Höchstens 50 |
Fortsetzungscluster | Höchstens 1 | Höchstens 10 |
Ausgewählter Cluster | Höchstens 1 | Höchstens 10 |
Schritt 0: Migration von einer bestehenden Media Home SDK-Integration
Datenmodelle aus vorhandener Integration zuordnen
Wenn Sie von einer bestehenden Media Home-Integration migrieren, wird in der folgenden Tabelle beschrieben, wie Datenmodelle in vorhandenen SDKs dem neuen Engage SDK zugeordnet werden:
Entsprechung für MediaHomeVideoContract-Integration | Engage-SDK-Integration Äquivalent |
---|---|
com.google.android.mediahome.video.PreviewChannel
|
com.google.android.engage.common.datamodel.RecommendationCluster
|
com.google.android.mediahome.video.PreviewChannel.Builder
|
com.google.android.engage.common.datamodel.RecommendationCluster.Builder
|
com.google.android.mediahome.video.PreviewChannelHelper
|
com.google.android.engage.video.service.AppEngageVideoClient
|
com.google.android.mediahome.video.PreviewProgram |
In separate Klassen unterteilt: EventVideo , LiveStreamingVideo , Movie , TvEpisode , TvSeason , TvShow , VideoClipEntity
|
com.google.android.mediahome.video.PreviewProgram.Builder
|
In Builders in separate Klassen unterteilt: EventVideo , LiveStreamingVideo , Movie , TvEpisode , TvSeason , TvShow und VideoClipEntity
|
com.google.android.mediahome.video.VideoContract |
Wird nicht mehr benötigt. |
com.google.android.mediahome.video.WatchNextProgram |
In Attribute in separaten Klassen unterteilt:
EventVideoEntity , LiveStreamingVideoEntity ,
MovieEntity , TvEpisodeEntity ,
TvSeasonEntity , TvShowEntity ,
VideoClipEntity |
com.google.android.mediahome.video.WatchNextProgram.Builder
|
In Attribute in separaten Klassen unterteilt:
EventVideoEntity , LiveStreamingVideoEntity ,
MovieEntity , TvEpisodeEntity ,
TvSeasonEntity , TvShowEntity ,
VideoClipEntity |
Cluster im Media Home SDK und im Engage SDK veröffentlichen
Mit dem Media Home SDK wurden Cluster und Entitäten über separate APIs veröffentlicht:
// 1. Fetch existing channels
List<PreviewChannel> channels = PreviewChannelHelper.getAllChannels();
// 2. If there are no channels, publish new channels
long channelId = PreviewChannelHelper.publishChannel(builder.build());
// 3. If there are existing channels, decide whether to update channel contents
PreviewChannelHelper.updatePreviewChannel(channelId, builder.build());
// 4. Delete all programs in the channel
PreviewChannelHelper.deleteAllPreviewProgramsByChannelId(channelId);
// 5. publish new programs in the channel
PreviewChannelHelper.publishPreviewProgram(builder.build());
Mit dem Engage SDK wird die Veröffentlichung von Clustern und Entitäten in einem einzigen API-Aufruf kombiniert. Alle Entitäten, die zu einem Cluster gehören, werden zusammen mit diesem Cluster veröffentlicht:
Kotlin
RecommendationCluster.Builder() .addEntity(MOVIE_ENTITY) .addEntity(MOVIE_ENTITY) .addEntity(MOVIE_ENTITY) .setTitle("Top Picks For You") .build()
Java
new RecommendationCluster.Builder() .addEntity(MOVIE_ENTITY) .addEntity(MOVIE_ENTITY) .addEntity(MOVIE_ENTITY) .setTitle("Top Picks For You") .build();
Schritt 1: Entitätsdaten angeben
Im SDK sind verschiedene Entitäten für jeden Elementtyp definiert. Für die Kategorie „Ansehen“ werden die folgenden Entitäten unterstützt:
In der folgenden Tabelle sind die Attribute und Anforderungen für die einzelnen Typen aufgeführt.
MovieEntity
Attribut | Anforderungen | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss ein Seitenverhältnis haben. (Das Querformat wird bevorzugt, es wird jedoch empfohlen, für verschiedene Szenarien Bilder im Hoch- und Querformat zu senden.)
Weitere Informationen finden Sie unter Bildspezifikationen. |
Wiedergabe-URI | Erforderlich |
Der Deeplink zur Anbieter-App, um die Wiedergabe des Films zu starten Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
URI der Informationsseite | Optional |
Der Deeplink zur Anbieter-App, um Details zum Film aufzurufen Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
Erscheinungsdatum | Erforderlich | In Epochenmillisekunden. |
Verfügbarkeit | Erforderlich | AVAILABLE: Der Inhalt ist für den Nutzer ohne weitere Aktionen verfügbar. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo gekauft hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. PURCHASED: Der Inhalt wurde vom Nutzer gekauft oder ausgeliehen. |
Angebotspreis | Optional | Freier Text |
Dauer | Erforderlich | In Millisekunden. |
Genre | Erforderlich | Freier Text |
Altersfreigaben | Erforderlich | Freier Text, folgen Sie dem Branchenstandard. (Beispiel) |
Videotyp „Nächstes Video ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. Er muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich diesen Inhalt schon länger als 1 Minute angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen von bestimmten Inhalten im Serienformat angesehen. Jetzt ist eine neue Folge verfügbar und es gibt genau eine noch nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER SCHRITT: Der Nutzer hat sich eine oder mehrere vollständige Folgen eines Serieninhalts angesehen. Es ist jedoch entweder mehr als eine weitere Folge oder genau eine weitere Folge übrig, bei der die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. WIEDERGABELISTE: Der Nutzer hat sich explizit dafür entschieden, einen Film, eine Serie, ein Ereignis oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes ansehen möchte. |
Letzte Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Positionszeit der letzten Wiedergabe | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und WatchNextType WEITER ist. In Epochenmillisekunden. |
TvShowEntity
Attribut | Anforderungen | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss ein Seitenverhältnis haben. (Das Querformat wird bevorzugt, es wird jedoch empfohlen, für verschiedene Szenarien Bilder im Hoch- und Querformat zu senden.)
Weitere Informationen finden Sie unter Bildspezifikationen. |
URI der Informationsseite | Erforderlich |
Der Deeplink zur Anbieter-App, der die Details der TV-Sendung anzeigt. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
Wiedergabe-URI | Optional |
Der Deeplink zur Anbieter-App, um die Wiedergabe der Serie zu starten Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
Ausstrahlungsdatum der ersten Folge | Erforderlich | In Epochenmillisekunden. |
Ausstrahlungsdatum der neuesten Folge | Optional | In Epochenmillisekunden. |
Verfügbarkeit | Erforderlich | AVAILABLE: Der Inhalt ist für den Nutzer ohne weitere Aktionen verfügbar. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo gekauft hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. PURCHASED: Der Inhalt wurde vom Nutzer gekauft oder ausgeliehen. |
Angebotspreis | Optional | Freier Text |
Anzahl der Staffeln | Erforderlich | Positive ganze Zahl |
Genre | Erforderlich | Freier Text |
Altersfreigaben | Erforderlich | Freier Text, folgen Sie dem Branchenstandard. (Beispiel) |
Videotyp „Nächstes Video ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. Er muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich diesen Inhalt schon länger als 1 Minute angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen von bestimmten Inhalten im Serienformat angesehen. Jetzt ist eine neue Folge verfügbar und es gibt genau eine noch nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER SCHRITT: Der Nutzer hat sich eine oder mehrere vollständige Folgen eines Serieninhalts angesehen. Es ist jedoch entweder mehr als eine weitere Folge oder genau eine weitere Folge übrig, bei der die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. WIEDERGABELISTE: Der Nutzer hat sich explizit dafür entschieden, einen Film, eine Serie, ein Ereignis oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes ansehen möchte. |
Letzte Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Positionszeit der letzten Wiedergabe | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und WatchNextType WEITER ist. In Epochenmillisekunden. |
TvSeasonEntity
Attribut | Anforderungen | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss ein Seitenverhältnis haben. (Das Querformat wird bevorzugt, es wird jedoch empfohlen, für verschiedene Szenarien Bilder im Hoch- und Querformat zu senden.)
Weitere Informationen finden Sie unter Bildspezifikationen. |
URI der Informationsseite | Erforderlich |
Der Deeplink zur Anbieter-App, der die Details der Staffel der TV-Sendung anzeigt. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
Wiedergabe-URI | Optional |
Der Deeplink zur Anbieter-App, um die Staffel der TV-Sendung wiederzugeben Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
Nummer der Staffel anzeigen |
Optional Verfügbar in Version 1.3.1 |
String |
Ausstrahlungsdatum der ersten Folge | Erforderlich | In Epochenmillisekunden. |
Ausstrahlungsdatum der neuesten Folge | Optional | In Epochenmillisekunden. |
Verfügbarkeit | Erforderlich | AVAILABLE: Der Inhalt ist für den Nutzer ohne weitere Aktionen verfügbar. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo gekauft hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. PURCHASED: Der Inhalt wurde vom Nutzer gekauft oder ausgeliehen. |
Angebotspreis | Optional | Freier Text |
Anzahl der Folgen | Erforderlich | Positive ganze Zahl |
Genre | Erforderlich | Freier Text |
Altersfreigaben | Erforderlich | Freier Text, folgen Sie dem Branchenstandard. (Beispiel) |
Videotyp „Nächstes Video ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. Er muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich diesen Inhalt schon länger als 1 Minute angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen von bestimmten Inhalten im Serienformat angesehen. Jetzt ist eine neue Folge verfügbar und es gibt genau eine noch nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER SCHRITT: Der Nutzer hat sich eine oder mehrere vollständige Folgen eines Serieninhalts angesehen. Es ist jedoch entweder mehr als eine weitere Folge oder genau eine weitere Folge übrig, bei der die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. WIEDERGABELISTE: Der Nutzer hat sich explizit dafür entschieden, einen Film, eine Serie, ein Ereignis oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes ansehen möchte. |
Letzte Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Positionszeit der letzten Wiedergabe | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und WatchNextType WEITER ist. In Epochenmillisekunden. |
TvEpisodeEntity
Attribut | Anforderungen | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss ein Seitenverhältnis haben. (Das Querformat wird bevorzugt, es wird jedoch empfohlen, für verschiedene Szenarien Bilder im Hoch- und Querformat zu senden.)
Weitere Informationen finden Sie unter Bildspezifikationen. |
Wiedergabe-URI | Erforderlich |
Der Deeplink zur Anbieter-App, um die Wiedergabe der Folge zu starten. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
URI der Informationsseite | Optional |
Der Deeplink zur Anbieter-App, um Details zur Folge der Serie aufzurufen. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
Nummer der Folge anzeigen |
Optional Verfügbar in Version 1.3.1 |
String |
Ausstrahlungsdatum | Erforderlich | In Epochenmillisekunden. |
Verfügbarkeit | Erforderlich | AVAILABLE: Der Inhalt ist für den Nutzer ohne weitere Aktionen verfügbar. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo gekauft hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. PURCHASED: Der Inhalt wurde vom Nutzer gekauft oder ausgeliehen. |
Angebotspreis | Optional | Freier Text |
Dauer | Erforderlich | Muss ein positiver Wert in Millisekunden sein. |
Genre | Erforderlich | Freier Text |
Altersfreigaben | Erforderlich | Freier Text, folgen Sie dem Branchenstandard. (Beispiel) |
Videotyp „Nächstes Video ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. Er muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich diesen Inhalt schon länger als 1 Minute angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen von bestimmten Inhalten im Serienformat angesehen. Jetzt ist eine neue Folge verfügbar und es gibt genau eine noch nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER SCHRITT: Der Nutzer hat sich eine oder mehrere vollständige Folgen eines Serieninhalts angesehen. Es ist jedoch entweder mehr als eine weitere Folge oder genau eine weitere Folge übrig, bei der die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. WIEDERGABELISTE: Der Nutzer hat sich explizit dafür entschieden, einen Film, eine Serie, ein Ereignis oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes ansehen möchte. |
Letzte Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Positionszeit der letzten Wiedergabe | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und WatchNextType WEITER ist. In Epochenmillisekunden. |
LiveStreamingVideoEntity
Attribut | Anforderungen | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss ein Seitenverhältnis haben. (Das Querformat wird bevorzugt, es wird jedoch empfohlen, für verschiedene Szenarien Bilder im Hoch- und Querformat zu senden.)
Weitere Informationen finden Sie unter Bildspezifikationen. |
Wiedergabe-URI | Erforderlich |
Der Deeplink zur Anbieter-App, über den das Video abgespielt werden kann. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
Broadcaster | Erforderlich | Freier Text |
Beginn | Optional | In Epochenmillisekunden. |
Ende | Optional | In Epochenmillisekunden. |
Anzahl der Aufrufe | Optional | Freier Text, muss lokalisiert werden. |
Videotyp „Nächstes Video ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. Er muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich diesen Inhalt schon länger als 1 Minute angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen von bestimmten Inhalten im Serienformat angesehen. Jetzt ist eine neue Folge verfügbar und es gibt genau eine noch nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER SCHRITT: Der Nutzer hat sich eine oder mehrere vollständige Folgen eines Serieninhalts angesehen. Es ist jedoch entweder mehr als eine weitere Folge oder genau eine weitere Folge übrig, bei der die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. WIEDERGABELISTE: Der Nutzer hat sich explizit dafür entschieden, einen Film, eine Serie, ein Ereignis oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes ansehen möchte. |
Letzte Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Positionszeit der letzten Wiedergabe | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und WatchNextType WEITER ist. In Epochenmillisekunden. |
VideoClipEntity
Das VideoClipEntity
-Objekt repräsentiert eine Videoentität aus sozialen Medien wie TikTok oder YouTube.
Attribut | Anforderungen | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss ein Seitenverhältnis haben. (Das Querformat wird bevorzugt, es wird jedoch empfohlen, für verschiedene Szenarien Bilder im Hoch- und Querformat zu senden.)
Weitere Informationen finden Sie unter Bildspezifikationen. |
Wiedergabe-URI | Erforderlich |
Der Deeplink zur Anbieter-App, über den das Video abgespielt werden kann. Hinweis: Für die Attribution können Sie Deeplinks verwenden. Weitere Informationen finden Sie in diesen FAQs |
Datum und Uhrzeit der Erstellung | Erforderlich | In Epochenmillisekunden. |
Dauer | Erforderlich | Muss ein positiver Wert in Millisekunden sein. |
Ersteller | Erforderlich | Freier Text |
Bild des Creators | Optional | Bild des Creator-Avatars |
Anzahl der Aufrufe | Optional | Freier Text, muss lokalisiert werden. |
Videotyp „Nächstes Video ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. Er muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich diesen Inhalt schon länger als 1 Minute angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen von bestimmten Inhalten im Serienformat angesehen. Jetzt ist eine neue Folge verfügbar und es gibt genau eine noch nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER SCHRITT: Der Nutzer hat sich eine oder mehrere vollständige Folgen eines Serieninhalts angesehen. Es ist jedoch entweder mehr als eine weitere Folge oder genau eine weitere Folge übrig, bei der die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. WIEDERGABELISTE: Der Nutzer hat sich explizit dafür entschieden, einen Film, eine Serie, ein Ereignis oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes ansehen möchte. |
Letzte Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Positionszeit der letzten Wiedergabe | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und WatchNextType WEITER ist. In Epochenmillisekunden. |
Bildspezifikationen
Im folgenden Abschnitt sind die erforderlichen Spezifikationen für Bild-Assets aufgeführt:
Dateiformate
PNG, JPG, statisches GIF, WebP
Maximale Dateigröße
5.120 KB
Weitere Empfehlungen
- Bildbereich:Wichtige Inhalte sollten in den mittleren 80% des Bildes positioniert werden.
Beispiel
Kotlin
var movie = MovieEntity.Builder() .setName("Avengers") .addPosterImage(Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(960) .setImageWidthInPixel(408) .build()) .setPlayBackUri(Uri.parse("http://tv.com/playback/1")) .setReleaseDateEpochMillis(1633032895L) .setAvailability(ContentAvailability.AVAILABILITY_AVAILABLE) .setDurationMillis(12345678L) .addGenre("action") .addContentRating("R") .setWatchNextType(WatchNextType.TYPE_NEW) .setLastEngagementTimeMillis(1664568895L) .build()
Java
MovieEntity movie = new MovieEntity.Builder() .setName("Avengers") .addPosterImage( new Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(960) .setImageWidthInPixel(408) .build()) .setPlayBackUri(Uri.parse("http://tv.com/playback/1")) .setReleaseDateEpochMillis(1633032895L) .setAvailability(ContentAvailability.AVAILABILITY_AVAILABLE) .setDurationMillis(12345678L) .addGenre("action") .addContentRating("R") .setWatchNextType(WatchNextType.TYPE_NEW) .setLastEngagementTimeMillis(1664568895L) .build();
Schritt 2: Clusterdaten bereitstellen
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 das Veröffentlichen von Clustern zuständig. Folgende APIs sind im Client verfügbar:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Mit dieser API wird geprüft, ob der Dienst für die Integration verfügbar ist und ob die Inhalte auf dem Gerät dargestellt werden können.
Kotlin
client.isServiceAvailable.addOnCompleteListener { task -> if (task.isSuccessful) { // Handle IPC call success if(task.result) { // Service is available on the device, proceed with content publish // calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } }
Java
client.isServiceAvailable().addOnCompleteListener(task - > { if (task.isSuccessful()) { // Handle success if(task.getResult()) { // Service is available on the device, proceed with content publish // calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } });
publishRecommendationClusters
Diese API wird verwendet, um eine Liste von RecommendationCluster
-Objekten zu veröffentlichen.
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build() ) .build() )
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build()) .build());
Wenn der Dienst die Anfrage empfängt, finden innerhalb einer Transaktion die folgenden Aktionen statt:
- Vorhandene
RecommendationCluster
-Daten des Entwicklerpartners werden entfernt. - Daten aus der Anfrage werden geparst und im aktualisierten Empfehlungscluster gespeichert.
Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishFeaturedCluster
Diese API wird verwendet, um eine Liste von FeaturedCluster
-Objekten zu veröffentlichen.
Kotlin
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishFeaturedCluster( new PublishFeaturedClustersRequest.Builder() .addFeaturedCluster( new FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Wenn der Dienst die Anfrage empfängt, finden innerhalb einer Transaktion die folgenden Aktionen statt:
- Vorhandene
FeaturedCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten „Featured Cluster“ gespeichert.
Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishContinuationCluster
Diese API wird zum Veröffentlichen eines ContinuationCluster
-Objekts verwendet.
Kotlin
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishContinuationCluster( new PublishContinuationClusterRequest.Builder() .setContinuationCluster( new ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Wenn der Dienst die Anfrage empfängt, finden innerhalb einer Transaktion die folgenden Aktionen statt:
- Vorhandene
ContinuationCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten Continuation-Cluster gespeichert.
Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishUserAccountManagementRequest
Dieses API wird verwendet, um eine Anmeldekarte zu veröffentlichen . Über die Anmeldeaktion werden Nutzer zur Anmeldeseite der App weitergeleitet, damit sie Inhalte veröffentlichen (oder stärker personalisierte Inhalte) bereitstellen kann.
Die folgenden Metadaten sind Teil der Anmeldekarte:
Attribut | Anforderungen | Beschreibung |
---|---|---|
Aktions-URI | Erforderlich | Deeplink zu Aktion (z.B. Weiterleitung zur Anmeldeseite der App) |
Bild | Optional – falls nicht angegeben, muss ein Titel angegeben werden |
Bild auf der Karte Bilder mit einem Seitenverhältnis von 16:9 und einer Auflösung von 1264 x 712 |
Titel | Optional – falls nicht angegeben, muss ein Bild angegeben werden | Titel auf der Karte |
Aktionstext | Optional | Text, der im CTA angezeigt wird (z.B. „Anmelden“) |
Untertitel | Optional | Optionale Untertitel auf der Karte |
Kotlin
var SIGN_IN_CARD_ENTITY = SignInCardEntity.Builder() .addPosterImage( Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(500) .setImageWidthInPixel(500) .build()) .setActionText("Sign In") .setActionUri(Uri.parse("http://xx.com/signin")) .build() client.publishUserAccountManagementRequest( PublishUserAccountManagementRequest.Builder() .setSignInCardEntity(SIGN_IN_CARD_ENTITY) .build());
Java
SignInCardEntity SIGN_IN_CARD_ENTITY = new SignInCardEntity.Builder() .addPosterImage( new Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(500) .setImageWidthInPixel(500) .build()) .setActionText("Sign In") .setActionUri(Uri.parse("http://xx.com/signin")) .build(); client.publishUserAccountManagementRequest( new PublishUserAccountManagementRequest.Builder() .setSignInCardEntity(SIGN_IN_CARD_ENTITY) .build());
Wenn der Dienst die Anfrage empfängt, finden innerhalb einer Transaktion die folgenden Aktionen statt:
- Vorhandene
UserAccountManagementCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten UserAccountManagementCluster-Cluster gespeichert.
Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
updatePublishStatus
Wenn aus internen geschäftlichen Gründen keiner der Cluster veröffentlicht wird, empfehlen wir dringend, den Veröffentlichungsstatus über die updatePublishStatus API zu aktualisieren. Dies ist aus folgenden Gründen wichtig :
- Die Angabe des Status in allen Szenarien, selbst wenn der Inhalt veröffentlicht wurde (STATUS == VERÖFFENTLICHT), ist wichtig, um Dashboards mit diesem expliziten Status zu füllen, um den Zustand und andere Messwerte deiner Integration zu vermitteln.
- Wenn keine Inhalte veröffentlicht werden, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google verhindern, dass Benachrichtigungen in den Dashboards zum Zustand der Anwendung ausgelöst werden. Er bestätigt, dass Inhalte aufgrund einer erwarteten Situation aus Sicht des Anbieters nicht veröffentlicht wurden.
- Sie hilft Entwicklern, einen Einblick 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 zu bewegen, damit sie den App-Inhalt sehen oder überwinden können.
Die Liste der zulässigen Veröffentlichungsstatuscodes sieht so aus :
// Content is published
AppEngagePublishStatusCode.PUBLISHED,
// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,
// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,
// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,
// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,
// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,
// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,
// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,
// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER
Wenn die Inhalte nicht veröffentlicht werden, weil ein Nutzer nicht angemeldet ist, empfiehlt Google, die Anmeldekarte zu veröffentlichen. Wenn Anbieter die Anmeldekarte aus irgendeinem Grund nicht veröffentlichen können, empfehlen wir, die updatePublishStatus API mit dem Statuscode NOT_PUBLISHED_REQUIRES_SIGN_IN aufzurufen.
Kotlin
client.updatePublishStatus( PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build())
Java
client.updatePublishStatus( new PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build());
deleteRecommendationClusters
Diese API wird verwendet, um den Inhalt von Empfehlungsclustern zu löschen.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus den Empfehlungsclustern entfernt. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteFeaturedCluster
Diese API wird verwendet, um den Inhalt von empfohlenen Clustern zu löschen.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem hervorgehobenen Cluster entfernt. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteContinuationCluster
Diese API wird verwendet, um den Inhalt des Fortsetzungsclusters zu löschen.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem Continuation-Cluster entfernt. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteUserManagementCluster
Diese API wird verwendet, um den Inhalt des UserAccountManagement-Clusters zu löschen.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem UserAccountManagement-Cluster entfernt. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteClusters
Diese API wird verwendet, um den Inhalt eines bestimmten Clustertyps zu löschen.
Kotlin
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build())
Java
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build());
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus allen Clustern entfernt, die den angegebenen Clustertypen entsprechen. Clients können einen oder mehrere Clustertypen übergeben. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
Fehlerbehandlung
Es wird dringend empfohlen, das Aufgabenergebnis der Publish APIs zu überwachen, damit eine Folgeaktion zum Wiederherstellen und erneuten Senden einer erfolgreichen Aufgabe eingeleitet werden kann.
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(..) .build()) .addOnCompleteListener { task -> if (task.isSuccessful) { // do something } else { val exception = task.exception if (exception is AppEngageException) { @AppEngageErrorCode val errorCode = exception.errorCode if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } }
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(...) .build()) .addOnCompleteListener( task -> { if (task.isSuccessful()) { // do something } else { Exception exception = task.getException(); if (exception instanceof AppEngageException) { @AppEngageErrorCode int errorCode = ((AppEngageException) exception).getErrorCode(); if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } });
Der Fehler wird als AppEngageException
zurückgegeben, wobei die Ursache als Fehlercode angegeben wird.
Fehlercode | Hinweis |
---|---|
SERVICE_NOT_FOUND |
Der Dienst ist auf dem betreffenden Gerät nicht verfügbar. |
SERVICE_NOT_AVAILABLE |
Der Dienst ist auf dem jeweiligen Gerät verfügbar, aber zum Zeitpunkt des Aufrufs nicht (z. B. explizit deaktiviert). |
SERVICE_CALL_EXECUTION_FAILURE |
Die Aufgabe konnte aufgrund von Threading-Problemen nicht ausgeführt werden. In diesem Fall kann es noch einmal versucht werden. |
SERVICE_CALL_PERMISSION_DENIED |
Der Aufrufer ist nicht berechtigt, den Dienstaufruf durchzuführen. |
SERVICE_CALL_INVALID_ARGUMENT |
Die Anfrage enthält ungültige Daten (z. B. mehr als die zulässige Anzahl von Clustern). |
SERVICE_CALL_INTERNAL |
Dienstseitig ist ein Fehler aufgetreten. |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Der Dienstaufruf erfolgt zu häufig. |
Schritt 3: Mit Broadcast-Intents umgehen
Neben den Aufrufen der Content API zur Veröffentlichung über einen Job muss auch ein BroadcastReceiver
eingerichtet werden, um die Anfrage für eine Inhaltsveröffentlichung zu erhalten.
Das Ziel von Broadcast-Intents besteht hauptsächlich darin, die App wieder zu aktivieren und die Datensynchronisierung zu erzwingen. Broadcast-Intents sind nicht für das häufige Senden konzipiert. Sie wird nur ausgelöst, wenn Google Engage für Agenturen feststellt, dass der Inhalt möglicherweise veraltet ist (z. B. eine Woche alt). So lässt sich die Sicherheit des Nutzers erhöhen, auch wenn die App längere Zeit nicht ausgeführt wurde.
BroadcastReceiver
muss auf zwei Arten eingerichtet werden:
- Registriert eine Instanz der
BroadcastReceiver
-Klasse dynamisch mitContext.registerReceiver()
. Dies ermöglicht die Kommunikation von Anwendungen, die sich noch im Arbeitsspeicher befinden.
Kotlin
class AppEngageBroadcastReceiver : BroadcastReceiver(){ // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } fun registerBroadcastReceivers(context: Context){ var context = context context = context.applicationContext // Register Recommendation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Continuation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION)) }
Java
class AppEngageBroadcastReceiver extends BroadcastReceiver { // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } public static void registerBroadcastReceivers(Context context) { context = context.getApplicationContext(); // Register Recommendation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Continuation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION)); }
- Deklariere eine Implementierung statisch mit dem
<receiver>
-Tag in der DateiAndroidManifest.xml
. Dadurch kann die Anwendung Übertragungs-Intents empfangen, wenn sie nicht ausgeführt wird, und Inhalte veröffentlichen.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
</intent-filter>
</receiver>
</application>
Die folgenden Intents werden vom Dienst gesendet:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
Es wird empfohlen, beim Empfang dieses Intents einenpublishRecommendationClusters
-Aufruf zu starten.com.google.android.engage.action.PUBLISH_FEATURED
Es wird empfohlen, beim Empfang dieses Intents einenpublishFeaturedCluster
-Aufruf zu starten.com.google.android.engage.action.PUBLISH_CONTINUATION
Es wird empfohlen, beim Empfang dieses Intents einenpublishContinuationCluster
-Aufruf zu starten.
Integrationsablauf
Eine detaillierte Anleitung zur Überprüfung Ihrer Integration nach ihrer Fertigstellung finden Sie im Workflow für die Engage-Entwicklerintegration.
Häufig gestellte Fragen
FAQs finden Sie unter Häufig gestellte Fragen zum Engage SDK.
Kontakt
Falls während des Integrationsprozesses Fragen auftauchen, wenden Sie sich bitte an Engage-developers@google.com.
Nächste Schritte
Nach Abschluss der Integration sind folgende Schritte erforderlich:
- Sende eine E-Mail an Engage-developers@google.com und hänge dein integriertes APK an, das von Google getestet werden kann.
- Google führt eine Überprüfung durch und überprüft intern, ob die Integration wie erwartet funktioniert. Wenn Änderungen erforderlich sind, kontaktiert Google Sie mit allen erforderlichen Details.
- Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, teilt Google dir mit, dass du mit der Veröffentlichung des aktualisierten und integrierten APK im Play Store beginnen kannst.
- Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Play Store veröffentlicht wurde, können Ihre Cluster Empfehlung, Empfohlen und Fortsetzung veröffentlicht und für Nutzer sichtbar sein.