Engage SDK Food: 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, Entertainment Space e il Play Store. L'integrazione aggiunge meno di 50 KB (compressi) all'APK medio e richiede agli sviluppatori circa una settimana di tempo. Scopri di più sul nostro sito aziendale.

Questa guida contiene istruzioni per i partner sviluppatori per la pubblicazione di contenuti alimentari (ordinazione di cibo, recensioni e scoperta di cibo o ristoranti, abbonamenti ai pasti, ricette) sulle piattaforme di contenuti di Engage.

Dettaglio integrazione

Terminologia

Questa integrazione include i seguenti cinque tipi di cluster: Consigli, In evidenza, Carrello della spesa alimentare, Lista della spesa alimentare e Riordina.

  • I cluster di consigli mostrano suggerimenti personalizzati relativi al cibo di un singolo partner sviluppatore. Questi consigli possono essere personalizzati per l'utente o generalizzati (ad esempio, nuovi in offerta). Utilizzali per visualizzare ricette, negozi, piatti, generi alimentari e così via come preferisci.

    • Un cluster di consigli può essere composto da schede ProductEntity, StoreEntity o RecipeEntity, ma non da un mix di diversi tipi di entità.
    Figura :`ProductEntity`, `StoreEntity` e `RecipeEntity`. (*UI solo a scopo illustrativo)
  • 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.

    Figura : cluster in primo piano con `RecipeEntity`. (*UI solo a scopo illustrativo)
  • Il cluster Carrello della spesa mostra un'anteprima dei carrelli della spesa di più partner sviluppatori in un unico raggruppamento dell'interfaccia utente, invitando gli utenti a completare i carrelli in sospeso. Esiste un solo cluster Carrello per l'acquisto di alimenti.

    • Il cluster Carrello della spesa deve mostrare il conteggio totale degli articoli nel carrello e può includere anche immagini per X articoli nel carrello dell'utente.

      Figura: cluster Carrello della spesa di un singolo partner. (*UI solo a scopo illustrativo)
  • 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 alimentare.

    Figura: cluster della lista della spesa alimentare di un singolo partner. (*UI solo a scopo illustrativo)
  • 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.
    Figura: cluster Riordina cibo da un singolo partner. (*UI solo a scopo illustrativo)

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

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 (ProductEntity, RecipeEntity o StoreEntity)
Cluster in primo piano Al massimo 1 Al massimo 20 (ProductEntity, RecipeEntity o StoreEntity)
Cluster Carrello degli acquisti di alimentari Al massimo 1 Al massimo 1 ShoppingCartEntity
Cluster Lista della spesa alimentare Al massimo 1 Al massimo 1 ShoppingListEntity
Cluster di ripetizione dell'ordine di cibo Al massimo 1 Al massimo 1 ReorderEntity

Passaggio 1: fornisci i dati dell'entità

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

  1. ProductEntity
  2. StoreEntity
  3. RecipeEntity
  4. FoodShoppingCart
  5. FoodShoppingList
  6. FoodReorderCluster

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

ProductEntity

L'oggetto ProductEntity rappresenta un singolo elemento (ad esempio un articolo di drogheria, un piatto di un ristorante o una promozione) che i partner sviluppatori vogliono pubblicare.

Figura : attributi di ProductEntity

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 del prodotto.

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

URI
Titolo Facoltativo Il nome del prodotto.

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 del prodotto.

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 il prodotto, 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 (facoltativo) - 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 il prodotto.

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 il prodotto.

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

StoreEntity

L'oggetto StoreEntity rappresenta un singolo negozio che i partner sviluppatori vogliono pubblicare, ad esempio un ristorante o un negozio di alimentari.

Figura : attributi di StoreEntity

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 del negozio.

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

URI
Titolo Facoltativo Il nome del negozio.

Testo libero

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

Posizione Facoltativo La sede del negozio.

Testo libero

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

Callout Facoltativo Callout per mettere in evidenza una promozione, un evento o un aggiornamento per lo store, 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)

Descrizione Facoltativo Una descrizione del negozio.

Testo libero

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

Categoria Facoltativo

Categoria di un negozio. Nel contesto dei ristoranti, può essere una cucina come "francese", "new american", "ramen", "fine dining".

Testo libero

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

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 il negozio.

Nota:fornisci questo campo se la tua app vuole controllare la modalità di visualizzazione per gli utenti. Fornisci la stringa concisa che può essere visualizzata dall'utente. Ad esempio, se il conteggio è 1.000.000, valuta la possibilità di utilizzare abbreviazioni come 1 M, in modo che non venga troncato su schermi più piccoli.

Stringa
Valutazione - Conteggio Facoltativo

Il conteggio delle valutazioni per il negozio.

Nota: fornisci questo campo se non vuoi gestire personalmente la logica dell'abbreviazione della visualizzazione. Se sono presenti sia Conteggio che Valore conteggio, utilizzeremo Conteggio per la visualizzazione per gli utenti

Lungo

RecipeEntity

L'oggetto RecipeEntity rappresenta una voce di ricetta che gli sviluppatori partner vogliono pubblicare.

Figura : attributi di RecipeEntity

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 della ricetta.

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

URI
Titolo Facoltativo Il nome della ricetta.

Testo libero

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

Autore Facoltativo L'autore della ricetta.

Testo libero

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

Tempo di cottura/preparazione Facoltativo Il tempo di cottura della ricetta.

Testo libero

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

Callout Facoltativo Callout per mettere in evidenza una promozione, un evento o un aggiornamento per la ricetta, se disponibile.

Testo libero

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

Categoria Facoltativo La categoria della ricetta.

Testo libero

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

Descrizione Facoltativo Una descrizione della ricetta.

Testo libero

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

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 la ricetta.

Nota:fornisci questo campo se la tua app vuole controllare la modalità di visualizzazione per gli utenti. Fornisci la stringa concisa che può essere visualizzata dall'utente. Ad esempio, se il conteggio è 1.000.000, valuta la possibilità di utilizzare abbreviazioni come 1 M, in modo che non venga troncato su schermi più piccoli.

Stringa
Valutazione - Conteggio Facoltativo

Il conteggio delle valutazioni per la ricetta.

Nota: fornisci questo campo se non vuoi gestire personalmente la logica dell'abbreviazione della visualizzazione. Se sono presenti sia Conteggio che Valore conteggio, utilizzeremo Conteggio per la visualizzazione per gli utenti

Lungo

FoodShoppingCart

Figura: attributi del cluster Carrello della spesa alimentare.

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 ci sono 3 arance e 1 mela, questo numero deve essere 4.

Numero intero >= 1
Titolo Facoltativo

Il titolo del carrello (ad esempio, Il tuo carrello).

Se lo sviluppatore non fornisce un titolo, Il tuo carrello è il valore predefinito.

Testo libero

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

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

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

FoodShoppingList

Figura: cluster Lista della spesa alimentare.

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)

FoodReorderCluster

Figura: cluster Riordina cibo.

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.

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

300x300 1200x1200
Orizzontale (1,91 x 1) 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).

AppEngageFoodClient è responsabile della pubblicazione dei cluster di alimenti.

Esistono le seguenti API per pubblicare cluster nel client:

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishFoodShoppingCart
  • publishFoodShoppingList
  • publishReorderCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteFoodShoppingCartCluster
  • deleteFoodShoppingListCluster
  • deleteReorderCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

Questa API viene utilizzata per verificare se il servizio è disponibile per l'integrazione e se i contenuti possono essere presentati sul dispositivo.

Kotlin

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

Java

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

publishRecommendationClusters

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

Un oggetto RecommendationCluster può avere i seguenti attributi:

Attributo Requisito Descrizione
Elenco di ProductEntity, StoreEntity o RecipeEntity Obbligatorio Un elenco di entità che compongono i suggerimenti per questo cluster di suggerimenti. Le entità in un singolo cluster devono essere dello stesso tipo.
Titolo Obbligatorio

Il titolo del cluster di consigli (ad esempio, Grandi risparmi sul menu del Ringraziamento).

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

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .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.

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.

publishFoodShoppingCart

Questa API viene utilizzata per pubblicare un oggetto FoodShoppingCart.

Kotlin

client.publishFoodShoppingCart(
            PublishFoodShoppingCartClusterRequest.Builder()
                .setShoppingCart(
                    FoodShoppingCart.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFoodShoppingCart(
            new PublishFoodShoppingCartClusterRequest.Builder()
                .setShoppingCart(
                    new FoodShoppingCart.Builder()
                        ...
                        .build())
                .build());

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

  • I dati FoodShoppingCart 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.

publishFoodShoppingList

Questa API viene utilizzata per pubblicare un oggetto FoodShoppingList.

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.

publishReorderCluster

Questa API viene utilizzata per pubblicare un oggetto FoodReorderCluster.

Kotlin

client.publishReorderCluster(
            PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    FoodReorderCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishReorderCluster(
            new PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    new FoodReorderCluster.Builder()
                        ...
                        .build())
                .build());

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

  • I dati FoodReorderCluster 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.

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

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.

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.

deleteFeaturedCluster

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

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

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

deleteFoodShoppingCartCluster

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

Kotlin

client.deleteFoodShoppingCartCluster()

Java

client.deleteFoodShoppingCartCluster();

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

deleteFoodShoppingListCluster

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

Kotlin

client.deleteFoodShoppingListCluster()

Java

client.deleteFoodShoppingListCluster();

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

deleteReorderCluster

Questa API viene utilizzata per eliminare i contenuti di FoodReorderCluster.

Kotlin

client.deleteReorderCluster()

Java

client.deleteReorderCluster();

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

deleteUserManagementCluster

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

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

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

deleteClusters

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

Kotlin

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_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.

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 food shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART broadcast
  // is received
  // Trigger food shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST broadcast
  // is received
  // Trigger reorder cluster publish when PUBLISH_REORDER_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 food Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register food Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FOOD_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)
}

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 food shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART broadcast is
// received

// Trigger food shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST broadcast is
// received

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

// Register food Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_FOOD_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);

}
  • 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.food.PUBLISH_FOOD_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER" />
      </intent-filter>
   </receiver>
</application>

I seguenti intent verranno inviati dal servizio:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Ti consigliamo di avviare una chiamata publishRecommendationClusters quando ricevi questo intent.
  • com.google.android.engage.action.PUBLISH_FEATURED È consigliabile avviare una chiamata publishFeaturedCluster quando ricevi questo intent.
  • com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART Ti consigliamo di avviare una chiamata publishFoodShoppingCart quando ricevi questo intent.
  • com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST Ti consigliamo di avviare una chiamata publishFoodShoppingList quando ricevi questo intent.
  • com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER È consigliabile avviare una chiamata publishReorderCluster quando ricevi 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 engage-developers@google.com in caso di domande durante la procedura di integrazione. Il nostro team ti risponderà il prima possibile.

Passaggi successivi

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

  • Invia un'email a engage-developers@google.com e allega l'APK integrato pronto per il test da parte di Google.
  • Google eseguirà 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 contatterà per comunicarti che puoi iniziare a pubblicare l'APK aggiornato e integrato sul Play Store.
  • Dopo che Google avrà confermato la pubblicazione dell'APK aggiornato sul Play Store, i cluster Consigliati, In evidenza, Carrello, Lista della spesa e Riordina verranno pubblicati e saranno visibili agli utenti.