频次上限过滤器

public final class FrequencyCapFilters
extends Object implements Parcelable

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

用于存储基于频次上限的广告过滤条件的容器。

与单个广告相关联的频次上限过滤器不能超过 20 个。

“频次上限”过滤条件可将事件类型与 KeyedFrequencyCap 对象列表相结合 以定义一系列广告过滤器如果给定广告超出上述任意频次上限 将从提交到买方广告技术平台的出价功能的广告组中移除该广告。

摘要

嵌套的类

class FrequencyCapFilters.Builder

用于创建 FrequencyCapFilters 对象的构建器。 

常量

int AD_EVENT_TYPE_CLICK

int AD_EVENT_TYPE_IMPRESSION

int AD_EVENT_TYPE_VIEW

int AD_EVENT_TYPE_WIN

系统会针对以下对象在 Protected Audience 服务中自动填充 WIN 广告事件类型： 从 Protected Audience 广告选择返回的胜出广告。

继承的常量

int CONTENTS_FILE_DESCRIPTOR

与 describeContents() 一起使用的描述符位：表示 Parcelable 对象的扁平化表示中包含一个文件描述符。

int PARCELABLE_WRITE_RETURN_VALUE

与 writeToParcel(Parcel, int) 搭配使用的标志：正在写入的对象 是一个返回值，该值是如下函数的结果： “Parcelable someFunction()”、 “void someFunction(out Parcelable)”或 “void someFunction(inout Parcelable)”。

字段

public static final Creator<FrequencyCapFilters> CREATOR

公共方法

boolean equals(Object o)

检查 FrequencyCapFilters 对象是否包含相同的信息。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents()

获取将根据 AD_EVENT_TYPE_CLICK 事件类型进行过滤的 KeyedFrequencyCap 对象的列表。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents()

获取将根据 AD_EVENT_TYPE_IMPRESSION 事件类型进行过滤的 KeyedFrequencyCap 对象的列表。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents()

获取将根据 AD_EVENT_TYPE_VIEW 事件类型进行过滤的 KeyedFrequencyCap 对象的列表。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents()

获取将根据 AD_EVENT_TYPE_WIN 事件类型进行过滤的 KeyedFrequencyCap 对象的列表。

int hashCode()

返回 FrequencyCapFilters 对象数据的哈希值。

String toString()

返回对象的字符串表示。

void writeToParcel(Parcel dest, int flags)

将此对象展平为 Parcel。

继承的方法

Object clone()

创建并返回此对象的副本。

boolean equals(Object obj)

指示某个其他对象是否“等于”这个。

void finalize()

垃圾回收时，由垃圾回收器针对对象调用 确定没有对对象的更多引用。

final Class<?> getClass()

返回此 Object 的运行时类。

int hashCode()

返回对象的哈希代码值。

final void notify()

唤醒正在等待此对象的 监控。

final void notifyAll()

唤醒正在等待此对象的监控器的所有线程。

String toString()

返回对象的字符串表示。

final void wait(long timeoutMillis, int nanos)

导致当前线程处于等待状态，直到其被唤醒，这通常是 通知或中断，或者直到 经过了一定量的实时。

final void wait(long timeoutMillis)

导致当前线程处于等待状态，直到其被唤醒，这通常是 通知或中断，或者直到 经过了一定量的实时。

final void wait()

导致当前线程处于等待状态，直到其被唤醒，这通常是 通知或中断。

abstract int describeContents()

描述此 Parcelable 中包含的特殊对象的种类。 实例的编排表示法。

abstract void writeToParcel(Parcel dest, int flags)

将此对象展平为 Parcel。

常量

AD_EVENT_TYPE_CLICK

在 Android UpsideDownCakePrivacySandbox 中添加的功能 
public static final int AD_EVENT_TYPE_CLICK

常量值： 3 次 (0x00000003)

AD_EVENT_TYPE_IMPRESSION

在 Android UpsideDownCakePrivacySandbox 中添加的功能 
public static final int AD_EVENT_TYPE_IMPRESSION

常量值： 1 次 (0x00000001)

AD_EVENT_TYPE_VIEW

在 Android UpsideDownCakePrivacySandbox 中添加的功能 
public static final int AD_EVENT_TYPE_VIEW

常量值： 2 次 (0x00000002)

AD_EVENT_TYPE_WIN

在 Android UpsideDownCakePrivacySandbox 中添加的功能 
public static final int AD_EVENT_TYPE_WIN

系统会针对以下对象在 Protected Audience 服务中自动填充 WIN 广告事件类型： 从 Protected Audience 广告选择返回的胜出广告。

不应将其用于手动更新广告计数器直方图。

常量值： 0 (0x00000000)

字段

公共方法

equals

public boolean equals (Object o)

检查 FrequencyCapFilters 对象是否包含相同的信息。

参数
o Object：用来进行比较的参照对象。
返回值
boolean 如果此对象与 obj 参数相同，则返回 true；否则返回 false。

getKeyedFrequencyCapsForClickEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents ()

获取将根据 AD_EVENT_TYPE_CLICK 事件类型进行过滤的 KeyedFrequencyCap 对象的列表。

这些频次上限会应用于与点击相关联的事件（由 广告技术使用 AD_EVENT_TYPE_CLICK 事件类型调用 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API 时，系统会统计点击事件。

返回
List<KeyedFrequencyCap> 此值不能为 null。

getKeyedFrequencyCapsForImpressionEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents ()

获取将根据 AD_EVENT_TYPE_IMPRESSION 事件类型进行过滤的 KeyedFrequencyCap 对象的列表。

这些频次上限适用于与展示次数（由 广告技术

请注意，调用 AdSelectionManager.reportImpression(ReportImpressionRequest, Executor, OutcomeReceiver) 时，系统不会自动统计事件。相反，AD_EVENT_TYPE_IMPRESSION 事件类型必须 使用 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API 进行更新。

返回
List<KeyedFrequencyCap> 此值不能为 null。

getKeyedFrequencyCapsForViewEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents ()

获取将根据 AD_EVENT_TYPE_VIEW 事件类型进行过滤的 KeyedFrequencyCap 对象的列表。

这些频次上限适用于与观看相关的事件（解读为 广告技术使用 AD_EVENT_TYPE_VIEW 事件类型调用 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API 时，系统会统计观看事件。

返回
List<KeyedFrequencyCap> 此值不能为 null。

getKeyedFrequencyCapsForWinEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents ()

获取将根据 AD_EVENT_TYPE_WIN 事件类型进行过滤的 KeyedFrequencyCap 对象的列表。

这些频次上限适用于广告被选为胜出者的广告的事件 选择。胜出的广告用于自动递增 事件类型。

请注意，AD_EVENT_TYPE_WIN 事件类型无法使用 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API。

返回
List<KeyedFrequencyCap> 此值不能为 null。

hashCode

public int hashCode ()

返回 FrequencyCapFilters 对象数据的哈希值。

返回值
int 此对象的哈希代码值。

toString

public String toString ()

返回对象的字符串表示。通常，toString 方法会返回一个“以文本形式表示”此对象的字符串。结果应该是一个简洁但信息丰富，并且便于阅读的字符串表示。建议所有子类都覆盖此方法。

类 Object 的 toString 方法会返回一个字符串，其中包含类的名称（相应对象是此类的实例）、字符“@”，以及此对象哈希代码的无符号十六进制表示。也就是说，此方法所返回的字符串等于以下公式的值： 

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

返回值
String 对象的字符串表示。

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

将此对象扁平化为 Parcel。

参数
dest Parcel：此值不能为 null。
flags int：关于如何写入对象的其他标志。可为 0 或 Parcelable.PARCELABLE_WRITE_RETURN_VALUE。 值为 0 或 Parcelable.PARCELABLE_WRITE_RETURN_VALUE 和 android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES 的组合