Engage SDK Watch: Anleitung zur technischen Integration von Drittanbietern

Google entwickelt eine On-Device-Oberfläche, die die Apps der Nutzer nach Branchen sortiert und ein neues immersives Erlebnis für personalisierte App-Inhalte ermöglicht. Diese Vollbildfunktion bietet Entwicklerpartnern die Möglichkeit, ihre besten Rich-Content-Inhalte in einem eigenen Kanal außerhalb ihrer App zu präsentieren.

Dieser Leitfaden enthält Anleitungen für Entwicklerpartner, wie sie ihre Videoinhalte mit dem Engage SDK integrieren können, um diesen neuen Bereich und vorhandene Google-Oberflächen auszufüllen.

Integrationsdetail

Terminologie

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

• Empfehlungscluster zeigen personalisierte Vorschläge für Inhalte einzelner Entwicklerpartner.

  Ihre Empfehlungen haben die folgende Struktur:

  • Empfehlungscluster: Eine UI-Ansicht, die eine Gruppe von Empfehlungen desselben Entwicklerpartners enthält.

    

    Abbildung 1: Entertainment Space-Benutzeroberfläche mit einem Empfehlungscluster eines einzelnen Partners.

  • Entität:Ein Objekt, das ein einzelnes Element in einem Cluster darstellt. Eine Entität kann ein Film, eine Serie, eine Serie, ein Live-Video usw. sein. Eine Liste der unterstützten Entitätstypen finden Sie im Abschnitt Entitätsdaten bereitstellen.

    

    Abbildung 2: Entertainment Space-UI mit einer einzelnen Entität im Empfehlungscluster eines Partners.

• Im Cluster Continuation werden noch nicht abgeschlossene Videos und relevante neu veröffentlichte Folgen von mehreren Entwicklerpartnern in einer UI-Gruppierung angezeigt. Jeder Entwicklerpartner darf maximal 10 Entitäten im Continuation-Cluster senden. Studien haben gezeigt, dass personalisierte Empfehlungen in Kombination mit personalisierten Fortsetzungsinhalten die besten Nutzerinteraktionen fördern.

  

  Abbildung 3: Entertainment Space-UI mit einem Continuation-Cluster mit noch nicht abgeschlossenen Empfehlungen von mehreren Partnern (derzeit ist nur eine Empfehlung sichtbar).

• Der Cluster Featured enthält eine Auswahl von Entitäten von mehreren Entwicklerpartnern in einer UI-Gruppierung. Es wird einen einzelnen hervorgehobenen Cluster geben, der oben auf der Benutzeroberfläche angezeigt wird und Priorität über allen Empfehlungsclustern hat. Jeder Entwicklerpartner darf bis zu 10 Entitäten im Cluster „Empfohlen“ senden.

  

  Abbildung 4: Entertainment Space-Benutzeroberfläche mit einem Cluster „Empfohlen“ mit Empfehlungen von mehreren Partnern (derzeit ist nur eine Empfehlung sichtbar).

Vorbereitung

Mindest-API-Level: 19

Füge deiner 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.4.0'
}

Weitere Informationen finden Sie 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
Fortsetzungs-Cluster	Höchstens 1	Höchstens 10
Hervorgehobener Cluster	Höchstens 1	Höchstens 10

Wichtig :Das Engage SDK hat die Media Home-Plattform ersetzt, die jetzt eingestellt wurde. Wenn du bereits eine Media Home-Integration hast, folge der Anleitung in Schritt 0, um deine Inhalte zum Engage SDK zu migrieren. Dadurch können sie auf mehr Geräten und Formfaktoren veröffentlicht werden. Wenden Sie sich an [e-mail]. Wenn Sie noch keine Media Home-Integration haben, fahren Sie mit Schritt 1 fort.

Schritt 0: Von der Media Home SDK-Integration migrieren

Datenmodelle aus vorhandener Integration zuordnen

Wenn Sie von einer bestehenden Media Home-Integration migrieren, finden Sie in der folgenden Tabelle Informationen dazu, wie Datenmodelle in vorhandenen SDKs dem neuen Engage SDK zugeordnet werden:

Äquivalent zur Integration von MediaHomeVideoContract	Entsprechung der Engage SDK-Integration
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 aufgeteilt: EventVideo, LiveStreamingVideo, Movie, TvEpisode, TvSeason, TvShow, VideoClipEntity
com.google.android.mediahome.video.PreviewProgram.Builder	In Builder in separaten Klassen unterteilt: EventVideo, LiveStreamingVideo, Movie, TvEpisode, TvSeason, TvShow, VideoClipEntity
com.google.android.mediahome.video.VideoContract	Wird nicht mehr benötigt.
com.google.android.mediahome.video.WatchNextProgram	In Attribute in separaten Klassen aufgeteilt: EventVideoEntity, LiveStreamingVideoEntity, MovieEntity, TvEpisodeEntity, TvSeasonEntity, TvShowEntity, VideoClipEntity
com.google.android.mediahome.video.WatchNextProgram.Builder	In Attribute in separaten Klassen aufgeteilt: 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äts-Veröffentlichung 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 wurden verschiedene Entitäten definiert, die die einzelnen Artikeltypen darstellen. Für die Kategorie „Watch“ werden die folgenden Entitäten unterstützt:

1. MovieEntity
2. TvShowEntity
3. TvSeasonEntity
4. TvEpisodeEntity
5. LiveStreamingVideoEntity
6. VideoClipEntity

Im folgenden Diagramm sind die Attribute und Anforderungen für die einzelnen Typen aufgeführt.

MovieEntity

Attribut	Voraussetzung	Hinweise
Name	Erforderlich
Posterbilder	Erforderlich	Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis bereitgestellt werden. Querformat wird bevorzugt, es wird jedoch empfohlen, je nach Szenario sowohl Bilder im Hoch- als auch im Querformat zu verwenden. Siehe Bildspezifikationen für eine Orientierungshilfe.
Wiedergabe-URI	Erforderlich	Der Deeplink zur Anbieter-App, über die die Wiedergabe des Films gestartet wird. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.
URI der Infoseite	Optional	Der Deeplink zur Anbieter-App, über die Details zum Film angezeigt werden Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.
Erscheinungsdatum	Erforderlich	In Millisekunden der Epoche.
Verfügbarkeit	Erforderlich	AVAILABLE: Die Inhalte stehen dem Nutzer ohne weitere Schritte zur Verfügung. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo erworben hat. PAID_CONTENT: Der Inhalt muss von einem 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, bitte folgen Sie dem Branchenstandard. (Beispiel)
Typ „Nächstes Video ansehen“	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet, und muss einer der folgenden vier Typen sein: WEITER: Der Nutzer hat bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen bestimmter Folgeninhalte angesehen, es ist aber eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei TV-Sendungen, aufgezeichneten Fußballspielen in einer Serie usw. WEITER: Der Nutzer hat sich eine oder mehrere vollständige Folgen bestimmter Serieninhalte angesehen. Es ist aber entweder mehr als eine Folge übrig oder genau eine Folge, bei der die letzte Folge nicht "NEU" ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. Merkliste: Der Nutzer hat explizit ausgewählt, einen Film, eine Veranstaltung oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes sehen möchte.
Zeitpunkt der letzten Interaktion	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden.
Zeitpunkt der letzten Wiedergabeposition	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und „WatchNextType“ auf WEITER gesetzt ist. In Millisekunden der Epoche.

TvShowEntity

Attribut	Voraussetzung	Hinweise
Name	Erforderlich
Posterbilder	Erforderlich	Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis bereitgestellt werden. Querformat wird bevorzugt, es wird jedoch empfohlen, je nach Szenario sowohl Bilder im Hoch- als auch im Querformat zu verwenden. Siehe Bildspezifikationen für eine Orientierungshilfe.
URI der Infoseite	Erforderlich	Der Deeplink zur Anbieter-App, über die die Details der Serie angezeigt werden Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.
Wiedergabe-URI	Optional	Der Deeplink zur Anbieter-App, um mit der Wiedergabe der Serie zu beginnen Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.
Ausstrahlungsdatum der ersten Folge	Erforderlich	In Millisekunden der Epoche.
Ausstrahlungsdatum der neuesten Folge	Optional	In Millisekunden der Epoche.
Verfügbarkeit	Erforderlich	AVAILABLE: Die Inhalte stehen dem Nutzer ohne weitere Schritte zur Verfügung. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo erworben hat. PAID_CONTENT: Der Inhalt muss von einem 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, bitte folgen Sie dem Branchenstandard. (Beispiel)
Typ „Nächstes Video ansehen“	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet, und muss einer der folgenden vier Typen sein: WEITER: Der Nutzer hat bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen bestimmter Folgeninhalte angesehen, es ist aber eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei TV-Sendungen, aufgezeichneten Fußballspielen in einer Serie usw. WEITER: Der Nutzer hat sich eine oder mehrere vollständige Folgen bestimmter Serieninhalte angesehen. Es ist aber entweder mehr als eine Folge übrig oder genau eine Folge, bei der die letzte Folge nicht "NEU" ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. Merkliste: Der Nutzer hat explizit ausgewählt, einen Film, eine Veranstaltung oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes sehen möchte.
Zeitpunkt der letzten Interaktion	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden.
Zeitpunkt der letzten Wiedergabeposition	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und „WatchNextType“ auf WEITER gesetzt ist. In Millisekunden der Epoche.

TvSeasonEntity

Attribut	Voraussetzung	Hinweise
Name	Erforderlich
Posterbilder	Erforderlich	Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis bereitgestellt werden. Querformat wird bevorzugt, es wird jedoch empfohlen, je nach Szenario sowohl Bilder im Hoch- als auch im Querformat zu verwenden. Siehe Bildspezifikationen für eine Orientierungshilfe.
URI der Infoseite	Erforderlich	Der Deeplink zur Anbieter-App zur Anzeige der Details zur Staffel der Serie Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.
Wiedergabe-URI	Optional	Der Deeplink zur Anbieter-App, über die die Staffel der Serie wiedergegeben wird Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.
Nummer der Staffel anzeigen	Optional Verfügbar in Version 1.3.1	String
Ausstrahlungsdatum der ersten Folge	Erforderlich	In Millisekunden der Epoche.
Ausstrahlungsdatum der neuesten Folge	Optional	In Millisekunden der Epoche.
Verfügbarkeit	Erforderlich	AVAILABLE: Die Inhalte stehen dem Nutzer ohne weitere Schritte zur Verfügung. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo erworben hat. PAID_CONTENT: Der Inhalt muss von einem 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, bitte folgen Sie dem Branchenstandard. (Beispiel)
Typ „Nächstes Video ansehen“	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet, und muss einer der folgenden vier Typen sein: WEITER: Der Nutzer hat bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen bestimmter Folgeninhalte angesehen, es ist aber eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei TV-Sendungen, aufgezeichneten Fußballspielen in einer Serie usw. WEITER: Der Nutzer hat sich eine oder mehrere vollständige Folgen bestimmter Serieninhalte angesehen. Es ist aber entweder mehr als eine Folge übrig oder genau eine Folge, bei der die letzte Folge nicht "NEU" ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. Merkliste: Der Nutzer hat explizit ausgewählt, einen Film, eine Veranstaltung oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes sehen möchte.
Zeitpunkt der letzten Interaktion	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden.
Zeitpunkt der letzten Wiedergabeposition	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und „WatchNextType“ auf WEITER gesetzt ist. In Millisekunden der Epoche.

TvEpisodeEntity

Attribut	Voraussetzung	Hinweise
Name	Erforderlich
Posterbilder	Erforderlich	Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis bereitgestellt werden. Querformat wird bevorzugt, es wird jedoch empfohlen, je nach Szenario sowohl Bilder im Hoch- als auch im Querformat zu verwenden. Siehe Bildspezifikationen für eine Orientierungshilfe.
Wiedergabe-URI	Erforderlich	Der Deeplink zur Anbieter-App, um mit der Wiedergabe der Folge zu beginnen. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.
URI der Infoseite	Optional	Der Deeplink zur Anbieter-App zur Anzeige von Details zur Folge der Serie. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen findest du in diesen FAQs.
Nummer der Folge anzeigen	Optional Verfügbar in Version 1.3.1	String
Ausstrahlungsdatum	Erforderlich	In Millisekunden der Epoche.
Verfügbarkeit	Erforderlich	AVAILABLE: Die Inhalte stehen dem Nutzer ohne weitere Schritte zur Verfügung. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo erworben hat. PAID_CONTENT: Der Inhalt muss von einem 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, bitte folgen Sie dem Branchenstandard. (Beispiel)
Typ „Nächstes Video ansehen“	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet, und muss einer der folgenden vier Typen sein: WEITER: Der Nutzer hat bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen bestimmter Folgeninhalte angesehen, es ist aber eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei TV-Sendungen, aufgezeichneten Fußballspielen in einer Serie usw. WEITER: Der Nutzer hat sich eine oder mehrere vollständige Folgen bestimmter Serieninhalte angesehen. Es ist aber entweder mehr als eine Folge übrig oder genau eine Folge, bei der die letzte Folge nicht "NEU" ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. Merkliste: Der Nutzer hat explizit ausgewählt, einen Film, eine Veranstaltung oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes sehen möchte.
Zeitpunkt der letzten Interaktion	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden.
Zeitpunkt der letzten Wiedergabeposition	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und „WatchNextType“ auf WEITER gesetzt ist. In Millisekunden der Epoche.

LiveStreamingVideoEntity

Attribut	Voraussetzung	Hinweise
Name	Erforderlich
Posterbilder	Erforderlich	Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis bereitgestellt werden. Querformat wird bevorzugt, es wird jedoch empfohlen, je nach Szenario sowohl Bilder im Hoch- als auch im Querformat zu verwenden. Siehe Bildspezifikationen für eine Orientierungshilfe.
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 findest du in diesen FAQs.
Broadcaster	Erforderlich	Freier Text
Beginn	Optional	In Millisekunden der Epoche.
Ende	Optional	In Millisekunden der Epoche.
Anzahl der Aufrufe	Optional	Freier Text, muss lokalisiert werden.
Typ „Nächstes Video ansehen“	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet, und muss einer der folgenden vier Typen sein: WEITER: Der Nutzer hat bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen bestimmter Folgeninhalte angesehen, es ist aber eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei TV-Sendungen, aufgezeichneten Fußballspielen in einer Serie usw. WEITER: Der Nutzer hat sich eine oder mehrere vollständige Folgen bestimmter Serieninhalte angesehen. Es ist aber entweder mehr als eine Folge übrig oder genau eine Folge, bei der die letzte Folge nicht "NEU" ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. Merkliste: Der Nutzer hat explizit ausgewählt, einen Film, eine Veranstaltung oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes sehen möchte.
Zeitpunkt der letzten Interaktion	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden.
Zeitpunkt der letzten Wiedergabeposition	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und „WatchNextType“ auf WEITER gesetzt ist. In Millisekunden der Epoche.

VideoClipEntity

Das VideoClipEntity-Objekt steht für eine Videoentität, die aus sozialen Medien wie TikTok oder YouTube stammt.

Attribut	Voraussetzung	Hinweise
Name	Erforderlich
Posterbilder	Erforderlich	Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis bereitgestellt werden. Querformat wird bevorzugt, es wird jedoch empfohlen, je nach Szenario sowohl Bilder im Hoch- als auch im Querformat zu verwenden. Siehe Bildspezifikationen für eine Orientierungshilfe.
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 findest du in diesen FAQs.
Datum und Uhrzeit der Erstellung	Erforderlich	In Millisekunden der Epoche.
Dauer	Erforderlich	Muss ein positiver Wert in Millisekunden sein.
Ersteller	Erforderlich	Freier Text
Bild des Erstellers	Optional	Bild des Creator-Avatars
Anzahl der Aufrufe	Optional	Freier Text, muss lokalisiert werden.
Typ „Nächstes Video ansehen“	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet, und muss einer der folgenden vier Typen sein: WEITER: Der Nutzer hat bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat sich alle verfügbaren Folgen bestimmter Folgeninhalte angesehen, es ist aber eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert bei TV-Sendungen, aufgezeichneten Fußballspielen in einer Serie usw. WEITER: Der Nutzer hat sich eine oder mehrere vollständige Folgen bestimmter Serieninhalte angesehen. Es ist aber entweder mehr als eine Folge übrig oder genau eine Folge, bei der die letzte Folge nicht "NEU" ist und veröffentlicht wurde, bevor der Nutzer mit der Wiedergabe der Inhalte begonnen hat. Merkliste: Der Nutzer hat explizit ausgewählt, einen Film, eine Veranstaltung oder eine Serie zu einer Merkliste hinzuzufügen, um manuell auszuwählen, was er als Nächstes sehen möchte.
Zeitpunkt der letzten Interaktion	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet. In Epochenmillisekunden.
Zeitpunkt der letzten Wiedergabeposition	Bedingt erforderlich	Muss angegeben werden, wenn sich das Element im Continuation-Cluster befindet und „WatchNextType“ auf WEITER gesetzt ist. In Millisekunden der Epoche.

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 Bilds 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 angeben

Wir empfehlen, den Job zur Inhaltsveröffentlichung im Hintergrund auszuführen (z. B. mit WorkManager) und regelmäßig oder ereignisbasiert zu planen (z. B. jedes Mal, wenn der Nutzer die App öffnet oder wenn er gerade etwas in den Einkaufswagen gelegt hat).

AppEngagePublishClient ist für die Veröffentlichung von Clustern verantwortlich. 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 der Inhalt auf dem Gerät angezeigt werden kann.

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

Hinweis: Wir empfehlen dringend, einen regelmäßigen Job auszuführen, um zu prüfen, ob der Dienst zu einem späteren Zeitpunkt verfügbar ist. Die Verfügbarkeit des Dienstes kann sich durch Upgrades der Android-Version, App-Upgrades, Installationen und Deinstallationen ändern. Durch regelmäßige Jobprüfungen in einem bestimmten Zeitintervall können Daten veröffentlicht werden, sobald der Dienst verfügbar ist.

publishRecommendationClusters

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

Wichtig: Die Publish-APIs sind Upsert-APIs. Sie ersetzen die vorhandenen Inhalte. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, wie dies von Natur aus bei den Publish-APIs der Fall ist.

Kotlin

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

Wenn der Dienst die Anfrage empfängt, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:

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

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

publishFeaturedCluster

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

Wichtig: Die Publish-APIs sind Upsert-APIs. Sie ersetzen die vorhandenen Inhalte. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, wie dies von Natur aus bei den Publish-APIs der Fall ist.

Kotlin

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

Wenn der Dienst die Anfrage empfängt, werden innerhalb einer Transaktion die folgenden Aktionen ausgeführt:

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

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

publishContinuationCluster

Diese API wird zum Veröffentlichen eines ContinuationCluster-Objekts verwendet.

Wichtig: Die Publish-APIs sind Upsert-APIs. Sie ersetzen die vorhandenen Inhalte. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, wie dies von Natur aus bei den Publish-APIs der Fall ist.

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

• Vorhandene ContinuationCluster-Daten des Entwicklerpartners werden entfernt.
• Die Daten aus der Anfrage werden geparst und im aktualisierten Continuation-Cluster gespeichert.

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

publishUserAccountManagementRequest

Dieses API wird zum Veröffentlichen einer Anmeldekarte verwendet . Durch die Anmeldeaktion werden Nutzer zur Anmeldeseite der App weitergeleitet, wo sie Inhalte veröffentlichen oder personalisiertere Inhalte bereitstellen kann.

Die folgenden Metadaten sind Teil der Anmeldekarte:

Attribut	Voraussetzung	Beschreibung
Aktions-URI	Erforderlich	Deeplink zur Aktion (d.h. Weiterleitung zur Anmeldeseite der App)
Bild	Optional – Wenn nicht angegeben, muss ein Titel angegeben werden.	Bild auf der Karte Bilder mit einem Seitenverhältnis von 16:9 und einer Auflösung von 1.264 x 712
Titel	Optional – Wenn nicht angegeben, muss das Bild zur Verfügung gestellt werden	Titel der Karte
Aktionstext	Optional	Text im CTA (z.B. „Anmeldung“)
Untertitel	Optional	Optionaler Untertitel auf der Karte

Wichtig: Die Publish-APIs sind Upsert-APIs. Sie ersetzen die vorhandenen Inhalte. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, wie dies von Natur aus bei den Publish-APIs der Fall ist.

Kotlin

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Wenn der Dienst die Anfrage empfängt, werden 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.

Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

updatePublishStatus

Falls aus internen geschäftlichen Gründen keiner der Cluster veröffentlicht wird, empfehlen wir dringend, den Veröffentlichungsstatus mithilfe der updatePublishStatus API zu aktualisieren. Das ist aus folgenden Gründen wichtig :

• Die Angabe des Status ist in allen Szenarien wichtig, selbst wenn der Inhalt veröffentlicht wird (STATUS = VERÖFFENTLICHT), um Dashboards mit diesem expliziten Status auszufüllen, um den Zustand und andere Messwerte Ihrer Integration zu vermitteln.
• Wenn kein Inhalt veröffentlicht ist, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google verhindern, dass Benachrichtigungen in den Dashboards zum Anwendungszustand ausgelöst werden. Damit wird bestätigt, dass Inhalte aufgrund einer aus Sicht des Anbieters erwarteten Situation nicht veröffentlicht werden.
• Es hilft Entwicklern, zu verstehen, 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 den App-Inhalt sehen oder überwinden können.

Die Liste der zulässigen Veröffentlichungsstatuscodes lautet :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

Wenn die Inhalte nicht veröffentlicht werden, weil ein Nutzer nicht angemeldet ist, empfiehlt Google, die Anmeldekarte zu veröffentlichen. Wenn Anbieter die Anmeldekarte aus irgendeinem Grund nicht veröffentlichen können, empfehlen wir, die updatePublishStatus API mit dem Statuscode NOT_PUBLISHED_REQUIRES_SIGN_IN aufzurufen.

Kotlin

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationClusters

Diese API wird zum Löschen des Inhalts von Empfehlungsclustern verwendet.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte zum Veröffentlichen vorhanden sind. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, da dies von Natur aus bei den Publish-APIs der Fall ist. Wenden Sie sich vor der Verwendung von APIs zum Löschen an responsive-developers@.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus den Empfehlungsclustern entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

Hinweis: Diese API ist ab Version 1.1.0 verfügbar.

deleteFeaturedCluster

Diese API wird zum Löschen des Inhalts des hervorgehobenen Clusters verwendet.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte zum Veröffentlichen vorhanden sind. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, da dies von Natur aus bei den Publish-APIs der Fall ist. Wenden Sie sich vor der Verwendung von APIs zum Löschen an responsive-developers@.

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 vorhandene Status beibehalten.

Hinweis: Diese API ist ab Version 1.1.0 verfügbar.

deleteContinuationCluster

Diese API wird zum Löschen des Inhalts des Fortsetzungsclusters verwendet.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte zum Veröffentlichen vorhanden sind. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, da dies von Natur aus bei den Publish-APIs der Fall ist. Wenden Sie sich vor der Verwendung von APIs zum Löschen an responsive-developers@.

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem Fortsetzungscluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

Hinweis: Diese API ist ab Version 1.1.0 verfügbar.

deleteUserManagementCluster

Diese API wird zum Löschen des Inhalts des UserAccountManagement-Clusters verwendet.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte zum Veröffentlichen vorhanden sind. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, da dies von Natur aus bei den Publish-APIs der Fall ist. Wenden Sie sich vor der Verwendung von APIs zum Löschen an responsive-developers@.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem UserAccountManagement-Cluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.

Hinweis: Diese API ist ab Version 1.1.0 verfügbar.

deleteClusters

Diese API wird zum Löschen des Inhalts eines bestimmten Clustertyps verwendet.

Wichtig :Delete APIs sollten nur aufgerufen werden, wenn keine Inhalte zum Veröffentlichen vorhanden sind. Rufen Sie im Anschluss die APIs „delete“ und „publish“ nicht auf, um den Inhalt zu ersetzen, da dies von Natur aus bei den Publish-APIs der Fall ist. Wenden Sie sich vor der Verwendung von APIs zum Löschen an responsive-developers@.

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

Fehlerbehandlung

Es wird dringend empfohlen, das Aufgabenergebnis der Publish-APIs zu beobachten, damit eine Folgeaktion ergriffen 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 mit der Ursache als Fehlercode zurückgegeben.

Fehlercode	Hinweis
SERVICE_NOT_FOUND	Der Dienst ist auf dem angegebenen Gerät nicht verfügbar.
SERVICE_NOT_AVAILABLE	Der Dienst ist auf dem jeweiligen Gerät verfügbar, aber zum Zeitpunkt des Aufrufs nicht verfügbar (z. B. weil er explizit deaktiviert wurde).
SERVICE_CALL_EXECUTION_FAILURE	Die Taskausführung ist aufgrund von Threading-Problemen fehlgeschlagen. In diesem Fall kann ein neuer Versuch unternommen werden.
SERVICE_CALL_PERMISSION_DENIED	Der Aufrufer ist nicht berechtigt, den Dienstaufruf zu tätigen.
SERVICE_CALL_INVALID_ARGUMENT	Die Anfrage enthält ungültige Daten, z. B. mehr als die zulässige Anzahl von Clustern.
SERVICE_CALL_INTERNAL	Auf der Dienstseite ist ein Fehler aufgetreten.
SERVICE_CALL_RESOURCE_EXHAUSTED	Der Dienstaufruf erfolgt zu häufig.

Schritt 3: Broadcast-Intents verarbeiten

Neben Aufrufen der API zur Veröffentlichung von Inhalten über einen Job ist es auch erforderlich, eine BroadcastReceiver einzurichten, um die Anfrage für eine Inhaltsveröffentlichung zu empfangen.

Der Zweck von Broadcast-Intents besteht hauptsächlich darin, Apps zu reaktivieren und die Datensynchronisierung zu erzwingen. Broadcast-Intents sind nicht darauf ausgelegt, sehr häufig zu senden. Sie wird nur ausgelöst, wenn der Engage-Dienst feststellt, dass der Inhalt möglicherweise veraltet ist (z. B. eine Woche alt). Auf diese Weise wird dem Nutzer mehr Sicherheit bei der Nutzung neuer Inhalte geboten, auch wenn die Anwendung über einen längeren Zeitraum hinweg nicht ausgeführt wurde.

BroadcastReceiver muss auf zwei Arten eingerichtet werden:

• Registrieren Sie mit Context.registerReceiver() eine Instanz der BroadcastReceiver-Klasse dynamisch. 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 mit dem Tag <receiver> in der Datei AndroidManifest.xml statisch. Die Anwendung kann dann Broadcast-Intents empfangen, wenn sie nicht ausgeführt wird, und die Inhalte können veröffentlicht werden.

<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, einen publishRecommendationClusters-Aufruf zu starten, wenn dieser Intent empfangen wird.
• com.google.android.engage.action.PUBLISH_FEATURED Es wird empfohlen, einen publishFeaturedCluster-Aufruf zu starten, wenn dieser Intent empfangen wird.
• com.google.android.engage.action.PUBLISH_CONTINUATION Es wird empfohlen, einen publishContinuationCluster-Aufruf zu starten, wenn dieser Intent empfangen wird.

Integrationsworkflow

Eine detaillierte Anleitung zum Prüfen der Einbindung nach Abschluss finden Sie unter Workflow für die Entwicklerintegration.

Häufig gestellte Fragen

Weitere Informationen findest du in den häufig gestellten Fragen zum Engage SDK.

Kontakt

Wenden Sie sich an [e-mail], wenn während des Integrationsprozesses Fragen auftreten.

Nächste Schritte

Nach Abschluss dieser Integration sind deine nächsten Schritte:

• Senden Sie eine E-Mail an [e-mail] und hängen Sie Ihr integriertes APK an, das zum Testen durch Google bereit ist.
• Google führt eine interne Überprüfung durch, um sicherzustellen, dass die Integration wie erwartet funktioniert. Falls Änderungen erforderlich sind, werden Sie von Google über die erforderlichen Details informiert.
• Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, werden Sie von Google darüber informiert, dass Sie mit der Veröffentlichung des aktualisierten und integrierten APKs im Play Store beginnen können.
• Nachdem Google bestätigt hat, dass Ihr aktualisiertes APK im Play Store veröffentlicht wurde, können die Cluster Empfehlung, Empfohlen und Fortsetzung veröffentlicht und für Nutzer sichtbar sein.