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

傳回要用於展示頻率上限的廣告計數器鍵。

廣告計數器鍵是廣告技術定義的隨機數字 ID，作用是定義之前可能已統計過並保留在裝置上的任何條件。如果裝置端計數超過特定時間間隔內的計數上限，就表示已超過展示頻率上限。

傳回
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