KeyedFrequencyCap

public final class KeyedFrequencyCap
extends Object implements Parcelable

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

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

频次上限定义了事件在给定时间间隔内的最大发生率。如果超出频次上限，关联的广告将被滤除，无法选择。

摘要

嵌套的类

class KeyedFrequencyCap.Builder

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

继承的常量

字段

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

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