Google sta creando una piattaforma sul dispositivo che organizza app per verticali e consente una nuova esperienza immersiva per la fruizione personalizzata dei contenuti delle app e scoperta. Questa esperienza a schermo intero offre ai partner sviluppatori l'opportunità di mostrare i migliori contenuti avanzati in un canale dedicato esterno della propria app.
Questa guida contiene le istruzioni per gli sviluppatori partner per integrare i propri utilizzando l'SDK Engage per compilare questa nuova area. e sulle piattaforme Google esistenti come Entertainment Space.
Dettagli integrazione
Terminologia
Questa integrazione include i seguenti cinque tipi di cluster: Recommendation, In primo piano, Carrello degli acquisti, Lista della spesa, Riordina e Monitoraggio degli ordini di Shopping.
I cluster di consigli mostrano suggerimenti per gli acquisti personalizzati di un sviluppatore partner individuali. Questi consigli possono essere personalizzati in base utente o generalizzato (ad esempio, articoli di tendenza). Usali per far emergere prodotti, eventi, saldi, promozioni e abbonamenti in base alle tue esigenze.
I consigli hanno la seguente struttura:
Cluster dei suggerimenti:una visualizzazione UI che contiene un gruppo di contenuti consigliati dallo stesso partner di sviluppo.
ShoppingEntity: un oggetto che rappresenta un singolo articolo in un cluster.
Il cluster In primo piano mostra l'eroe scelto
ShoppingEntity
tra molti di sviluppatori partner in un unico raggruppamento di UI. C'è un solo annuncio visualizzato nella parte superiore della UI, con priorità il posizionamento migliore su tutti i cluster di suggerimenti. Ogni partner di sviluppo autorizzato a pubblicare una singola ShoppingEntity nel cluster In primo piano.Il cluster Carrello degli acquisti mostra un'anteprima dei carrelli degli acquisti di molti sviluppatori partner in un unico raggruppamento di UI, che invitano gli utenti a completare carrelli in sospeso. È disponibile un solo cluster di carrello acquisti, visualizzate nella parte superiore dell'interfaccia utente, con un posizionamento prioritario Cluster di suggerimenti. Ogni partner sviluppatore è autorizzato a trasmettere un singolo
ShoppingCart
nel cluster Carrello degli acquisti.Il tuo carrello degli acquisti ha la seguente struttura:
Cluster Carrello degli acquisti:una visualizzazione UI che contiene un gruppo di articoli acquistati. anteprime del carrello di molti sviluppatori partner.
Carrello degli acquisti: un oggetto che rappresenta l'anteprima del carrello degli acquisti per un unico partner sviluppatore, da mostrare nel carrello in un cluster Kubernetes.
ShoppingCart
deve mostrare il numero totale di elementi nell'attributo e può includere anche immagini di alcuni articoli.
Il cluster Lista della spesa mostra un'anteprima degli acquisti da più sviluppatori partner in un unico raggruppamento della UI, che invita gli utenti a tornare all'app corrispondente per aggiornare e completare i relativi elenchi. C'è un in un unico cluster Shopping List.
Il cluster Riordina mostra un'anteprima degli ordini precedenti a partire da più sviluppatori partner in un unico raggruppamento della UI, che chiede agli utenti di effettuare un nuovo ordine. Esiste un solo cluster Riordina.
Il cluster di riordinamento deve mostrare il numero totale di elementi nel ordine precedente dell'utente e deve includere anche uno dei seguenti elementi:
- Immagini per X articoli nell'ordine precedente dell'utente.
- Etichette di X articoli nell'ordine precedente dell'utente.
Il cluster Monitoraggio ordini di acquisto mostra un'anteprima delle ordini di acquisto completati di recente da numerosi sviluppatori partner in un'unica interfaccia utente per consentire agli utenti di monitorare i loro ordini.
Viene visualizzato un solo cluster ShoppingOrderTracking nella parte superiore dell'interfaccia utente, con un posizionamento prioritario sopra tutti i consigli cluster. Ogni sviluppatore partner è autorizzato a trasmettere più Articoli ShoppingOrderTrackingEntity nel cluster di monitoraggio degli ordini di Shopping.
Il tuo cluster di monitoraggio degli ordini Shopping ha la seguente struttura:
- ShoppingOrderTracking Cluster: una visualizzazione dell'interfaccia utente che contiene un gruppo di anteprime di monitoraggio degli ordini da molti sviluppatori partner
- ShoppingOrderTrackingEntity: un oggetto che rappresenta un ordine di acquisto monitoraggio dell'anteprima per un singolo sviluppatore partner, da visualizzare nel Cluster di monitoraggio degli ordini di Shopping. ShoppingOrderTrackingEntity deve mostrare lo stato dell'ordine e l'ora dell'ordine. Ti consigliamo vivamente di inserire i tempi di consegna previsti per ShoppingOrderTrackingEntity, viene mostrato agli utenti, quando fornito.
Attività preliminare
Livello API minimo: 19
Aggiungi la raccolta com.google.android.engage:engage-core
alla tua app:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.5.2'
}
Per ulteriori informazioni, consulta la sezione Visibilità dei pacchetti su Android. 11.
Riepilogo
La progettazione si basa sull'implementazione di un Google Cloud.
I dati che un cliente può pubblicare sono soggetti ai seguenti limiti per diversi tipi di cluster:
Tipo di cluster | Limiti del cluster | Limiti massimi di entità in un cluster |
---|---|---|
Cluster di suggerimenti | Al massimo 5 | Al massimo 25 ShoppingEntity |
Cluster in primo piano | Al massimo 1 | Al massimo 1 ShoppingEntity |
Cluster carrello degli acquisti | Al massimo 1 | Al massimo 1 ShoppingCart |
Cluster della lista della spesa | Al massimo 1 | Al massimo 1 ShoppingListEntity |
Cluster per il riordinamento Shopping | Al massimo 1 | Al massimo 1 ReorderEntity |
Cluster di monitoraggio degli ordini di Shopping | Al massimo 3 | Al massimo 3 ShoppingOrderTrackingEntity |
Passaggio 1: fornisci i dati dell'entità
L'SDK ha definito diverse entità per rappresentare ogni tipo di elemento. La per la categoria Shopping sono supportate le seguenti entità:
ShoppingEntity
ShoppingCart
ShoppingList
Reorder
ShoppingOrderTracking
I grafici riportati di seguito descrivono gli attributi e i requisiti disponibili per ogni tipo.
ShoppingEntity
L'oggetto ShoppingEntity
rappresenta un prodotto, una promozione, un'offerta, un abbonamento
o l'evento che gli sviluppatori partner vogliono pubblicare.
ShoppingEntity
Attributo | Requisito | Descrizione | Formato |
---|---|---|---|
Immagini poster | Obbligatorie | Devi fornire almeno un'immagine. | Per indicazioni, consulta le Specifiche delle immagini. |
URI azione | Obbligatorie |
Il link diretto alla pagina dell'app che mostra i dettagli sul dell'oggetto. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
URI |
Titolo | Facoltativo | Il nome dell'entità. | Testo libero Dimensioni del testo consigliate: meno di 90 caratteri (testo che troppo a lungo possono mostrare puntini di sospensione) |
Prezzo - attuale | Obbligatorio in modo condizionale |
Il prezzo corrente dell'entità. Deve essere indicato se viene indicato il prezzo barrato. |
Testo libero |
Prezzo barrato | Facoltativo | Il prezzo originale dell'entità, che viene barrato nei nell'interfaccia utente. | Testo libero |
Callout | Facoltativo | Callout per mostrare una promozione, un evento o un aggiornamento per l'entità, se disponibili. | Testo libero Dimensioni del testo consigliate: meno di 45 caratteri (testo che troppo a lungo possono mostrare puntini di sospensione) |
Clausole dei callout | Facoltativo | Testo in piccolo per il callout. | Testo libero Dimensioni del testo consigliate: meno di 45 caratteri (testo che troppo a lungo possono mostrare puntini di sospensione) |
(Facoltativo) Valutazione - Nota: tutte le valutazioni sono visualizzate usando il nostro sistema di valutazione a stelle standard. | |||
Valutazione - Valore massimo | Facoltativo | Il valore massimo della scala di valutazione. Deve essere fornito se è anche il valore corrente della valutazione forniti. |
Numero >= 0,0 |
Classificazione - Valore corrente | Facoltativo | Il valore attuale della scala di valutazione. Deve essere fornito se anche il valore massimo della valutazione è forniti. |
Numero >= 0,0 |
Valutazione - Conteggio | Facoltativo |
Il conteggio delle valutazioni per l'entità. Nota: fornisci questo campo se la tua app controlla come il conteggio viene mostrato agli utenti. Usa una stringa concisa. Ad esempio, se il conteggio è 1.000.000, valuta la possibilità di usare un'abbreviazione ad esempio 1 M, in modo che il conteggio non venga troncato su schermi di dimensioni inferiori. |
Stringa |
Valutazione - Valore conteggio | Facoltativo | Il conteggio delle valutazioni per l'entità. Nota: fornisci questo campo se non gestisci la logica delle abbreviazioni del display. Se sia il valore di conteggio che quello di conteggio se presenti, il conteggio viene mostrato agli utenti. |
Lungo |
DisplayTimeWindow (facoltativo) – Imposta una finestra temporale di un contenuto in superficie | |||
Timestamp inizio | Facoltativo |
Il timestamp dell'epoca dopo il quale i contenuti devono essere mostrati nella superficie. Se non viene configurato, i contenuti sono idonei a essere mostrati in piattaforma. |
Timestamp in millisecondi |
Data e ora di fine | Facoltativo |
Il timestamp dell'epoca dopo il quale i contenuti non vengono più mostrati in superficie. Se non viene configurato, i contenuti sono idonei a essere mostrati in piattaforma. |
Timestamp in millisecondi |
ShoppingCart
Attributo | Requisito | Descrizione | Formato |
---|---|---|---|
URI azione | Obbligatorie |
Il link diretto al carrello nell'app del partner. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
URI |
Numero di elementi | Obbligatorie |
Il numero di articoli (non solo il numero di prodotti) nel carrello degli acquisti. Ad esempio, se nel carrello ci sono 3 camicie identiche e un cappello, questo numero dovrebbe essere 4. |
Numero intero >= 1 |
Testo dell'azione | Facoltativo |
Il testo dell'invito all'azione del pulsante sul carrello degli acquisti (ad es. La tua borsa della spesa). Se lo sviluppatore non fornisce alcun testo di azione, L'impostazione predefinita è Visualizza carrello. Questo attributo è supportato dalla versione 1.1.0 in poi. |
Stringa |
Titolo | Facoltativo | Il titolo del carrello (ad esempio, La tua borsa della spesa). Se lo sviluppatore non fornisce alcun titolo, Il tuo carrello è l'impostazione predefinita. |
Testo libero Dimensioni del testo consigliate: meno di 25 caratteri (testo che troppo a lungo possono mostrare puntini di sospensione) |
Immagini del carrello | Facoltativo | Immagini di ogni prodotto nel carrello. È possibile fornire fino a 10 immagini in ordine di priorità. il il numero effettivo di immagini visualizzate dipende dalla forma del dispositivo fattore. |
Per indicazioni, consulta le Specifiche delle immagini. |
Etichette elemento | Facoltativo | L'elenco di 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 (testo che troppo lungo possono mostrare puntini di sospensione) |
DisplayTimeWindow (facoltativo) – Imposta una finestra temporale di un contenuto in superficie | |||
Timestamp inizio | Facoltativo |
Il timestamp dell'epoca dopo il quale i contenuti devono essere mostrati nella superficie. Se non viene configurato, i contenuti sono idonei a essere mostrati in piattaforma. |
Timestamp in millisecondi |
Data e ora di fine | Facoltativo |
Il timestamp dell'epoca dopo il quale i contenuti non vengono più mostrati in superficie. Se non viene configurato, i contenuti sono idonei a essere mostrati in piattaforma. |
Timestamp in millisecondi |
ShoppingList
Attributo | Requisito | Descrizione | Formato |
---|---|---|---|
URI azione | Obbligatorie |
Il link diretto alla lista della spesa nell'app del partner. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
URI |
Numero di elementi | Obbligatorie | Il numero di articoli presenti 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 alcun titolo, L'impostazione predefinita è Lista della spesa. |
Testo libero Dimensioni del testo consigliate: meno di 25 caratteri (testo che troppo a lungo possono mostrare puntini di sospensione) |
Etichette elemento | Obbligatorie | L'elenco di etichette per gli articoli nella lista della spesa. È necessario fornire almeno 1 etichetta e possono essere fino a 10 etichette forniti 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 (testo che troppo a lungo possono mostrare puntini di sospensione) |
ShoppingReorderCluster
Attributo | Requisito | Descrizione | Formato |
---|---|---|---|
URI azione | Obbligatorie |
Il link diretto da riordinare nell'app del partner. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
URI |
Testo dell'azione | Facoltativo |
Il testo dell'invito all'azione del pulsante in Riordina (ad esempio, Ordina di nuovo). Se lo sviluppatore non fornisce alcun testo di azione, Riordina è l'impostazione predefinita. Questo attributo è supportato dalla versione 1.1.0 in poi. |
Stringa |
Numero di elementi | Obbligatorie |
Il numero di articoli (non solo il numero di prodotti) nella precedente ordine. Ad esempio: se ci fossero 3 caffè piccoli e 1 croissant nella nell'ordine precedente, questo numero dovrebbe essere 4. |
Numero intero >= 1 |
Titolo | Obbligatorie | Il titolo dell'articolo dell'ordine. | Testo libero Dimensioni del testo consigliate: meno di 40 caratteri (testo che troppo lungo possono mostrare puntini di sospensione) |
Etichette elemento | Facoltativo (Se non vengono fornite, è necessario fornire immagini poster) |
L'elenco di etichette degli articoli per l'ordine precedente. È possibile fornire fino a 10 etichette in ordine di priorità. il il numero effettivo di etichette visualizzate dipende dalla forma del dispositivo fattore. |
Elenco di testo libero Dimensioni del testo consigliate per etichetta: meno di 20 caratteri (Un testo troppo lungo potrebbe mostrare dei puntini di sospensione) |
Immagini poster | Facoltativo (Se non vengono fornite, è necessario fornire le etichette degli articoli) |
Immagini degli articoli nell'ordine precedente. È possibile fornire fino a 10 immagini in ordine di priorità. il il numero effettivo di immagini visualizzate dipende dalla forma del dispositivo fattore. |
Per indicazioni, consulta le Specifiche delle immagini. |
ShoppingOrderTrackingCluster
Attributo | Requisito | Descrizione | Formato |
---|---|---|---|
Titolo | Obbligatorie |
Un breve titolo del pacchetto/degli articoli monitorati o del tracciamento numero. |
Testo libero Dimensioni del testo consigliate: 50 caratteri (il testo troppo lungo mostra ellissi) |
Tipo di ordine | Obbligatorie |
Un breve titolo del pacchetto/degli articoli monitorati o del tracciamento numero. |
Enum: IN_STORE_PICKUP, SAME_DAY_delivery, MULTI_DAY_delivery |
Stato | Obbligatorie |
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 mostra ellissi) |
Data/ora ordine | Obbligatorie |
Il timestamp dell'epoca in millisecondi in cui è stato effettuato l'ordine. L'orario dell'ordine verrà visualizzato se la finestra dei tempi di consegna prevista non è presente |
Timestamp in millisecondi |
URI azione | Obbligatorie |
Link diretto al monitoraggio degli ordini nell'app del partner. |
URI |
OrderDeliveryTimeWindow (facoltativo) - Imposta un orario finestra per l'ordine monitorato dal momento in cui è stato effettuato posizionati in base ai tempi di consegna previsti/effettivi. | |||
OrderDeliveryTimeWindow - Ora di inizio | Facoltativo |
Il timestamp dell'epoca in millisecondi il giorno/dopo il quale verrà eseguito l'ordine o essere pronti per il ritiro. |
Timestamp in millisecondi |
OrderDeliveryTimeWindow - Ora di fine | Facoltativo |
Il timestamp dell'epoca in millisecondi relativo al/prima del quale verrà eseguito l'ordine o essere pronti per il ritiro. |
Timestamp in millisecondi |
Immagini poster | Facoltativo | Immagine di un articolo/prodotto che fa parte dell'ordine. Le proporzioni consigliate sono 1:1 |
Per indicazioni, consulta le Specifiche delle immagini. |
Numero di elementi | Facoltativo | Il numero di articoli nell'ordine. | Numero intero >= 1 |
Descrizione | Facoltativo | Un singolo paragrafo di testo per descrivere gli elementi dell'ordine. Nota: la descrizione o l'elenco di sottotitoli verranno visualizzati mostrati all'utente, non a entrambi. |
Testo libero Dimensioni del testo consigliate: 180 caratteri |
Elenco sottotitoli | Facoltativo | Fino a 3 sottotitoli, ognuno con una singola riga di testo. Nota: la descrizione o l'elenco di sottotitoli verranno visualizzati mostrati all'utente, non a entrambi. |
Testo libero Dimensioni del testo consigliate per ogni sottotitolo: max 50 caratteri |
Valore ordine - CurrentPrice | Facoltativo | Il valore corrente dell'ordine. | Testo libero |
Numero ordine | Facoltativo | Il numero/ID dell'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 riferimento della consegna dell'ordine/del pacco in caso di ordine richiede una consegna. |
Testo libero Dimensioni del testo consigliate: massimo 25 caratteri |
Specifiche per le immagini
Di seguito sono elencate le specifiche obbligatorie per gli asset immagine:
Proporzioni | Numero minimo di pixel | Pixel consigliati |
---|---|---|
Quadrato (1 x 1) Preferito per i cluster non in primo piano |
300x300 | 1200x1200 |
Orizzontale (1,91 x 1) Preferito per i cluster in primo piano |
600x314 | 1200x628 |
Verticale (4 x 5) | 480x600 | 960x1200 |
Formati file
PNG, JPG, GIF statica, WebP
Dimensioni massime del file
5120 kB
Consigli aggiuntivi
- Area di sicurezza dell'immagine:inserisci i contenuti importanti al centro dell'80% della sezione dell'immagine.
- Utilizza uno sfondo trasparente per consentire una corretta visualizzazione dell'immagine Impostazioni 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 pianificato con cadenza regolare o evento (ad esempio, ogni volta l'utente apre l'app o quando ha appena aggiunto qualcosa al carrello).
AppEngageShoppingClient
è responsabile della pubblicazione di cluster di shopping.
Le seguenti API sono esposte per pubblicare cluster nel client:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishShoppingCart
publishShoppingList
publishShoppingReorderCluster
publishShoppingOrderTrackingCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteShoppingCartCluster
deleteShoppingListCluster
deleteShoppingReorderCluster
deleteShoppingOrderTrackingCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Questa API viene utilizzata per verificare se il servizio è disponibile per l'integrazione e se i contenuti possono essere presentati sul dispositivo.
Kotlin
client.isServiceAvailable.addOnCompleteListener { task -> if (task.isSuccessful) { // Handle IPC call success if(task.result) { // Service is available on the device, proceed with content publish // calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } }
Java
client.isServiceAvailable().addOnCompleteListener(task - > { if (task.isSuccessful()) { // Handle success if(task.getResult()) { // Service is available on the device, proceed with content // publish calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } });
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 | Obbligatorie | Un elenco di oggetti ShoppingEntity che costituiscono i suggerimenti per questo cluster di suggerimenti. |
Titolo | Obbligatorie | Il titolo del cluster di suggerimenti. Dimensioni del testo consigliate: meno di 25 caratteri (testo che troppo a lungo possono mostrare puntini di sospensione) |
Sottotitolo | Facoltativo | Il sottotitolo per il cluster dei suggerimenti. |
URI azione | Facoltativo |
Il link diretto alla pagina nell'app del partner in cui gli utenti possono vedere l'elenco completo dei consigli. Nota: puoi utilizzare i link diretti per l'attribuzione. Fai riferimento a queste domande frequenti |
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: una transazione:
- Tutti i dati esistenti del cluster di suggerimenti vengono rimossi.
- I dati della richiesta vengono analizzati e archiviati in nuovi cluster dei suggerimenti.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
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: una transazione:
- I dati esistenti relativi a
FeaturedCluster
dello sviluppatore partner verranno rimossi. - I dati della richiesta vengono analizzati e archiviati nel cluster in primo piano aggiornato.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
publishShoppingCart
Questa API viene utilizzata per pubblicare un oggetto ShoppingCartCluster
.
Kotlin
client.publishShoppingCart( PublishShoppingCartRequest.Builder() .setShoppingCart( ShoppingCart.Builder() ... .build()) .build())
Java
client.publishShoppingCart( new PublishShoppingCartRequest.Builder() .setShoppingCart( new ShoppingCart.Builder() ... .build()) .build())
Quando il servizio riceve la richiesta, vengono eseguite le seguenti azioni: una transazione:
- I dati esistenti relativi a
ShoppingCart
dello sviluppatore partner verranno rimossi. - I dati della richiesta vengono analizzati e archiviati nel carrello degli acquisti aggiornato di un cluster Kubernetes.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
publishShoppingList
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: una transazione:
- I dati esistenti relativi a
FoodShoppingList
dello sviluppatore partner verranno rimossi. - I dati della richiesta vengono analizzati e memorizzati nella lista della spesa aggiornata di un cluster Kubernetes.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
publishShoppingReorderCluster
Questa API viene utilizzata per pubblicare un oggetto ShoppingReorderCluster
.
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: una transazione:
- I dati esistenti relativi a
ShoppingReorderCluster
dello sviluppatore partner verranno rimossi. - I dati della richiesta vengono analizzati e archiviati nel cluster di riordinamento aggiornato.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
publishShoppingOrderTrackingCluster
Questa API viene utilizzata per pubblicare un oggetto ShoppingOrderTrackingCluster
.
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: una transazione:
- I dati di
ShoppingOrderTrackingCluster
esistenti dallo sviluppatore partner sono rimosso. - I dati della richiesta vengono analizzati e archiviati nell'ordine di Shopping aggiornato Cluster di monitoraggio.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
publishUserAccountManagementRequest
Questa API viene utilizzata per pubblicare una scheda di accesso . L'azione di accesso indirizza gli utenti a alla pagina di accesso dell'app, in modo che quest'ultima possa pubblicare contenuti (o fornire contenuti personalizzati)
I seguenti metadati fanno parte della scheda di accesso:
Attributo | Requisito | Descrizione |
---|---|---|
URI azione | Obbligatorio | Link diretto all'azione (ad esempio, per passare alla pagina di accesso all'app) |
Immagine | Facoltativo: se non viene specificato, è necessario indicare il titolo |
Immagine mostrata sulla scheda Immagini con proporzioni 16:9 con una risoluzione di 1264 x 712 |
Titolo | Facoltativo: se non viene fornita, è necessario fornire l'immagine | Titolo sulla scheda |
Testo dell'azione | Facoltativo | Testo mostrato sull'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: una transazione:
- I dati di
UserAccountManagementCluster
esistenti dallo sviluppatore partner sono rimosso. - I dati della richiesta vengono analizzati e archiviati nel Cluster UserAccountManagementCluster.
In caso di errore, l'intera richiesta viene rifiutata e lo stato esistente viene viene mantenuta.
updatePublishStatus
Se, per qualsiasi motivo di business interno, nessuno dei cluster viene pubblicato, ti consigliamo vivamente di aggiornare lo stato di pubblicazione utilizzando API updatePubblicaStatus. Questo è importante perché :
- Indicare lo stato in tutti gli scenari, anche quando i contenuti vengono pubblicati (STATO == PUBBLICATO), è fondamentale per compilare le dashboard che utilizzano questo stato esplicito per comunicare lo stato di integrità e altre metriche della tua integrazione.
- Se non sono stati pubblicati contenuti, ma lo stato dell'integrazione non funziona (STATUS == NOT_PUBLISHERED), Google può evitare di attivare avvisi nell'app dashboard dell'integrità. Conferma che i contenuti non sono stati pubblicati a causa di un situazione prevista dal punto di vista del provider.
- Consente agli sviluppatori di capire quando i dati vengono pubblicati e quando .
- Google può utilizzare i codici di stato per sollecitare l'utente a eseguire determinate azioni nel dell'app in modo da poter vedere o risolvere i contenuti dell'app.
Ecco un elenco di codici di stato idonei per la pubblicazione :
// 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 riescono a pubblicare la scheda di accesso ti consigliamo di chiamare l'API updatePubblicaStatus con il codice di stato NOT_PUBLISHERED_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 dei suggerimenti.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Quando il servizio riceve la richiesta, rimuove i dati esistenti Cluster di suggerimenti. In caso di errore, l'intera richiesta viene rifiutata. e lo stato esistente viene mantenuto.
deleteFeaturedCluster
Questa API viene utilizzata per eliminare i contenuti del cluster in primo piano.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Quando il servizio riceve la richiesta, rimuove i dati esistenti Cluster in primo piano. In caso di errore, l'intera richiesta viene rifiutata. e lo stato esistente viene mantenuto.
deleteShoppingCartCluster
Questa API viene utilizzata per eliminare i contenuti del cluster del carrello degli acquisti.
Kotlin
client.deleteShoppingCartCluster()
Java
client.deleteShoppingCartCluster();
Quando il servizio riceve la richiesta, rimuove i dati esistenti Cluster del carrello degli acquisti. In caso di errore, l'intera richiesta viene rifiutata. e lo stato esistente viene mantenuto.
deleteShoppingListCluster
Questa API viene utilizzata per eliminare i contenuti del cluster della lista della spesa.
Kotlin
client.deleteShoppingListCluster()
Java
client.deleteShoppingListCluster();
Quando il servizio riceve la richiesta, rimuove i dati esistenti Cluster della lista della spesa. In caso di errore, l'intera richiesta viene rifiutata. e lo stato esistente viene mantenuto.
deleteShoppingReorderCluster
Questa API viene utilizzata per eliminare i contenuti del cluster di riordinamento Shopping.
Kotlin
client.deleteShoppingReorderCluster()
Java
client.deleteShoppingReorderCluster();
Quando il servizio riceve la richiesta, rimuove i dati esistenti Cluster per il riordinamento di Shopping. In caso di errore, l'intera richiesta viene rifiutata. e lo stato esistente viene mantenuto.
deleteShoppingOrderTrackingCluster
Questa API viene utilizzata per eliminare i contenuti del cluster di monitoraggio degli ordini Shopping.
Kotlin
client.deleteShoppingOrderTrackingCluster()
Java
client.deleteShoppingOrderTrackingCluster();
Quando il servizio riceve la richiesta, rimuove i dati esistenti Cluster di monitoraggio degli ordini di Shopping. In caso di errore, l'intera richiesta viene viene rifiutato 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 Cluster UserAccountManagement. In caso di errore, l'intera richiesta viene viene rifiutato 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 corrispondenti ai tipi di cluster specificati. I clienti possono scegliere di superare uno o per molti tipi di cluster. In caso di errore, l'intera richiesta viene rifiutata e viene mantenuto.
Gestione degli errori
Ti consigliamo vivamente di ascoltare il risultato dell'attività dalle API di pubblicazione, ad esempio che è possibile eseguire un'azione di follow-up per recuperare e inviare nuovamente un'attività riuscita.
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(..) .build()) .addOnCompleteListener { task -> if (task.isSuccessful) { // do something } else { val exception = task.exception if (exception is AppEngageException) { @AppEngageErrorCode val errorCode = exception.errorCode if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } }
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(...) .build()) .addOnCompleteListener( task -> { if (task.isSuccessful()) { // do something } else { Exception exception = task.getException(); if (exception instanceof AppEngageException) { @AppEngageErrorCode int errorCode = ((AppEngageException) exception).getErrorCode(); if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } });
L'errore viene restituito come AppEngageException
con la causa inclusa come un
codice di errore.
Codice di errore | Nota |
---|---|
SERVICE_NOT_FOUND |
Il servizio non è disponibile sul dispositivo specificato. |
SERVICE_NOT_AVAILABLE |
Il servizio è disponibile sul dispositivo specificato, ma non lo è al momento della chiamata (ad esempio, è esplicitamente disabilitata). |
SERVICE_CALL_EXECUTION_FAILURE |
Esecuzione dell'attività non riuscita a causa di problemi di thread. In questo caso, da riprovare. |
SERVICE_CALL_PERMISSION_DENIED |
Il chiamante non è autorizzato a effettuare la chiamata di servizio. |
SERVICE_CALL_INVALID_ARGUMENT |
La richiesta contiene dati non validi (ad esempio, più del numero consentito di cluster). |
SERVICE_CALL_INTERNAL |
Si è verificato un errore sul lato del servizio. |
SERVICE_CALL_RESOURCE_EXHAUSTED |
La chiamata all'assistenza viene effettuata troppo spesso. |
Passaggio 3: gestisci gli intent di trasmissione
Oltre a effettuare chiamate all'API Publication di contenuti tramite un job, è anche
necessario per configurare
BroadcastReceiver
per ricevere
la richiesta di pubblicazione di contenuti.
L'obiettivo degli intent di trasmissione è principalmente la riattivazione dell'app e l'applicazione forzata dei dati sincronizzare. Gli intent di trasmissione non sono progettati per essere inviati molto spesso. È solo attivata quando il servizio Engage stabilisce che i contenuti potrebbero essere obsoleti (ad ad esempio, una settimana fa). In questo modo, l'utente può avere una maggiore sicurezza nuova esperienza con i contenuti, anche se l'applicazione non è stata eseguita per per un lungo periodo di tempo.
BroadcastReceiver
deve essere configurato nei due modi seguenti:
- Registra dinamicamente un'istanza della classe
BroadcastReceiver
utilizzandoContext.registerReceiver()
. Ciò consente la comunicazione dalle applicazioni ancora in memoria.
Kotlin
class AppEngageBroadcastReceiver : BroadcastReceiver(){ // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION // broadcast is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is // received // Trigger shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast // is received // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast // is received // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is // received // Trigger shopping order tracking cluster publish when // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER broadcast is received } fun registerBroadcastReceivers(context: Context){ var context = context context = context.applicationContext // Register Recommendation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Shopping Cart Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART)) // Register Shopping List Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST)) // Register Reorder Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER)) // Register Shopping Order Tracking Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER)) }
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)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Shopping Cart Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART)); // Register Shopping List Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST)); // Register Reorder Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER)); // 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)); }
- Dichiarare in modo statico un'implementazione con il tag
<receiver>
nel tuoAndroidManifest.xml
file. Ciò consente all'applicazione di ricevere annunci quando non è in esecuzione e consente inoltre all'applicazione di pubblicare dei contenuti.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.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 servizio:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
È consigliabile avviare una chiamatapublishRecommendationClusters
quando l'intenzione di acquisto.com.google.android.engage.action.PUBLISH_FEATURED
Ti consigliamo di avviare una chiamatapublishFeaturedCluster
quando questo intent ricevuto.com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART
Ti consigliamo di avviare una chiamatapublishShoppingCart
quando questo intent ricevuto.com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST
Ti consigliamo di avviare una chiamatapublishShoppingList
quando questo intent ricevuto.com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER
Ti consigliamo di avviare una chiamatapublishReorderCluster
quando questo intent ricevuto.com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER
È consigliabile avviare una chiamatapublishShoppingOrderTrackingCluster
quando questo intent.
Flusso di lavoro di integrazione
Per una guida passo passo sulla verifica dell'integrazione dopo il suo completamento, consulta Flusso di lavoro per l'integrazione degli sviluppatori del coinvolgimento.
Domande frequenti
Consulta le domande frequenti sull'SDK Engage per Domande frequenti.
Contact
Contatto engagement-developers@google.com se ci sono a eventuali domande durante il processo di integrazione. Il nostro team risponde possibile.
Passaggi successivi
Dopo aver completato l'integrazione, i passaggi successivi sono i seguenti:
- Invia un'email a engagement-developers@google.com e collega l'APK integrato, pronto per essere testato da Google.
- Google esegue una verifica ed esamina internamente per assicurarsi che che funzioni come previsto. Se sono necessarie modifiche, Google ti contatta con tutti i dettagli necessari.
- Quando il test è stato completato e non sono necessarie modifiche, Google ti contatta per ti comunicherà che puoi iniziare a pubblicare l'APK aggiornato e integrato sul Play Store.
- Dopo che Google avrà confermato la pubblicazione dell'APK aggiornato su Play Store, il tuo Consiglio, In primo piano, Carrello degli acquisti, Lista della spesa, Riordina cluster e Cluster di monitoraggio degli ordini Shopping possono essere pubblicati ed essere visibili agli utenti.