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

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Google sta creando una piattaforma on-device che organizza le app degli utenti per verticali e consente una nuova esperienza immersiva per la scoperta e il consumo di contenuti delle app personalizzati. Questa esperienza a schermo intero offre agli sviluppatori partner l'opportunità di mostrare i loro migliori contenuti avanzati in un canale dedicato al di fuori della loro app.

Questo documento contiene le istruzioni per gli sviluppatori partner per integrare i propri contenuti social utilizzando l'SDK Engage per compilare questa nuova area.

Dettaglio dell'integrazione

La sezione seguente acquisisce i dettagli dell'integrazione.

Terminologia

I cluster di consigli mostrano suggerimenti personalizzati di un singolo sviluppatore partner.

I consigli hanno la seguente struttura:

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

Ogni cluster di consigli è costituito da uno dei seguenti due tipi di entità :

• PortraitMediaEntity
• SocialPostEntity

PortraitMediaEntity deve contenere un'immagine verticale per il post. I metadati relativi a profilo e interazione sono facoltativi.

• Post

  • Immagine in modalità Ritratto e timestamp oppure
  • Immagine in modalità Ritratto + contenuti di testo e timestamp

• Profilo

  • Avatar, Nome o Handle, Immagine aggiuntiva

• Interazioni

  • Contare e etichettare solo oppure
  • Conteggio e visualizzazione (icona)

SocialPostEntity contiene metadati relativi a profilo, post e interazioni.

• Profilo

  • Avatar, nome o handle, testo aggiuntivo, immagine aggiuntiva

• Post

  • Testo e timestamp oppure
  • Rich media (immagine o URL rich) e timestamp oppure
  • Testo e rich media (immagine o URL rich) e timestamp oppure
  • Anteprima del video (miniatura e durata) e timestamp

• Interazioni

  • Conta e etichetta solo oppure
  • Conteggio e visualizzazione (icona)

Preparazione

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

Riepilogo

Il design si basa su un'implementazione di un servizio vincolato.

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

Passaggio 1: fornisci i dati delle entità

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

1. PortraitMediaEntity
2. SocialPostEntity

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

PortraitMediaEntity

SocialPostEntity

Specifiche per le immagini

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

Formati file

PNG, JPG, GIF statico, WebP

Dimensioni massime del file

5120 kB

Consigli aggiuntivi

• Area di sicurezza dell'immagine:inserisci i contenuti importanti al centro dell'immagine in modo da occuparne l'80%.
• Utilizza uno sfondo trasparente in modo che l'immagine possa essere visualizzata correttamente nelle impostazioni dei temi scuro e chiaro.

Passaggio 2: fornisci i dati del cluster

Ti consigliamo di eseguire il job di pubblicazione dei contenuti in background (ad esempio utilizzando WorkManager) e di pianificarlo su base regolare o in base a un evento (ad esempio ogni volta che l'utente apre l'app o quando l'utente ha appena seguito un nuovo account)

AppEngageSocialClient è responsabile della pubblicazione dei cluster sociali.

Esistono le seguenti API per pubblicare i cluster nel client:

• isServiceAvailable
• publishRecommendationClusters
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• 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.

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

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:

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Latest from your friends")
                        .build())
                .build())

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Latest from your friends")
                        .build())
                .build());

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

• Tutti i dati esistenti dei 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.

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

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

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

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

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

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 è pubblicato, consigliamo vivamente di aggiornare lo stato di pubblicazione utilizzando l'API updatePublishStatus. Questo è importante perché :

• Fornire lo stato in tutti gli scenari, anche quando i contenuti sono pubblicati (STATUS == PUBLISHED), è fondamentale per compilare le dashboard che utilizzano questo stato esplicito per trasmettere l'integrità e altre metriche dell'integrazione.
• Se non vengono pubblicati contenuti, ma lo stato dell'integrazione non è in errore (STATUS == NOT_PUBLISHED), Google può evitare di attivare avvisi nelle dashboard di salute dell'app. Conferma che i contenuti non vengono pubblicati a causa di una situazione prevedibile dal punto di vista del fornitore.
• Aiuta gli sviluppatori a fornire informazioni su quando i dati vengono pubblicati o meno.
• Google potrebbe utilizzare i codici di stato per indurre l'utente a eseguire determinate azioni nell'app in modo da poter vedere i contenuti dell'app o superarli.

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

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

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

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

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

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

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

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

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

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

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

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

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.

client.deleteRecommendationClusters()

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.

deleteUserManagementCluster

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

client.deleteUserManagementCluster()

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.

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

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

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

Gestione degli errori

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

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.

Passaggio 3: gestisci gli intent di trasmissione

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

Lo scopo degli intent di trasmissione è principalmente la riattivazione dell'app e l'applicazione forzata della sincronizzazione dei dati. Gli intent di trasmissione non sono progettati per essere inviati molto di frequente. Viene attivata solo quando il servizio Engage determina che i contenuti potrebbero essere obsoleti (ad esempio, risalenti a una settimana prima). In questo modo, l'utente può avere una maggiore certezza di poter usufruire di contenuti aggiornati, anche se l'applicazione non è stata eseguita per un lungo periodo di tempo.

BroadcastReceiver deve essere configurato nei seguenti due modi:

• Registra dinamicamente un'istanza della classe BroadcastReceiver utilizzando Context.registerReceiver(). In questo modo, viene attivata la comunicazione da applicazioni che sono ancora attive in memoria.

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION 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));

}

• Dichiara in modo statico un'implementazione con il tag <receiver> nel AndroidManifest.xml file. In questo modo, l'applicazione può ricevere intent di trasmissione quando non è in esecuzione e pubblicare i contenuti.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
   </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 questa intenzione.

Flusso di lavoro di integrazione

Per una guida passo passo sulla verifica dell'integrazione al termine, consulta Flusso di lavoro di integrazione degli sviluppatori di Engage.

Domande frequenti

Consulta le Domande frequenti sull'SDK Engage per approfondire.

Contatto

Contatta engage-developers@google.com in caso di domande durante la procedura di integrazione. Il nostro team risponderà il prima possibile.

Passaggi successivi

Dopo aver completato questa integrazione, svolgi i seguenti passaggi:

• Invia un'email all'indirizzo engage-developers@google.com e allega il tuo APK integrato pronto per i test da parte di Google.
• Google esegue una verifica e delle revisioni interne per assicurarsi che l'integrazione funzioni come previsto. Se sono necessarie modifiche, Google ti contatterà con tutti i dettagli necessari.
• Al termine del test, se non sono necessarie modifiche, Google ti contatta per informarti che puoi iniziare a pubblicare l'APK aggiornato e integrato sul Play Store.
• Una volta che Google avrà confermato che l'APK aggiornato è stato pubblicato sul Play Store, i tuoi consigli e i cluster verranno pubblicati e saranno visibili agli utenti.