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. Dieser Vollbildmodus bietet Entwicklerpartnern die Möglichkeit, ihre besten Inhalte in einem speziellen Kanal außerhalb ihrer App zu präsentieren.
Dieser Leitfaden enthält eine Anleitung für Entwicklerpartner, wie sie ihre Videoinhalte mit dem Engage SDK einbinden und damit sowohl diese neue Oberfläche als auch bestehende Google-Oberflächen befüllen können.
Integrationsdetails
Terminologie
Diese Integration umfasst die folgenden drei Clustertypen: Empfehlung, Fortsetzung und Empfohlen.
In Clustern vom Typ Empfehlung werden personalisierte Vorschläge für Inhalte von einem einzelnen Entwicklerpartner angezeigt.
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 oder ein Live-Video sein. Eine Liste der unterstützten Entitätstypen finden Sie im Abschnitt Entitätsdaten bereitstellen.
Im Cluster Fortsetzung werden unvollständige Videos und relevante, neu veröffentlichte Folgen von mehreren Entwicklerpartnern in einer UI-Gruppierung angezeigt. Jeder Entwicklerpartner darf maximal 10 Entitäten im Fortsetzungscluster übertragen. Studien haben gezeigt, dass personalisierte Empfehlungen in Kombination mit personalisierten Fortsetzungsinhalten das Nutzer-Engagement am besten steigern.
Im Cluster Empfohlen werden in einer UI-Gruppierung eine Auswahl von Entitäten verschiedener Entwicklerpartner präsentiert. Es wird einen einzelnen empfohlenen Cluster geben, der oben in der UI angezeigt wird und über allen Empfehlungsclustern platziert wird. Jeder Entwicklerpartner kann bis zu zehn Entitäten im Cluster „Empfohlen“ übertragen.
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'
}
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 | Clusterlimits | Maximale Entitätslimits in einem Cluster |
---|---|---|
Empfehlungscluster | Maximal 5 | Maximal 50 |
Fortsetzungscluster | Höchstens 1 | Maximal 10 |
Empfohlener Cluster | Maximal 1 | Höchstens 10 |
Schritt 0: Migration von der vorhandenen Media Home SDK-Integration
Datenmodelle aus einer vorhandenen Integration zuordnen
Wenn Sie von einer bestehenden Media Home-Integration migrieren, wird in der folgenden Tabelle beschrieben, wie Sie Datenmodelle in vorhandenen SDKs dem neuen Engage SDK zuordnen:
Entsprechung für MediaHomeVideoContract-Integration | Entspricht der Integration des Engage SDK |
---|---|
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 separate Klassen unterteilt in Bauherren: EventVideo ,
LiveStreamingVideo , Movie ,
TvEpisode , TvSeason , TvShow ,
VideoClipEntity
|
com.google.android.mediahome.video.VideoContract |
Nicht mehr erforderlich. |
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 werden Cluster- und Entitätsveröffentlichungen 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 „Uhr“ werden die folgenden Entitäten unterstützt:
Im folgenden Diagramm sind die Attribute und Anforderungen für die einzelnen Typen aufgeführt.
MovieEntity
Attribut | Anforderung | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Es ist mindestens ein Bild erforderlich, das ein Seitenverhältnis haben muss. Das Querformat wird bevorzugt, aber es wird empfohlen, sowohl Bilder im Hoch- als auch im Querformat für verschiedene Szenarien zu übergeben.
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Wiedergabe-URI | Erforderlich |
Der Deeplink zur Anbieter-App, um die Wiedergabe des Films zu starten Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
URI der Infoseite | Optional |
Der Deeplink zur Anbieter-App, um Details zum Film anzuzeigen. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Erscheinungsdatum | Erforderlich | In Epochen-Millisekunden. |
Verfügbarkeit | Erforderlich | VERFÜGBAR: Die Inhalte sind für den Nutzer ohne weitere Maßnahmen verfügbar. FREE_WITH_SUBSCRIPTION: Die Inhalte sind verfügbar, nachdem der Nutzer ein Abo abgeschlossen hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. GEKAUFT: 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) |
Typ für „Als Nächstes ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich bereits mehr als eine Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen einer Reihe angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER: Der Nutzer hat sich eine oder mehrere vollständige Folgen von Serieninhalten angesehen, es verbleiben aber entweder mehr als eine Folge oder genau eine Folge. Die letzte Folge ist nicht als „NEU“ gekennzeichnet und wurde veröffentlicht, bevor der Nutzer mit der Wiedergabe der Serieninhalte begonnen hat. MERKLISTE: Der Nutzer hat explizit einen Film, ein Ereignis oder eine Serie zu einer Merkliste hinzugefügt, um manuell auszuwählen, was er sich als Nächstes ansehen möchte. |
Zeitpunkt der letzten Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Letzte Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet und „WatchNextType“ auf „CONTINUE“ festgelegt ist. In Epochen-Millisekunden. |
TvShowEntity
Attribut | Anforderung | 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 Anforderungen an Bilder. |
URI der Infoseite | 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 TV-Sendung zu starten. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Ausstrahlungsdatum der ersten Folge | Erforderlich | In Epochen-Millisekunden. |
Datum der Ausstrahlung der neuesten Folge | Optional | In Epochen-Millisekunden. |
Verfügbarkeit | Erforderlich | VERFÜGBAR: Die Inhalte sind für den Nutzer ohne weitere Maßnahmen verfügbar. FREE_WITH_SUBSCRIPTION: Die Inhalte sind verfügbar, nachdem der Nutzer ein Abo abgeschlossen hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. GEKAUFT: 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) |
Typ für „Als Nächstes ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich bereits mehr als eine Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen einer Reihe angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER: Der Nutzer hat sich eine oder mehrere vollständige Folgen von Serieninhalten angesehen, es verbleiben aber entweder mehr als eine Folge oder genau eine Folge. Die letzte Folge ist nicht als „NEU“ gekennzeichnet und wurde veröffentlicht, bevor der Nutzer mit der Wiedergabe der Serieninhalte begonnen hat. MERKLISTE: Der Nutzer hat explizit einen Film, ein Ereignis oder eine Serie zu einer Merkliste hinzugefügt, um manuell auszuwählen, was er sich als Nächstes ansehen möchte. |
Zeitpunkt der letzten Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Letzte Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet und „WatchNextType“ auf „CONTINUE“ festgelegt ist. In Epochen-Millisekunden. |
TvSeasonEntity
Attribut | Anforderung | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Es ist mindestens ein Bild erforderlich, das ein Seitenverhältnis haben muss. Das Querformat wird bevorzugt, aber es wird empfohlen, sowohl Bilder im Hoch- als auch im Querformat für verschiedene Szenarien zu übergeben.
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
URI der Informationsseite | Erforderlich |
Der Deeplink zur Anbieter-App, um die Details der Staffel der TV-Sendung anzuzeigen. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Wiedergabe-URI | Optional |
Der Deeplink zur Anbieter-App, über den die Staffel der TV-Serie gestartet wird. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in diesen FAQs |
Staffelnummer anzeigen |
Optional Verfügbar in Version 1.3.1 |
String |
Datum der Erstausstrahlung der ersten Folge | Erforderlich | In Epochen-Millisekunden. |
Datum der Ausstrahlung der neuesten Folge | Optional | In Epochen-Millisekunden. |
Verfügbarkeit | Erforderlich | VERFÜGBAR: Die Inhalte sind für den Nutzer ohne weitere Maßnahmen verfügbar. FREE_WITH_SUBSCRIPTION: Die Inhalte sind verfügbar, nachdem der Nutzer ein Abo abgeschlossen hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. GEKAUFT: 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, der dem Branchenstandard entspricht. (Beispiel) |
Typ für „Als Nächstes ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich bereits mehr als eine Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen einer Reihe angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER: Der Nutzer hat sich eine oder mehrere vollständige Folgen von Serieninhalten angesehen, es verbleiben aber entweder mehr als eine Folge oder genau eine Folge. Die letzte Folge ist nicht als „NEU“ gekennzeichnet und wurde veröffentlicht, bevor der Nutzer mit der Wiedergabe der Serieninhalte begonnen hat. MERKLISTE: Der Nutzer hat explizit einen Film, ein Ereignis oder eine Serie zu einer Merkliste hinzugefügt, um manuell auszuwählen, was er sich als Nächstes ansehen möchte. |
Zeitpunkt der letzten Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Letzte Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet und „WatchNextType“ auf „CONTINUE“ festgelegt ist. In Epochen-Millisekunden. |
TvEpisodeEntity
Attribut | Anforderung | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Es ist mindestens ein Bild erforderlich, das ein Seitenverhältnis haben muss. Das Querformat wird bevorzugt, aber es wird empfohlen, sowohl Bilder im Hoch- als auch im Querformat für verschiedene Szenarien zu übergeben.
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Wiedergabe-URI | Erforderlich |
Der Deeplink zur Anbieter-App, um die Wiedergabe der Folge zu starten. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
URI der Infoseite | Optional |
Der Deeplink zur Anbieter-App, um Details zur Folge der TV-Sendung anzuzeigen. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Folgenummer anzeigen |
Optional Verfügbar in Version 1.3.1 |
String |
Ausstrahlungsdatum | Erforderlich | In Epochen-Millisekunden. |
Verfügbarkeit | Erforderlich | VERFÜGBAR: Die Inhalte sind für den Nutzer ohne weitere Maßnahmen verfügbar. FREE_WITH_SUBSCRIPTION: Die Inhalte sind verfügbar, nachdem der Nutzer ein Abo abgeschlossen hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. GEKAUFT: 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) |
Typ für „Als Nächstes ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich bereits mehr als eine Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen einer Reihe angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER: Der Nutzer hat sich eine oder mehrere vollständige Folgen von Serieninhalten angesehen, es verbleiben aber entweder mehr als eine Folge oder genau eine Folge. Die letzte Folge ist nicht als „NEU“ gekennzeichnet und wurde veröffentlicht, bevor der Nutzer mit der Wiedergabe der Serieninhalte begonnen hat. MERKLISTE: Der Nutzer hat explizit einen Film, ein Ereignis oder eine Serie zu einer Merkliste hinzugefügt, um manuell auszuwählen, was er sich als Nächstes ansehen möchte. |
Zeitpunkt der letzten Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Letzte Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet und „WatchNextType“ auf „CONTINUE“ festgelegt ist. In Epochen-Millisekunden. |
LiveStreamingVideoEntity
Attribut | Anforderung | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Es ist mindestens ein Bild erforderlich, das ein Seitenverhältnis haben muss. Das Querformat wird bevorzugt, aber es wird empfohlen, sowohl Bilder im Hoch- als auch im Querformat für verschiedene Szenarien zu übergeben.
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Wiedergabe-URI | Erforderlich |
Der Deeplink zur Anbieter-App, um die Wiedergabe des Videos zu starten. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
Broadcaster | Erforderlich | Freier Text |
Beginn | Optional | In Epochenmillisekunden. |
Ende | Optional | In Epochen-Millisekunden. |
Anzahl der Aufrufe | Optional | Freier Text, muss lokalisiert werden. |
Videotyp „Nächstes Video ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich bereits mehr als eine Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen einer Reihe angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER: Der Nutzer hat sich eine oder mehrere vollständige Folgen von Serieninhalten angesehen, es verbleiben aber entweder mehr als eine Folge oder genau eine Folge. Die letzte Folge ist nicht als „NEU“ gekennzeichnet und wurde veröffentlicht, bevor der Nutzer mit der Wiedergabe der Serieninhalte begonnen hat. MERKLISTE: Der Nutzer hat explizit einen Film, ein Ereignis oder eine Serie zu einer Merkliste hinzugefügt, um manuell auszuwählen, was er sich als Nächstes ansehen möchte. |
Zeitpunkt der letzten Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Letzte Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet und „WatchNextType“ auf „CONTINUE“ festgelegt ist. In Epochen-Millisekunden. |
VideoClipEntity
Das VideoClipEntity
-Objekt stellt eine Videoentität aus sozialen Medien wie TikTok oder YouTube dar.
Attribut | Anforderung | Hinweise |
---|---|---|
Name | Erforderlich | |
Posterbilder | Erforderlich | Es ist mindestens ein Bild erforderlich, das ein Seitenverhältnis haben muss. Das Querformat wird bevorzugt, aber es wird empfohlen, sowohl Bilder im Hoch- als auch im Querformat für verschiedene Szenarien zu übergeben.
Weitere Informationen finden Sie unter Anforderungen an Bilder. |
Wiedergabe-URI | Erforderlich |
Der Deeplink zur Anbieter-App, um die Wiedergabe des Videos zu starten. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in dieser FAQ. |
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 Avatars des Creators |
Anzahl der Aufrufe | Optional | Freier Text, muss lokalisiert werden. |
Videotyp „Nächstes Video ansehen“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: WEITER: Der Nutzer hat sich bereits mehr als eine Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen einer Reihe angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei Fernsehsendungen, aufgezeichneten Fußballspielen in einer Serie usw. NÄCHSTER: Der Nutzer hat sich eine oder mehrere vollständige Folgen von Serieninhalten angesehen, es verbleiben aber entweder mehr als eine Folge oder genau eine Folge. Die letzte Folge ist nicht als „NEU“ gekennzeichnet und wurde veröffentlicht, bevor der Nutzer mit der Wiedergabe der Serieninhalte begonnen hat. MERKLISTE: Der Nutzer hat explizit einen Film, ein Ereignis oder eine Serie zu einer Merkliste hinzugefügt, um manuell auszuwählen, was er sich als Nächstes ansehen möchte. |
Zeitpunkt der letzten Interaktion | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden. |
Letzte Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet und „WatchNextType“ auf „CONTINUE“ festgelegt ist. In Epochen-Millisekunden. |
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: Platzieren Sie wichtige Inhalte in den mittleren 80 % des Bildes.
Verwendungsbeispiele
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 angeben
Wir empfehlen, den Job zum Veröffentlichen von Inhalten im Hintergrund auszuführen (z. B. mit WorkManager) und regelmäßig oder auf Ereignisbasis zu planen (z. B. jedes Mal, wenn der Nutzer die App öffnet oder etwas in den Einkaufswagen gelegt hat).
AppEngagePublishClient
ist für die Veröffentlichung von Clustern verantwortlich. Die folgenden 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 Einbindung verfügbar ist und ob die Inhalte auf dem Gerät präsentiert 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
Mit dieser API wird eine Liste von FeaturedCluster
-Objekten veröffentlicht.
Kotlin
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishFeaturedCluster( new PublishFeaturedClustersRequest.Builder() .addFeaturedCluster( new FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
Wenn der Dienst die Anfrage erhält, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:
- Vorhandene
FeaturedCluster
-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden analysiert und im aktualisierten „Empfohlen“-Cluster gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.
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 erhält, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:
- 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 1.264 x 712 |
Titel | Optional. Wenn nicht angegeben, muss „Image“ angegeben werden. | Titel auf der Karte |
Aktionstext | Optional | Text im CTA (z. B. „Anmelden“) |
Untertitel | Optional | 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 erhält, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:
- 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 mit der updatePublishStatus API zu aktualisieren. Das ist wichtig, weil:
- Es ist wichtig, den Status in allen Szenarien anzugeben, auch wenn die Inhalte veröffentlicht wurden (STATUS == PUBLISHED), um Dashboards zu erstellen, in denen dieser explizite Status verwendet wird, um den Zustand und andere Messwerte deiner Integration zu vermitteln.
- Wenn keine Inhalte veröffentlicht werden, 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.
Folgende Veröffentlichungsstatuscodes sind zulässig:
// Content is published
AppEngagePublishStatusCode.PUBLISHED,
// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,
// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,
// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,
// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,
// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,
// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,
// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,
// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER
Wenn die Inhalte nicht veröffentlicht werden, weil ein Nutzer nicht angemeldet ist, empfiehlt Google, die Anmeldekarte zu veröffentlichen. Wenn Anbieter die Anmeldekarte aus irgendeinem Grund nicht veröffentlichen können, empfehlen wir, die API updatePublishStatus mit dem Statuscode NOT_PUBLISHED_REQUIRES_SIGN_IN aufzurufen.
Kotlin
client.updatePublishStatus( PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build())
Java
client.updatePublishStatus( new PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build());
deleteRecommendationClusters
Mit dieser API können Sie den Inhalt von Empfehlungsclustern 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 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. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status beibehalten.
deleteContinuationCluster
Mit dieser API können Sie den Inhalt eines Fortsetzungsclusters löschen.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Wenn der Dienst die Anfrage erhält, entfernt er die vorhandenen Daten aus dem Fortsetzungscluster. 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 erhält, entfernt er die vorhandenen Daten aus dem Cluster „UserAccountManagement“. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der aktuelle Status bleibt erhalten.
deleteClusters
Mit dieser API können Sie den Inhalt eines bestimmten Clustertyps löschen.
Kotlin
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build())
Java
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build());
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus allen Clustern entfernt, die den angegebenen Clustertypen entsprechen. Clients können einen oder mehrere Clustertypen übergeben. Tritt ein Fehler auf, wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
Fehlerbehandlung
Es wird dringend empfohlen, das Aufgabenergebnis aus den Veröffentlichungs-APIs abzuhören, damit eine Folgeaktion ausgeführt werden kann, um eine erfolgreiche Aufgabe wiederherzustellen und noch einmal einzureichen.
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(..) .build()) .addOnCompleteListener { task -> if (task.isSuccessful) { // do something } else { val exception = task.exception if (exception is AppEngageException) { @AppEngageErrorCode val errorCode = exception.errorCode if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } }
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(...) .build()) .addOnCompleteListener( task -> { if (task.isSuccessful()) { // do something } else { Exception exception = task.getException(); if (exception instanceof AppEngageException) { @AppEngageErrorCode int errorCode = ((AppEngageException) exception).getErrorCode(); if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } });
Der Fehler wird als AppEngageException
zurückgegeben, wobei die Ursache als Fehlercode enthalten ist.
Fehlercode | Fehlername | Hinweis |
---|---|---|
1 |
SERVICE_NOT_FOUND |
Der Dienst ist auf dem angegebenen Gerät nicht verfügbar. |
2 |
SERVICE_NOT_AVAILABLE |
Der Dienst ist auf dem angegebenen Gerät verfügbar, aber zum Zeitpunkt des Anrufs nicht (z. B. weil er explizit deaktiviert ist). |
3 |
SERVICE_CALL_EXECUTION_FAILURE |
Die 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.
Broadcast-Intents dienen hauptsächlich zur Reaktivierung von Apps und zum Erzwingen der Datensynchronisierung. Broadcast-Intents sind nicht für das häufige Senden konzipiert. 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()
. 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)); }
- 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
Wir empfehlen, bei Erhalt dieser Absicht 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
Wir empfehlen, bei Erhalt dieser Absicht einenpublishContinuationCluster
-Anruf zu starten.
Integrationsablauf
Eine detaillierte Anleitung zum Überprüfen Ihrer Integration nach Abschluss finden Sie unter Integrationsablauf für Entwickler.
Häufig gestellte Fragen
Häufig gestellte Fragen zum Engage SDK
Kontakt
Wenn Sie während der Integration Fragen haben, wenden Sie sich an engage-developers@google.com.
Nächste Schritte
Nach Abschluss dieser 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 interne Überprüfung durch, um sicherzustellen, dass die Integration wie erwartet funktioniert. Falls Änderungen erforderlich sind, kontaktiert Google Sie mit den notwendigen Details.
- Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, benachrichtigt Sie Google, dass Sie mit der Veröffentlichung des aktualisierten und integrierten APK im Play Store beginnen können.
- 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.