Seleziona una creatività per frequenza

Esegui un worklet dello spazio di archiviazione condiviso per selezionare un URL ed eseguirne il rendering in un frame recintato.

L'API Shared Storage è una soluzione Proposta di sandbox per uso generico, archiviazione cross-site, che supporta molti e i possibili casi d'uso. Un esempio è il controllo della frequenza, disponibile per test in Chrome Beta 104.0.5086.0 e versioni successive.

Esegui uno script di worklet per selezionare un URL da un elenco fornito, in base alle ed eseguire il rendering dell'URL in un frame recintato. Può essere utilizzato per selezionare nuovi annunci o altri contenuti al raggiungimento del limite di frequenza.

Testare la selezione delle creatività in base alla frequenza

Per testare la selezione delle creatività in base alla frequenza con lo spazio di archiviazione condiviso e i frame recintati, conferma di utilizzando Chrome 104.0.5086.0 o versioni successive. Attiva tutte le API di privacy per gli annunci in chrome://settings/adPrivacy.

Puoi anche abilitare Archiviazione condivisa con il flag --enable-features=PrivacySandboxAdsAPIsOverride,OverridePrivacySandboxSettingsLocalTesting,SharedStorageAPI,FencedFrames nella riga di comando.

Sperimenta con gli esempi di codice

Per selezionare e creare un URL opaco, registra un modulo di worklet da leggere archiviazione dati. La classe di worklet riceve un elenco di massimo otto URL e poi restituisce l'indice dell'URL scelto.

Quando il client chiama sharedStorage.selectURL(), il worklet esegue e restituisce un URL opaco da visualizzare in un frame recintato.

Supponiamo che tu voglia selezionare un annuncio o un contenuto diverso da visualizzare in base alla frequenza con cui un utente li ha visualizzati prima. Puoi contare quante volte un utente ha visualizzato un contenuto e archiviare quel valore nello spazio di archiviazione condiviso. Una volta archiviato, il valore nello spazio di archiviazione condiviso diventa disponibile per te in diverse origini.

Quindi, il worklet dello spazio di archiviazione condiviso legge i valori nello spazio di archiviazione condiviso e incrementa il contatore a ogni visualizzazione aggiuntiva. Se il conteggio non ha raggiunto il limite predefinito, vengono restituiti i contenuti di cui vuoi eseguire il rendering (indice 1). In caso contrario, viene restituito l'URL predefinito (indice 0).

In questo esempio:

  • creative-selection-by-frequencyjs viene caricato tramite l'iframe del produttore di contenuti o dell'inserzionista ed è responsabile per il caricamento del worklet dello spazio di archiviazione condiviso e il rendering dell'opaco restituito in un frame recintato.
  • creative-selection-by-frequency-worklet.js è il worklet dello spazio di archiviazione condiviso che legge le il conteggio della frequenza per determinare quale URL viene restituito per un contenuto o una creatività dell'annuncio.

creative-selection-by-frequency.js

// The first URL is the default content or ad to be rendered when the frequency limits reached.
const CONTENT_URLS = [
  { url: `https://${contentProducerUrl}/default-content.html` },
  { url: `https://${contentProducerUrl}/example-content.html` },
];

async function injectAd() {
  // Load the worklet module.
  await window.sharedStorage.worklet.addModule('creative-selection-by-frequency-worklet.js');

  // Set the initial frequency count
  window.sharedStorage.set('frequency-count', 0, {
    ignoreIfPresent: true,
  });

  // Run the URL selection operation to choose an ad based on the frequency count in shared storage.
  const fencedFrameConfig = await window.sharedStorage.selectURL('creative-selection-by-frequency', CONTENT_URLS, {
    resolveToConfig: true
  });

  // Render the opaque URL into a fenced frame
  document.getElementById('content-slot').config = fencedFrameConfig;
}

injectAd();

creative-selection-by-frequency-worklet.js

const FREQUENCY_LIMIT = 5;

class CreativeSelectionByFrequencyOperation {
  async run(urls, data) {
    // Read the current frequency limit in shared storage
    const count = parseInt(await sharedStorage.get('frequency-count'));

    // Check if the frequency limit has been reached.
    if (count === FREQUENCY_LIMIT) {
      console.log('Frequency limit has been reached, and the default content will be rendered.');
      return 0;
    }

    // Set the new frequency count in shared storage
    await sharedStorage.set('frequency-count', count + 1);
    return 1;
  }
}

// Register the operation as 'creative-selection-by-frequency'.
register('creative-selection-by-frequency', CreativeSelectionByFrequencyOperation);

Use cases

All available use cases for Select URL API can be found in this section. We'll continue to add examples as we receive feedback and discover new test cases.

Engage and share feedback

Note that the Select URL API proposal is under active discussion and development and subject to change.

We're eager to hear your thoughts on the Select URL API.

Stay Informed

  • Mailing List: Subscribe to our mailing list for the latest updates and announcements related to the Select URL and Shared Storage APIs.

Need Help?