Google sta creando una piattaforma sul dispositivo che organizza app per verticali e consente una nuova esperienza immersiva per la fruizione personalizzata dei contenuti delle app e scoperta. Questa esperienza a schermo intero offre ai partner sviluppatori l'opportunità di mostrare i migliori contenuti avanzati in un canale dedicato esterno della propria app.
Questa guida contiene le istruzioni per gli sviluppatori partner per integrare il proprio audio utilizzando l'SDK Engage per compilare sia questa nuova area piattaforme Google esistenti.
Dettagli integrazione
Terminologia
Questa integrazione include i seguenti tre tipi di cluster: Recommendation, Continuazione e In primo piano.
I cluster di consigli mostrano suggerimenti personalizzati per i contenuti da leggere di un singolo sviluppatore partner.
I consigli hanno la seguente struttura:
Cluster dei suggerimenti:una visualizzazione UI che contiene un gruppo di contenuti consigliati dallo stesso partner di sviluppo.
Figura 1. UI di Entertainment Space che mostra una Cluster di suggerimenti di un singolo partner. Entità: un oggetto che rappresenta un singolo elemento in un cluster. Un'entità può essere una playlist, un audiolibro, un podcast e altro ancora. Consulta le Dati delle entità per un elenco delle entità supportate di testo.
Figura 2. UI di Entertainment Space che mostra una singola Entità all'interno di un cluster di suggerimenti di un singolo partner.
Il cluster Continuazione mostra i contenuti audio coinvolti di recente dagli utenti di più sviluppatori partner in un unico raggruppamento di UI. Ogni sviluppatore partner potrà trasmettere un massimo di 10 entità in Cluster di continuazione.
Figura 3. UI di Entertainment Space che mostra una Cluster di continuazione con suggerimenti non completati da più partner (al momento è visibile un solo consiglio). Il cluster In primo piano mostra una selezione di elementi da più gli sviluppatori partner in un unico raggruppamento di UI. Ci sarà un singolo In primo piano cluster, che verrà visualizzato nella parte superiore della UI con priorità il posizionamento migliore rispetto a tutti i cluster di suggerimenti. Ogni sviluppatore partner autorizzato a trasmettere fino a 10 entità nel cluster In primo piano.
Figura 4. UI di Entertainment Space che mostra un elemento In primo piano cluster con suggerimenti di più partner (solo uno consiglio è attualmente visibile).
Attività preliminare
Livello API minimo: 19
Aggiungi la raccolta com.google.android.engage:engage-core
alla tua app:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.5.2'
}
Riepilogo
La progettazione si basa sull'implementazione di un Google Cloud.
I dati che un cliente può pubblicare sono soggetti ai seguenti limiti per diversi tipi di cluster:
Tipo di cluster | Limiti del cluster | Limiti massimi di entità in un cluster |
---|---|---|
Cluster di suggerimenti | Al massimo 5 | Al massimo 50 |
Cluster di continuazione | Al massimo 1 | Al massimo 10 |
Cluster in primo piano | Al massimo 1 | Al massimo 10 |
Passaggio 1: fornisci i dati dell'entità
L'SDK ha definito diverse entità per rappresentare ogni tipo di elemento. Supportiamo le seguenti entità per la categoria Ascolta:
MusicAlbumEntity
MusicArtistEntity
MusicTrackEntity
MusicVideoEntity
PlaylistEntity
PodcastSeriesEntity
PodcastEpisodeEntity
LiveRadioStationEntity
AudiobookEntity
I grafici riportati di seguito descrivono gli attributi e i requisiti disponibili per ogni tipo.
MusicAlbumEntity
L'oggetto MusicAlbumEntity
rappresenta un album musicale (ad esempio, Mezzanotte
di Taylor Swift).
Attributo | Requisito | Note |
---|---|---|
Nome | Obbligatorie | Il titolo dell'album musicale. |
Immagini poster | Obbligatorie | Devi fornire almeno un'immagine. Consulta Specifiche delle immagini come guida. |
URI pagina delle informazioni | Obbligatorie |
Il link diretto all'app del fornitore per i dettagli sull'album musicale. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Artisti | Obbligatorie | Elenco degli artisti presenti nell'album musicale. |
URI di riproduzione | Facoltativo |
Un link diretto che avvia la riproduzione dell'album nell'app del provider. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Descrizione | Facoltativo | Deve contenere al massimo 200 caratteri, se fornito. |
Numero di brani | Facoltativo | Il numero di brani inclusi nell'album musicale. |
Generi | Facoltativo | Elenco dei generi presenti nell'album musicale. |
Formato album | Facoltativo |
ALBUM (include LP e doppio LP) EP SINGOLA Mixtape |
Case discografiche | Facoltativo | Elenco delle case discografiche associate all'album. |
Scaricato sul dispositivo | Facoltativo | Valore booleano che indica se l'album musicale viene scaricato sul dispositivo. |
Esplicito | Facoltativo |
Un valore booleano che indica se i contenuti sono espliciti o meno Elementi che contengono materiale esplicito o che hanno un'avvertenza per i genitori L'avviso deve essere impostato su TRUE. Gli elementi espliciti sono contrassegnati dalla lettera "E" del tag. |
Data di uscita | Facoltativo | La data di uscita dell'album in millisecondi epoca. |
Durata | Facoltativo | La durata dell'album in millisecondi. |
Durata ultimo coinvolgimento | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Può essere utilizzato per la classificazione. In millisecondi epoche |
Percentuale di avanzamento completata | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Numero intero compreso tra 0 e 100 |
MusicArtistEntity
L'oggetto MusicArtistEntity
rappresenta un'arista musicale (ad esempio Adele).
Attributo | Requisito | Note |
---|---|---|
Nome | Obbligatorie | Nome dell'artista musicale. |
Immagini poster | Obbligatorie | Devi fornire almeno un'immagine. Consulta Specifiche delle immagini come guida. |
URI pagina informazioni | Obbligatorie |
Il link diretto all'app del fornitore per i dettagli sulla musica artista. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
URI di riproduzione | Facoltativo |
Il link diretto che avvia la riproduzione dei brani dell'artista nel provider dell'app. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Descrizione | Facoltativo | Deve contenere al massimo 200 caratteri, se fornito. |
Durata ultimo coinvolgimento | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Può essere utilizzato per la classificazione. In millisecondi epoche |
MusicTrackEntity
L'oggetto MusicTrackEntity
rappresenta una traccia musicale (ad esempio, Giallo di
i Coldplay).
Attributo | Requisito | Note |
---|---|---|
Nome | Obbligatorie | Titolo della traccia musicale. |
Immagini poster | Obbligatorie | Devi fornire almeno un'immagine. Consulta Specifiche delle immagini come guida. |
URI di riproduzione | Obbligatorie |
Un link diretto che avvia la riproduzione della traccia musicale nel provider dell'app. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti |
URI pagina informazioni | Facoltativo |
Un link diretto all'app del fornitore per i dettagli sulla traccia musicale. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Descrizione | Facoltativo | Deve contenere al massimo 200 caratteri, se fornito. |
Durata | Facoltativo | La durata della traccia in millisecondi. |
Album | Facoltativo | Il nome dell'album a cui appartiene il brano. |
Artisti | Obbligatorie | Elenco degli artisti della traccia musicale. |
Scaricato sul dispositivo | Facoltativo | Valore booleano che indica se la traccia musicale viene scaricata sul dispositivo. |
Esplicito | Facoltativo |
Un valore booleano che indica se i contenuti sono espliciti o meno Elementi che contengono materiale esplicito o che hanno un'avvertenza per i genitori L'avviso deve essere impostato su TRUE. Gli elementi espliciti sono contrassegnati dalla lettera "E" del tag. |
Durata ultimo coinvolgimento | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Può essere utilizzato per la classificazione. In millisecondi epoche |
Percentuale di avanzamento completata | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Numero intero compreso tra 0 e 100 |
MusicVideoEntity
L'oggetto MusicVideoEntity
rappresenta un video musicale (ad esempio,
The Weeknd - Take My Breath (video musicale ufficiale)).
Attributo | Requisito | Note |
---|---|---|
Nome | Obbligatorie | Il titolo del video musicale. |
Immagini poster | Obbligatorie | Devi fornire almeno un'immagine. Consulta Specifiche delle immagini come guida. |
URI di riproduzione | Obbligatorie |
Un link diretto che avvia la riproduzione del video musicale nel provider dell'app. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti |
URI pagina delle informazioni | Facoltativo |
Un link diretto all'app del fornitore per i dettagli sul video musicale. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Durata | Facoltativo | La durata del video in millisecondi. |
Numero di visualizzazioni | Facoltativo | Il numero di visualizzazioni del video in formato di testo libero. |
Artisti | Facoltativo | Elenco degli artisti del video musicale. |
Classificazione dei contenuti | Facoltativo | Elenco delle classificazioni dei contenuti della traccia. |
Descrizione | Facoltativo | Deve contenere al massimo 200 caratteri, se fornito. |
Scaricato sul dispositivo | Facoltativo | Valore booleano che indica se il video musicale viene scaricato sul dispositivo. |
Esplicito | Facoltativo |
Un valore booleano che indica se i contenuti sono espliciti o meno Elementi che contengono materiale esplicito o che hanno un'avvertenza per i genitori L'avviso deve essere impostato su TRUE. Gli elementi espliciti sono contrassegnati dalla lettera "E" del tag. |
Durata ultimo coinvolgimento | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Può essere utilizzato per la classificazione. In millisecondi epoche |
Percentuale di avanzamento completata | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Numero intero compreso tra 0 e 100 |
PlaylistEntity
L'oggetto PlaylistEntity
rappresenta una playlist musicale (ad esempio, il video
10).
Attributo | Requisito | Note |
---|---|---|
Nome | Obbligatorie | Titolo della playlist. |
Immagini poster | Obbligatorie | Devi fornire almeno un'immagine. Consulta Specifiche delle immagini come guida. |
URI di riproduzione | Obbligatorie |
Un link diretto che avvia la riproduzione della playlist musicale nel provider dell'app. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
URI pagina delle informazioni | Facoltativo |
Un link diretto all'app del fornitore per i dettagli sulla playlist musicale. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Durata | Facoltativo | La durata della playlist in millisecondi. |
Numero di brani | Facoltativo | Il numero di brani presenti nella playlist musicale. |
Descrizione | Facoltativo | Deve contenere al massimo 200 caratteri, se fornito. |
Scaricato sul dispositivo | Facoltativo | Valore booleano che indica se la playlist viene scaricata sul dispositivo. |
Esplicito | Facoltativo |
Un valore booleano che indica se i contenuti sono espliciti o meno Elementi che contengono materiale esplicito o che hanno un'avvertenza per i genitori L'avviso deve essere impostato su TRUE. Gli elementi espliciti sono contrassegnati dalla lettera "E" del tag. |
Durata ultimo coinvolgimento | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Può essere utilizzato per la classificazione. In millisecondi epoche |
Percentuale di avanzamento completata | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Numero intero compreso tra 0 e 100 |
PodcastSeriesEntity
L'oggetto PodcastSeriesEntity
rappresenta una serie di podcast (ad esempio, Questo
American Life).
Attributo | Requisito | Note |
---|---|---|
Nome | Obbligatorie | Il titolo della serie di podcast. |
Immagini poster | Obbligatorie | Devi fornire almeno un'immagine. Consulta Specifiche delle immagini come guida. |
URI pagina informazioni | Obbligatorie |
Un link diretto all'app del fornitore per i dettagli sul podcast Google Cloud. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
URI di riproduzione | Facoltativo |
Un link diretto che avvia la riproduzione della serie di podcast nell'app del fornitore. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Numero di puntate | Facoltativo | Il numero di puntate della serie di podcast. |
Nome produzione | Facoltativo | Il nome della produzione della serie di podcast. |
Host | Facoltativo | Elenco dei conduttori della serie di podcast. |
Generi | Facoltativo | Elenco dei generi della serie di podcast. |
Scaricato sul dispositivo | Facoltativo | Valore booleano che indica se il podcast viene scaricato sul dispositivo. |
Descrizione | Facoltativo | Deve contenere al massimo 200 caratteri, se fornito. |
Esplicito | Facoltativo |
Un valore booleano che indica se i contenuti sono espliciti o meno Elementi che contengono materiale esplicito o che hanno un'avvertenza per i genitori L'avviso deve essere impostato su TRUE. Gli elementi espliciti sono contrassegnati dalla lettera "E" del tag. |
Durata ultimo coinvolgimento | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Può essere utilizzato per la classificazione. In millisecondi epoche |
PodcastEpisodeEntity
L'oggetto PodcastEpisodeEntity
rappresenta una serie di podcast (ad esempio,
Spark Bird, puntata 754: This American Life).
Attributo | Requisito | Note |
---|---|---|
Nome | Obbligatorie | Il titolo della puntata del podcast. |
Immagini poster | Obbligatorie | Devi fornire almeno un'immagine. Consulta Specifiche delle immagini come guida. |
URI di riproduzione | Obbligatorie |
Un link diretto che avvia la riproduzione della puntata del podcast nel fornitore dell'app. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Titolo della serie di produzione | Obbligatorie | Il nome della serie di podcast a cui appartiene la puntata. |
Durata | Obbligatorie | La durata della puntata del podcast in millisecondi. |
Data di pubblicazione | Obbligatorie | Data di pubblicazione del podcast (in millisecondi epoca) |
URI pagina informazioni | Facoltativo |
Un link diretto all'app del fornitore per i dettagli sulla puntata del podcast. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Nome produzione | Facoltativo | Il nome della produzione della serie di podcast. |
Indice della puntata | Facoltativo | L'indice della puntata della serie (il primo indice è 1). |
Host | Facoltativo | Elenco dei conduttori della puntata del podcast. |
Generi | Facoltativo | Elenco dei generi della puntata del podcast. |
Scaricato sul dispositivo | Facoltativo | Valore booleano che indica se la puntata del podcast è stata scaricata sul dispositivo. |
Descrizione | Facoltativo | Deve contenere al massimo 200 caratteri, se fornito. |
Podcast video | Facoltativo | Valore booleano che indica se la puntata del podcast include contenuti video |
Esplicito | Facoltativo |
Un valore booleano che indica se i contenuti sono espliciti o meno Elementi che contengono materiale esplicito o che hanno un'avvertenza per i genitori L'avviso deve essere impostato su TRUE. Gli elementi espliciti sono contrassegnati dalla lettera "E" del tag. |
Tipo di ascolto successivo | Facoltativo |
Consigliata per gli elementi nel cluster di continuazione TYPE_CONTINUA - Riprendi su un elemento audio da completare. TYPE_NEXT: continua su un nuovo elemento di una serie. TYPE_NEW - Appena uscito. |
Durata ultimo coinvolgimento | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Può essere utilizzato per la classificazione. In millisecondi epoche |
Percentuale di avanzamento completata | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Numero intero compreso tra 0 e 100 |
LiveRadioStationEntity
L'oggetto LiveRadioStationEntity
rappresenta una stazione radio in diretta (ad
esempio, 98.1 The Breeze).
Attributo | Requisito | Note |
---|---|---|
Nome | Obbligatorie | Titolo della stazione radio in diretta. |
Immagini poster | Obbligatorie | Devi fornire almeno un'immagine. Consulta Specifiche delle immagini come guida. |
URI di riproduzione | Obbligatorie |
Un link diretto che avvia la riproduzione della stazione radio nel fornitore dell'app. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
URI pagina informazioni | Facoltativo |
Un link diretto all'app del fornitore per i dettagli sulla stazione radio. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Frequenza | Facoltativo | La frequenza con cui viene trasmessa la stazione radio (ad esempio, "98.1 FM"). |
Mostra titolo | Facoltativo | Il programma attualmente in riproduzione sulla stazione radio. |
Host | Facoltativo | Elenco di conduttori della stazione radio. |
Descrizione | Facoltativo | Deve contenere al massimo 200 caratteri, se fornito. |
Durata ultimo coinvolgimento | Facoltativo |
Consigliato per gli elementi nel cluster di continuazione. Può essere utilizzato per la classificazione. In millisecondi epoche |
AudiobookEntity
L'oggetto AudiobookEntity
rappresenta un audiolibro (ad esempio, l'audiolibro
di Becoming di Michelle Obama).
Attributo | Requisito | Note |
---|---|---|
Nome | Obbligatorie | |
Immagini poster | Obbligatorie | Devi fornire almeno un'immagine. Vedi Immagine specifiche. |
Autore | Obbligatorie | Devi specificare almeno un nome di autore. |
Narratore | Obbligatorie | Devi fornire almeno il nome di un narratore. |
URI link azione | Obbligatorie |
Il link diretto all'app del fornitore per l'audiolibro. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
Data di pubblicazione | Facoltativo | In epoch millisecondi se fornito. |
Descrizione | Facoltativo | Deve contenere al massimo 200 caratteri, se fornito. |
Prezzo | Facoltativo | Testo libero |
Durata | Facoltativo | Deve essere un valore positivo, se fornito. |
Genere | Facoltativo | Elenco di generi associati al libro. |
Nome serie | Facoltativo | Il nome della serie a cui appartiene l'audiolibro (ad esempio, Harry Potter. |
Indice unità di serie | Facoltativo | L'indice dell'audiolibro della serie, dove 1 è il primo audiolibro della serie. Ad esempio, se Harry Potter e il prigioniero di Azkaban è il terzo libro della serie, quindi dovrebbe essere impostato su 3. |
Continua tipo di libro | Facoltativo |
TYPE_CONTINUA - Riprendi un libro da completare. TYPE_NEXT: continua su un nuovo elemento di una serie. TYPE_NEW - Appena uscito. |
Durata ultimo coinvolgimento | Obbligatorio in modo condizionale | Deve essere fornito quando l'elemento si trova nel cluster Continuazione. In millisecondi di epoca. |
Percentuale progressi compiuti | Obbligatorio in modo condizionale |
Deve essere fornito quando l'elemento si trova nel cluster Continuazione. Gli audiolibri appena acquisiti possono essere inclusi nella continua a leggere in un cluster Kubernetes. Il valore deve essere maggiore di 0 e minore di 100. |
DisplayTimeWindow: imposta una finestra temporale per un contenuto da mostrare in superficie | ||
Timestamp inizio | Facoltativo |
Il timestamp dell'epoca dopo il quale i contenuti devono essere mostrati nella superficie. Se non viene configurato, i contenuti sono idonei a essere mostrati in piattaforma. In millisecondi di epoca. |
Data e ora di fine | Facoltativo |
Il timestamp dell'epoca dopo il quale i contenuti non vengono più mostrati in superficie. Se non viene configurato, i contenuti sono idonei a essere mostrati in piattaforma. In millisecondi di epoca. |
Specifiche per le immagini
Di seguito sono elencate le specifiche obbligatorie per gli asset immagine:
Proporzioni | Requisito | Numero minimo di pixel | Pixel consigliati |
---|---|---|---|
Quadrato (1 x 1) | Obbligatorie | 300x300 | 1200x1200 |
Orizzontale (1,91 x 1) | Facoltativo | 600x314 | 1200x628 |
Verticale (4 x 5) | Facoltativo | 480x600 | 960x1200 |
Formati file
PNG, JPG, GIF statica, WebP
Dimensioni massime del file
5120 kB
Consigli aggiuntivi
- Area di sicurezza dell'immagine:inserisci i contenuti importanti al centro dell'80% della sezione dell'immagine.
Esempi
MusicAlbumEntity musicAlbumEntity =
new MusicAlbumEntity.Builder()
.setName(NAME)
.addPosterImage(new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(960)
.setImageWidthInPixel(408)
.build())
.setPlayBackUri("https://play.google/album/play")
.setInfoPageUri("https://play.google/album/info")
.setDescription("A description of this album.")
.addArtist("Artist")
.addGenre("Genre")
.addMusicLabel("Label")
.addContentRating("Rating")
.setSongsCount(960)
.setReleaseDateEpochMillis(1633032895L)
.setDurationMillis(1633L)
.build();
AudiobookEntity audiobookEntity =
new AudiobookEntity.Builder()
.setName("Becoming")
.addPosterImage(new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(960)
.setImageWidthInPixel(408)
.build())
.addAuthor("Michelle Obama")
.addNarrator("Michelle Obama")
.setActionLinkUri(
Uri.parse("https://play.google/audiobooks/1"))
.setDurationMillis(16335L)
.setPublishDateEpochMillis(1633032895L)
.setDescription("An intimate, powerful, and inspiring memoir")
.setPrice("$16.95")
.addGenre("biography")
.build();
Passaggio 2: fornisci i dati del cluster
Ti consigliamo di eseguire il job di pubblicazione dei contenuti in background (ad esempio, utilizzando WorkManager). e pianificato con cadenza regolare o evento (ad esempio, ogni volta l'utente apre l'app o quando ha appena aggiunto qualcosa al carrello).
AppEngagePublishClient
è responsabile della pubblicazione dei cluster. Persone che seguo
Le API sono disponibili nel client:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Questa API viene utilizzata per verificare se il servizio è disponibile per l'integrazione e se i contenuti possono essere presentati sul dispositivo.
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
Questa API viene utilizzata per pubblicare un elenco di oggetti RecommendationCluster
.
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Trending music") .build()) .build())
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Trending music") .build()) .build());
Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni: una transazione:
- I dati esistenti relativi a
RecommendationCluster
dello sviluppatore partner verranno rimossi. - I dati della richiesta vengono analizzati e archiviati nel suggerimento aggiornato di un cluster Kubernetes.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
publishFeaturedCluster
Questa API viene utilizzata per pubblicare un elenco di oggetti FeaturedCluster
.
Kotlin
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() ... .build()) .build())
Java
client.publishFeaturedCluster( new PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( new FeaturedCluster.Builder() ... .build()) .build());
Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni: una transazione:
- I dati esistenti relativi a
FeaturedCluster
dello sviluppatore partner verranno rimossi. - I dati della richiesta vengono analizzati e archiviati nel cluster in primo piano aggiornato.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
publishContinuationCluster
Questa API viene utilizzata per pubblicare un oggetto ContinuationCluster
.
Kotlin
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni: una transazione:
- I dati esistenti relativi a
ContinuationCluster
dello sviluppatore partner verranno rimossi. - I dati della richiesta vengono analizzati e archiviati nella continuazione aggiornata di un cluster Kubernetes.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
publishUserAccountManagementRequest
Questa API viene utilizzata per pubblicare una scheda di accesso . L'azione di accesso indirizza gli utenti a alla pagina di accesso dell'app, in modo che quest'ultima possa pubblicare contenuti (o fornire contenuti personalizzati)
I seguenti metadati fanno parte della scheda di accesso:
Attributo | Requisito | Descrizione |
---|---|---|
URI azione | Obbligatorio | Link diretto all'azione (ad esempio, per passare alla pagina di accesso all'app) |
Immagine | Facoltativo: se non viene specificato, è necessario indicare il titolo |
Immagine mostrata sulla scheda Immagini con proporzioni 16:9 con una risoluzione di 1264 x 712 |
Titolo | Facoltativo: se non viene fornita, è necessario fornire l'immagine | Titolo sulla scheda |
Testo dell'azione | Facoltativo | Testo mostrato sull'invito all'azione (ad es. Accedi) |
Sottotitolo | Facoltativo | Sottotitolo facoltativo sulla scheda |
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());
Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni: una transazione:
- I dati di
UserAccountManagementCluster
esistenti dallo sviluppatore partner sono rimosso. - I dati della richiesta vengono analizzati e archiviati nel Cluster UserAccountManagementCluster.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
updatePublishStatus
Se, per qualsiasi motivo di business interno, nessuno dei cluster viene pubblicato, ti consigliamo vivamente di aggiornare lo stato di pubblicazione utilizzando API updatePubblicaStatus. Questo è importante perché :
- Indicare lo stato in tutti gli scenari, anche quando i contenuti vengono pubblicati (STATO == PUBBLICATO), è fondamentale per compilare le dashboard che utilizzano questo stato esplicito per comunicare lo stato di integrità e altre metriche della tua integrazione.
- Se non sono stati pubblicati contenuti, ma lo stato dell'integrazione non funziona (STATUS == NOT_PUBLISHERED), Google può evitare di attivare avvisi nell'app dashboard dell'integrità. Conferma che i contenuti non sono stati pubblicati a causa di un situazione prevista dal punto di vista del provider.
- Consente agli sviluppatori di capire quando i dati vengono pubblicati e quando .
- Google può utilizzare i codici di stato per sollecitare l'utente a eseguire determinate azioni nel dell'app in modo da poter vedere o risolvere i contenuti dell'app.
Ecco un elenco di codici di stato idonei per la pubblicazione :
// 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
Se i contenuti non vengono pubblicati perché un utente non ha eseguito l'accesso, Google consiglia di pubblicare la scheda di accesso. Se per qualsiasi motivo i fornitori non riescono a pubblicare la scheda di accesso ti consigliamo di chiamare l'API updatePubblicaStatus con il codice di stato NOT_PUBLISHERED_REQUIRES_SIGN_IN
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
Questa API viene utilizzata per eliminare i contenuti dei cluster dei suggerimenti.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Quando il servizio riceve la richiesta, rimuove i dati esistenti Cluster di suggerimenti. In caso di errore, l'intera richiesta viene rifiutata. e lo stato esistente viene mantenuto.
deleteFeaturedCluster
Questa API viene utilizzata per eliminare i contenuti del cluster in primo piano.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Quando il servizio riceve la richiesta, rimuove i dati esistenti Cluster in primo piano. In caso di errore, l'intera richiesta viene rifiutata. e lo stato esistente viene mantenuto.
deleteContinuationCluster
Questa API viene utilizzata per eliminare i contenuti del cluster di continuazione.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Quando il servizio riceve la richiesta, rimuove i dati esistenti Cluster di continuazione. In caso di errore, l'intera richiesta viene rifiutata. e lo stato esistente viene mantenuto.
deleteUserManagementCluster
Questa API viene utilizzata per eliminare i contenuti del cluster UserAccountManagement.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Quando il servizio riceve la richiesta, rimuove i dati esistenti Cluster UserAccountManagement. In caso di errore, l'intera richiesta viene viene rifiutato e lo stato esistente viene mantenuto.
deleteClusters
Questa API viene utilizzata per eliminare i contenuti di un determinato tipo di cluster.
Kotlin
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build())
Java
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build());
Quando il servizio riceve la richiesta, rimuove i dati esistenti da tutti corrispondenti ai tipi di cluster specificati. I clienti possono scegliere di superare uno o per molti tipi di cluster. In caso di errore, l'intera richiesta viene rifiutata e viene mantenuto.
Gestione degli errori
Ti consigliamo vivamente di ascoltare il risultato dell'attività dalle API di pubblicazione, ad esempio che è possibile eseguire un'azione di follow-up per recuperare e inviare nuovamente un'attività riuscita.
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
}
}
}
});
L'errore viene restituito come AppEngageException
con la causa inclusa come un
codice di errore.
Codice di errore | Nota |
---|---|
SERVICE_NOT_FOUND |
Il servizio non è disponibile sul dispositivo specificato. |
SERVICE_NOT_AVAILABLE |
Il servizio è disponibile sul dispositivo specificato, ma non lo è al momento della chiamata (ad esempio, è esplicitamente disabilitata). |
SERVICE_CALL_EXECUTION_FAILURE |
Esecuzione dell'attività non riuscita a causa di problemi di thread. In questo caso, da riprovare. |
SERVICE_CALL_PERMISSION_DENIED |
Il chiamante non è autorizzato a effettuare la chiamata di servizio. |
SERVICE_CALL_INVALID_ARGUMENT |
La richiesta contiene dati non validi (ad esempio, più del numero consentito di cluster). |
SERVICE_CALL_INTERNAL |
Si è verificato un errore sul lato del servizio. |
SERVICE_CALL_RESOURCE_EXHAUSTED |
La chiamata all'assistenza viene effettuata troppo spesso. |
Passaggio 3: gestisci gli intent di trasmissione
Oltre a effettuare chiamate all'API Publication di contenuti tramite un job, è anche
necessario per configurare
BroadcastReceiver
per ricevere
la richiesta di pubblicazione di contenuti.
L'obiettivo degli intent di trasmissione è principalmente la riattivazione dell'app e l'applicazione forzata dei dati sincronizzare. Gli intent di trasmissione non sono progettati per essere inviati molto spesso. È solo attivata quando il servizio Engage stabilisce che i contenuti potrebbero essere obsoleti (ad esempio, una settimana fa). In questo modo, l'utente può avere una maggiore sicurezza nuova esperienza con i contenuti, anche se l'applicazione non è stata eseguita per per un lungo periodo di tempo.
BroadcastReceiver
deve essere configurato nei due modi seguenti:
- Registra dinamicamente un'istanza della classe
BroadcastReceiver
utilizzandoContext.registerReceiver()
. Ciò consente la comunicazione dalle applicazioni ancora in memoria.
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));
}
- Dichiarare in modo statico un'implementazione con il tag
<receiver>
nel tuoAndroidManifest.xml
file. Ciò consente all'applicazione di ricevere annunci quando non è in esecuzione e consente inoltre all'applicazione di pubblicare dei contenuti.
<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>
I seguenti intent verranno inviati dall' servizio:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
È consigliabile avviare una chiamatapublishRecommendationClusters
quando che ricevono questo intento.com.google.android.engage.action.PUBLISH_FEATURED
Ti consigliamo di avviare una chiamatapublishFeaturedCluster
quando ricevi questo l'intento.com.google.android.engage.action.PUBLISH_CONTINUATION
È consigliabile avviare una chiamatapublishContinuationCluster
quando ricevi questo intento.
Flusso di lavoro di integrazione
Per una guida passo passo sulla verifica dell'integrazione dopo il suo completamento, consulta Flusso di lavoro per l'integrazione degli sviluppatori del coinvolgimento.
Domande frequenti
Consulta le domande frequenti sull'SDK Engage per Domande frequenti.
Contact
Contatto engagement-developers@google.com se ci sono a eventuali domande durante il processo di integrazione. Il nostro team ti risponderà il prima possibile possibile.
Passaggi successivi
Dopo aver completato l'integrazione, i passaggi successivi sono i seguenti:
- Invia un'email a engagement-developers@google.com e collega l'APK integrato, pronto per essere testato da Google.
- Google eseguirà una verifica e una revisione interna per garantire che che funzioni come previsto. In caso di modifiche, Google ti contatterà con tutti i dettagli necessari.
- Quando il test è stato completato e non sono necessarie modifiche, Google ti contatterà per ti comunicherà che puoi iniziare a pubblicare l'APK aggiornato e integrato sul Play Store.
- Dopo che Google avrà confermato la pubblicazione dell'APK aggiornato su Play Store, il tuo Consiglio, In primo piano e Continuazione verranno pubblicati e saranno visibili agli utenti.