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 per verticali e offre una nuova esperienza immersiva per il consumo e la scoperta di contenuti delle app personalizzati. Questa esperienza a schermo intero offre agli sviluppatori partner l'opportunità di mostrare i loro migliori contenuti avanzati in un canale dedicato esterno all'app.Questa guida contiene istruzioni per gli sviluppatori partner per integrare i loro contenuti relativi agli incontri utilizzando l'SDK Engage per completare questa nuova area.

Dettagli integrazione

Terminologia

Questa integrazione include i seguenti tre tipi di cluster: Consiglio, In primo piano e Continuazione.

• I cluster di consigli mostrano suggerimenti personalizzati di incontri da un singolo partner di sviluppo. Questi consigli possono essere personalizzati in base all'utente.

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

  I consigli hanno la seguente struttura:

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

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

    • ArticleEntity: rappresenta una raccomandazione 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 spiegare le informazioni agli utenti.

      

      Figura 1: UI che mostra una singola ArticleEntity all'interno del cluster Recommendations.

    • PersonEntity: rappresenta una persona. I consigli potrebbero essere quello di mettere in evidenza una persona che cerca un appuntamento.

      

      Figura 2: UI che mostra una singola PersonEntity all'interno del cluster Recommendations.

    • 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 una singola EventEntity all'interno del cluster Recommendations.

• Il cluster Continuazione mostra i contenuti coinvolti di recente dagli utenti di più sviluppatori partner in un unico raggruppamento di UI. Ogni partner di sviluppo potrà trasmettere un massimo di 10 entità nel cluster di continuazione.

  I contenuti della continuazione possono assumere la seguente struttura:

  • ArticleEntity: rappresenta una raccomandazione 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 utilizzare dal punto in cui l'ha lasciato.

    

    Figura 6. UI che mostra una singola ArticleEntity all'interno di un cluster di continuazione.

  • EventReservationEntity: EventReservationEntity rappresenta la prenotazione di un evento e aiuta gli utenti a tenere traccia delle prenotazioni in corso o di incontri in corso e le prenotazioni di eventi di Meet.

    

    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'elemento hero scelto GenericFeaturedEntity da molti sviluppatori partner in un unico raggruppamento dell'interfaccia utente. Esiste un unico cluster in primo piano che viene visualizzato nella parte superiore dell'UI, con un posizionamento prioritario sopra tutti i cluster di suggerimenti. Ogni partner per sviluppatori può trasmettere una singola entità di un tipo supportato in In primo piano, con molte entità (potenzialmente di tipi diversi) di più sviluppatori di app nel cluster In primo piano.

  • GenericFeatureEntity: l'elemento in primo piano è diverso dall'elemento consigliato perché dovrebbe essere utilizzato per un unico contenuto principale degli sviluppatori e dovrebbe rappresentare i singoli contenuti più importanti che saranno interessanti e pertinenti per gli utenti.

    

    Figura 12: UI che mostra un FeatureCluster con un elenco di GenericFeatureEntity

Preparazione

Livello API minimo: 19

Aggiungi la raccolta com.google.android.play:engage 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.4.1'
}

Riepilogo

La progettazione si basa sull'implementazione di un servizio associato.

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

Tipo di cluster	Limiti del cluster	Limiti minimi di entità in un cluster	Limiti massimi di entità in un cluster
Cluster di suggerimenti	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 dell'entità

L'SDK ha definito diverse entità per rappresentare ogni tipo di elemento. Per la categoria Incontri, supportiamo le seguenti persone giuridiche:

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

I grafici riportati di seguito descrivono gli attributi disponibili e i requisiti per ciascun tipo.

GenericFeaturedEntity

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorie	Link diretto all'entità nell'app del provider. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti	URI
Immagini poster	Obbligatorie	Se vengono fornite più immagini, mostreremo una sola immagine. Le proporzioni consigliate sono 16:9 Nota: se viene fornito un badge, assicurati che lo spazio di sicurezza sia pari a 24 dps nella parte superiore e inferiore dell'immagine.	Per istruzioni, consulta la sezione Specifiche delle immagini.
Titolo	Facoltativo	Titolo dell'entità.	Testo libero Dimensione del testo consigliata: 50 caratteri
Descrizione	Facoltativo	Un singolo paragrafo di testo per descrivere l'entità. Nota: all'utente verrà mostrata la descrizione o l'elenco di sottotitoli, non entrambi.	Testo libero Dimensione del testo consigliata: 180 caratteri
Elenco di sottotitoli	Facoltativo	Fino a 3 sottotitoli, ognuno dei quali con una singola riga di testo. Nota: all'utente verrà mostrata la descrizione o l'elenco di sottotitoli, non entrambi.	Testo libero Dimensioni del testo consigliate per ciascun sottotitolo: massimo 50 caratteri
Badge	Facoltativo	Ogni badge può essere composto da testo libero (massimo 15 caratteri) o immagine piccola. Trattamento speciale dell'esperienza utente sull'immagine o sul video, ad esempio tramite overlay del badge sull'immagine Ad es. "Aggiornamento in tempo reale" Ad es. Durata di lettura degli articoli
Testo del badge	Facoltativo	Titolo del badge Nota: per il badge è necessario fornire testo o un'immagine	Testo libero Dimensione del testo consigliata: massimo 15 caratteri
Badge - Immagine	Facoltativo	Immagine piccola Trattamento speciale dell'UX, ad esempio tramite l'overlay del badge sulla miniatura dell'immagine o del video. Nota: per il badge è necessario fornire testo o un'immagine	Per istruzioni, consulta la sezione Specifiche delle immagini.
Categorie di contenuti	Facoltativo	Descrivi la categoria dei contenuti nell'entità.	Elenco di enumerazioni Per istruzioni, consulta la sezione relativa alle categorie di contenuti.

ArticleEntity

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorie	Link diretto all'entità nell'app del provider. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti	URI
Titolo	Obbligatorie	Titolo dell'entità.	Testo libero Dimensioni del testo consigliate: max 50 caratteri
Immagini poster	Facoltativo	Se vengono fornite più immagini, mostreremo una sola immagine. Le proporzioni consigliate sono 16:9 Nota:ti consigliamo vivamente di utilizzare l'immagine. Se viene fornito un badge, assicurati che lo spazio di sicurezza sia di 24 dps nella parte superiore e inferiore dell'immagine	Per istruzioni, consulta la sezione Specifiche delle immagini.
Fonte - Titolo	Facoltativo	Il nome dell'autore, dell'organizzazione o dell'autore della segnalazione	Testo libero Dimensione del testo consigliata: meno di 25 caratteri
Origine - Immagine	Facoltativo	Un'immagine della fonte, come l'autore, l'organizzazione, il giornalista	Per istruzioni, consulta la sezione Specifiche delle immagini.
Descrizione	Facoltativo	Un singolo paragrafo di testo per descrivere l'entità. Nota: all'utente verrà mostrata la descrizione o l'elenco di sottotitoli, non entrambi.	Testo libero Dimensione del testo consigliata: 180 caratteri
Elenco di sottotitoli	Facoltativo	Fino a 3 sottotitoli, ognuno dei quali con una singola riga di testo. Nota: all'utente verrà mostrata la descrizione o l'elenco di sottotitoli, non entrambi.	Testo libero Dimensioni del testo consigliate per ciascun sottotitolo: massimo 50 caratteri
Badge	Facoltativo	Ogni badge può essere composto da testo libero (massimo 15 caratteri) o immagine piccola. Trattamento speciale dell'esperienza utente sull'immagine o sul video, ad esempio tramite overlay del badge sull'immagine Ad es. "Aggiornamento in tempo reale" Ad es. Durata di lettura degli articoli
Testo del badge	Facoltativo	Titolo del badge Nota: per il badge è necessario fornire testo o un'immagine	Testo libero Dimensione del testo consigliata: massimo 15 caratteri
Badge - Immagine	Facoltativo	Immagine piccola Trattamento speciale dell'UX, ad esempio tramite l'overlay del badge sulla miniatura dell'immagine o del video. Nota: per il badge è necessario fornire testo o un'immagine	Per istruzioni, consulta la sezione Specifiche delle immagini.
Ora di pubblicazione dei contenuti	Facoltativo	Questo è il timestamp dell'epoca in millisecondi relativo a quando i contenuti sono stati pubblicati / aggiornati nell'app.	Timestamp epoca in millisecondi
Data/ora ultimo coinvolgimento	Obbligatoria condizionalmente	Il timestamp dell'epoca in millisecondi in cui l'utente ha interagito con l'ultima entità. Nota: questo campo è obbligatorio se l'entità fa parte del cluster di continuazione.	Timestamp epoca in millisecondi
Percentuale di avanzamento	Obbligatoria condizionalmente	La percentuale di contenuti totali utilizzati dall'utente fino a oggi. Nota: questo campo è obbligatorio se l'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 enumerazioni Per istruzioni, consulta la sezione relativa alle categorie di contenuti.

PersonEntity

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorie	Link diretto all'entità nell'app del provider. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti	URI
Profilo - Nome	Obbligatorie	Nome, ID o handle del profilo, ad esempio "Mario Rossi", "@TeamPixel" e così via.	Stringa Dimensioni del testo consigliate: max 50 caratteri
Profilo - Avatar	Obbligatorie	Immagine del profilo o dell'avatar dell'utente. Nota: deve essere un'immagine quadrata 1:1.	Per istruzioni, consulta la sezione Specifiche delle immagini.
Profilo - Testo aggiuntivo	Facoltativo	Testo libero come l'handle del profilo.	Testo libero Dimensioni del testo consigliate: max 15 caratteri
Profilo - Immagine aggiuntiva	Facoltativo	Immagine piccola come un badge di verifica.	Per istruzioni, consulta la sezione Specifiche delle immagini.
Immagine intestazione	Facoltativo	Se vengono fornite più immagini, mostreremo una sola immagine. Le proporzioni consigliate sono 16:9 Nota:ti consigliamo vivamente di utilizzare l'immagine. Se viene fornito un badge, assicurati che lo spazio di sicurezza sia di 24 dps nella parte superiore e inferiore dell'immagine	Per istruzioni, consulta la sezione Specifiche delle immagini.
Popolarità - Numero	Facoltativo	Rappresenta l'immagine intestazione. Deve essere diversa dall'immagine del profilo. Questa opzione può essere utilizzata se è presente un'immagine aggiuntiva per evidenziare la persona come il suo lavoro. Nota: deve essere un'immagine in formato 16:9. Se viene fornito un badge, assicurati che lo spazio di sicurezza sia di 24 dps nella parte superiore e inferiore dell'immagine	Stringa Dimensione del testo consigliata: max 20 caratteri per conteggio + etichetta combinate
Popolarità - Valore di conteggio	Facoltativo	Il numero di follower o il valore popolarità. Nota: fornisci un valore di conteggio se la tua app non vuole gestire la logica di ottimizzazione di un numero grande per diverse dimensioni di visualizzazione. Se vengono forniti sia Conteggio che Conteggio, verrà utilizzato Conteggio.	Lungo
Popolarità - Etichetta	Facoltativo	Indica l'etichetta di popolarità, ad esempio "Mi piace".	Stringa Dimensione del testo consigliata: max 20 caratteri per conteggio + etichetta combinate
Popolarità - Contenuti visivi	Facoltativo	Indica lo scopo dell'interazione. Ad esempio: immagine che mostra l'icona dei Mi piace, emoji. È possibile fornire più di un'immagine, anche se non tutte potrebbero essere mostrate in tutti i fattori di forma. Nota: deve essere un'immagine quadrata 1:1	Per istruzioni, consulta la sezione Specifiche delle immagini.
Valutazione - Valore massimo	Obbligatorio	Il valore massimo della scala di valutazione. Deve essere fornito se viene fornito anche il valore attuale della valutazione.	Numero >= 0,0
Classificazione - Valore attuale	Obbligatorio	Il valore attuale della scala di valutazione. Deve essere fornito se viene fornito anche un valore massimo della valutazione.	Numero >= 0,0
Valutazione - Conteggio	Facoltativo	Il conteggio delle valutazioni per l'entità. Nota: fornisci questo campo se la tua app vuole controllare come viene mostrata agli utenti. Fornisci la stringa concisa che può essere visualizzata dall'utente. Ad esempio, se il conteggio è 1.000.000, è consigliabile utilizzare abbreviazioni come 1 milione, in modo che non venga troncato sui display di dimensioni inferiori.	Stringa
Valutazione - Valore conteggio	Facoltativo	Il conteggio delle valutazioni per l'entità. Nota: fornisci questo campo se non vuoi gestire personalmente la logica delle abbreviazioni di visualizzazione. Se sono presenti sia Conteggio che Conteggio, utilizzeremo Conteggio per mostrare agli utenti	Lungo
Località - Paese	Facoltativo	Il paese in cui si trova l'utente o in cui opera l'utente.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Città	Facoltativo	La città in cui si trova l'utente o in cui opera l'utente.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Indirizzo visualizzato	Facoltativo	L'indirizzo in cui si trova l'utente o in cui opera questa persona verrà mostrato all'utente.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Indirizzo	Facoltativo	La via (se applicabile) in cui si trova la persona o che presta servizio.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Stato	Facoltativo	Lo stato, se applicabile, in cui la persona si trova o in cui fornisce il servizio.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località: CAP	Facoltativo	Il codice postale (se applicabile) del luogo in cui si trova la persona o che fornisce servizi.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Posizione - Quartiere	Facoltativo	Il quartiere (se applicabile) in cui si trova l'utente o in cui opera.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Badge	Facoltativo	Ogni badge può essere composto da testo libero (massimo 15 caratteri) o immagine piccola.
Testo del badge	Facoltativo	Titolo del badge Nota: per il badge è necessario fornire testo o un'immagine	Testo libero Dimensione del testo consigliata: massimo 15 caratteri
Badge - Immagine	Facoltativo	Immagine piccola Trattamento speciale dell'UX, ad esempio tramite l'overlay del badge sulla miniatura dell'immagine o del video. Nota: per il badge è necessario fornire testo o un'immagine	Per istruzioni, consulta la sezione Specifiche delle immagini.
Descrizione	Facoltativo	Un singolo paragrafo di testo per descrivere l'entità. Nota: all'utente verrà mostrata la descrizione o l'elenco di sottotitoli, non entrambi.	Testo libero Dimensione del testo consigliata: 180 caratteri
Elenco di sottotitoli	Facoltativo	Fino a 3 sottotitoli, ognuno dei quali con una singola riga di testo. Nota: all'utente verrà mostrata la descrizione o l'elenco di sottotitoli, non entrambi.	Testo libero Dimensioni del testo consigliate per ciascun sottotitolo: massimo 50 caratteri
Categorie di contenuti	Facoltativo	Descrivi la categoria dei contenuti nell'entità.	Elenco di enum idonee TYPE_HEALTH_AND_FITENESS (ad es. yoga/formatore) TYPE_HOME_AND_AUTO (ad es. Idraulico) TYPE_SPORTS (ad es. giocatore) INSERIMENTO_TIPO Per istruzioni, consulta la sezione relativa alle categorie di contenuti.

EventEntity

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorie	Link diretto all'entità nell'app del provider. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti	URI
Titolo	Obbligatorie	Titolo dell'entità.	Stringa Dimensioni del testo consigliate: max 50 caratteri
Ora di inizio	Obbligatorie	Il timestamp dell'epoca in cui è previsto l'inizio dell'evento. Nota:questo valore viene rappresentato in millisecondi.	Timestamp epoca in millisecondi
Modalità evento	Obbligatorie	Un campo per indicare se l'evento sarà virtuale, di persona o entrambi.	Enum: VIRTUAL, IN_PERSON o HYBRID
Immagini poster	Obbligatorie	Se vengono fornite più immagini, mostreremo una sola immagine. Le proporzioni consigliate sono 16:9 Nota:ti consigliamo vivamente di utilizzare l'immagine. Se viene fornito un badge, assicurati che lo spazio di sicurezza sia di 24 dps nella parte superiore e inferiore dell'immagine	Per istruzioni, consulta la sezione Specifiche delle immagini.
Località - Paese	Obbligatoria condizionalmente	Il paese in cui si svolge l'evento. Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Città	Obbligatoria condizionalmente	La città in cui si svolge l'evento. Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Indirizzo visualizzato	Obbligatoria condizionalmente	L'indirizzo o il nome della sede in cui si svolgerà l'evento che dovrebbe essere mostrato all'utente. Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Indirizzo	Facoltativo	La via (se applicabile) del luogo in cui si svolge l'evento.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Stato	Facoltativo	Lo stato o la provincia (se applicabile) in cui l'evento viene ospitato.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località: CAP	Facoltativo	Il codice postale (se applicabile) della località in cui viene ospitato l'evento.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Posizione - Quartiere	Facoltativo	Il quartiere (se applicabile) in cui si trova l'evento.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Ora di fine	Facoltativo	Il timestamp dell'epoca in cui è prevista la fine dell'evento. Nota:questo valore viene rappresentato in millisecondi.	Timestamp epoca in millisecondi
Descrizione	Facoltativo	Un singolo paragrafo di testo per descrivere l'entità. Nota: all'utente verrà mostrata la descrizione o l'elenco di sottotitoli, non entrambi.	Testo libero Dimensione del testo consigliata: 180 caratteri
Elenco di sottotitoli	Facoltativo	Fino a 3 sottotitoli, ognuno dei quali con una singola riga di testo. Nota: all'utente verrà mostrata la descrizione o l'elenco di sottotitoli, non entrambi.	Testo libero Dimensioni del testo consigliate per ciascun sottotitolo: massimo 50 caratteri
Badge	Facoltativo	Ogni badge può essere composto da testo libero (massimo 15 caratteri) o immagine piccola.
Testo del badge	Facoltativo	Titolo del badge Nota: per il badge è necessario fornire testo o un'immagine	Testo libero Dimensione del testo consigliata: massimo 15 caratteri
Badge - Immagine	Facoltativo	Immagine piccola Trattamento speciale dell'UX, ad esempio tramite l'overlay del badge sulla miniatura dell'immagine o del video. Nota: per il badge è necessario fornire testo o un'immagine	Per istruzioni, consulta la sezione Specifiche delle immagini.
Prezzo - CurrentPrice	Obbligatoria condizionalmente	Il prezzo attuale del biglietto/pass per l'evento. Deve essere specificato se viene indicato un prezzo barrato.	Testo libero
Prezzo - Prezzo barrato	Facoltativo	Il prezzo originale del biglietto/pass per l'evento.	Testo libero
Callout prezzo	Facoltativo	Callout del prezzo per mettere in evidenza una promozione, un evento o uno sconto per i membri, se disponibile.	Testo libero Dimensione del testo consigliata: inferiore a 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 idonee TYPE_MovieS_AND_TV_SHOWS (ad es. Cinema) TYPE_DIGITAL_GAMES (ad es. eSport) TYPE_MUSIC (ad es. concerto) TYPE_TRAVEL_AND_LOCAL (ad es. tour, festival) TYPE_HEALTH_AND_FITENESS (ad es. lezione di yoga) TYPE_EDUCATION (ad es. classe) TYPE_SPORTS (ad es. partita di calcio) TYPE_DATING (ad es. Meet) Per istruzioni, consulta la sezione relativa alle categorie di contenuti.

EventReservationEntity

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorie	Link diretto all'entità nell'app del provider. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti	URI
Titolo	Obbligatorie	Titolo dell'entità.	Stringa Dimensioni del testo consigliate: max 50 caratteri
Ora di inizio	Obbligatorie	Il timestamp dell'epoca in cui è previsto l'inizio dell'evento. Nota:questo valore viene rappresentato in millisecondi.	Timestamp epoca in millisecondi
Modalità evento	Obbligatorie	Un campo per indicare se l'evento sarà virtuale, di persona o entrambi.	Enum: VIRTUAL, IN_PERSON o HYBRID
Località - Paese	Obbligatoria condizionalmente	Il paese in cui si svolge l'evento. Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Città	Obbligatoria condizionalmente	La città in cui si svolge l'evento. Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Indirizzo visualizzato	Obbligatoria condizionalmente	L'indirizzo o il nome della sede in cui si svolgerà l'evento che dovrebbe essere mostrato all'utente. Nota: questo campo è obbligatorio per gli eventi IN_PERSON o HYBRID	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Indirizzo	Facoltativo	La via (se applicabile) del luogo in cui si svolge l'evento.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località - Stato	Facoltativo	Lo stato o la provincia (se applicabile) in cui l'evento viene ospitato.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Località: CAP	Facoltativo	Il codice postale (se applicabile) della località in cui viene ospitato l'evento.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Posizione - Quartiere	Facoltativo	Il quartiere (se applicabile) in cui si trova l'evento.	Testo libero Dimensione del testo consigliata: massimo ~20 caratteri
Immagini poster	Facoltativo	Se vengono fornite più immagini, mostreremo una sola immagine. Le proporzioni consigliate sono 16:9 Nota:ti consigliamo vivamente di utilizzare l'immagine. Se viene fornito un badge, assicurati che lo spazio di sicurezza sia di 24 dps nella parte superiore e inferiore dell'immagine	Per istruzioni, consulta la sezione Specifiche delle immagini.
Ora di fine	Facoltativo	Il timestamp dell'epoca in cui è prevista la fine dell'evento. Nota:questo valore viene rappresentato in millisecondi.	Timestamp epoca in millisecondi
Fornitore di servizi - Nome	Facoltativo	Il nome del fornitore di servizi. Nota: per il fornitore di servizi è obbligatorio fornire un testo o un'immagine.	Testo libero. Ad es. Nome dell'organizzatore/tour dell'evento
Fornitore di servizi - Immagine	Facoltativo	Logo/immagine del fornitore di servizi. Nota: per il fornitore di servizi è obbligatorio fornire un testo o un'immagine.	Per istruzioni, consulta la sezione Specifiche delle immagini.
Descrizione	Facoltativo	Un singolo paragrafo di testo per descrivere l'entità. Nota: all'utente verrà mostrata la descrizione o l'elenco di sottotitoli, non entrambi.	Testo libero Dimensione del testo consigliata: 180 caratteri
Elenco di sottotitoli	Facoltativo	Fino a 3 sottotitoli, ognuno dei quali con una singola riga di testo. Nota: all'utente verrà mostrata la descrizione o l'elenco di sottotitoli, non entrambi.	Testo libero Dimensioni del testo consigliate per ciascun sottotitolo: massimo 50 caratteri
Badge	Facoltativo	Ogni badge può essere composto da testo libero (massimo 15 caratteri) o immagine piccola.
Testo del badge	Facoltativo	Titolo del badge Nota: per il badge è necessario fornire testo o un'immagine	Testo libero Dimensione del testo consigliata: massimo 15 caratteri
Badge - Immagine	Facoltativo	Immagine piccola Trattamento speciale dell'UX, ad esempio tramite l'overlay del badge sulla miniatura dell'immagine o del video. Nota: per il badge è necessario fornire testo o un'immagine	Per istruzioni, consulta la sezione Specifiche delle immagini.
ID prenotazione	Facoltativo	L'ID per la prenotazione dell'evento.	Testo libero
Prezzo - CurrentPrice	Obbligatoria condizionalmente	Il prezzo attuale del biglietto/pass per l'evento. Deve essere specificato se viene indicato un prezzo barrato.	Testo libero
Prezzo - Prezzo barrato	Facoltativo	Il prezzo originale del biglietto/pass per l'evento.	Testo libero
Callout prezzo	Facoltativo	Callout del prezzo per mettere in evidenza una promozione, un evento o uno sconto per i membri, se disponibile.	Testo libero Dimensione del testo consigliata: inferiore a 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 attuale della valutazione.	Numero >= 0,0
Classificazione - Valore attuale	Facoltativo	Il valore attuale della scala di valutazione. Deve essere fornito se viene fornito anche un valore massimo della valutazione.	Numero >= 0,0
Valutazione - Conteggio	Facoltativo	Il conteggio delle valutazioni per l'evento. Nota: fornisci questo campo se la tua app vuole controllare come viene mostrata agli utenti. Fornisci la stringa concisa che può essere visualizzata dall'utente. Ad esempio, se il conteggio è 1.000.000, è consigliabile utilizzare abbreviazioni come 1 milione, in modo che non venga troncato sui display di dimensioni inferiori.	Stringa
Valutazione - Valore conteggio	Facoltativo	Il conteggio delle valutazioni per l'evento. Nota: fornisci questo campo se non vuoi gestire personalmente la logica delle abbreviazioni di visualizzazione. Se sono presenti sia Conteggio che Conteggio, utilizzeremo Conteggio per mostrare agli utenti	Lungo
Categorie di contenuti	Facoltativo	Descrivi la categoria dei contenuti nell'entità.	Elenco di enum idonee TYPE_MovieS_AND_TV_SHOWS (ad es. Cinema) TYPE_DIGITAL_GAMES (ad es. eSport) TYPE_MUSIC (ad es. concerto) TYPE_TRAVEL_AND_LOCAL (ad es. tour, festival) TYPE_HEALTH_AND_FITENESS (ad es. lezione di yoga) TYPE_EDUCATION (ad es. classe) TYPE_SPORTS (ad es. partita di calcio) TYPE_DATING (ad es. Meet) Per istruzioni, consulta la sezione relativa alle categorie di contenuti.

Specifiche per le immagini

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

Proporzioni	Numero minimo di pixel	Numero consigliato di pixel
Quadrato (1 x 1) Preferito	300x300	1200x1200
Orizzontale (1,91 x 1)	600x314	1200x628
Verticale (4 x 5)	480x600	960x1200

Le immagini devono essere ospitate su reti CDN pubbliche per consentire a Google di accedervi.

Formati file

PNG, JPG, GIF statica, WebP

Dimensione massima del file

5120 kB

Consigli aggiuntivi

• Area di sicurezza dell'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 del tema 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 reti CDN pubbliche per consentire a Google di accedervi.

Linee guida per l'utilizzo delle categorie di contenuti

1. Alcune entità, come ArticleEntity e GenericFeatureEntity, sono idonee a utilizzare qualsiasi categoria di contenuti. Per altre entità come EventEntity, EventReservationEntity, PersonEntity, solo un sottoinsieme di queste categorie è idoneo. Controlla l'elenco delle categorie idonee per un tipo di entità prima di completarlo.

2. Utilizza il tipo di entità specifico per alcune categorie di contenuti rispetto a una combinazione di entità generiche e ContentCategory:

   • TYPE_MovieS_AND_TV_SHOWS - Consulta le entità nella Guarda la guida all'integrazione prima di utilizzare le entità generiche.
   • TYPE_BOOKS - Consulta l'EbookEntity prima di utilizzare le entità generiche.
   • TYPE_AUDIOBOOKS - Consulta AudiobookEntity prima di utilizzare le entità generiche.
   • TYPE_SHOPPING - Controlla ShoppingEntity prima di utilizzare le entità generiche.
   • TYPE_FOOD_AND_DRINK - Controlla le entità nella guida all'integrazione dei prodotti alimentari prima di utilizzare le entità generiche.

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

4. Nel caso in cui vengano fornite più categorie di contenuti, forniscile in ordine di pertinenza rispetto ai contenuti, con la categoria di contenuti più pertinente al primo posto nell'elenco.

Passaggio 2: fornisci i dati del cluster

È consigliabile eseguire il job di pubblicazione dei contenuti in background (ad esempio, utilizzando WorkManager) e pianificato a intervalli regolari o in base agli eventi (ad esempio, ogni volta che l'utente apre l'app o quando l'utente ha appena aggiunto qualcosa al carrello).

AppEngagePublishClient è responsabile della pubblicazione dei cluster.

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

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

Nota: consigliamo vivamente di mantenere un job periodico in esecuzione per verificare se il servizio diventa disponibile in un secondo momento. La disponibilità del servizio può variare con gli upgrade della versione di Android, gli upgrade delle app, le installazioni e le disinstallazioni. Garantendo controlli periodici dei job a un determinato intervallo di tempo, i dati possono essere pubblicati non appena il servizio diventa disponibile.

publishRecommendationClusters

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

Importante: le API di pubblicazione sono API upsert e sostituiscono i contenuti esistenti. Non chiamare delete e pubblicare successivamente le API per sostituire i contenuti, come fanno le API di pubblicazione intrinsecamente.

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, le seguenti azioni vengono eseguite nell'ambito di una transazione:

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

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

publishFeaturedCluster

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

Importante: le API di pubblicazione sono API upsert e sostituiscono i contenuti esistenti. Non chiamare delete e pubblicare successivamente le API per sostituire i contenuti, come fanno le API di pubblicazione intrinsecamente.

Kotlin

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

Java

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

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

• I dati di FeaturedCluster esistenti dal partner sviluppatore 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 viene mantenuto lo stato esistente.

publishContinuationCluster

Questa API viene utilizzata per pubblicare un oggetto ContinuationCluster.

Importante: le API di pubblicazione sono API upsert e sostituiscono i contenuti esistenti. Non chiamare delete e pubblicare successivamente le API per sostituire i contenuti, come fanno le API di pubblicazione intrinsecamente.

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, le seguenti azioni vengono eseguite nell'ambito di una transazione:

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

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

publishUserAccountManagementRequest

Questa API viene utilizzata per pubblicare una scheda di accesso . L'azione di accesso indirizza gli utenti alla pagina di accesso dell'app affinché quest'ultima possa pubblicare contenuti (o fornire contenuti più personalizzati)

I seguenti metadati fanno parte della scheda di accesso:

Attributo	Requisito	Descrizione
URI azione	Obbligatorio	Link diretto all'azione (ad esempio, consente di accedere alla pagina di accesso dell'app)
Immagine	Facoltativo: se non viene specificato, è necessario specificare il titolo	Immagine mostrata nella scheda Immagini con proporzioni 16:9 con una risoluzione di 1264x712
Titolo	Facoltativo - Se non viene fornita, è necessario fornire l'immagine	Titolo sulla scheda
Testo dell'azione	Facoltativo	Testo visualizzato nell'invito all'azione (ad es. Accedi)
Sottotitolo	Facoltativo	Sottotitolo facoltativo sulla scheda

Importante: le API di pubblicazione sono API upsert e sostituiscono i contenuti esistenti. Non chiamare delete e pubblicare successivamente le API per sostituire i contenuti, come fanno le API di pubblicazione intrinsecamente.

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, le seguenti azioni vengono eseguite nell'ambito di una transazione:

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

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

updatePublishStatus

Se per qualsiasi motivo aziendale interno non è stato pubblicato nessuno dei cluster, 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 vengono pubblicati (STATUS == PUBBLICATO), è fondamentale per completare le dashboard che utilizzano questo stato esplicito per comunicare lo stato e altre metriche dell'integrazione.
• Se non vengono pubblicati contenuti, ma lo stato dell'integrazione non funziona (STATUS == NOT_PUBED), Google può evitare di attivare avvisi nelle dashboard di integrità dell'app. Conferma che i contenuti non sono stati pubblicati a causa di una situazione prevista dal punto di vista del fornitore.
• Aiuta gli sviluppatori a fornire insight sul momento in cui i dati vengono pubblicati o meno.
• Google potrebbe utilizzare i codici di stato per sollecitare l'utente a eseguire determinate azioni nell'app, in modo da visualizzarne i contenuti o superarli.

Di seguito sono elencati i codici di stato di pubblicazione idonei :

// 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 provider non riescono a pubblicare la scheda di accesso, ti consigliamo di chiamare l'API updatePubblicaStatus con il codice di stato NOT_PUBLICED_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 il contenuto dei cluster di suggerimenti.

Importante: le API di eliminazione dovrebbero essere richiamate solo quando non ci sono contenuti da pubblicare. Non chiamare "delete" e pubblicare successivamente le API per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta engagement-developers@ prima di utilizzare le API di eliminazione.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

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.

Nota: questa API è disponibile a partire dalla versione 1.1.0.

deleteFeaturedCluster

Questa API viene utilizzata per eliminare i contenuti del cluster in primo piano.

Importante: le API di eliminazione dovrebbero essere richiamate solo quando non ci sono contenuti da pubblicare. Non chiamare "delete" e pubblicare successivamente le API per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta engagement-developers@ prima di utilizzare le API di eliminazione.

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.

Nota: questa API è disponibile a partire dalla versione 1.1.0.

deleteContinuationCluster

Questa API viene utilizzata per eliminare il contenuto del cluster di continuazione.

Importante: le API di eliminazione dovrebbero essere richiamate solo quando non ci sono contenuti da pubblicare. Non chiamare "delete" e pubblicare successivamente le API per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta engagement-developers@ prima di utilizzare le API di eliminazione.

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.

Nota: questa API è disponibile a partire dalla versione 1.1.0.

deleteUserManagementCluster

Questa API viene utilizzata per eliminare il contenuto del cluster UserAccountManagement.

Importante: le API di eliminazione dovrebbero essere richiamate solo quando non ci sono contenuti da pubblicare. Non chiamare "delete" e pubblicare successivamente le API per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta engagement-developers@ prima di utilizzare le API di eliminazione.

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.

Nota: questa API è disponibile a partire dalla versione 1.1.0.

deleteClusters

Questa API viene utilizzata per eliminare i contenuti di un determinato tipo di cluster.

Importante: le API di eliminazione dovrebbero essere richiamate solo quando non ci sono contenuti da pubblicare. Non chiamare "delete" e pubblicare successivamente le API per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta engagement-developers@ prima di utilizzare le API di eliminazione.

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 eseguire 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 in questione, ma non al momento della chiamata (ad esempio, è disabilitato esplicitamente).
SERVICE_CALL_EXECUTION_FAILURE	Esecuzione dell'attività non riuscita a causa di problemi di organizzazione in thread. In questo caso, sarà 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, più del numero consentito di cluster).
SERVICE_CALL_INTERNAL	È presente un errore sul lato servizio.
SERVICE_CALL_RESOURCE_EXHAUSTED	La chiamata al servizio viene effettuata troppo spesso.

Passaggio 3: gestisci gli intent di trasmissione

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

L'obiettivo degli intent di trasmissione è principalmente la riattivazione dell'app e la forzatura della sincronizzazione 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, una settimana fa). In questo modo, si può avere più sicurezza che l'utente possa avere un'esperienza con i contenuti aggiornati, anche se l'applicazione non è stata eseguita per un lungo periodo di tempo.

BroadcastReceiver deve essere configurato nei due modi seguenti:

• Registra dinamicamente un'istanza della classe BroadcastReceiver utilizzando Context.registerReceiver(). Ciò consente la comunicazione dalle applicazioni ancora presenti in memoria.

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
  // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
  // received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION))

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))

// Register Continuation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION))
}

Java

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
// received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION));

}

• Dichiara in modo statico un'implementazione con il tag <receiver> nel file AndroidManifest.xml. Ciò consente all'applicazione di ricevere intent di trasmissione quando non è in esecuzione e all'applicazione di pubblicare i 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>

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.

Flusso di lavoro di integrazione

Per una guida passo passo sulla verifica dell'integrazione dopo il completamento, consulta Flusso di lavoro dell'integrazione per gli sviluppatori sul coinvolgimento.

Domande frequenti

Consulta le Domande frequenti sull'SDK Engage per le domande frequenti.

Contact

Contatta [e-mail] in caso di domande durante la procedura di integrazione.

Passaggi successivi

Una volta completata l'integrazione, i passaggi successivi sono i seguenti:

• Invia un'email all'indirizzo [e-mail] e allega l'APK integrato pronto per i test di Google.
• Google esegue una verifica ed esamina internamente per assicurarsi che l'integrazione funzioni come previsto. Se sono necessarie modifiche, Google ti contatta fornendoti tutti i dettagli necessari.
• Quando il test è completo e non sono necessarie modifiche, Google ti contatta per informarti 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 Consigli, In primo piano e Continuazione potrebbero essere pubblicati e visibili agli utenti.