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

Aumenta il coinvolgimento con l'app raggiungendo i tuoi utenti ovunque si trovino. Integra l'SDK Engage per fornire suggerimenti personalizzati e contenuti in continuità direttamente agli utenti su più piattaforme on-device, come Raccolte, Entertainment Space e il Play Store. L'integrazione aggiunge meno di 50 KB (compressi) all'APK medio e richiede circa una settimana di lavoro per gli sviluppatori della maggior parte delle app. Scopri di più sul nostro sito aziendale.

Questa guida contiene istruzioni per i partner sviluppatori su come fornire contenuti per lo shopping alle piattaforme di contenuti di Engage.

Supporto delle categorie e piattaforme

L'idoneità alla piattaforma dell'SDK Engage si basa sulla categoria di contenuti della tua app. Utilizza la tabella seguente per determinare la tua idoneità per piattaforme specifiche:

Stato	Categoria di contenuti o caso d'uso	Piattaforme supportate
Supportato (Idoneo su tutte le piattaforme)	Acquisto di abbigliamento Marketplace online Vendita al dettaglio Spesa di cibo e bevande / alimentari Sconti e coupon Animali domestici / forniture Casa e arredamento / Immobiliare	Raccolte Scheda App Play Store Scheda Tu del Play Store Pagina della scheda del Play Store
Non supportato	App per gli acquirenti Acquisti B2B App per venditori / commercianti Premi dello scanner di ricevute Servizio di telecomunicazione Buy now, pay later

Competenze Android

Visualizza su GitHub

Integra l'SDK Engage

Utilizza la competenza Android dell'SDK Engage per integrare, eseguire il debug e risolvere i problemi di implementazione.

Per installare lo skill dalla CLI Android, esegui:

android skills add engage-sdk-integration

Dettaglio dell'integrazione

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

Terminologia

Questa integrazione include i seguenti cinque tipi di cluster: Contenuti consigliati, In primo piano, Carrello, Lista della spesa, Riordina e Monitoraggio degli ordini di acquisto.

• I cluster di consigli mostrano suggerimenti di acquisto personalizzati di un singolo partner sviluppatore. Questi consigli possono essere personalizzati per l'utente o generalizzati (ad esempio, articoli di tendenza). Utilizzali per mettere in evidenza prodotti, eventi, saldi, promozioni e abbonamenti.

  I suggerimenti hanno la seguente struttura:

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

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

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

• 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 unico cluster Carrello, che viene visualizzato nella parte superiore della UI, con un posizionamento prioritario rispetto a tutti i cluster di Contenuti consigliati. Ogni partner sviluppatore può trasmettere fino a 3 istanze ShoppingCart nel cluster Shopping Cart.

  Il carrello degli acquisti ha la seguente struttura:

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

  • ShoppingCart:un oggetto che rappresenta l'anteprima del carrello degli acquisti per un singolo partner sviluppatore, da visualizzare nel cluster Carrello degli acquisti. La ShoppingCart deve mostrare il numero totale di articoli nel carrello e può anche includere immagini per 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 proprie liste. Esiste un singolo cluster Lista della spesa.

• Il cluster Riordina mostra un'anteprima degli ordini precedenti di più partner sviluppatori in un unico raggruppamento dell'interfaccia utente, invitando gli utenti a riordinare. Esiste un unico cluster di riordino.

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

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

• Il cluster Monitoraggio degli ordini di acquisto mostra un'anteprima degli ordini di acquisto 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.

  Esiste un singolo cluster ShoppingOrderTracking che viene visualizzato nella parte superiore della UI, con un posizionamento prioritario rispetto a tutti i cluster di contenuti consigliati. Ogni partner sviluppatore può trasmettere più elementi ShoppingOrderTrackingEntity nel cluster Shopping Order Tracking.

  • Il tuo ShoppingOrderTrackingCluster ha la seguente struttura:

    • Cluster ShoppingOrderTracking: una visualizzazione dell'interfaccia utente che contiene un gruppo di anteprime del monitoraggio degli ordini di molti partner sviluppatori
    • ShoppingOrderTrackingEntity: un oggetto che rappresenta un'anteprima del monitoraggio degli ordini di acquisto per un singolo partner sviluppatore, da visualizzare nel cluster Monitoraggio degli ordini di acquisto. ShoppingOrderTrackingEntity deve mostrare lo stato e l'ora dell'ordine. Ti consigliamo vivamente di compilare i tempi di consegna previsti per ShoppingOrderTrackingEntity, in quanto vengono mostrati agli utenti quando vengono forniti.
    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.6.0'
}

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

Riepilogo

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

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

Tipo di cluster	Limiti dei cluster	Limiti massimi di entità in un cluster
Cluster di suggerimenti	Al massimo 7	Al massimo 50 ShoppingEntity
Cluster in primo piano	Al massimo 1	Al massimo 20 ShoppingEntity
Cluster Carrello	Al massimo 1	Al massimo 3 ShoppingCart Sono previsti più carrelli solo per le app con carrelli separati per commerciante.
Cluster Lista della spesa	Al massimo 1	Al massimo 3 ShoppingList
Cluster di riordino di Shopping	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 della persona giuridica

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

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

I seguenti grafici 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 del poster	Obbligatorio	Devi fornire almeno un'immagine.	Per indicazioni, consulta le specifiche per le immagini.
URI azione	Obbligatorio	Il deep link alla pagina dell'app che mostra i dettagli dell'entità. Nota: puoi utilizzare i deep link 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 viene 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 per il callout.	Testo libero Dimensioni del testo consigliate: meno di 45 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
(Facoltativo) Valutazione - Nota: tutte le valutazioni vengono visualizzate utilizzando il nostro sistema di valutazione a stelle standard.
Valutazione - Valore massimo	Facoltativo	Il valore massimo della scala di valutazione. Deve essere fornito se viene fornito anche il valore corrente della valutazione.	Numero >= 0,0
Rating - Current value	Facoltativo	Il valore attuale della scala di valutazione. Deve essere fornito se viene fornito anche il valore massimo della valutazione.	Numero >= 0,0
Valutazione - Conteggio	Facoltativo	Il numero di valutazioni per l'entità. Nota:fornisci questo campo se la tua app controlla il modo in cui il conteggio viene mostrato agli 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 di dimensioni ridotte.	Stringa
Rating - Count Value	Facoltativo	Il numero di valutazioni per l'entità. Nota: specifica questo campo se non gestisci autonomamente la logica di abbreviazione della visualizzazione. Se sono presenti sia Count che Count Value, agli utenti viene mostrato Count.	Lungo
DisplayTimeWindow (facoltativo): imposta un intervallo 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 viene impostato, i contenuti sono idonei alla visualizzazione sulla piattaforma.	Timestamp epoch in millisecondi
Timestamp di fine	Facoltativo	Il timestamp epoch dopo il quale i contenuti non vengono più mostrati sulla piattaforma. Se non viene impostato, i contenuti sono idonei alla visualizzazione sulla piattaforma.	Timestamp epoch in millisecondi

ShoppingCart

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorio	Il deep link al carrello nell'app del partner. Nota: puoi utilizzare i deep link per l'attribuzione. Consulta queste domande frequenti	URI
Numero di elementi	Obbligatorio	Il numero di articoli (non solo il numero di prodotti) nel carrello. Ad esempio, se nel carrello sono presenti 3 magliette identiche e 1 cappello, questo numero deve essere 4.	Numero intero >= 1
Testo di azione	Facoltativo	Il testo della call to action del pulsante nel carrello acquisti (ad esempio, Il tuo carrello). Se lo sviluppatore non fornisce un testo per l'azione, il valore predefinito è Visualizza carrello. Questo attributo è supportato dalla versione 1.1.0 in poi.	Stringa
Titolo	Facoltativo	Il titolo del carrello (ad esempio, Il tuo carrello). Se lo sviluppatore non fornisce un titolo, il titolo predefinito è Il tuo carrello. Se lo sviluppatore partner 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 le specifiche per le immagini.
Etichette degli elementi	Facoltativo	L'elenco delle etichette per gli articoli nella lista della spesa. Il numero effettivo di etichette visualizzate dipende dal fattore di forma del dispositivo.	Elenco di 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'epoch, che identifica l'ultima volta che l'utente ha interagito con il carrello. Questo valore verrà trasmesso come input dai partner sviluppatori che pubblicano un carrello separato per commerciante e potrebbe essere utilizzato per il ranking.	Timestamp epoch in millisecondi
DisplayTimeWindow (facoltativo): imposta un intervallo 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 viene impostato, i contenuti sono idonei alla visualizzazione sulla piattaforma.	Timestamp epoch in millisecondi
Timestamp di fine	Facoltativo	Il timestamp epoch dopo il quale i contenuti non vengono più mostrati sulla piattaforma. Se non viene impostato, i contenuti sono idonei alla visualizzazione sulla piattaforma.	Timestamp epoch in millisecondi

ShoppingList

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorio	Il deep link alla lista della spesa nell'app del partner. Nota: puoi utilizzare i deep link 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, il titolo predefinito è Lista della spesa.	Testo libero Dimensioni del testo consigliate: meno di 25 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Etichette degli elementi	Obbligatorio	L'elenco delle etichette per gli articoli nella lista della spesa. È necessario fornire almeno un'etichetta e un massimo di 10 etichette in ordine di priorità; il numero effettivo di etichette visualizzate dipende dal fattore di forma del dispositivo.	Elenco di 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	Obbligatorio	Numero di millisecondi trascorsi dall'epoch, che identifica l'ultima volta in cui l'utente ha interagito con la lista della spesa.	Timestamp epoch in millisecondi

ShoppingReorderCluster

Attributo	Requisito	Descrizione	Formato
URI azione	Obbligatorio	Il deep link per riordinare nell'app del partner. Nota: puoi utilizzare i deep link per l'attribuzione. Consulta queste domande frequenti	URI
Testo di azione	Facoltativo	Il testo della call to action del pulsante per riordinare (ad esempio, Ordina di nuovo). Se lo sviluppatore non fornisce un testo per l'azione, viene utilizzato il testo predefinito Riordina. Questo attributo è supportato dalla versione 1.1.0 in poi.	Stringa
Numero di elementi	Obbligatorio	Il numero di articoli (non solo il numero di prodotti) nell'ordine precedente. Ad esempio, se l'ordine precedente conteneva 3 caffè piccoli e 1 croissant, questo numero deve essere 4.	Numero intero >= 1
Titolo	Obbligatorio	Il titolo dell'articolo da riordinare.	Testo libero Dimensioni del testo consigliate: meno di 40 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Etichette degli elementi	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 testi liberi Dimensioni del testo consigliate per etichetta: meno di 20 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Immagini del poster	Facoltativo (Se non viene fornito, devono essere fornite le etichette degli articoli)	Immagini degli articoli nell'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 le specifiche per le immagini.

ShoppingOrderTrackingCluster

Attributo	Requisito	Descrizione	Formato
Titolo	Obbligatorio	Un titolo breve del pacco/degli articoli monitorati o il numero di tracciamento.	Testo libero Dimensioni del testo consigliate: 50 caratteri (il testo troppo lungo verrà visualizzato con i puntini di sospensione)
Tipo di ordine	Obbligatorio	Un titolo breve del pacco/degli articoli monitorati o il 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", "In ritardo", "Spedito", "Consegnato", "Non disponibile", "Ordine pronto"	Testo libero Dimensioni del testo consigliate: 25 caratteri (il testo troppo lungo verrà visualizzato con i puntini di sospensione)
Ora dell'ordine	Obbligatorio	Il timestamp epoch in millisecondi in cui è stato effettuato l'ordine. L'orario dell'ordine verrà visualizzato se non è presente la finestra temporale di consegna prevista	Timestamp epoch in millisecondi
URI azione	Obbligatorio	Deep link al monitoraggio dell'ordine nell'app del partner.	URI
OrderDeliveryTimeWindow (facoltativo): imposta una finestra temporale per l'ordine monitorato dal momento in cui è stato effettuato al momento della consegna prevista/effettiva.
OrderDeliveryTimeWindow - Start Time	Facoltativo	Il timestamp epoch in millisecondi in cui l'ordine verrà consegnato o sarà pronto per il ritiro.	Timestamp epoch in millisecondi
OrderDeliveryTimeWindow - End Time	Facoltativo	Il timestamp epoch in millisecondi entro il quale l'ordine verrà consegnato o sarà pronto per il ritiro.	Timestamp epoch in millisecondi
Immagini del poster	Facoltativo	Immagine di un articolo/prodotto che fa parte dell'ordine. Le proporzioni consigliate sono 1:1	Per indicazioni, consulta le specifiche per le immagini.
Numero di elementi	Facoltativo	Il numero di articoli nell'ordine.	Numero intero >= 1
Descrizione	Facoltativo	Un singolo paragrafo di testo per descrivere gli articoli nell'ordine. Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.	Testo libero Dimensioni del testo consigliate: 180 caratteri
Elenco dei sottotitoli	Facoltativo	Fino a 3 sottotitoli, ciascuno composto da una singola riga di testo. Nota: all'utente verrà mostrato l'elenco delle descrizioni o dei sottotitoli, non entrambi.	Testo libero Dimensioni del testo consigliate per ogni sottotitolo: massimo 50 caratteri
Valore degli ordini - Prezzo attuale	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 Dimensioni del testo consigliate: massimo 25 caratteri
Numero di riferimento	Facoltativo	Il numero di tracciamento per la consegna dell'ordine/del pacco nel caso in cui l'ordine richieda una consegna.	Testo libero Dimensioni del testo consigliate: massimo 25 caratteri

Specifiche per le immagini

La tabella seguente elenca le specifiche richieste per gli asset immagine:

Proporzioni	Numero minimo di pixel	Numero consigliato di pixel
Immagine quadrata (1 x 1). Preferito per i cluster non in evidenza	300x300	1200x1200
Immagine 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 per l'immagine:inserisci i contenuti importanti al centro dell'immagine in modo da occuparne l'80%.
• Utilizza uno sfondo trasparente in modo che l'immagine possa essere visualizzata correttamente nelle impostazioni dei temi scuro e chiaro.

Passaggio 2: fornisci i dati del cluster

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

AppEngageShoppingClient è responsabile della pubblicazione dei cluster di acquisto.

Le seguenti API sono esposte per i cluster publisher nel client:

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishShoppingCarts
• publishShoppingLists
• publishShoppingReorderCluster
• publishShoppingOrderTrackingCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteShoppingCartCluster
• deleteShoppingListCluster
• deleteReorderCluster
• 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.

Per l'SDK Engage v1.6.0 e versioni successive (consigliato)

Competenze Android

Visualizza su GitHub

Integrazione dell'SDK Engage

Per installare lo skill dalla CLI Android, esegui:

android skills add engage-sdk-integration

Se il tuo team utilizza strumenti di programmazione AI (come Gemini in Android Studio), puoi automatizzare questa migrazione chiedendo all'assistente AI:

Use the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.

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

Tipo di cluster	Costante del tipo di cluster	Valore intero
Sconosciuto	TYPE_UNKNOWN	0
Cluster di suggerimenti	TYPE_RECOMMENDATION	1
Cluster in primo piano	TYPE_FEATURED	2
Cluster di continuazione	TYPE_CONTINUATION	3
Cluster Carrello	TYPE_SHOPPING_CART	4
Cluster di gestione utenti	TYPE_ENGAGEMENT	8
Cluster Lista della spesa	TYPE_SHOPPING_LIST	9
Cluster di riordino di Shopping	TYPE_SHOPPING_REORDER	10
Cluster di monitoraggio degli ordini di acquisto	TYPE_SHOPPING_ORDER_TRACKING	11
Cluster di sottoscrizione	TYPE_SUBSCRIPTION	12

Kotlin

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

Java

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
});

Funzionalità di disponibilità del servizio condizionale

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

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

• I cluster di continuazione (come Carrello, Lista della spesa, Riordina e Monitoraggio degli ordini di acquisto) rimangono attivi per impostazione predefinita su tutti i dispositivi supportati.
• Altri tipi di cluster (come i suggerimenti) vengono attivati e disattivati a intermittenza.

Se questa configurazione predefinita non è adatta alle tue esigenze, contatta [e-mail].

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

Kotlin

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

Java

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

Nota: ti consigliamo vivamente di mantenere in esecuzione un job periodico per verificare se il servizio diventa disponibile in un secondo momento. La disponibilità del servizio potrebbe cambiare con gli upgrade della versione di Android, gli upgrade, le installazioni e le disinstallazioni delle app. Garantendo 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 costituiscono i consigli per questo cluster di consigli.
Titolo	Obbligatorio	Il titolo del cluster di suggerimenti. Dimensioni del testo consigliate: meno di 25 caratteri (il testo troppo lungo potrebbe mostrare i puntini di sospensione)
Sottotitolo	Facoltativo	Il sottotitolo del gruppo di suggerimenti.
URI azione	Facoltativo	Il deep link alla pagina nell'app partner in cui gli utenti possono visualizzare l'elenco completo dei consigli. Nota: puoi utilizzare i deep link per l'attribuzione. Consulta queste domande frequenti

Importante: le API di pubblicazione sono API di 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 all'interno di una transazione:

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

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 di 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 all'interno di una transazione:

• I dati FeaturedCluster esistenti del partner sviluppatore vengono rimossi.
• I dati della richiesta vengono analizzati e archiviati nel cluster in primo piano aggiornato.

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

publishShoppingCarts

Questa API viene utilizzata per pubblicare un elenco di oggetti ShoppingCart. Questo vale per i partner sviluppatori che pubblicano carrelli separati per ogni commerciante. Includi il nome del commerciante nel titolo quando utilizzi questa API.

Importante: le API di pubblicazione sono API di 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 all'interno di una transazione:

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

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

publishShoppingLists

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

Importante: le API di pubblicazione sono API di 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.publishShoppingLists(
            PublishShoppingListsRequest.Builder()
                .addShoppingList(
                    ShoppingList.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingLists(
            new PublishShoppingListsRequest.Builder()
                .addShoppingList(
                    new ShoppingList.Builder()
                        ...
                        .build())
                .build());

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

• I dati ShoppingList esistenti del partner sviluppatore vengono rimossi.
• I dati della richiesta vengono analizzati e archiviati nel cluster della lista della spesa 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 di 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 all'interno di 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 di 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 all'interno di 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 tessera di accesso . L'azione di accesso indirizza gli utenti alla pagina di accesso dell'app in modo che l'app possa pubblicare contenuti (o fornire contenuti più personalizzati)

I seguenti metadati fanno parte della scheda Accedi:

Attributo	Requisito	Descrizione
URI azione	Obbligatorio	Deep link all'azione (ad es. rimanda alla pagina di accesso all'app)
Immagine	Facoltativo. Se non viene fornito, è necessario fornire il titolo	Immagine mostrata sulla scheda Immagini con proporzioni 16:9 e risoluzione di 1264 x 712
Titolo	Facoltativo. Se non viene fornito, è necessario fornire l'immagine	Titolo sulla scheda
Testo di azione	Facoltativo	Testo mostrato nella CTA (ad es. Accedi)
Sottotitolo	Facoltativo	Sottotitolo facoltativo sulla scheda

Importante: le API di pubblicazione sono API di 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 all'interno di una transazione:

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

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

updatePublishStatus

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

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

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

Se i contenuti non vengono pubblicati perché un utente non ha eseguito l'accesso, Google consiglia di pubblicare la scheda di accesso. Se per qualsiasi motivo i fornitori non sono in grado di pubblicare la scheda di accesso, consigliamo di chiamare l'API updatePublishStatus con il codice di stato NOT_PUBLISHED_REQUIRES_SIGN_IN

Kotlin

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationsClusters

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

Importante: le API di eliminazione devono essere chiamate solo quando non sono presenti 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.deleteRecommendationsClusters()

Java

client.deleteRecommendationsClusters();

Quando il servizio riceve la richiesta, rimuove i dati esistenti dai cluster di suggerimenti. In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene mantenuto.

Nota: questa API è disponibile dalla versione 1.1.0 in poi.

deleteFeaturedCluster

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

Importante: le API di eliminazione devono essere chiamate solo quando non sono presenti 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 dalla versione 1.1.0 in poi.

deleteShoppingCartCluster

Questa API viene utilizzata per eliminare i contenuti del cluster del carrello acquisti.

Importante: le API di eliminazione devono essere chiamate solo quando non sono presenti 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 del carrello acquisti. In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene mantenuto.

Nota: questa API è disponibile dalla versione 1.1.0 in poi.

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 sono presenti 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 della lista della spesa. In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene mantenuto.

Nota: questa API è disponibile dalla versione 1.1.0 in poi.

deleteReorderCluster

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 sono presenti 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.deleteReorderCluster()

Java

client.deleteReorderCluster();

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

Nota: questa API è disponibile dalla versione 1.1.0 in poi.

deleteShoppingOrderTrackingCluster

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

Importante: le API di eliminazione devono essere chiamate solo quando non sono presenti 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 di 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 sono presenti 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 dalla versione 1.1.0 in poi.

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 sono presenti 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 client possono scegliere di passare uno o più tipi di cluster. In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene mantenuto.

Gestione degli errori

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

Kotlin

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

Java

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

L'errore viene restituito come AppEngageException con la causa inclusa come codice di errore.

Codice di errore	Nome 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 è disponibile 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, è possibile riprovare.
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 di frequente.

Passaggio 3: gestisci gli intent di trasmissione

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

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

BroadcastReceiver deve essere configurato nei seguenti due modi:

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

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION
  // broadcast is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is
  // received
  // Trigger 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. In questo modo, l'applicazione può ricevere intent di trasmissione quando non è in esecuzione e può anche pubblicare i contenuti.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.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 Quando viene ricevuto questo intent, è consigliabile avviare una chiamata publishRecommendationClusters.
• 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 publishShoppingCarts quando viene ricevuto questo intent.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST Ti consigliamo di avviare una chiamata publishShoppingLists 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 Quando viene ricevuto questo intent, è consigliabile avviare una chiamata publishShoppingOrderTrackingCluster.

Workflow di integrazione

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

Domande frequenti

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

Contatto

Contatta [e-mail] in caso di domande durante il processo 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 all'indirizzo [e-mail] e allega l'APK integrato pronto per essere testato da Google.
• Google esegue una verifica e dei controlli interni per assicurarsi che l'integrazione funzioni come previsto. Se sono necessarie modifiche, Google ti contatterà con tutti i dettagli necessari.
• Al termine dei test, se non sono necessarie modifiche, Google ti contatta per informarti che puoi iniziare a pubblicare l'APK aggiornato e integrato sul Play Store.
• Dopo che Google ha confermato che l'APK aggiornato è stato pubblicato sul Play Store, i cluster Contenuti consigliati, In primo piano, Carrello, Lista della spesa, Riordina e Monitoraggio degli ordini di acquisto potrebbero essere pubblicati e visibili agli utenti.