Engage SDK Shopping: istruzioni per l'integrazione tecnica di terze parti

Aumenta il coinvolgimento nell'app raggiungendo gli utenti ovunque si trovino. Integra l'SDK Engage per fornire consigli personalizzati e contenuti di continuazione direttamente agli utenti su più piattaforme on-device, come Raccolte, Spazio Intrattenimento e il Play Store. L'integrazione aggiunge meno di 50 KB (compressi) all'APK medio e richiede agli sviluppatori circa una settimana di tempo per la maggior parte delle app. Scopri di più sul nostro sito aziendale.

Questa guida contiene istruzioni per i partner sviluppatori per pubblicare contenuti Shopping sulle piattaforme di contenuti di Engage.

Dettaglio integrazione

Terminologia

Questa integrazione include i seguenti cinque tipi di cluster: Consigliato, In evidenza, Carrello, Lista della spesa, Riordina e Monitoraggio ordine acquisto.

• I cluster Suggerimento mostrano suggerimenti per lo shopping personalizzati di un singolo partner sviluppatore. Questi consigli possono essere personalizzati per l'utente o generalizzati (ad esempio, elementi di tendenza). Utilizzali per mostrare prodotti, eventi, vendite, promozioni e abbonamenti come preferisci.

  I consigli hanno la seguente struttura:

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

  • ShoppingEntity:un oggetto che rappresenta un singolo elemento in un cluster.

• Il cluster In evidenza mostra una selezione di entità di più partner di sviluppo in un unico raggruppamento dell'interfaccia utente. Ci sarà un unico cluster In primo piano, che viene visualizzato nella parte superiore della UI con un posizionamento prioritario sopra tutti i cluster di consigli. A ogni partner sviluppatore sarà consentito trasmettere fino a 10 entità nel cluster In primo piano.

• Il cluster Carrello mostra un'anteprima dei carrelli di molti partner sviluppatori in un unico raggruppamento dell'interfaccia utente, invitando gli utenti a completare i carrelli in sospeso. Esiste un singolo cluster Carrello, che viene visualizzato nella parte superiore della UI, con un posizionamento prioritario rispetto a tutti i cluster Consigli. A ogni partner sviluppatore è consentito trasmettere fino a 3 istanze ShoppingCart nel cluster del carrello.

  Il carrello degli acquisti ha la seguente struttura:

  • Cluster carrello:una visualizzazione dell'interfaccia utente che contiene un gruppo di anteprime del carrello di molti partner sviluppatori.

  • ShoppingCart:un oggetto che rappresenta l'anteprima del carrello acquisti per un singolo partner sviluppatore, da visualizzare nel cluster del carrello acquisti. Il ShoppingCart deve mostrare il conteggio totale degli articoli nel carrello e può includere anche immagini di alcuni articoli nel carrello dell'utente.

• Il cluster Lista della spesa mostra un'anteprima delle liste della spesa di più partner sviluppatori in un unico raggruppamento dell'interfaccia utente, invitando gli utenti a tornare all'app corrispondente per aggiornare e completare le loro liste. Esiste un unico cluster Lista della spesa.

• Il cluster Riordina mostra un'anteprima degli ordini precedenti di più partner sviluppatori in un unico raggruppamento della UI, invitando gli utenti a riordinare. Esiste un solo cluster Riordina.

  • Il cluster di riordino deve mostrare il conteggio totale degli articoli nell'ordine precedente dell'utente e deve includere anche uno dei seguenti elementi:

    • Immagini per X articoli nell'ordine precedente dell'utente.
    • Etichette per X articoli nell'ordine precedente dell'utente.

• Il cluster Monitoraggio ordini Shopping mostra un'anteprima degli ordini Shopping in attesa o completati di recente di molti partner sviluppatori in un unico gruppo dell'interfaccia utente, consentendo agli utenti di monitorare i propri ordini.

  Nella parte superiore della UI è presente un singolo cluster ShoppingOrderTracking, con un posizionamento prioritario rispetto a tutti i cluster Recommendation. A ogni partner sviluppatore è consentito trasmettere più elementi ShoppingOrderTrackingEntity nel cluster di monitoraggio degli ordini Shopping.

  • ShoppingOrderTrackingCluster ha la seguente struttura:

    • Cluster ShoppingOrderTracking: una visualizzazione dell'interfaccia utente che contiene un gruppo di anteprime di monitoraggio degli ordini di molti partner sviluppatori
    • ShoppingOrderTrackingEntity: un oggetto che rappresenta un'anteprima del monitoraggio di un ordine Shopping per un singolo partner sviluppatore, da visualizzare nel cluster Monitoraggio ordini Shopping. ShoppingOrderTrackingEntity deve mostrare lo stato dell'ordine e l'ora dell'ordine. Ti consigliamo vivamente di compilare il tempo di consegna previsto per ShoppingOrderTrackingEntity, in quanto viene visualizzato dagli utenti se fornito.
    Nota: fornisci più oggetti ShoppingOrderTrackingEntity se un ordine è stato suddiviso in più spedizioni.

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.5.2'
}

Per maggiori informazioni, consulta la sezione Visibilità dei pacchetti in Android 11.

Riepilogo

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

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

Tipo di cluster	Limiti del cluster	Limiti massimi delle entità in un cluster
Cluster di consigli	Al massimo 7	Al massimo 50 ShoppingEntity
Cluster in primo piano	Al massimo 1	Al massimo 20 ShoppingEntity
Cluster Carrello degli acquisti	Al massimo 1	Al massimo 3 ShoppingCart Più carrelli previsti solo per le app con carrelli separati per commerciante.
Cluster Lista della spesa	Al massimo 1	Al massimo 1 ShoppingListEntity
Shopping Reorder Cluster	Al massimo 1	Al massimo 1 ReorderEntity
Cluster di monitoraggio degli ordini di acquisto	Al massimo 3	Al massimo 3 ShoppingOrderTrackingEntity

Passaggio 1: fornisci i dati dell'entità

L'SDK ha definito entità diverse per rappresentare ogni tipo di elemento. Per la categoria Shopping sono supportate le seguenti entità:

1. ShoppingEntity
2. ShoppingCart
3. ShoppingList
4. Reorder
5. ShoppingOrderTracking

I grafici riportati di seguito illustrano gli attributi e i requisiti disponibili per ogni tipo.

ShoppingEntity

L'oggetto ShoppingEntity rappresenta un prodotto, una promozione, un'offerta, un abbonamento o un evento che i partner sviluppatori vogliono pubblicare.

ShoppingEntity

Attributo	Requisito	Descrizione	Formato
Immagini poster	Obbligatorio	Devi fornire almeno un'immagine.	Per indicazioni, consulta Specifiche per le immagini.
URI azione	Obbligatorio	Il link diretto alla pagina dell'app che mostra i dettagli dell'entità. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti	URI
Titolo	Facoltativo	Il nome dell'entità.	Testo libero Dimensioni del testo consigliate: meno di 90 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Prezzo - attuale	Obbligatorio condizionalmente	Il prezzo attuale dell'entità. Deve essere fornito se viene fornito il prezzo barrato.	Testo libero
Prezzo - barrato	Facoltativo	Il prezzo originale dell'entità, che verrà barrato nell'interfaccia utente.	Testo libero
Callout	Facoltativo	Callout per mettere in evidenza una promozione, un evento o un aggiornamento per l'entità, se disponibile.	Testo libero Dimensioni del testo consigliate: meno di 45 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Clausole del callout	Facoltativo	Testo delle clausole del callout.	Testo libero Dimensioni del testo consigliate: meno di 45 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Valutazione (facoltativa) - Nota: tutte le valutazioni vengono visualizzate utilizzando il nostro sistema di valutazione a stelle standard.
Classificazione - Valore massimo	Facoltativo	Il valore massimo della scala di valutazione. Deve essere fornito se viene fornito anche il valore attuale della classificazione.	Numero >= 0,0
Classificazione - Valore attuale	Facoltativo	Il valore attuale della scala di valutazione. Deve essere fornito se viene fornito anche il valore massimo della classificazione.	Numero >= 0,0
Valutazione - Conteggio	Facoltativo	Il conteggio delle valutazioni per l'entità. Nota:fornisci questo campo se la tua app controlla la modalità di visualizzazione del conteggio per gli utenti. Utilizza una stringa concisa. Ad esempio, se il conteggio è 1.000.000, valuta la possibilità di utilizzare un'abbreviazione come 1M in modo che il conteggio non venga troncato su schermi più piccoli.	Stringa
Valutazione - Conteggio	Facoltativo	Il conteggio delle valutazioni per l'entità. Nota: fornisci questo campo se non gestisci personalmente la logica dell'abbreviazione della visualizzazione. Se sono presenti sia Conteggio che Valore conteggio, agli utenti viene mostrato Conteggio.	Lungo
DisplayTimeWindow (facoltativo) - Imposta un periodo di tempo per la visualizzazione di un contenuto sulla piattaforma
Timestamp di inizio	Facoltativo	Il timestamp epoch dopo il quale i contenuti devono essere mostrati sulla piattaforma. Se non è impostato, i contenuti sono idonei a essere visualizzati sulla piattaforma.	Timestamp Unix epoch in millisecondi
Timestamp fine	Facoltativo	Il timestamp dell'epoca dopo il quale i contenuti non vengono più visualizzati sulla piattaforma. Se non è impostato, i contenuti sono idonei a essere visualizzati sulla piattaforma.	Timestamp Unix epoch in millisecondi

ShoppingCart

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorio	Il link diretto al carrello nell'app del partner. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti	URI
Numero di elementi	Obbligatorio	Il numero di articoli (non solo di prodotti) nel carrello degli acquisti. Ad esempio: se nel carrello sono presenti 3 magliette identiche e 1 cappello, questo numero deve essere 4.	Numero intero >= 1
Testo dell'azione	Facoltativo	Il testo dell'invito all'azione del pulsante nel carrello (ad esempio, La tua borsa degli acquisti). Se lo sviluppatore non fornisce alcun testo di azione, Visualizza carrello è l'opzione predefinita. Questo attributo è supportato a partire dalla versione 1.1.0.	Stringa
Titolo	Facoltativo	Il titolo del carrello (ad esempio, La tua borsa della spesa). Se lo sviluppatore non fornisce un titolo, Il tuo carrello è il valore predefinito. Se il partner sviluppatore pubblica un carrello separato per commerciante, includi il nome del commerciante nel titolo.	Testo libero Dimensioni del testo consigliate: meno di 25 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Immagini del carrello	Facoltativo	Immagini di ogni prodotto nel carrello. È possibile fornire fino a 10 immagini in ordine di priorità; il numero effettivo di immagini visualizzate dipende dal fattore di forma del dispositivo.	Per indicazioni, consulta Specifiche per le immagini.
Etichette elemento	Facoltativo	L'elenco delle etichette per gli articoli della lista della spesa. Il numero effettivo di etichette visualizzate dipende dal fattore di forma del dispositivo.	Elenco delle etichette di testo libero Dimensioni del testo consigliate: meno di 20 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Timestamp dell'ultima interazione dell'utente	Facoltativo	Numero di millisecondi trascorsi dall'epoca, che identifica l'ultima volta in cui l'utente ha interagito con il carrello. Questo valore verrà trasmesso come input dai partner sviluppatori che pubblicano carrelli separati per commerciante e potrebbe essere utilizzato per il ranking.	Timestamp Unix epoch in millisecondi
DisplayTimeWindow (facoltativo) - Imposta un intervallo di tempo per la visualizzazione di un contenuto sulla superficie
Timestamp di inizio	Facoltativo	Il timestamp epoch dopo il quale i contenuti devono essere mostrati sulla piattaforma. Se non è impostato, i contenuti sono idonei a essere visualizzati sulla piattaforma.	Timestamp Unix epoch in millisecondi
Timestamp fine	Facoltativo	Il timestamp dell'epoca dopo il quale i contenuti non vengono più visualizzati sulla piattaforma. Se non è impostato, i contenuti sono idonei a essere visualizzati sulla piattaforma.	Timestamp Unix epoch in millisecondi

ShoppingList

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorio	Il link diretto alla lista della spesa nell'app del partner. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti	URI
Numero di elementi	Obbligatorio	Il numero di articoli nella lista della spesa.	Numero intero >= 1
Titolo	Facoltativo	Il titolo dell'elenco (ad esempio, La tua lista della spesa). Se lo sviluppatore non fornisce un titolo, Lista della spesa è il titolo predefinito.	Testo libero Dimensioni del testo consigliate: meno di 25 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Etichette elemento	Obbligatorio	L'elenco delle etichette per gli articoli della lista della spesa. Devi fornire almeno un'etichetta e puoi fornirne fino a 10 in ordine di priorità. Il numero effettivo di etichette visualizzate dipende dal fattore di forma del dispositivo.	Elenco delle etichette di testo libero Dimensioni del testo consigliate: meno di 20 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)

ShoppingReorderCluster

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorio	Il link diretto per riordinare nell'app del partner. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti	URI
Testo dell'azione	Facoltativo	Il testo dell'invito all'azione del pulsante su Riordina (ad esempio, Ordina di nuovo). Se lo sviluppatore non fornisce un testo dell'azione, Riordina è l'impostazione predefinita. Questo attributo è supportato a partire dalla versione 1.1.0.	Stringa
Numero di elementi	Obbligatorio	Il numero di articoli (non solo di prodotti) nell'ordine precedente. Ad esempio: se nell'ordine precedente c'erano 3 caffè piccoli e 1 croissant, questo numero deve essere 4.	Numero intero >= 1
Titolo	Obbligatorio	Il titolo dell'articolo di riordino.	Testo libero Dimensioni del testo consigliate: meno di 40 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Etichette elemento	Facoltativo Se non vengono fornite, devono essere fornite le immagini poster.	L'elenco delle etichette degli articoli per l'ordine precedente. È possibile fornire fino a 10 etichette in ordine di priorità; il numero effettivo di etichette visualizzate dipende dal fattore di forma del dispositivo.	Elenco di testo libero Dimensione del testo consigliata per etichetta: meno di 20 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Immagini poster	Facoltativo Se non viene fornito, devono essere fornite le etichette degli articoli.	Immagini degli articoli dell'ordine precedente. È possibile fornire fino a 10 immagini in ordine di priorità; il numero effettivo di immagini visualizzate dipende dal fattore di forma del dispositivo.	Per indicazioni, consulta Specifiche per le immagini.

ShoppingOrderTrackingCluster

Attributo	Requisito	Descrizione	Formato
Titolo	Obbligatorio	Un titolo breve del pacchetto/degli articoli tracciati o del numero di tracciamento.	Testo libero Dimensioni del testo consigliate: 50 caratteri (il testo troppo lungo mostrerà i puntini di sospensione)
Tipo di ordine	Obbligatorio	Un titolo breve del pacchetto/degli articoli tracciati o del numero di tracciamento.	Enum: IN_STORE_PICKUP, SAME_DAY_DELIVERY, MULTI_DAY_DELIVERY
Stato	Obbligatorio	Lo stato attuale dell'ordine. Ad esempio: "In ritardo", "In transito", "Ritardato", "Spedito", "Consegnato", "Esaurito", "Ordine pronto"	Testo libero Dimensioni del testo consigliate: 25 caratteri (il testo troppo lungo mostrerà i puntini di sospensione)
Ora dell'ordine	Obbligatorio	Il timestamp dell'epoca in millisecondi in cui è stato effettuato l'ordine. L'ora dell'ordine verrà visualizzata se non è presente la finestra temporale di consegna prevista	Timestamp Unix epoch in millisecondi
URI azione	Obbligatorio	Link diretto al monitoraggio dell'ordine nell'app del partner.	URI
OrderDeliveryTimeWindow (facoltativo): imposta un intervallo di tempo per l'ordine in fase di monitoraggio dal momento in cui è stato effettuato fino al momento della consegna prevista/effettiva.
OrderDeliveryTimeWindow - Start Time	Facoltativo	Il timestamp epoch in millisecondi a partire dal quale l'ordine verrà consegnato o sarà pronto per il ritiro.	Timestamp Unix epoch in millisecondi
OrderDeliveryTimeWindow - End Time	Facoltativo	Il timestamp epoch in millisecondi entro e non oltre il quale l'ordine verrà consegnato o sarà pronto per il ritiro.	Timestamp Unix epoch in millisecondi
Immagini poster	Facoltativo	Immagine di un articolo/prodotto che fa parte dell'ordine. Le proporzioni consigliate sono 1:1.	Per indicazioni, consulta Specifiche per le immagini.
Numero di elementi	Facoltativo	Il numero di articoli nell'ordine.	Numero intero >= 1
Descrizione	Facoltativo	Un unico paragrafo di testo per descrivere gli articoli nell'ordine. Nota: all'utente verrà mostrata la descrizione o l'elenco dei sottotitoli, non entrambi.	Testo libero Dimensione del testo consigliata: 180 caratteri
Elenco dei sottotitoli	Facoltativo	Fino a tre sottotitoli, ognuno composto da una sola riga di testo. Nota: all'utente verrà mostrata la descrizione o l'elenco dei sottotitoli, non entrambi.	Testo libero Dimensioni del testo consigliate per ogni sottotitolo: max 50 caratteri
Valore ordine - CurrentPrice	Facoltativo	Il valore attuale dell'ordine.	Testo libero
Numero ordine	Facoltativo	Il numero/ID ordine che può essere utilizzato per identificare in modo univoco l'ordine.	Testo libero Dimensione del testo consigliata: massimo 25 caratteri
Numero di tracciamento	Facoltativo	Il numero di tracciamento per la consegna dell'ordine/del pacco nel caso in cui l'ordine richieda una consegna.	Testo libero Dimensione del testo consigliata: massimo 25 caratteri

Specifiche per le immagini

Di seguito sono elencate le specifiche obbligatorie per gli asset immagine:

Proporzioni	Numero minimo di pixel	Numero consigliato di pixel
Quadrato (1 x 1) Preferito per i cluster non in evidenza	300x300	1200x1200
Orizzontale (1,91 x 1) Preferito per i cluster in primo piano	600x314	1200x628
Verticale (4x5)	480x600	960x1200

Formati file

PNG, JPG, GIF statico, WebP

Dimensioni massime del file

5120 kB

Altri consigli

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

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 ha appena aggiunto qualcosa al carrello).

AppEngageShoppingClient è responsabile della pubblicazione dei cluster di acquisto.

Le seguenti API vengono esposte per pubblicare i cluster nel client:

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishShoppingCart
• publishShoppingCarts
• publishShoppingList
• publishShoppingReorderCluster
• publishShoppingOrderTrackingCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteShoppingCartCluster
• deleteShoppingListCluster
• deleteShoppingReorderCluster
• deleteShoppingOrderTrackingCluster
• 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: ti consigliamo vivamente di eseguire un job periodico per verificare se il servizio diventa disponibile in un secondo momento. La disponibilità del servizio può cambiare con gli upgrade della versione di Android, gli upgrade, le installazioni e le disinstallazioni delle app. Se garantisci controlli periodici dei job a un determinato intervallo di tempo, i dati possono essere pubblicati una volta che il servizio diventa disponibile.

publishRecommendationClusters

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

Un oggetto RecommendationCluster può avere i seguenti attributi:

Attributo	Requisito	Descrizione
Elenco di ShoppingEntity	Obbligatorio	Un elenco di oggetti ShoppingEntity che compongono i suggerimenti per questo cluster di suggerimenti.
Titolo	Obbligatorio	Il titolo del cluster di consigli. Dimensioni del testo consigliate: meno di 25 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Sottotitolo	Facoltativo	Il sottotitolo del cluster di suggerimenti.
URI azione	Facoltativo	Il deep link alla pagina dell'app partner in cui gli utenti possono visualizzare l'elenco completo dei consigli. Nota: puoi utilizzare i link diretti per l'attribuzione. Consulta queste domande frequenti

Importante: le API di pubblicazione sono API upsert, ovvero sostituiscono i contenuti esistenti. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, in quanto le API di pubblicazione lo fanno intrinsecamente.

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build());

Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni in una transazione:

• Tutti i dati esistenti del cluster di consigli vengono rimossi.
• I dati della richiesta vengono analizzati e archiviati in nuovi cluster di consigli.

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

publishFeaturedCluster

Questa API viene utilizzata per pubblicare un oggetto FeaturedCluster.

Importante: le API di pubblicazione sono API upsert, ovvero sostituiscono i contenuti esistenti. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, in quanto le API di pubblicazione lo fanno intrinsecamente.

Kotlin

client.publishFeaturedCluster(
            PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    FeaturedCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    new FeaturedCluster.Builder()
                        ...
                        .build())
                .build());

Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni in 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.

publishShoppingCart

Questa API viene utilizzata per pubblicare un oggetto ShoppingCartCluster.

Importante: le API di pubblicazione sono API upsert, ovvero sostituiscono i contenuti esistenti. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, in quanto le API di pubblicazione lo fanno intrinsecamente.

Kotlin

client.publishShoppingCart(
            PublishShoppingCartRequest.Builder()
                .setShoppingCart(
                    ShoppingCart.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingCart(
            new PublishShoppingCartRequest.Builder()
                .setShoppingCart(
                    new ShoppingCart.Builder()
                        ...
                        .build())
                .build())

Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni in una transazione:

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

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

publishShoppingCarts

Questa API viene utilizzata per pubblicare più oggetti ShoppingCart. Ciò è applicabile alla pubblicazione di carrelli separati per commerciante da parte dei partner di sviluppo. Includi il nome del commerciante nel titolo quando utilizzi questa API.

Importante: le API di pubblicazione sono API upsert, ovvero sostituiscono i contenuti esistenti. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, in quanto le API di pubblicazione lo fanno intrinsecamente.

Kotlin

client.publishShoppingCarts(
            PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    ShoppingCart.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingCarts(
            new PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    new ShoppingCart.Builder()
                        ...
                        .build())
                .build())

Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni in una transazione:

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

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

publishShoppingList

Questa API viene utilizzata per pubblicare un oggetto FoodShoppingList.

Importante: le API di pubblicazione sono API upsert, ovvero sostituiscono i contenuti esistenti. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, in quanto le API di pubblicazione lo fanno intrinsecamente.

Kotlin

client.publishFoodShoppingList(
            PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFoodShoppingList(
            new PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    new FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build());

Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni in una transazione:

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

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

publishShoppingReorderCluster

Questa API viene utilizzata per pubblicare un oggetto ShoppingReorderCluster.

Importante: le API di pubblicazione sono API upsert, ovvero sostituiscono i contenuti esistenti. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, in quanto le API di pubblicazione lo fanno intrinsecamente.

Kotlin

client.publishShoppingReorderCluster(
            PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingReorderCluster(
            new PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    new ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build());

Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni in una transazione:

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

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

publishShoppingOrderTrackingCluster

Questa API viene utilizzata per pubblicare un oggetto ShoppingOrderTrackingCluster.

Importante: le API di pubblicazione sono API upsert, ovvero sostituiscono i contenuti esistenti. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, in quanto le API di pubblicazione lo fanno intrinsecamente.

Kotlin

client.publishShoppingOrderTrackingCluster(
            PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingOrderTrackingCluster(
            new PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    new ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build());

Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni in una transazione:

• I dati ShoppingOrderTrackingCluster esistenti del partner sviluppatore vengono rimossi.
• I dati della richiesta vengono analizzati e archiviati nel cluster di monitoraggio degli ordini di Shopping aggiornato.

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

publishUserAccountManagementRequest

Questa API viene utilizzata per pubblicare una scheda Accedi . 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 di accesso:

Attributo	Requisito	Descrizione
URI azione	Obbligatorio	Link diretto all'azione (ad es. alla pagina di accesso all'app)
Immagine	Facoltativo: se non viene fornito, deve essere fornito il titolo	Immagine mostrata sulla scheda Immagini con proporzioni 16:9 e risoluzione 1264 x 712
Titolo	Facoltativo: se non fornito, l'immagine è obbligatoria	Titolo sulla carta
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, ovvero sostituiscono i contenuti esistenti. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, in quanto le API di pubblicazione lo fanno 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, vengono eseguite le seguenti azioni in 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 vengono 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 nei dashboard sull'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 di accesso. Se per qualsiasi motivo i fornitori non sono in grado di pubblicare la scheda di accesso, ti 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());

deleteRecommendationClusters

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

Importante: le API di eliminazione devono essere chiamate solo quando non ci sono contenuti da pubblicare. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta [e-mail] 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 consigli. 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 devono essere chiamate solo quando non ci sono contenuti da pubblicare. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta [e-mail] 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.

deleteShoppingCartCluster

Questa API viene utilizzata per eliminare i contenuti del cluster Carrello.

Importante: le API di eliminazione devono essere chiamate solo quando non ci sono contenuti da pubblicare. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta [e-mail] prima di utilizzare le API di eliminazione.

Kotlin

client.deleteShoppingCartCluster()

Java

client.deleteShoppingCartCluster();

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

deleteShoppingListCluster

Questa API viene utilizzata per eliminare i contenuti del cluster della lista della spesa.

Importante: le API di eliminazione devono essere chiamate solo quando non ci sono contenuti da pubblicare. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta [e-mail] prima di utilizzare le API di eliminazione.

Kotlin

client.deleteShoppingListCluster()

Java

client.deleteShoppingListCluster();

Quando il servizio riceve la richiesta, rimuove i dati esistenti dal cluster Elenco acquisti. 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.

deleteShoppingReorderCluster

Questa API viene utilizzata per eliminare i contenuti del cluster di riordino di Shopping.

Importante: le API di eliminazione devono essere chiamate solo quando non ci sono contenuti da pubblicare. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta [e-mail] prima di utilizzare le API di eliminazione.

Kotlin

client.deleteShoppingReorderCluster()

Java

client.deleteShoppingReorderCluster();

Quando il servizio riceve la richiesta, rimuove i dati esistenti dal cluster Riordina acquisti. 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.

deleteShoppingOrderTrackingCluster

Questa API viene utilizzata per eliminare i contenuti del cluster di monitoraggio degli ordini Shopping.

Importante: le API di eliminazione devono essere chiamate solo quando non ci sono contenuti da pubblicare. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta [e-mail] prima di utilizzare le API di eliminazione.

Kotlin

client.deleteShoppingOrderTrackingCluster()

Java

client.deleteShoppingOrderTrackingCluster();

Quando il servizio riceve la richiesta, rimuove i dati esistenti dal cluster di monitoraggio degli ordini Shopping. In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene mantenuto.

Nota: questa API è disponibile nelle versioni 1.4.0 e successive.

deleteUserManagementCluster

Questa API viene utilizzata per eliminare i contenuti del cluster UserAccountManagement.

Importante: le API di eliminazione devono essere chiamate solo quando non ci sono contenuti da pubblicare. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta [e-mail] 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 devono essere chiamate solo quando non ci sono contenuti da pubblicare. Non chiamare le API di eliminazione e pubblicazione successivamente per sostituire i contenuti, poiché le API di pubblicazione lo fanno intrinsecamente. Contatta [e-mail] prima di utilizzare le API di eliminazione.

Kotlin

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      ...
      .build())

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                ...
                .build());

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

Gestione degli errori

È consigliabile 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	Nome dell'errore	Nota
1	SERVICE_NOT_FOUND	Il servizio non è disponibile sul dispositivo specificato.
2	SERVICE_NOT_AVAILABLE	Il servizio è disponibile sul dispositivo specificato, ma non al momento della chiamata (ad esempio, è disattivato esplicitamente).
3	SERVICE_CALL_EXECUTION_FAILURE	L'esecuzione dell'attività non è riuscita a causa di problemi di threading. In questo caso, può essere riprovato.
4	SERVICE_CALL_PERMISSION_DENIED	Il chiamante non è autorizzato a effettuare la chiamata di servizio.
5	SERVICE_CALL_INVALID_ARGUMENT	La richiesta contiene dati non validi (ad esempio, un numero di cluster superiore a quello consentito).
6	SERVICE_CALL_INTERNAL	Si è verificato un errore lato servizio.
7	SERVICE_CALL_RESOURCE_EXHAUSTED	La chiamata di servizio viene effettuata troppo spesso.

Passaggio 3: gestisci gli intent di trasmissione

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

Lo scopo 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 spesso. Viene attivato solo quando il servizio Engage determina che i contenuti potrebbero essere obsoleti (ad esempio, una settimana). In questo modo, l'utente può avere maggiore fiducia di poter usufruire di un'esperienza con contenuti nuovi, 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 attive 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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast
  // is received
  // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast
  // is received
  // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
  // received
  // Trigger shopping order tracking cluster publish when
  // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER 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 Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Reorder Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping Order Tracking Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                           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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast is
// received

// Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER
// 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 Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping Order Tracking Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                         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. Ciò consente all'applicazione di ricevere intent di trasmissione quando non è in esecuzione e di 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.shopping.PUBLISH_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER" />
      </intent-filter>
   </receiver>
</application>

I seguenti intent vengono inviati dal servizio:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION È consigliabile avviare una chiamata publishRecommendationClusters quando viene ricevuto questo intent.
• com.google.android.engage.action.PUBLISH_FEATURED Ti consigliamo di avviare una chiamata publishFeaturedCluster quando viene ricevuto questo intent.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART Ti consigliamo di avviare una chiamata publishShoppingCart quando viene ricevuto questo intent.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST Ti consigliamo di avviare una chiamata publishShoppingList quando viene ricevuto questo intent.
• com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER Ti consigliamo di avviare una chiamata publishReorderCluster quando viene ricevuto questo intent.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER È consigliabile avviare una chiamata publishShoppingOrderTrackingCluster quando viene ricevuto questo intent.

Workflow di integrazione

Per una guida passo passo alla verifica dell'integrazione una volta completata, consulta Flusso di lavoro di integrazione per sviluppatori di Engage.

Domande frequenti

Consulta le Domande frequenti sull'SDK Engage.

Contatto

Contatta [e-mail] in caso di domande durante la procedura di integrazione. Il nostro team risponde il prima possibile.

Passaggi successivi

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

• Invia un'email a [e-mail] e allega l'APK integrato pronto per il test da parte di Google.
• Google esegue una verifica e un controllo interni per assicurarsi che l'integrazione funzioni come previsto. Se sono necessarie modifiche, Google ti contatterà con i dettagli necessari.
• Al termine del test e se non sono necessarie modifiche, Google ti contatta per comunicarti che puoi iniziare a pubblicare l'APK aggiornato e integrato su Play Store.
• Dopo che Google avrà confermato la pubblicazione dell'APK aggiornato sul Play Store, i cluster Consigli, In evidenza, Carrello, Lista acquisti, Cluster riordino e Cluster monitoraggio ordini potrebbero essere pubblicati e visibili agli utenti.