Sie können die App-Interaktion steigern, indem Sie Ihre Nutzer dort erreichen, wo sie sich gerade befinden. Mit dem Engage SDK kannst du Inhalte zum Fortsetzen der Wiedergabe und personalisierte Empfehlungen direkt auf verschiedenen On-Device-Oberflächen präsentieren, zum Beispiel in Sammlungen, in Entertainment Space und im Google Play Store. Die Integration vergrößert das APK im Durchschnitt um weniger als 50 KB (komprimiert) und dauert bei den meisten Apps etwa eine Woche. Weitere Informationen finden Sie auf unserer Unternehmenswebsite.
Dieser Leitfaden enthält eine Anleitung für Entwicklerpartner, wie sie ihre Videoinhalte mithilfe des Engage SDK in diesen neuen Bereich und in bestehende Google-Bereiche einbinden können.
Unterstützung von Kategorien und Oberflächen
Die Berechtigung für die Engage SDK-Oberfläche richtet sich nach der Inhaltskategorie Ihrer App. Anhand der folgenden Tabelle können Sie feststellen, ob Sie die Voraussetzungen für bestimmte Oberflächen erfüllen:
| Status | Inhaltskategorie oder Anwendungsfall | Unterstützte Oberflächen |
|---|---|---|
|
Unterstützt (Auf allen Oberflächen verfügbar) |
|
|
|
Teilweise unterstützt (Auf einigen Oberflächen verfügbar) |
|
|
| Nicht unterstützt |
|
Android-Fähigkeiten
Auf GitHub ansehenEngage SDK einbinden
android skills add engage-sdk-integrationIntegrationsdetails
In diesem Abschnitt werden die Schritte, Datenmodelle und die Terminologie beschrieben, die für die Einbindung des Engage SDK für Videoinhalte erforderlich sind.
Terminologie
Diese Integration umfasst die folgenden drei Clustertypen: Empfehlung, Fortsetzung und Empfohlen.
Empfehlungscluster enthalten personalisierte Vorschläge für Inhalte, die sich Nutzer ansehen können, von einem einzelnen 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 von einem einzelnen Partner. Entität: Ein Objekt, das ein einzelnes Element in einem Cluster darstellt. Eine Entität kann ein Film, eine TV-Sendung, eine TV-Serie, ein Live-Video und mehr sein. Eine Liste der unterstützten Entitätstypen finden Sie im Abschnitt Entitätsdaten bereitstellen.
Abbildung 2. Entertainment Space-Benutzeroberfläche mit einer einzelnen Entität im Empfehlungscluster eines einzelnen Partners.
Im Cluster Fortsetzen werden unvollendete 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 zusammen mit personalisierten Fortsetzungsinhalten das beste Nutzer-Engagement erzielen.
Abbildung 3. Entertainment Space-Benutzeroberfläche mit einem Fortsetzungscluster mit unvollständigen Empfehlungen von mehreren Partnern (derzeit ist nur eine Empfehlung sichtbar). Der Cluster Empfohlen zeigt eine Auswahl von Entitäten von mehreren Entwicklerpartnern in einer UI-Gruppierung an. Es gibt einen einzelnen Cluster „Empfohlen“, der im oberen Bereich der Benutzeroberfläche mit einer Prioritätsplatzierung über allen Empfehlungsclustern angezeigt wird. Jeder Entwicklerpartner darf bis zu 10 Entitäten im Cluster „Empfohlen“ übertragen.
Abbildung 4: Entertainment Space-Benutzeroberfläche mit einem Cluster „Empfohlen“ mit Empfehlungen von mehreren Partnern (derzeit ist nur eine Empfehlung sichtbar).
Vorarbeit
Mindest-API-Level: 19
Fügen Sie die Bibliothek com.google.android.engage:engage-core zu Ihrer App hinzu:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.6.0'
}
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 Anzahl von Entitäten in einem Cluster |
|---|---|---|
| Cluster mit Empfehlungen | Höchstens 7 | Höchstens 50 |
| Fortsetzungscluster | Höchstens 1 | Höchstens 20 |
| Empfohlener Cluster | Höchstens 1 | Höchstens 20 |
Schritt 0: Migration von einer vorhandenen Media Home SDK-Integration
In diesem Abschnitt wird beschrieben, wie Sie Ihre vorhandenen Media Home SDK-Datenmodelle und API-Aufrufe zum Engage SDK migrieren.
Datenmodelle aus vorhandener Integration zuordnen
Wenn du von einer vorhandenen Media Home-Integration migrierst, findest du in der folgenden Tabelle Informationen dazu, wie du Datenmodelle in vorhandenen SDKs dem neuen Engage SDK zuordnest:
| Äquivalent zur MediaHomeVideoContract-Integration | Äquivalent zur 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 unterteilt: EventVideo, LiveStreamingVideo, Movie, TvEpisode, TvSeason, TvShow, VideoClipEntity
|
com.google.android.mediahome.video.PreviewProgram.Builder
|
Unterteilt in Builder in separaten Klassen: 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 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 |
Vergleich von Publishing-Clustern im Media Home SDK und im Engage SDK
Beim 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 die Veröffentlichung von Clustern und Entitäten in einem einzigen API-Aufruf kombiniert. Alle Entitäten, die zu einem Cluster gehören, werden zusammen mit diesem Cluster veröffentlicht:
Kotlin
RecommendationCluster.Builder()
.addEntity(MOVIE_ENTITY)
.addEntity(MOVIE_ENTITY)
.addEntity(MOVIE_ENTITY)
.setTitle("Top Picks For You")
.build()
Java
new RecommendationCluster.Builder()
.addEntity(MOVIE_ENTITY)
.addEntity(MOVIE_ENTITY)
.addEntity(MOVIE_ENTITY)
.setTitle("Top Picks For You")
.build();
Schritt 1: Daten zum Rechtssubjekt angeben
Im SDK sind verschiedene Entitäten definiert, die die einzelnen Artikeltypen darstellen. Wir unterstützen die folgenden Entitäten für die Kategorie „Ansehen“:
In der folgenden Tabelle sind die Attribute und Anforderungen für die einzelnen Typen aufgeführt.
MovieEntity
| Attribut | Anforderung | Hinweise |
|---|---|---|
| Name | Erforderlich | |
| Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis angegeben werden. (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 Bildspezifikationen. |
| Wiedergabe-URI | Für Mobilgeräte 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 diesen FAQs. |
| Plattformspezifische Wiedergabe-URIs | Optional für Mobilgeräte; erforderlich für Google TV |
Plattformspezifische Deeplinks zur App des Anbieters, um die Wiedergabe des Films zu starten. |
| URI der Infoseite | Optional |
Der Deeplink zur Anbieter-App, über den Details zum Film angezeigt werden. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in diesen FAQs. |
| Erscheinungsdatum | Optional | In Epochen-Millisekunden. |
| Verfügbarkeit | Optional | AVAILABLE: Der Inhalt ist für den Nutzer ohne weitere Maßnahmen verfügbar. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo abgeschlossen hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. PURCHASED: Der Inhalt wurde vom Nutzer gekauft oder ausgeliehen. |
| Angebotspreis | Optional | Freier Text |
| Dauer | Erforderlich | In Millisekunden. |
| Genre | Optional | Freier Text |
| Altersfreigaben | Optional | Freitext, der dem Branchenstandard entspricht. (Beispiel) |
| Call-to-Action-Text | Optional | Freitext, der als Call-to-Action angezeigt werden soll. |
| Tags | Optional | Liste der mit der Entität verknüpften Tags. |
| Typ „Empfohlene Videos“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: CONTINUE: Der Nutzer hat sich bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat alle verfügbaren Folgen einer Serie angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert für episodische Inhalte wie TV-Sendungen oder aufgezeichnete Fußballspiele in einer Serie. WEITER: Der Nutzer hat eine oder mehrere vollständige Folgen eines episodischen Inhalts angesehen, aber es gibt entweder mehr als eine Folge oder genau eine Folge, wobei die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit dem Ansehen des episodischen Inhalts begonnen hat. MERKLISTE: Der Nutzer hat einen Film, ein Event oder eine Serie explizit 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 Fortsetzungscluster befindet. In Epochen-Millisekunden. |
| Zeitpunkt der letzten Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Cluster „Fortsetzen“ befindet und WatchNextType den Wert CONTINUE hat. In Epochen-Millisekunden. |
TvShowEntity
| Attribut | Anforderung | Hinweise |
|---|---|---|
| Name | Erforderlich | |
| Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis angegeben werden. (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 Bildspezifikationen. |
| URI der Infoseite | Erforderlich |
Der Deeplink zur Anbieter-App, um die Details der TV-Sendung anzuzeigen. Hinweis: Sie können Deeplinks für die Attribution 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 diesen FAQs. |
| Plattformspezifische Wiedergabe-URIs | Optional für Mobilgeräte; erforderlich für Google TV |
Plattformspezifische Deeplinks zur App des Anbieters, um die Wiedergabe der TV-Sendung zu starten. |
| Ausstrahlungsdatum der ersten Folge | Optional | In Epochen-Millisekunden. |
| Ausstrahlungsdatum der neuesten Folge | Optional | In Epochen-Millisekunden. |
| Verfügbarkeit | Optional | AVAILABLE: Der Inhalt ist für den Nutzer ohne weitere Maßnahmen verfügbar. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo abgeschlossen hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. PURCHASED: Der Inhalt wurde vom Nutzer gekauft oder ausgeliehen. |
| Angebotspreis | Optional | Freier Text |
| Anzahl der Staffeln | Optional | Positive Ganzzahl |
| Genre | Optional | Freier Text |
| Altersfreigaben | Optional | Freitext, der dem Branchenstandard entspricht. (Beispiel) |
| Call-to-Action-Text | Optional | Freitext, der als Call-to-Action angezeigt werden soll. |
| Tags | Optional | Liste der mit der Entität verknüpften Tags. |
| Typ „Empfohlene Videos“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: CONTINUE: Der Nutzer hat sich bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat alle verfügbaren Folgen einer Serie angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert für episodische Inhalte wie TV-Sendungen oder aufgezeichnete Fußballspiele in einer Serie. WEITER: Der Nutzer hat eine oder mehrere vollständige Folgen eines episodischen Inhalts angesehen, aber es gibt entweder mehr als eine Folge oder genau eine Folge, wobei die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit dem Ansehen des episodischen Inhalts begonnen hat. MERKLISTE: Der Nutzer hat einen Film, ein Event oder eine Serie explizit 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 Fortsetzungscluster befindet. In Epochen-Millisekunden. |
| Zeitpunkt der letzten Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Cluster „Fortsetzen“ befindet und WatchNextType den Wert CONTINUE hat. In Epochen-Millisekunden. |
TvSeasonEntity
| Attribut | Anforderung | Hinweise |
|---|---|---|
| Name | Erforderlich | |
| Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis angegeben werden. (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 Bildspezifikationen. |
| URI der Infoseite | Erforderlich |
Der Deeplink zur Anbieter-App, um die Details der Staffel der Serie anzuzeigen. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in diesen FAQs. |
| Wiedergabe-URI | Optional |
Der Deeplink zur Anbieter-App, um die Wiedergabe der Staffel der Serie zu starten. 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 |
| Ausstrahlungsdatum der ersten Folge | Optional | In Epochen-Millisekunden. |
| Ausstrahlungsdatum der neuesten Folge | Optional | In Epochen-Millisekunden. |
| Verfügbarkeit | Optional | AVAILABLE: Der Inhalt ist für den Nutzer ohne weitere Maßnahmen verfügbar. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo abgeschlossen hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. PURCHASED: Der Inhalt wurde vom Nutzer gekauft oder ausgeliehen. |
| Angebotspreis | Optional | Freier Text |
| Anzahl der Folgen | Optional | Positive Ganzzahl |
| Genre | Optional | Freier Text |
| Altersfreigaben | Optional | Freitext, der dem Branchenstandard entspricht. (Beispiel) |
| Call-to-Action-Text | Optional | Freitext, der als Call-to-Action angezeigt werden soll. |
| Tags | Optional | Liste der mit der Entität verknüpften Tags. |
| Typ „Empfohlene Videos“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: CONTINUE: Der Nutzer hat sich bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat alle verfügbaren Folgen einer Serie angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert für episodische Inhalte wie TV-Sendungen oder aufgezeichnete Fußballspiele in einer Serie. WEITER: Der Nutzer hat eine oder mehrere vollständige Folgen eines episodischen Inhalts angesehen, aber es gibt entweder mehr als eine Folge oder genau eine Folge, wobei die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit dem Ansehen des episodischen Inhalts begonnen hat. MERKLISTE: Der Nutzer hat einen Film, ein Event oder eine Serie explizit 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 Fortsetzungscluster befindet. In Epochen-Millisekunden. |
| Zeitpunkt der letzten Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Cluster „Fortsetzen“ befindet und WatchNextType den Wert CONTINUE hat. In Epochen-Millisekunden. |
TvEpisodeEntity
| Attribut | Anforderung | Hinweise |
|---|---|---|
| Name | Erforderlich | |
| Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis angegeben werden. (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 Bildspezifikationen. |
| Wiedergabe-URI | Für Mobilgeräte 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 diesen FAQs. |
| Plattformspezifische Wiedergabe-URIs | Optional für Mobilgeräte; erforderlich für Google TV |
Plattformspezifische Deeplinks zur App des Anbieters, um die Wiedergabe der Folge zu starten. |
| URI der Infoseite | Optional |
Der Deeplink zur Anbieter-App, um Details zur Folge der TV-Serie anzuzeigen. Hinweis: Sie können Deeplinks für die Attribution verwenden. Weitere Informationen finden Sie in diesen FAQs. |
| Titel einblenden | Optional für Mobilgeräte; erforderlich für „Weiter ansehen“ auf Google TV | Titel der übergeordneten TV-Serie der Folge. |
| Nummer der Staffel | Optional für Mobilgeräte; erforderlich für „Weiter ansehen“ auf Google TV | String |
| Nummer der Folge anzeigen |
Optional für Mobilgeräte; erforderlich für „Weiter ansehen“ auf Google TV Verfügbar in Version 1.3.1 |
String |
| Ausstrahlungsdatum | Optional | In Epochen-Millisekunden. |
| Verfügbarkeit | Optional | AVAILABLE: Der Inhalt ist für den Nutzer ohne weitere Maßnahmen verfügbar. FREE_WITH_SUBSCRIPTION: Der Inhalt ist verfügbar, nachdem der Nutzer ein Abo abgeschlossen hat. PAID_CONTENT: Der Inhalt muss vom Nutzer gekauft oder ausgeliehen werden. PURCHASED: Der Inhalt wurde vom Nutzer gekauft oder ausgeliehen. |
| Angebotspreis | Optional | Freier Text |
| Dauer | Erforderlich | Muss ein positiver Wert in Millisekunden sein. |
| Genre | Optional | Freier Text |
| Altersfreigaben | Optional | Freitext, der dem Branchenstandard entspricht. (Beispiel) |
| Call-to-Action-Text | Optional | Freitext, der als Call-to-Action angezeigt werden soll. |
| Tags | Optional | Liste der mit der Entität verknüpften Tags. |
| Typ „Empfohlene Videos“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: CONTINUE: Der Nutzer hat sich bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat alle verfügbaren Folgen einer Serie angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert für episodische Inhalte wie TV-Sendungen oder aufgezeichnete Fußballspiele in einer Serie. WEITER: Der Nutzer hat eine oder mehrere vollständige Folgen eines episodischen Inhalts angesehen, aber es gibt entweder mehr als eine Folge oder genau eine Folge, wobei die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit dem Ansehen des episodischen Inhalts begonnen hat. MERKLISTE: Der Nutzer hat einen Film, ein Event oder eine Serie explizit 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 Fortsetzungscluster befindet. In Epochen-Millisekunden. |
| Zeitpunkt der letzten Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Cluster „Fortsetzen“ befindet und WatchNextType den Wert CONTINUE hat. In Epochen-Millisekunden. |
LiveStreamingVideoEntity
| Attribut | Anforderung | Hinweise |
|---|---|---|
| Name | Erforderlich | |
| Posterbilder | Erforderlich | Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis angegeben werden. (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 Bildspezifikationen. |
| Wiedergabe-URI | Für Mobilgeräte 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 diesen FAQs. |
| Plattformspezifische Wiedergabe-URIs | Optional für Mobilgeräte; erforderlich für Google TV |
Plattformspezifische Deeplinks zur Anbieter-App, um die Wiedergabe des Videos zu starten. |
| Broadcaster | Optional | Freier Text |
| Beginn | Optional | In Epochen-Millisekunden. |
| Ende | Optional | In Epochen-Millisekunden. |
| Anzahl der Aufrufe | Optional | Freier Text, muss lokalisiert werden. |
| Call-to-Action-Text | Optional | Freitext, der als Call-to-Action angezeigt werden soll. |
| Tags | Optional | Liste der mit der Entität verknüpften Tags. |
| Typ „Empfohlene Videos“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: CONTINUE: Der Nutzer hat sich bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat alle verfügbaren Folgen einer Serie angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert für episodische Inhalte wie TV-Sendungen oder aufgezeichnete Fußballspiele in einer Serie. WEITER: Der Nutzer hat eine oder mehrere vollständige Folgen eines episodischen Inhalts angesehen, aber es gibt entweder mehr als eine Folge oder genau eine Folge, wobei die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit dem Ansehen des episodischen Inhalts begonnen hat. MERKLISTE: Der Nutzer hat einen Film, ein Event oder eine Serie explizit 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 Fortsetzungscluster befindet. In Epochen-Millisekunden. |
| Zeitpunkt der letzten Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Cluster „Fortsetzen“ befindet und WatchNextType den Wert CONTINUE hat. 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 | Mindestens ein Bild ist erforderlich und muss mit einem Seitenverhältnis angegeben werden. (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 Bildspezifikationen. |
| Wiedergabe-URI | Für Mobilgeräte 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 diesen FAQs. |
| Plattformspezifische Wiedergabe-URIs | Optional für Mobilgeräte; erforderlich für Google TV |
Plattformspezifische Deeplinks zur Anbieter-App, um die Wiedergabe des Videos zu starten. |
| Erstellt um | Optional | In Epochen-Millisekunden. |
| Dauer | Erforderlich | Muss ein positiver Wert in Millisekunden sein. |
| Ersteller | Optional | Freier Text |
| Bild des Creators | Optional | Bild des Creator-Avatars |
| Anzahl der Aufrufe | Optional | Freier Text, muss lokalisiert werden. |
| Call-to-Action-Text | Optional | Freitext, der als Call-to-Action angezeigt werden soll. |
| Tags | Optional | Liste der mit der Entität verknüpften Tags. |
| Typ „Empfohlene Videos“ | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Fortsetzungscluster befindet, und muss einen der folgenden vier Typen haben: CONTINUE: Der Nutzer hat sich bereits mehr als 1 Minute dieses Inhalts angesehen. NEU: Der Nutzer hat alle verfügbaren Folgen einer Serie angesehen, aber es ist eine neue Folge verfügbar und es gibt genau eine nicht angesehene Folge. Das funktioniert für episodische Inhalte wie TV-Sendungen oder aufgezeichnete Fußballspiele in einer Serie. WEITER: Der Nutzer hat eine oder mehrere vollständige Folgen eines episodischen Inhalts angesehen, aber es gibt entweder mehr als eine Folge oder genau eine Folge, wobei die letzte Folge nicht „NEU“ ist und veröffentlicht wurde, bevor der Nutzer mit dem Ansehen des episodischen Inhalts begonnen hat. MERKLISTE: Der Nutzer hat einen Film, ein Event oder eine Serie explizit 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 Fortsetzungscluster befindet. In Epochen-Millisekunden. |
| Zeitpunkt der letzten Wiedergabeposition | Bedingt erforderlich | Muss angegeben werden, wenn sich das Element im Cluster „Fortsetzen“ befindet und WatchNextType den Wert CONTINUE hat. In Epochen-Millisekunden. |
Bildspezifikationen
Im folgenden Abschnitt finden Sie die erforderlichen Spezifikationen für Bild-Assets:
Dateiformate
PNG, JPG, statisches GIF, WebP
Maximale Dateigröße
5.120 KB
Zusätzliche Empfehlungen
- Bildbereich:Platzieren Sie wichtige Inhalte in den mittleren 80% des Bildes.
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)
.setCallToActionText("Watch Now")
.addTag("Action")
.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)
.setCallToActionText("Watch Now")
.addTag("Action")
.build();
Schritt 2: Clusterdaten angeben
Es wird empfohlen, den Job zur Veröffentlichung von Inhalten im Hintergrund auszuführen (z. B. mit WorkManager) und regelmäßig oder ereignisbasiert zu planen (z. B. jedes Mal, wenn der Nutzer die App öffnet oder wenn er gerade etwas in den Einkaufswagen gelegt hat).
AppEngagePublishClient ist für die Veröffentlichung von Clustern verantwortlich. Die folgenden APIs sind im Client verfügbar:
isServiceAvailablepublishRecommendationClusterspublishFeaturedClusterpublishContinuationClusterpublishUserAccountManagementRequestupdatePublishStatusdeleteRecommendationsClustersdeleteFeaturedClusterdeleteContinuationClusterdeleteUserManagementClusterdeleteClusters
isServiceAvailable
Mit dieser API wird geprüft, ob der Dienst für die Integration verfügbar ist und ob die Inhalte auf dem Gerät präsentiert werden können.
Für Engage SDK Version 1.6.0 und höher (empfohlen)
Android-Fähigkeiten
Auf GitHub ansehenEngage SDK-Integration
android skills add engage-sdk-integrationUse the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.Sie können die Dienstverfügbarkeit für jeden Clustertyp prüfen, den Sie veröffentlichen möchten. Die isServiceAvailable API akzeptiert ein Anfrageobjekt, ServiceAvailabilityRequest, das die Clustertypen enthält, für die die Dienstverfügbarkeit geprüft werden muss. Die für ServiceAvailabilityRequest erforderlichen ClusterType-Enum-Werte finden Sie in der folgenden Tabelle.
| Clustertyp | Clustertypkonstante | Ganzzahlwert |
|---|---|---|
| Unbekannt | TYPE_UNKNOWN |
0 |
| Empfehlungscluster | TYPE_RECOMMENDATION |
1 |
| Empfohlener Cluster | TYPE_FEATURED |
2 |
| Fortsetzungscluster | TYPE_CONTINUATION |
3 |
| Nutzerverwaltungscluster | TYPE_ENGAGEMENT |
8 |
| Abo-Cluster | TYPE_SUBSCRIPTION |
12 |
Kotlin
val request = ServiceAvailabilityRequest.Builder()
.addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
.addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
.build()
client.isServiceAvailable(request).addOnCompleteListener { task ->
if (task.isSuccessful) {
val availabilityMap = task.result
if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
// Proceed with publishing continuation content
}
if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
// Proceed with publishing recommendation content
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
}
Java
ServiceAvailabilityRequest request =
new ServiceAvailabilityRequest.Builder()
.addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
.addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
.build();
client.isServiceAvailable(request).addOnCompleteListener(task -> {
if (task.isSuccessful()) {
Map<Integer, Boolean> availabilityMap = task.getResult();
if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
// Proceed with publishing continuation content
}
if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
// Proceed with publishing recommendation content
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
});
Funktion für bedingte Dienstverfügbarkeit
Einige integrierte Apps erfordern eine spezielle Konfiguration, bei der der Engage-Dienst zeitweise aktiviert und deaktiviert wird, um die Kosten für die Bereitstellung zu senken. Diese Strategie der unregelmäßigen Contentaufnahme wirkt sich jedoch negativ auf die Nutzerfreundlichkeit aus: Veraltete Inhalte werden nicht präsentiert und einige Oberflächen werden nicht bedient.
Ab Version 1.6.0 kann mit dem Engage SDK die Verfügbarkeit für bestimmte Clustertypen geprüft werden. Wenn Ihre App die Aufnahme mit Unterbrechungen verwendet:
- Fortsetzungscluster (z. B. „Weiter ansehen“) bleiben auf allen unterstützten Geräten standardmäßig aktiviert.
- Andere Clustertypen (z. B. Empfehlungen) werden zeitweise aktiviert und deaktiviert.
Wenn diese Standardkonfiguration nicht Ihren Anforderungen entspricht, wenden Sie sich an engage-developers@google.com.
Für SDK-Versionen vor v1.6.0 (eingestellt)
Kotlin
client.isServiceAvailable.addOnCompleteListener { task ->
if (task.isSuccessful) {
// Handle IPC call success
if(task.result) {
// Service is available on the device, proceed with content publish
// calls.
} else {
// Service is not available, no further action is needed.
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
}
Java
client.isServiceAvailable().addOnCompleteListener(task - > {
if (task.isSuccessful()) {
// Handle success
if(task.getResult()) {
// Service is available on the device, proceed with content publish
// calls.
} else {
// Service is not available, no further action is needed.
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
});
publishRecommendationClusters
Diese API wird verwendet, um eine Liste von RecommendationCluster-Objekten zu veröffentlichen.
Kotlin
client.publishRecommendationClusters(
PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Top Picks For You")
.build()
)
.build()
)
Java
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
new RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Top Picks For You")
.build())
.build());
Wenn der Dienst die Anfrage empfängt, werden die folgenden Aktionen innerhalb einer Transaktion ausgeführt:
- Vorhandene
RecommendationCluster-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten Empfehlungscluster gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishFeaturedCluster
Diese API wird verwendet, um eine Liste von FeaturedCluster-Objekten zu veröffentlichen.
Kotlin
client.publishFeaturedCluster(
PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
FeaturedCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build())
Java
client.publishFeaturedCluster(
new PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
new FeaturedCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build());
Wenn der Dienst die Anfrage empfängt, werden die folgenden Aktionen innerhalb einer Transaktion ausgeführt:
- Vorhandene
FeaturedCluster-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten empfohlenen Cluster gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishContinuationCluster
Diese API wird verwendet, um ein ContinuationCluster-Objekt zu veröffentlichen.
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 die folgenden Aktionen innerhalb einer Transaktion ausgeführt:
- Vorhandene
ContinuationCluster-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten Fortsetzungscluster gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
publishUserAccountManagementRequest
Diese API wird verwendet, um eine Anmeldekarte zu veröffentlichen . Die Anmeldeaktion leitet Nutzer zur Anmeldeseite der App weiter, damit die App Inhalte veröffentlichen oder personalisierte Inhalte bereitstellen kann.
Die folgenden Metadaten sind Teil der Anmeldekarte:
| Attribut | Anforderung | Beschreibung |
|---|---|---|
| Aktions-URI | Erforderlich | Deeplink zur Aktion (z.B. zur Anmeldeseite der App) |
| Bild | Optional – wenn nicht angegeben, muss der Titel angegeben werden |
Auf der Karte angezeigtes Bild Bilder im Seitenverhältnis 16:9 mit einer Auflösung von 1264 × 712 |
| Titel | Optional – wenn nicht angegeben, muss ein Bild angegeben werden | Titel auf der Karte |
| Aktionstext | Optional | Text, der im CTA angezeigt wird (z.B. „Anmelden“) |
| Untertitel | Optional | Optionaler Untertitel auf der Karte |
Kotlin
var SIGN_IN_CARD_ENTITY =
SignInCardEntity.Builder()
.addPosterImage(
Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(500)
.setImageWidthInPixel(500)
.build())
.setActionText("Sign In")
.setActionUri(Uri.parse("http://xx.com/signin"))
.build()
client.publishUserAccountManagementRequest(
PublishUserAccountManagementRequest.Builder()
.setSignInCardEntity(SIGN_IN_CARD_ENTITY)
.build());
Java
SignInCardEntity SIGN_IN_CARD_ENTITY =
new SignInCardEntity.Builder()
.addPosterImage(
new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(500)
.setImageWidthInPixel(500)
.build())
.setActionText("Sign In")
.setActionUri(Uri.parse("http://xx.com/signin"))
.build();
client.publishUserAccountManagementRequest(
new PublishUserAccountManagementRequest.Builder()
.setSignInCardEntity(SIGN_IN_CARD_ENTITY)
.build());
Wenn der Dienst die Anfrage empfängt, werden die folgenden Aktionen innerhalb einer Transaktion ausgeführt:
- Vorhandene
UserAccountManagementCluster-Daten des Entwicklerpartners werden entfernt. - Die Daten aus der Anfrage werden geparst und im aktualisierten Cluster „UserAccountManagementCluster“ gespeichert.
Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
updatePublishStatus
Wenn aus internen geschäftlichen Gründen keiner der Cluster veröffentlicht wird, empfehlen wir dringend, den Veröffentlichungsstatus mit der API updatePublishStatus zu aktualisieren. Das ist aus folgenden Gründen wichtig :
- Die Angabe des Status in allen Szenarien, auch wenn der Inhalt veröffentlicht ist (STATUS == PUBLISHED), ist wichtig, um Dashboards zu füllen, die diesen expliziten Status verwenden, um den Zustand und andere Messwerte Ihrer Integration zu vermitteln.
- Wenn keine Inhalte veröffentlicht werden, der Integrationsstatus aber nicht fehlerhaft ist (STATUS == NOT_PUBLISHED), kann Google vermeiden, dass Benachrichtigungen in den Dashboards zum App-Zustand ausgelöst werden. Sie bestätigt, dass Inhalte aufgrund einer aus Sicht des Anbieters erwarteten Situation nicht veröffentlicht werden.
- So können Entwickler Informationen dazu bereitstellen, wann die Daten veröffentlicht werden und wann nicht.
- Google kann die Statuscodes verwenden, um den Nutzer zu bestimmten Aktionen in der App aufzufordern, damit er den App-Inhalt sehen oder das Problem beheben kann.
Die Liste der zulässigen Statuscodes für die Veröffentlichung lautet :
// Content is published
AppEngagePublishStatusCode.PUBLISHED,
// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,
// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,
// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,
// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,
// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,
// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,
// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,
// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER
Wenn die Inhalte nicht veröffentlicht werden, weil ein Nutzer nicht angemeldet ist, empfiehlt Google, die Anmeldekarte zu veröffentlichen. Wenn Anbieter aus irgendeinem Grund die Anmeldekarte 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());
deleteRecommendationsClusters
Diese API wird verwendet, um den Inhalt von Empfehlungsclustern zu löschen.
Kotlin
client.deleteRecommendationsClusters()
Java
client.deleteRecommendationsClusters();
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.
deleteFeaturedCluster
Diese API wird verwendet, um den Inhalt des empfohlenen Clusters zu löschen.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem empfohlenen Cluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteContinuationCluster
Diese API wird verwendet, um den Inhalt des Fortsetzungsclusters zu löschen.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem Fortsetzungscluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteUserManagementCluster
Diese API wird verwendet, um den Inhalt des UserAccountManagement-Clusters zu löschen.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Wenn der Dienst die Anfrage empfängt, werden die vorhandenen Daten aus dem UserAccountManagement-Cluster entfernt. Bei einem Fehler wird die gesamte Anfrage abgelehnt und der vorhandene Status beibehalten.
deleteClusters
Mit dieser API wird der Inhalt eines bestimmten Clustertyps gelöscht.
Kotlin
client.deleteClusters(
DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_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 vorhandene Status beibehalten.
Fehlerbehandlung
Es wird dringend empfohlen, das Ergebnis der Aufgabe von den Veröffentlichungs-APIs zu überwachen, damit eine Folgemaßnahme 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 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 nicht zum Zeitpunkt des Aufrufs (z. B. weil er explizit deaktiviert ist). |
3 |
SERVICE_CALL_EXECUTION_FAILURE |
Die Ausführung der Aufgabe ist aufgrund von Threading-Problemen fehlgeschlagen. In diesem Fall kann der Vorgang wiederholt werden. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Der Aufrufer ist nicht berechtigt, den Dienstaufruf auszuführen. |
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 |
Auf der Dienstseite ist ein Fehler aufgetreten. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Der Dienstaufruf wird zu häufig ausgeführt. |
Schritt 3: Broadcast-Intents verarbeiten
Zusätzlich zu Content API-Aufrufen zum Veröffentlichen von Inhalten über einen Job müssen Sie auch einen BroadcastReceiver einrichten, um die Anfrage für eine Inhaltsveröffentlichung zu erhalten.
Broadcast-Intents dienen hauptsächlich der Reaktivierung von Apps und der erzwungenen Datensynchronisierung. Broadcast-Intents sind nicht dafür gedacht, sehr häufig gesendet zu werden. Er wird nur ausgelöst, wenn der Engage-Dienst feststellt, dass der Inhalt möglicherweise veraltet ist (z. B. eine Woche alt). So ist es wahrscheinlicher, dass der Nutzer aktuelle Inhalte sieht, auch wenn die Anwendung längere Zeit nicht ausgeführt wurde.
BroadcastReceiver muss auf die folgenden zwei Arten eingerichtet werden:
Registrieren Sie eine Instanz der Klasse
BroadcastReceiverdynamisch mitContext.registerReceiver(). Dies ermöglicht die Kommunikation von Anwendungen, die noch im Speicher aktiv sind.
Kotlin
class AppEngageBroadcastReceiver : BroadcastReceiver(){
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger 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),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Featured Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Continuation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
}
Java
class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger 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),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
}
Deklarieren Sie eine Implementierung statisch mit dem
<receiver>-Tag in IhrerAndroidManifest.xml-Datei. Dadurch kann die Anwendung Broadcast-Intents empfangen, wenn sie nicht ausgeführt wird, und die Inhalte veröffentlichen.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
</intent-filter>
</receiver>
</application>
Die folgenden Intents werden vom Dienst gesendet:
com.google.android.engage.action.PUBLISH_RECOMMENDATIONEs wird empfohlen, einenpublishRecommendationClusters-Anruf zu starten, wenn dieser Intent empfangen wird.com.google.android.engage.action.PUBLISH_FEATUREDEs wird empfohlen, einenpublishFeaturedCluster-Anruf zu starten, wenn dieser Intent empfangen wird.com.google.android.engage.action.PUBLISH_CONTINUATIONEs wird empfohlen, einenpublishContinuationCluster-Anruf zu starten, wenn dieser Intent empfangen wird.
Integrationsworkflow
Eine detaillierte Anleitung zum Überprüfen der Integration nach Abschluss finden Sie unter Engage-Entwickler-Integrationsworkflow.
Häufig gestellte Fragen
Häufig gestellte Fragen zum Engage SDK
Kontakt
Wende dich an engage-developers@google.com, wenn du während des Integrationsprozesses Fragen hast.
Nächste Schritte
Nach Abschluss dieser Integration sind die nächsten Schritte:
- Senden Sie eine E-Mail an
engage-developers@google.comund hängen Sie Ihr 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, wird Google Sie mit den entsprechenden Details kontaktieren.
- Wenn die Tests abgeschlossen sind und keine Änderungen erforderlich sind, wirst du von Google benachrichtigt, dass du die aktualisierte und integrierte APK im Play Store veröffentlichen kannst.
- Nachdem Google bestätigt hat, dass dein aktualisiertes APK im Google Play Store veröffentlicht wurde, können deine Cluster Empfehlung, Empfohlen und Fortsetzung veröffentlicht und für Nutzer sichtbar gemacht werden.