FrequencyCapFilters

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

WIN 广告事件类型会自动填充在 Protected Audience 服务中，适用于从 Protected Audience 广告选择返回的任何胜出广告。

继承的常量

字段

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()

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

返回 FrequencyCapFilters 对象数据的哈希值。
String toString()

返回对象的字符串表示形式。
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

WIN 广告事件类型会自动填充在 Protected Audience 服务中，适用于从 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 对象列表。

这些频率上限适用于广告技术方解释为点击的事件。当调用 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API 并指定 AD_EVENT_TYPE_CLICK 事件类型时，会计算点击事件。

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

getKeyedFrequencyCapsForImpressionEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents ()

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

这些频率上限适用于广告技术方解释为展示的事件。

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

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

getKeyedFrequencyCapsForViewEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents ()

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

这些频率上限适用于广告技术方解释为视图的事件。当调用 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API 并指定 AD_EVENT_TYPE_VIEW 事件类型时，会计算视图事件。

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

getKeyedFrequencyCapsForWinEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents ()

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

这些频率上限适用于在广告选择中被选为胜出的广告事件。胜出的广告用于自动增加胜出事件类型上关联的计数器键。

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

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

hashCode

public int hashCode ()

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

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

toString

public String toString ()

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

类 Object 的 toString 方法返回一个字符串，该字符串由对象的实例的类名、at 符号字符 `@' 以及对象的哈希代码的无符号十六进制表示组成。换句话说，此方法返回一个等于以下值的字符串：

 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 的组合。