KeyedFrequencyCap

public final class KeyedFrequencyCap
extends Object implements Parcelable

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

针对特定广告计数器键的频次上限。

频次上限定义了给定时间间隔内事件可发生的最大速率。如果超过频次上限，关联的广告将从广告选择中过滤掉。

摘要

嵌套类

class KeyedFrequencyCap.Builder

用于创建 KeyedFrequencyCap 对象的 Builder。 

继承的常量

字段

public static final Creator<KeyedFrequencyCap> CREATOR

公共方法

boolean equals(Object o)

检查 KeyedFrequencyCap 对象是否包含相同信息。
int getAdCounterKey()

返回应用频次上限的广告计数器键。
Duration getInterval()

返回间隔，其格式为 Duration（将被截断为最接近的秒），频次上限将在此间隔上计算。
int getMaxCount()

返回给定时间间隔内允许的事件发生的最大计数。
int hashCode()

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

返回对象的字符串表示形式。
void writeToParcel(Parcel dest, int flags)

将此对象展平到 Parcel 中。

继承的方法

字段

公共方法

equals

public boolean equals (Object o)

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

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

getAdCounterKey

public int getAdCounterKey ()

返回应用频次上限的广告计数器键。

广告计数器键由广告技术方定义，是一个任意数字标识符，用于定义先前可能已在设备上计数和持久存储的任何条件。如果设备上的计数在特定时间间隔内超过最大计数，则表示已超过频次上限。

返回
int 此值不能为 null。

getInterval

public Duration getInterval ()

返回间隔，其格式为 Duration（将被截断为最接近的秒），频次上限将在此间隔上计算。

计算此频次上限时，会在最近的时间间隔内对持久存储的事件数量进行计数。如果某个广告技术方的先前发生的匹配事件的计数大于 getMaxCount() 返回的数字，则表示已超过频次上限，该广告将不符合广告选择的条件。

返回
Duration 此值不能为 null。

getMaxCount

public int getMaxCount ()

返回给定时间间隔内允许的事件发生的最大计数。

如果在 getInterval() 定义的时间间隔内，设备上计数的匹配广告计数器键和广告事件类型的事件数量更多，则表示已超过频次上限，该广告将不符合广告选择的条件。

例如，如果某个事件在广告选择过程之前的一小时内已被计数两次或更多次，则指定在一小时内最大计数为两次的广告将不符合广告选择的条件。

返回
int

hashCode

public int hashCode ()

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

返回
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 的组合