Sélectionner une création par fréquence

Exécutez un worklet Shared Storage pour sélectionner une URL et l'afficher dans un cadre cloisonné.

L'API Shared Storage est une proposition de la Privacy Sandbox pour le stockage multisite à usage général, qui prend en charge de nombreux cas d'utilisation possibles. Par exemple, le contrôle de la fréquence est disponible pour les tests dans Chrome bêta 104.0.5086.0 et versions ultérieures.

Exécutez un script de worklet pour sélectionner une URL dans une liste fournie, en fonction des données stockées, puis affichez cette URL dans un cadre délimité. Cette fonctionnalité permet de sélectionner de nouvelles annonces ou d'autres contenus lorsque la limite de fréquence est atteinte.

Tester la sélection de créations par fréquence

Pour tester la sélection de créations par fréquence avec Shared Storage et les cadres isolés, vérifiez que vous utilisez Chrome 104.0.5086.0 ou version ultérieure. Activez toutes les API de confidentialité des annonces sous chrome://settings/adPrivacy.

Vous pouvez également activer le stockage partagé avec l'indicateur --enable-features=PrivacySandboxAdsAPIsOverride,OverridePrivacySandboxSettingsLocalTesting,SharedStorageAPI,FencedFrames dans la ligne de commande.

Tester des exemples de code

Pour sélectionner et créer une URL opaque, enregistrez un module de worklet afin de lire les données de stockage partagé. La classe de worklet reçoit une liste de huit URL maximum, puis renvoie l'index de l'URL choisie.

Lorsque le client appelle sharedStorage.selectURL(), le worklet s'exécute et renvoie une URL opaque à afficher dans une frame clôturée.

Imaginons que vous souhaitiez sélectionner une autre annonce ou un autre contenu à afficher en fonction de la fréquence à laquelle un utilisateur l'a déjà vu. Vous pouvez compter le nombre de fois qu'un utilisateur a vu un contenu et stocker cette valeur dans l'espace de stockage partagé. Une fois stockée, la valeur dans le stockage partagé devient disponible pour vous sur différentes origines.

Ensuite, le worklet de stockage partagé lit les valeurs dans le stockage partagé et incrémente le compteur à chaque vue supplémentaire. Si le nombre n'a pas atteint la limite prédéfinie, le contenu que vous souhaitez afficher est renvoyé (index 1). Sinon, l'URL par défaut est renvoyée (index 0).

Dans cet exemple :

  • creative-selection-by-frequencyjs est chargé via l'iframe du producteur de contenu ou de l'annonceur, et est responsable du chargement du worklet de stockage partagé et du rendu de la source opaque renvoyée dans un cadre cloisonné.
  • creative-selection-by-frequency-worklet.js est le worklet de stockage partagé qui lit le nombre de fréquences pour déterminer l'URL renvoyée pour un contenu ou une création publicitaire.

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.