Coinvolgi incontri con SDK: istruzioni per l'integrazione tecnica di terze parti

Google sta creando una piattaforma on-device che organizza le app degli utenti in base ai verticali e consente una nuova esperienza immersiva per la fruizione e la scoperta di contenuti personalizzati delle app. Questa esperienza a schermo intero offre agli sviluppatori partner l'opportunità di mostrare i loro migliori contenuti avanzati in un canale dedicato al di fuori della loro app.Questa guida contiene istruzioni per gli sviluppatori partner per integrare i loro contenuti di dating, utilizzando l'SDK Engage per compilare questa nuova area di superficie.

Dettaglio dell'integrazione

Questa sezione descrive in dettaglio i passaggi, i modelli di dati e la terminologia necessari per l'integrazione con l'SDK Engage per i contenuti di dating.

Terminologia

Questa integrazione include i seguenti tre tipi di cluster: Contenuti consigliati, In primo piano e Continua.

  • I cluster di consigli mostrano suggerimenti di incontri personalizzati di un singolo sviluppatore partner. Questi consigli possono essere personalizzati per l'utente.

    • Un cluster di suggerimenti può essere composto da ArticleEntity, PersonEntity o EventEntity, ma non da un mix di tipi di entità diversi.

    I suggerimenti hanno la seguente struttura:

    • Cluster di contenuti consigliati:una visualizzazione dell'interfaccia utente che contiene un gruppo di contenuti consigliati dello stesso partner sviluppatore.

    • Entità: un oggetto che rappresenta un singolo elemento in un cluster. Questa integrazione offre alcune entità che verrebbero mostrate utilizzando il cluster di suggerimenti:

      • ArticleEntity: ArticleEntity rappresenta un consiglio per i contenuti basati su testo correlati agli incontri. L'elemento ArticleEntity consente agli sviluppatori di fornire una varietà di contenuti di testo e immagini con più metadati per articolare le informazioni per gli utenti.

        Figura 1: UI che mostra un singolo ArticleEntity all'interno del cluster di contenuti consigliati.
      • PersonEntity: PersonEntity rappresenta una persona. I consigli potrebbero essere quelli di mettere in evidenza una persona tra i potenziali partner.

        Figura 2: UI che mostra una singola PersonEntity all'interno del cluster dei contenuti consigliati.
      • EventEntity: EventEntity rappresenta un evento che si verificherà in futuro. L'ora di inizio dell'evento è un'informazione fondamentale che deve essere comunicata agli utenti.

        Figura 3: UI che mostra un singolo EventEntity all'interno del cluster di contenuti consigliati.
  • Il cluster Continuazione mostra i contenuti con cui gli utenti hanno interagito di recente da più partner sviluppatori in un unico raggruppamento dell'interfaccia utente. Ogni partner sviluppatore potrà trasmettere un massimo di 10 entità nel cluster di continuazione.

    I contenuti di continuazione possono avere la seguente struttura:

    • ArticleEntity: ArticleEntity rappresenta un consiglio per i contenuti basati su testo correlati agli incontri. Questa entità può essere utilizzata per rappresentare articoli di notizie non completati o altri contenuti che l'utente vorrebbe continuare a consultare da dove li aveva interrotti.

      Figura 6. UI che mostra un singolo ArticleEntity all'interno di un cluster di continuazione.
    • EventReservationEntity: EventReservationEntity rappresenta la prenotazione di un evento e aiuta gli utenti a monitorare le prenotazioni di eventi di incontri e appuntamenti imminenti o in corso.

      Figura 8. UI che mostra una singola EventReservationEntity all'interno di un cluster di continuazione.
  • Il cluster In primo piano è una visualizzazione dell'interfaccia utente che mostra l'hero scelto GenericFeaturedEntity di molti partner sviluppatori in un unico raggruppamento dell'interfaccia utente. Esiste un unico cluster In primo piano, che viene visualizzato nella parte superiore della UI, con un posizionamento prioritario rispetto a tutti i cluster di Contenuti consigliati. Ogni partner sviluppatore può trasmettere una singola entità di un tipo supportato in In evidenza, con molte entità (potenzialmente di tipi diversi) di più sviluppatori di app nel cluster In evidenza.

    • GenericFeaturedEntity: GenericFeaturedEntity è diverso dall'elemento Recommendation in quanto l'elemento in primo piano deve essere utilizzato per un singolo contenuto principale degli sviluppatori e deve rappresentare il singolo contenuto più importante che sarà interessante e pertinente per gli utenti.

      Figura 12: UI che mostra un FeaturedCluster con un elenco di GenericFeaturedEntity

Preparazione

Livello API minimo: 19

Aggiungi la libreria 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.6.0'
}

Riepilogo

Il design si basa sull'implementazione di un servizio associato.

I dati che un client può pubblicare sono soggetti ai seguenti limiti per i diversi tipi di cluster:

Tipo di cluster Limiti dei cluster Limiti minimi delle entità in un cluster Limiti massimi di entità in un cluster
Cluster di suggerimenti Al massimo 5 Almeno 5 Al massimo 25 (ArticleEntity, PersonEntity o EventEntity)
Cluster di continuazione Al massimo 1 Almeno 1 Al massimo 10 (ArticleEntity o EventReservationEntity)
Cluster in primo piano Al massimo 1 Almeno 1 Al massimo 10 (GenericFeaturedEntity)

Passaggio 1: fornisci i dati della persona giuridica

L'SDK ha definito entità diverse per rappresentare ogni tipo di articolo. Supportiamo le seguenti entità per la categoria Incontri:

  1. GenericFeaturedEntity
  2. ArticleEntity
  3. PersonEntity
  4. EventEntity
  5. EventReservationEntity

I seguenti grafici illustrano gli attributi e i requisiti disponibili per ogni tipo.

GenericFeaturedEntity

Attributo Requisito Descrizione Formato
URI azione Obbligatorio

Deep link all'entità nell'app del fornitore.

Nota: puoi utilizzare i deep link per l'attribuzione. Consulta queste domande frequenti

URI
Immagini del poster Obbligatorio

Se vengono fornite più immagini, ne mostreremo solo una. Le proporzioni consigliate sono 16:9

Nota: se viene fornito un badge, assicurati che lo spazio sicuro sia di 24 dp sia nella parte superiore che in quella inferiore dell'immagine

Per indicazioni, consulta le specifiche per le immagini.
Titolo Facoltativo Titolo dell'entità.

Testo libero

Dimensioni del testo consigliate: 50 caratteri

Descrizione Facoltativo

Un singolo paragrafo di testo che descrive l'entità.

Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.

Testo libero

Dimensioni del testo consigliate: 180 caratteri

Elenco dei sottotitoli Facoltativo

Fino a 3 sottotitoli, ciascuno composto da una singola riga di testo.

Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.

Testo libero

Dimensioni del testo consigliate per ogni sottotitolo: massimo 50 caratteri

Badge Facoltativo

Ogni badge è un testo libero (massimo 15 caratteri) o una piccola immagine.

Trattamento UX speciale sopra l'immagine/il video, ad esempio come overlay del badge sull'immagine

  • "Aggiornamento in tempo reale"
  • Durata della lettura dell'articolo
Badge - Testo Facoltativo

Titolo del badge

Nota:per il badge è necessario un testo o un'immagine

Testo libero

Dimensioni del testo consigliate: massimo 15 caratteri

Badge - Immagine Facoltativo

Immagine piccola

Trattamento UX speciale, ad esempio come overlay del badge sulla miniatura dell'immagine/del video.

Nota:per il badge è necessario un testo o un'immagine

Per indicazioni, consulta le specifiche per le immagini.
Categorie di contenuti Facoltativo Descrivi la categoria dei contenuti nell'entità.

Elenco di enum

Per indicazioni, consulta la sezione Categoria di contenuti.

ArticleEntity

Attributo Requisito Descrizione Formato
URI azione Obbligatorio

Deep link all'entità nell'app del fornitore.

Nota: puoi utilizzare i deep link per l'attribuzione. Consulta queste domande frequenti

URI
Titolo Obbligatorio Titolo dell'entità.

Testo libero

Recommended text size: Max 50 chars

Immagini del poster Facoltativo

Se vengono fornite più immagini, ne mostreremo solo una. Le proporzioni consigliate sono 16:9

Nota: l'immagine è vivamente consigliata. Se viene fornito un badge, assicurati che lo spazio sicuro sia di 24 dp sia nella parte superiore che in quella inferiore dell'immagine.

Per indicazioni, consulta le specifiche per le immagini.
Source - Title Facoltativo Il nome dell'autore, dell'organizzazione o del giornalista

Testo libero

Dimensioni del testo consigliate: meno di 25 caratteri

Origine - Immagine Facoltativo Un'immagine della fonte, ad esempio l'autore, l'organizzazione, il giornalista Per indicazioni, consulta le specifiche per le immagini.
Descrizione Facoltativo

Un singolo paragrafo di testo che descrive l'entità.

Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.

Testo libero

Dimensioni del testo consigliate: 180 caratteri

Elenco dei sottotitoli Facoltativo

Fino a 3 sottotitoli, ciascuno composto da una singola riga di testo.

Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.

Testo libero

Dimensioni del testo consigliate per ogni sottotitolo: massimo 50 caratteri

Badge Facoltativo

Ogni badge è un testo libero (massimo 15 caratteri) o una piccola immagine.

Trattamento UX speciale sopra l'immagine/il video, ad esempio come overlay del badge sull'immagine

  • Ad esempio, "Aggiornamento in tempo reale"
  • Ad esempio, Durata della lettura dell'articolo
Badge - Testo Facoltativo

Titolo del badge

Nota:per il badge è necessario un testo o un'immagine

Testo libero

Dimensioni del testo consigliate: massimo 15 caratteri

Badge - Immagine Facoltativo

Immagine piccola

Trattamento UX speciale, ad esempio come overlay del badge sulla miniatura dell'immagine/del video.

Nota:per il badge è necessario un testo o un'immagine

Per indicazioni, consulta le specifiche per le immagini.
Data/ora pubblicazione dei contenuti Facoltativo Questo è il timestamp dell'epoca in millisecondi relativo alla data di pubblicazione / aggiornamento dei contenuti nell'app. Timestamp epoch in millisecondi
Last Engagement Time Obbligatorio condizionalmente

Il timestamp epoch in millisecondi dell'ultima interazione dell'utente con questa entità.

Nota:questo campo è obbligatorio se questa entità fa parte del cluster di continuazione.

Timestamp epoch in millisecondi
Percentuale di avanzamento Obbligatorio condizionalmente

La percentuale dei contenuti completi consumati dall'utente fino ad oggi.

Nota:questo campo è obbligatorio se questa entità fa parte del cluster di continuazione.

Un valore int compreso tra 0 e 100 inclusi.
Categorie di contenuti Facoltativo Descrivi la categoria dei contenuti nell'entità.

Elenco di enum

Per indicazioni, consulta la sezione Categoria di contenuti.

PersonEntity

Attributo Requisito Descrizione Formato
URI azione Obbligatorio

Deep link all'entità nell'app del fornitore.

Nota: puoi utilizzare i deep link per l'attribuzione. Consulta queste domande frequenti

URI
Profilo - Nome Obbligatorio Nome, ID o handle del profilo, ad esempio "Mario Rossi", "@TeamPixel" e così via.

Stringa

Recommended text size: Max 50 chars

Profilo - Avatar Obbligatorio

Immagine del profilo o avatar dell'utente.

Nota: deve essere un'immagine quadrata 1:1.

Per indicazioni, consulta le specifiche per le immagini.
Profilo - Testo aggiuntivo Facoltativo Testo libero come l'handle del profilo.

Testo libero

Dimensioni del testo consigliate: massimo 15 caratteri

Profilo - Immagine aggiuntiva Facoltativo Immagine di piccole dimensioni, ad esempio un badge di verifica. Per indicazioni, consulta le specifiche per le immagini.
Immagine intestazione Facoltativo

Rappresenta l'immagine intestazione. Deve essere diversa dall'immagine del profilo. Può essere utilizzato se è presente un'immagine aggiuntiva per mettere in evidenza la persona, ad esempio il suo lavoro.

Nota: l'immagine deve essere in formato 16:9. Se viene fornito un badge, assicurati che lo spazio sicuro sia di 24 dp sia nella parte superiore che in quella inferiore dell'immagine

Per indicazioni, consulta le specifiche per le immagini.
Popolarità - Conteggio Facoltativo

Indica il numero di follower o il valore di popolarità, ad esempio "3,7 M".

Nota: se vengono forniti sia Count che Count Value, verrà utilizzato Count.

Stringa

Dimensioni del testo consigliate: massimo 20 caratteri per il conteggio e l'etichetta combinati

Popolarità - Valore conteggio Facoltativo

Il numero di follower o il valore di popolarità.

Nota: specifica il valore del conteggio se la tua app non vuole gestire la logica relativa alla modalità di ottimizzazione di un numero elevato per schermi di dimensioni diverse. Se vengono forniti sia Count che Count Value, agli utenti viene mostrato Count.

Lungo
Popolarità - Etichetta Facoltativo Indica l'etichetta di popolarità, ad esempio "Mi piace".

Stringa

Dimensioni del testo consigliate: massimo 20 caratteri per il conteggio e l'etichetta combinati

Popolarità - Visual Facoltativo

Indica lo scopo dell'interazione. Ad esempio, un'immagine che mostra l'icona Mi piace, un'emoji.

Puoi fornire più di un'immagine, anche se non tutte potrebbero essere visualizzate su tutti i fattori di forma.

Nota:deve essere un'immagine quadrata 1:1

Per indicazioni, consulta le specifiche per le immagini.
Valutazione - Valore massimo Obbligatorio

Il valore massimo della scala di valutazione.

Deve essere fornito se viene fornito anche il valore corrente della valutazione.

Numero >= 0,0
Rating - Current value Obbligatorio

Il valore attuale della scala di valutazione.

Deve essere fornito se viene fornito anche il valore massimo della valutazione.

Numero >= 0,0
Valutazione - Conteggio Facoltativo

Il numero di valutazioni per l'entità.

Nota:fornisci questo campo se la tua app vuole controllare il modo in cui viene visualizzato agli utenti. Fornisci la stringa concisa che può essere mostrata all'utente. Ad esempio, se il conteggio è 1.000.000, valuta la possibilità di utilizzare abbreviazioni come 1M, in modo che non venga troncato su schermi di dimensioni ridotte.

Stringa
Rating - Count Value Facoltativo

Il numero di valutazioni per l'entità.

Nota: specifica questo campo se non vuoi gestire autonomamente la logica di abbreviazione della visualizzazione. Se sono presenti sia Count che Count Value, utilizzeremo Count per la visualizzazione agli utenti

Lungo
Località - Paese Facoltativo Il paese in cui si trova o presta servizio la persona.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Città Facoltativo La città in cui si trova o presta servizio la persona.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Indirizzo visualizzato Facoltativo L'indirizzo in cui si trova o opera la persona verrà mostrato all'utente.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Via Facoltativo La via (se applicabile) in cui si trova o presta servizio la persona.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Stato Facoltativo Lo stato (se applicabile) in cui si trova o presta servizio la persona.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Codice postale Facoltativo Il codice postale (se applicabile) in cui si trova o opera la persona.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Quartiere Facoltativo Il quartiere (se applicabile) in cui si trova o opera la persona.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Badge Facoltativo

Ogni badge è un testo libero (massimo 15 caratteri) o una piccola immagine.

Badge - Testo Facoltativo

Titolo del badge

Nota:per il badge è necessario un testo o un'immagine

Testo libero

Dimensioni del testo consigliate: massimo 15 caratteri

Badge - Immagine Facoltativo

Immagine piccola

Trattamento UX speciale, ad esempio come overlay del badge sulla miniatura dell'immagine/del video.

Nota:per il badge è necessario un testo o un'immagine

Per indicazioni, consulta le specifiche per le immagini.
Descrizione Facoltativo

Un singolo paragrafo di testo che descrive l'entità.

Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.

Testo libero

Dimensioni del testo consigliate: 180 caratteri

Elenco dei sottotitoli Facoltativo

Fino a 3 sottotitoli, ciascuno composto da una singola riga di testo.

Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.

Testo libero

Dimensioni del testo consigliate per ogni sottotitolo: massimo 50 caratteri

Categorie di contenuti Facoltativo Descrivi la categoria dei contenuti nell'entità.

Elenco di enum idonei

  • TYPE_HEALTH_AND_FITENESS (ad esempio, istruttore di yoga/fitness)
  • TYPE_HOME_AND_AUTO (esempio: idraulico)
  • TYPE_SPORTS (esempio: giocatore)
  • TYPE_DATING

Per indicazioni, consulta la sezione Categoria di contenuti.

EventEntity

Attributo Requisito Descrizione Formato
URI azione Obbligatorio

Deep link all'entità nell'app del fornitore.

Nota: puoi utilizzare i deep link per l'attribuzione. Consulta queste domande frequenti

URI
Titolo Obbligatorio Titolo dell'entità.

Stringa

Recommended text size: Max 50 chars

Ora di inizio Obbligatorio

Il timestamp epoch in cui è previsto l'inizio dell'evento.

Nota: questo valore verrà rappresentato in millisecondi.

Timestamp epoch in millisecondi
Modalità evento Obbligatorio

Un campo per indicare se l'evento sarà virtuale, di persona o entrambi.

Enum: VIRTUAL, IN_PERSON o HYBRID
Immagini del poster Obbligatorio

Se vengono fornite più immagini, ne mostreremo solo una. Le proporzioni consigliate sono 16:9

Nota: l'immagine è vivamente consigliata. Se viene fornito un badge, assicurati che lo spazio sicuro sia di 24 dp sia nella parte superiore che in quella inferiore dell'immagine.

Per indicazioni, consulta le specifiche per le immagini.
Località - Paese Obbligatorio condizionalmente

Il paese in cui si svolge l'evento.

Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Città Obbligatorio condizionalmente

La città in cui si svolge l'evento.

Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Indirizzo visualizzato Obbligatorio condizionalmente

L'indirizzo o il nome della sede in cui si terrà l'evento che deve essere mostrato all'utente.

Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Via Facoltativo L'indirizzo (se applicabile) della sede in cui si tiene l'evento.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Stato Facoltativo Lo stato o la provincia (se applicabile) in cui si tiene l'evento.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Codice postale Facoltativo Il codice postale (se applicabile) della località in cui si tiene l'evento.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Quartiere Facoltativo Il quartiere (se applicabile) in cui si tiene l'evento.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Ora di fine Facoltativo

Il timestamp epoch in cui è prevista la fine dell'evento.

Nota: questo valore verrà rappresentato in millisecondi.

Timestamp epoch in millisecondi
Descrizione Facoltativo

Un singolo paragrafo di testo che descrive l'entità.

Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.

Testo libero

Dimensioni del testo consigliate: 180 caratteri

Elenco dei sottotitoli Facoltativo

Fino a 3 sottotitoli, ciascuno composto da una singola riga di testo.

Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.

Testo libero

Dimensioni del testo consigliate per ogni sottotitolo: massimo 50 caratteri

Badge Facoltativo

Ogni badge è un testo libero (massimo 15 caratteri) o una piccola immagine.

Badge - Testo Facoltativo

Titolo del badge

Nota:per il badge è necessario un testo o un'immagine

Testo libero

Dimensioni del testo consigliate: massimo 15 caratteri

Badge - Immagine Facoltativo

Immagine piccola

Trattamento UX speciale, ad esempio come overlay del badge sulla miniatura dell'immagine/del video.

Nota:per il badge è necessario un testo o un'immagine

Per indicazioni, consulta le specifiche per le immagini.
Price - CurrentPrice Obbligatorio condizionalmente

Il prezzo attuale del biglietto/pass per l'evento.

Deve essere fornito se viene fornito il prezzo barrato.

Testo libero
Price - StrikethroughPrice Facoltativo Il prezzo originale del biglietto/pass per l'evento. Testo libero
Callout di prezzo Facoltativo Callout del prezzo per mostrare una promozione, un evento o uno sconto per gli abbonati, se disponibile.

Testo libero

Dimensioni del testo consigliate: meno di 45 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)

Categorie di contenuti Facoltativo Descrivi la categoria dei contenuti nell'entità.

Elenco di enum idonei

  • TYPE_MOVIES_AND_TV_SHOWS (esempio: Cinema)
  • TYPE_DIGITAL_GAMES (ad esempio, eSport)
  • TYPE_MUSIC (esempio: concerto)
  • TYPE_TRAVEL_AND_LOCAL (esempio: tour, festival)
  • TYPE_HEALTH_AND_FITENESS (ad esempio, un corso di yoga)
  • TYPE_EDUCATION (esempio: corso)
  • TYPE_SPORTS (ad esempio, una partita di calcio)
  • TYPE_DATING (esempio: meetup)

Per indicazioni, consulta la sezione Categoria di contenuti.

EventReservationEntity

Attributo Requisito Descrizione Formato
URI azione Obbligatorio

Deep link all'entità nell'app del fornitore.

Nota: puoi utilizzare i deep link per l'attribuzione. Consulta queste domande frequenti

URI
Titolo Obbligatorio Titolo dell'entità.

Stringa

Recommended text size: Max 50 chars

Ora di inizio Obbligatorio

Il timestamp epoch in cui è previsto l'inizio dell'evento.

Nota: questo valore verrà rappresentato in millisecondi.

Timestamp epoch in millisecondi
Modalità evento Obbligatorio

Un campo per indicare se l'evento sarà virtuale, di persona o entrambi.

Enum: VIRTUAL, IN_PERSON o HYBRID
Località - Paese Obbligatorio condizionalmente

Il paese in cui si svolge l'evento.

Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Città Obbligatorio condizionalmente

La città in cui si svolge l'evento.

Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Indirizzo visualizzato Obbligatorio condizionalmente

L'indirizzo o il nome della sede in cui si terrà l'evento che deve essere mostrato all'utente.

Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Via Facoltativo L'indirizzo (se applicabile) della sede in cui si tiene l'evento.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Stato Facoltativo Lo stato o la provincia (se applicabile) in cui si tiene l'evento.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Codice postale Facoltativo Il codice postale (se applicabile) della località in cui si tiene l'evento.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Località - Quartiere Facoltativo Il quartiere (se applicabile) in cui si tiene l'evento.

Testo libero

Dimensioni del testo consigliate: massimo ~20 caratteri

Immagini del poster Facoltativo

Se vengono fornite più immagini, ne mostreremo solo una. Le proporzioni consigliate sono 16:9

Nota: l'immagine è vivamente consigliata. Se viene fornito un badge, assicurati che lo spazio sicuro sia di 24 dp sia nella parte superiore che in quella inferiore dell'immagine.

Per indicazioni, consulta le specifiche per le immagini.
Ora di fine Facoltativo

Il timestamp epoch in cui è prevista la fine dell'evento.

Nota: questo valore verrà rappresentato in millisecondi.

Timestamp epoch in millisecondi
Fornitore di servizi - Nome Facoltativo

Il nome del fornitore di servizi.

Nota: per il fornitore di servizi è necessario il testo o l'immagine.

Testo libero. Ad esempio, il nome dell'organizzatore dell'evento o del tour
Fornitore di servizi - Immagine Facoltativo

Il logo/l'immagine del fornitore di servizi.

Nota: per il fornitore di servizi è necessario il testo o l'immagine.

Per indicazioni, consulta le specifiche per le immagini.
Descrizione Facoltativo

Un singolo paragrafo di testo che descrive l'entità.

Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.

Testo libero

Dimensioni del testo consigliate: 180 caratteri

Elenco dei sottotitoli Facoltativo

Fino a 3 sottotitoli, ciascuno composto da una singola riga di testo.

Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.

Testo libero

Dimensioni del testo consigliate per ogni sottotitolo: massimo 50 caratteri

Badge Facoltativo

Ogni badge è un testo libero (massimo 15 caratteri) o una piccola immagine.

Badge - Testo Facoltativo

Titolo del badge

Nota:per il badge è necessario un testo o un'immagine

Testo libero

Dimensioni del testo consigliate: massimo 15 caratteri

Badge - Immagine Facoltativo

Immagine piccola

Trattamento UX speciale, ad esempio come overlay del badge sulla miniatura dell'immagine/del video.

Nota:per il badge è necessario un testo o un'immagine

Per indicazioni, consulta le specifiche per le immagini.
ID prenotazione Facoltativo L'ID prenotazione per la prenotazione dell'evento. Testo libero
Price - CurrentPrice Obbligatorio condizionalmente

Il prezzo attuale del biglietto/pass per l'evento.

Deve essere fornito se viene fornito il prezzo barrato.

Testo libero
Price - StrikethroughPrice Facoltativo Il prezzo originale del biglietto/pass per l'evento. Testo libero
Callout di prezzo Facoltativo Callout del prezzo per mostrare una promozione, un evento o uno sconto per gli abbonati, se disponibile.

Testo libero

Dimensioni del testo consigliate: meno di 45 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)

Valutazione - Valore massimo Facoltativo

Il valore massimo della scala di valutazione.

Deve essere fornito se viene fornito anche il valore corrente della valutazione.

Numero >= 0,0
Rating - Current value Facoltativo

Il valore attuale della scala di valutazione.

Deve essere fornito se viene fornito anche il valore massimo della valutazione.

Numero >= 0,0
Valutazione - Conteggio Facoltativo

Il numero di valutazioni per l'evento.

Nota:fornisci questo campo se la tua app vuole controllare il modo in cui viene visualizzato agli utenti. Fornisci la stringa concisa che può essere mostrata all'utente. Ad esempio, se il conteggio è 1.000.000, valuta la possibilità di utilizzare abbreviazioni come 1M, in modo che non venga troncato su schermi di dimensioni ridotte.

Stringa
Rating - Count Value Facoltativo

Il numero di valutazioni per l'evento.

Nota: specifica questo campo se non vuoi gestire autonomamente la logica di abbreviazione della visualizzazione. Se sono presenti sia Count che Count Value, utilizzeremo Count per la visualizzazione agli utenti

Lungo
Categorie di contenuti Facoltativo Descrivi la categoria dei contenuti nell'entità.

Elenco di enum idonei

  • TYPE_MOVIES_AND_TV_SHOWS (esempio: Cinema)
  • TYPE_DIGITAL_GAMES (ad esempio, eSport)
  • TYPE_MUSIC (esempio: concerto)
  • TYPE_TRAVEL_AND_LOCAL (esempio: tour, festival)
  • TYPE_HEALTH_AND_FITENESS (ad esempio, un corso di yoga)
  • TYPE_EDUCATION (esempio: corso)
  • TYPE_SPORTS (ad esempio, una partita di calcio)
  • TYPE_DATING (esempio: meetup)

Per indicazioni, consulta la sezione Categoria di contenuti.

Specifiche per le immagini

Le specifiche obbligatorie per gli asset immagine sono elencate in questa tabella:

Proporzioni Numero minimo di pixel Numero consigliato di pixel

Immagine quadrata (1 x 1).

Preferred

300x300 1200x1200
Immagine orizzontale (1,91 x 1) 600x314 1200x628
Verticale (4x5) 480x600 960x1200

Le immagini devono essere ospitate su CDN pubbliche in modo che Google possa accedervi.

Formati file

PNG, JPG, GIF statico, WebP

Dimensioni massime del file

5120 kB

Altri consigli

  • Area di sicurezza per l'immagine:inserisci i contenuti importanti al centro dell'immagine in modo da occuparne l'80%.
  • Utilizza uno sfondo trasparente in modo che l'immagine possa essere visualizzata correttamente nelle impostazioni dei temi scuro e chiaro.

Categoria di contenuti

La categoria di contenuti consente alle app di pubblicare contenuti appartenenti a più categorie. In questo modo, i contenuti vengono mappati con alcune delle categorie predefinite, ovvero:

  • TYPE_EDUCATION
  • TYPE_SPORTS
  • TYPE_MOVIES_AND_TV_SHOWS
  • TYPE_BOOKS
  • TYPE_AUDIOBOOKS
  • TYPE_MUSIC
  • TYPE_DIGITAL_GAMES
  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_HOME_AND_AUTO
  • TYPE_BUSINESS
  • TYPE_NEWS
  • TYPE_FOOD_AND_DRINK
  • TYPE_SHOPPING
  • TYPE_HEALTH_AND_FITENESS
  • TYPE_MEDICAL
  • TYPE_PARENTING
  • TYPE_DATING

Le immagini devono essere ospitate su CDN pubbliche in modo che Google possa accedervi.

Linee guida per l'utilizzo delle categorie di contenuti

  1. Alcune entità come ArticleEntity e GenericFeaturedEntity sono idonee a utilizzare una qualsiasi delle categorie di contenuti. Per altre entità come EventEntity, EventReservationEntity, PersonEntity, è idoneo solo un sottoinsieme di queste categorie. Controlla l'elenco delle categorie idonee per un tipo di entità prima di compilarlo.
  2. Utilizza il tipo di entità specifico per alcune categorie di contenuti anziché una combinazione di entità generiche e ContentCategory:

  3. Il campo ContentCategory è facoltativo e deve essere lasciato vuoto se i contenuti non appartengono a nessuna delle categorie menzionate in precedenza.

  4. Se vengono fornite più categorie di contenuti, forniscile in ordine di pertinenza rispetto ai contenuti, con la categoria di contenuti più pertinente posizionata per prima nell'elenco.

Passaggio 2: fornisci i dati del cluster

Ti consigliamo di eseguire il job di pubblicazione dei contenuti in background (ad esempio utilizzando WorkManager) e di pianificarlo regolarmente o in base a un evento (ad esempio ogni volta che l'utente apre l'app o quando aggiunge un articolo al carrello).

AppEngagePublishClient è responsabile dei cluster publisher.

Esistono le seguenti API per pubblicare i cluster 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.

Puoi verificare la disponibilità del servizio per ogni tipo di cluster che intendi pubblicare. L'API isServiceAvailable accetta un oggetto di richiesta, ServiceAvailabilityRequest, che contiene i tipi di cluster per i quali deve essere verificata la disponibilità del servizio. Puoi trovare i valori enum ClusterType richiesti per ServiceAvailabilityRequest nella tabella seguente.

Tipo di cluster Costante del tipo di cluster Valore intero
Sconosciuto TYPE_UNKNOWN 0
Cluster di suggerimenti TYPE_RECOMMENDATION 1
Cluster in primo piano TYPE_FEATURED 2
Cluster di continuazione TYPE_CONTINUATION 3
Cluster di gestione utenti TYPE_ENGAGEMENT 8
Cluster di sottoscrizione 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.
    }
});
Funzionalità di disponibilità del servizio condizionale

Alcune app integrate richiedono una configurazione speciale che attiva e disattiva il servizio Engage in modo intermittente per ridurre i costi di pubblicazione. Tuttavia, questa strategia di importazione di contenuti intermittente influisce negativamente sull'esperienza utente: i contenuti obsoleti non verranno presentati e alcune piattaforme non verranno pubblicate.

A partire dalla versione 1.6.0, l'SDK Engage consente di verificare la disponibilità di tipi di cluster specifici. Se la tua app utilizza l'importazione intermittente:

  • I cluster di continuazione (come Continua a leggere e Prenotazioni di eventi) rimangono attivi per impostazione predefinita su tutti i dispositivi supportati.
  • Altri tipi di cluster (come i suggerimenti) vengono attivati e disattivati a intermittenza.

Se questa configurazione predefinita non è adatta alle tue esigenze, contatta engage-developers@google.com.

Per le versioni dell'SDK precedenti alla 1.6.0 (ritirate)

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("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());

Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni all'interno di una transazione:

  • I dati RecommendationCluster esistenti del partner sviluppatore vengono rimossi.
  • I dati della richiesta vengono analizzati e archiviati nel cluster di suggerimenti aggiornato.

In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene mantenuto.

publishFeaturedCluster

Questa API viene utilizzata per pubblicare un elenco di oggetti FeaturedCluster.

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());

Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni all'interno di una transazione:

  • I dati FeaturedCluster esistenti del partner sviluppatore vengono 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 mantenuto.

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(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni all'interno di una transazione:

  • I dati ContinuationCluster esistenti del partner sviluppatore vengono rimossi.
  • I dati della richiesta vengono analizzati e archiviati nel cluster di continuazione aggiornato.

In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene mantenuto.

publishUserAccountManagementRequest

Questa API viene utilizzata per pubblicare una tessera di accesso . L'azione di accesso indirizza gli utenti alla pagina di accesso dell'app in modo che l'app possa pubblicare contenuti (o fornire contenuti più personalizzati)

I seguenti metadati fanno parte della scheda Accedi:

Attributo Requisito Descrizione
URI azione Obbligatorio Deep link all'azione (ad es. rimanda alla pagina di accesso all'app)
Immagine Facoltativo. Se non viene fornito, è necessario fornire il titolo

Immagine mostrata sulla scheda

Immagini con proporzioni 16:9 e risoluzione di 1264 x 712

Titolo Facoltativo. Se non viene fornito, è necessario fornire l'immagine Titolo sulla scheda
Testo di azione Facoltativo Testo mostrato nella CTA (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 all'interno di una transazione:

  • I dati UserAccountManagementCluster esistenti del partner sviluppatore vengono rimossi.
  • I dati della richiesta vengono analizzati e archiviati nel cluster UserAccountManagementCluster aggiornato.

In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene mantenuto.

updatePublishStatus

Se per qualsiasi motivo aziendale interno nessuno dei cluster viene pubblicato, ti consigliamo vivamente di aggiornare lo stato di pubblicazione utilizzando l'API updatePublishStatus. Questo è importante perché :

  • Fornire lo stato in tutti gli scenari, anche quando i contenuti sono pubblicati (STATUS == PUBLISHED), è fondamentale per compilare le dashboard che utilizzano questo stato esplicito per comunicare l'integrità e altre metriche della tua integrazione.
  • Se non vengono pubblicati contenuti, ma lo stato dell'integrazione non è interrotto (STATUS == NOT_PUBLISHED), Google può evitare di attivare avvisi nelle dashboard di integrità dell'app. Conferma che i contenuti non vengono pubblicati a causa di una situazione prevista dal punto di vista del fornitore.
  • Aiuta gli sviluppatori a fornire informazioni su quando i dati vengono pubblicati e quando no.
  • Google potrebbe utilizzare i codici di stato per invitare l'utente a eseguire determinate azioni nell'app in modo che possa visualizzare i contenuti dell'app o superare il problema.

L'elenco dei codici di stato di pubblicazione idonei è il seguente :

// 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 Accedi. Se per qualsiasi motivo i fornitori non sono in grado di pubblicare la scheda di accesso, consigliamo di chiamare l'API updatePublishStatus con il codice di stato NOT_PUBLISHED_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());

deleteRecommendationsClusters

Questa API viene utilizzata per eliminare i contenuti dei cluster di suggerimenti.

Kotlin

client.deleteRecommendationsClusters()

Java

client.deleteRecommendationsClusters();

Quando il servizio riceve la richiesta, rimuove i dati esistenti dai 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 evidenza.

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

Quando il servizio riceve la richiesta, rimuove i dati esistenti dal 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 dal 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 dal cluster UserAccountManagement. In caso di errore, l'intera richiesta viene rifiutata 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_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());

Quando il servizio riceve la richiesta, rimuove i dati esistenti da tutti i cluster corrispondenti ai tipi di cluster specificati. I client possono scegliere di passare uno o più tipi di cluster. In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene mantenuto.

Gestione degli errori

Ti consigliamo vivamente di ascoltare il risultato dell'attività dalle API di pubblicazione in modo da poter intraprendere un'azione di follow-up per recuperare e inviare nuovamente un'attività riuscita.

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

L'errore viene restituito come AppEngageException con la causa inclusa come 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 è disponibile al momento della chiamata (ad esempio, è disattivato esplicitamente).
SERVICE_CALL_EXECUTION_FAILURE L'esecuzione dell'attività non è riuscita a causa di problemi di threading. In questo caso, è possibile 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, un numero di cluster superiore a quello consentito).
SERVICE_CALL_INTERNAL Si è verificato un errore lato servizio.
SERVICE_CALL_RESOURCE_EXHAUSTED La chiamata di servizio viene effettuata troppo di frequente.

Passaggio 3: gestisci gli intent di trasmissione

Oltre a effettuare chiamate API Content tramite un job, è necessario anche configurare un BroadcastReceiver per ricevere la richiesta di pubblicazione di contenuti.

L'obiettivo degli intent di trasmissione è principalmente la riattivazione dell'app e la sincronizzazione forzata dei dati. Gli intent di trasmissione non sono progettati per essere inviati molto di frequente. Viene attivato solo quando il servizio Engage determina che i contenuti potrebbero essere obsoleti (ad esempio, risalenti a una settimana prima). In questo modo, è più probabile che l'utente possa usufruire di un'esperienza con contenuti aggiornati, anche se l'applicazione non è stata eseguita per un lungo periodo di tempo.

BroadcastReceiver deve essere configurato nei seguenti due modi:

  • Registra dinamicamente un'istanza della classe BroadcastReceiver utilizzando Context.registerReceiver(). In questo modo, le applicazioni ancora attive in memoria possono comunicare.

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

}
  • Dichiara staticamente un'implementazione con il tag <receiver> nel file AndroidManifest.xml. In questo modo, l'applicazione può ricevere intent di trasmissione quando non è in esecuzione e può anche pubblicare i contenuti.

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

Il servizio invia i seguenti intent:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Ti consigliamo di avviare una chiamata publishRecommendationClusters quando ricevi questo intent.
  • com.google.android.engage.action.PUBLISH_FEATURED Ti consigliamo di avviare una chiamata publishFeaturedCluster quando ricevi questo intent.
  • com.google.android.engage.action.PUBLISH_CONTINUATION Ti consigliamo di avviare una chiamata publishContinuationCluster quando ricevi questo intent.

Workflow di integrazione

Per una guida passo passo sulla verifica dell'integrazione una volta completata, consulta il flusso di lavoro di integrazione per gli sviluppatori di Engage.

Domande frequenti

Per le domande frequenti, consulta Domande frequenti sull'SDK Engage.

Contatto

Contatta engage-developers@google.com in caso di domande durante il processo di integrazione.

Passaggi successivi

Dopo aver completato questa integrazione, i passaggi successivi sono i seguenti:

  • Invia un'email all'indirizzo engage-developers@google.com e allega l'APK integrato pronto per essere testato da Google.
  • Google esegue una verifica e dei controlli interni per assicurarsi che l'integrazione funzioni come previsto. Se sono necessarie modifiche, Google ti contatterà con tutti i dettagli necessari.
  • Al termine dei test, se non sono necessarie modifiche, Google ti contatta per comunicarti che puoi iniziare a pubblicare l'APK aggiornato e integrato sul Play Store.
  • Dopo che Google avrà confermato che l'APK aggiornato è stato pubblicato sul Play Store, i cluster Contenuti consigliati, In evidenza e Continua potrebbero essere pubblicati e visibili agli utenti.