频次上限过滤器

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 广告选择返回的任何胜出的广告,系统会在 Protected Audience 服务中自动填充 WIN 广告事件类型。

继承的常量

字段

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)

将此对象展平为一个地块。

继承的方法

常量

AD_EVENT_TYPE_CLICK

public static final int AD_EVENT_TYPE_CLICK

常量值: 3 (0x00000003)

AD_EVENT_TYPE_IMPRESSION

public static final int AD_EVENT_TYPE_IMPRESSION

常量值: 1 (0x00000001)

AD_EVENT_TYPE_VIEW

public static final int AD_EVENT_TYPE_VIEW

常量值: 2 (0x00000002)

AD_EVENT_TYPE_WIN

public static final int AD_EVENT_TYPE_WIN

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

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

常量值: 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) 时,系统不会自动统计事件。必须改为使用 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API 更新 AD_EVENT_TYPE_IMPRESSION 事件类型。

开球回攻次数
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 对象的列表。

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

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

开球回攻次数
List<KeyedFrequencyCap> 此值不能为 null

hashCode

public int hashCode ()

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

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

toString

public String toString ()

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

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

 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。 值为 0Parcelable.PARCELABLE_WRITE_RETURN_VALUE 和 android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES 的组合