FrequencyCapFilters (Filtres des limites du nombre d'expositions)

public final class FrequencyCapFilters
extends Object implements Parcelable

java.lang.Object
   ↳ android.adservices.common.FrequencyCapFilters

Conteneur pour les filtres d'annonces basés sur les limites de fréquence d'exposition.

Vous ne pouvez pas associer plus de 20 filtres de limitation du nombre d'expositions à une même annonce.

Les filtres de limite de la fréquence d'exposition combinent un type d'événement avec une liste d'objets KeyedFrequencyCap pour définir un ensemble de filtres d'annonces. Si l'une de ces limites du nombre d'expositions est dépassée pour une annonce donnée, l'annonce sera supprimée du groupe d'annonces envoyées à la fonction d'enchères d'une technologie publicitaire de l'acheteur.

Résumé

Classes imbriquées

class FrequencyCapFilters.Builder

Compilateur permettant de créer des objets FrequencyCapFilters. 

Constantes

int AD_EVENT_TYPE_CLICK

int AD_EVENT_TYPE_IMPRESSION

int AD_EVENT_TYPE_VIEW

int AD_EVENT_TYPE_WIN

Le type d'événement d'annonce WIN est automatiquement renseigné dans le service Protected Audience pour toute annonce gagnante renvoyée par la sélection d'annonces Protected Audience.

Constantes héritées

Champs

public static final Creator<FrequencyCapFilters> CREATOR

Méthodes publiques

boolean equals(Object o)

Vérifie si deux objets FrequencyCapFilters contiennent les mêmes informations.

List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents()

Récupère la liste des objets KeyedFrequencyCap qui seront filtrés en fonction du type d'événement AD_EVENT_TYPE_CLICK.

List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents()

Récupère la liste des objets KeyedFrequencyCap qui seront filtrés en fonction du type d'événement AD_EVENT_TYPE_IMPRESSION.

List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents()

Récupère la liste des objets KeyedFrequencyCap qui seront filtrés en fonction du type d'événement AD_EVENT_TYPE_VIEW.

List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents()

Récupère la liste des objets KeyedFrequencyCap qui seront filtrés en fonction du type d'événement AD_EVENT_TYPE_WIN.

int hashCode()

Renvoie le hachage des données de l'objet FrequencyCapFilters.

String toString()

Affiche une représentation de l'objet sous forme de chaîne.

void writeToParcel(Parcel dest, int flags)

Aplatit cet objet dans un élément Parcel.

Méthodes héritées

Constantes

AD_EVENT_TYPE_CLICK

Ajoutée à Android UpsideDownCakePrivacySandbox 
public static final int AD_EVENT_TYPE_CLICK

Valeur constante: 3. (0x00000003)

AD_EVENT_TYPE_IMPRESSION

Ajoutée à Android UpsideDownCakePrivacySandbox 
public static final int AD_EVENT_TYPE_IMPRESSION

Valeur constante: 1 fois (0x00000001)

AD_EVENT_TYPE_VIEW

Ajoutée à Android UpsideDownCakePrivacySandbox 
public static final int AD_EVENT_TYPE_VIEW

Valeur constante: 2. (0x00000002)

AD_EVENT_TYPE_WIN

Ajoutée à Android UpsideDownCakePrivacySandbox 
public static final int AD_EVENT_TYPE_WIN

Le type d'événement d'annonce WIN est automatiquement renseigné dans le service Protected Audience pour toute annonce gagnante renvoyée par la sélection d'annonces Protected Audience.

Il ne doit pas être utilisé pour mettre à jour manuellement un histogramme de compteur d'annonces.

Valeur constante : 0 (0x00000000)

Champs

Méthodes publiques

égal à

public boolean equals (Object o)

Vérifie si deux objets FrequencyCapFilters contiennent les mêmes informations.

Paramètres
o Object : objet de référence à comparer.
Renvoie
boolean true si cet objet est identique à l'argument obj ; false dans les autres cas.

getKeyedFrequencyCapsForClickEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents ()

Récupère la liste des objets KeyedFrequencyCap qui seront filtrés en fonction du type d'événement AD_EVENT_TYPE_CLICK.

Ces limites du nombre d'expositions s'appliquent aux événements en corrélation avec un clic interprété par un AdTech. Les événements de clic sont comptabilisés lorsque l'API AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) est appelée avec le type d'événement AD_EVENT_TYPE_CLICK.

Renvoie
List<KeyedFrequencyCap> Cette valeur ne peut pas être null.

getKeyedFrequencyCapsForImpressionEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents ()

Récupère la liste des objets KeyedFrequencyCap qui seront filtrés en fonction du type d'événement AD_EVENT_TYPE_IMPRESSION.

Ces limites de la fréquence d'exposition s'appliquent aux événements en corrélation avec une impression interprétée par un AdTech.

Notez que les événements ne sont pas automatiquement comptabilisés lorsque vous appelez AdSelectionManager.reportImpression(ReportImpressionRequest, Executor, OutcomeReceiver). À la place, le type d'événement AD_EVENT_TYPE_IMPRESSION doit être mis à jour à l'aide de l'API AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver).

Renvoie
List<KeyedFrequencyCap> Cette valeur ne peut pas être null.

getKeyedFrequencyCapsForViewEvents (Limites de fréquence d'exposition pour les événements)

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents ()

Récupère la liste des objets KeyedFrequencyCap qui seront filtrés en fonction du type d'événement AD_EVENT_TYPE_VIEW.

Ces limites de la fréquence d'exposition s'appliquent aux événements en corrélation avec une vue interprétée par une AdTech. Les événements de vue sont comptabilisés lorsque l'API AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) est appelée avec le type d'événement AD_EVENT_TYPE_VIEW.

Renvoie
List<KeyedFrequencyCap> Cette valeur ne peut pas être null.

getKeyedFrequencyCapsForWinEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents ()

Récupère la liste des objets KeyedFrequencyCap qui seront filtrés en fonction du type d'événement AD_EVENT_TYPE_WIN.

Ces limites de la fréquence d'exposition s'appliquent aux événements correspondant aux annonces qui ont été sélectionnées comme gagnantes dans l'annonce de votre choix. Les annonces gagnantes sont utilisées pour incrémenter automatiquement les clés de compteur associées au "Victoires".

Notez que le type d'événement AD_EVENT_TYPE_WIN ne peut pas être mis à jour manuellement à l'aide de API AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver).

Renvoie
List<KeyedFrequencyCap> Cette valeur ne peut pas être null.

hashCode

public int hashCode ()

Renvoie le hachage des données de l'objet FrequencyCapFilters.

Valeur affichée
int Une valeur de code de hachage pour cet objet.

toString

public String toString ()

Renvoie une représentation de l'objet sous forme de chaîne. En général, la méthode toString renvoie une chaîne qui "représente textuellement" cet objet. Le résultat doit être une représentation concise, mais informative, et facile à lire. Il est recommandé que toutes les sous-classes remplacent cette méthode.

La méthode toString pour la classe Object renvoie une chaîne composée du nom de la classe dont l'objet est une instance, du caractère arobase "@", ainsi que de la représentation hexadécimale non signée du code de hachage de l'objet. En d'autres termes, cette méthode renvoie une chaîne égale à la valeur de : 

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Valeur affichée
String une représentation de l'objet sous forme de chaîne.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Aplatit cet objet dans un élément Parcel.

Paramètres
dest Parcel : cette valeur ne peut pas être null.
flags int : indicateurs supplémentaires concernant la manière dont l'objet doit être écrit. Peut prendre la valeur 0 ou Parcelable.PARCELABLE_WRITE_RETURN_VALUE. La valeur est 0 ou une combinaison de Parcelable.PARCELABLE_WRITE_RETURN_VALUE et android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES.