API SDK Runtime: guida all'integrazione

Mentre leggi la documentazione di Privacy Sandbox su Android, utilizza il pulsante Anteprima per sviluppatori o Beta per selezionare la versione del programma che stai utilizzando, poiché le istruzioni possono variare.


Per aiutarti nella pianificazione dell'integrazione, questa guida fornisce una visione completa del processo di integrazione, che può includere funzionalità non ancora implementate nella fase attuale di Privacy Sandbox nell'Anteprima per gli sviluppatori di Android. In questi casi, vengono fornite indicazioni sulle tempistiche.

Il grafico seguente mostra il flusso di lavoro di sviluppo aggiornato per l'integrazione di SDK Runtime. Le sezioni elencate nella stessa colonna possono essere modificate in parallelo; ad esempio, Coinvolgimento dei partner può essere eseguito contemporaneamente alla configurazione dell'ambiente di test.

Diagramma visivo del flusso di lavoro di integrazione di SDK Runtime.
Flusso di lavoro per l'integrazione di SDK Runtime.

Prerequisiti e configurazione

Il completamento di questa sezione di pre-lavoro garantisce una buona comprensione di SDK Runtime e ti consentirà di ottenere risultati significativi quando utilizzi l'API nell'ecosistema ad tech.

Acquisire familiarità con l'API

Inizia leggendo la proposta di progettazione per acquisire familiarità con il runtime dell'SDK, le sue funzionalità e limitazioni.

Leggi la Guida per gli sviluppatori per scoprire come incorporare il codice e le chiamate API necessarie per i tuoi casi d'uso.

Invia eventuali feedback in merito alla documentazione, in particolare per quanto riguarda le domande aperte.

Registrati per ricevere aggiornamenti su Privacy Sandbox su Android. In questo modo potrai rimanere sempre aggiornato sulle nuove funzionalità introdotte nelle versioni future.

Configura e testa l'app di esempio

Quando è tutto pronto per iniziare l'integrazione, scarica l'Anteprima per sviluppatori più recente in Android Studio seguendo le istruzioni elencate qui. Questa guida richiede l'utilizzo dell'ultima versione canary di Android Studio. Puoi eseguire questa versione di Android Studio in parallelo ad altre versioni che utilizzi, quindi comunicacelo se questo requisito non soddisfa le tue esigenze.

Esegui il fork ed esegui il codice nella nostra app di esempio per acquisire familiarità con l'installazione dell'SDK RE denominato "example-sdk" e dell'app client chiamata "client-app" su un dispositivo o emulatore, in modo da assicurarti che venga caricato un annuncio di esempio.

Adatta l'SDK esistente al runtime dell'SDK

L'obiettivo di questa sezione è implementare funzionalità, ad esempio mostrare un annuncio banner, dall'SDK esistente in un SDK RE abilitato per il runtime, e impostare la comunicazione tra l'app e l'SDK RE.

  • Crea o aggiorna gli esempi sdk e implementazioni sdk per implementare le funzionalità nell'SDK RE.

  • Dal punto di vista dell'architettura, valuta la possibilità di aggiungere l'SDK RE come dipendenza all'SDK esistente, che funge da wrapper. Ciò consente all'app client di continuare a chiamare direttamente l'SDK esistente, o il wrapper. L'SDK wrapper può indirizzare le chiamate API in base alle diverse strategie descritte di seguito.

Diagramma visivo dell'architettura di sistema dopo l'integrazione di SDK Runtime.
Architettura di sistema dopo l'integrazione di SDK Runtime.

Per i casi d'uso che richiedono dati personalizzati, come le chiamate alle PPAPI, sarà necessario creare una definizione API tramite IPC. Utilizzando IBinder e AIDL di Android, crea un protocollo di comunicazione per inviare informazioni all'SDK abilitato per il runtime per eventuali azioni o informazioni richieste. Scopri di più nella guida per gli sviluppatori di SDK Runtime qui.

Instrada il traffico all'SDK abilitato per il runtime

Strategie di routing per le chiamate API

A seconda dei casi d'uso, ti consigliamo di instradare le chiamate all'SDK tramite l'SDK esistente e i percorsi di codice dell'SDK RE. In questo modo potrai implementare i test A/B nell'implementazione iniziale. Per facilitare l'integrazione dell'app, questa guida prende in considerazione che l'app dipenderà dall'SDK RE e delegherà all'SDK esistente quando opportuno. Considera le seguenti strategie:

Instrada una percentuale di chiamate SDK all'SDK RE

Indirizza solo una percentuale di chiamate dell'SDK all'SDK RE. Indirizza il resto al percorso del codice dell'SDK esistente. Prendi in considerazione questa strategia per i casi in cui devi soddisfare la richiesta dell'SDK una sola volta, come la visualizzazione di un annuncio banner.

  • Modifica l'SDK esistente per indirizzare una percentuale di richieste all'SDK RE. Ad esempio, utilizza un flag di configurazione dinamico basato su server, come Firebase Remote Config, per controllare i criteri di deviazione in modo dinamico.
  • In pratica, questo rende l'SDK esistente l'unica interfaccia con cui l'app interagisce e gestisce il routing delle richieste dell'SDK al nuovo SDK RE.
  • Il codice deve reindirizzare solo le richieste che possono essere gestite dall'SDK RE. Ad esempio, verifica che il formato dell'annuncio sia supportato da SDK Runtime.
  • Segui queste istruzioni per aggiornare il codice dell'SDK in modo che interagisca con l'SDK RE.

Pseudocodice per la logica di routing:

void showAd(AdRequest request) {
  if (request.isBannerAd() && enableRuntimeSdkDiversion() == true) {
    // Call showAd() from the RE SDK
  } else {
    // Call showAd() using the existing SDK code path
  }
}

Instrada tutte le chiamate agli SDK sia agli SDK esistenti che a quelli RE

Instrada tutte le chiamate all'SDK sia al percorso del codice dell'SDK esistente sia al percorso del codice dell'SDK RE, sui dispositivi supportati. Considera questa strategia per i casi in cui devi applicare percorsi di codice nuovi ed esistenti a scopo di confronto. Ad esempio, confronta i risultati dei report sulle conversioni.

  • Modifica il codice per instradare tutte le chiamate all'SDK sia al percorso del codice dell'SDK esistente sia al percorso del codice dell'SDK RE. Devi verificare che la funzionalità sia supportata da SDK Runtime e che l'SDK RE sia stato caricato correttamente.

Pseudocodice per la logica di routing:

void reportAttribution(AdRequest request) {
  if (request.isFeatureSupported() && isSdkLoaded() == true) {
    // Call RE SDK
  }

  // Call existing SDK code path
}

Beta chiusa per la distribuzione di SDK abilitati per il runtime

Google Play offre agli sviluppatori che si registrano al programma beta e hanno eseguito test locali un programma beta chiuso per SDK relativi agli annunci. Se ti interessa partecipare, registrati qui.