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

系統會在 Protected Audience 服務中,自動填入 WIN 廣告事件類型 從 Protected Audience 廣告選擇傳回的任何勝出廣告。

繼承常數

欄位

public static final Creator<FrequencyCapFilters> CREATOR

公用方法

boolean equals(Object o)

檢查 FrequencyCapFilters 物件是否包含相同的資訊。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents()

取得 KeyedFrequencyCap 物件清單,篩選 AD_EVENT_TYPE_CLICK 事件類型。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents()

取得 KeyedFrequencyCap 物件清單,篩選 AD_EVENT_TYPE_IMPRESSION 事件類型。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents()

取得 KeyedFrequencyCap 物件清單,篩選 AD_EVENT_TYPE_VIEW 事件類型。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents()

取得 KeyedFrequencyCap 物件清單,篩選 AD_EVENT_TYPE_WIN 事件類型。

int hashCode()

傳回 FrequencyCapFilters 物件資料的雜湊。

String toString()

傳回該物件的字串表示法。

void writeToParcel(Parcel dest, int flags)

壓平合併此物件並加入至 Parcel。

繼承方法

常數

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 服務中,自動填入 WIN 廣告事件類型 從 Protected Audience 廣告選擇傳回的任何勝出廣告。

不得用來手動更新廣告計數器直方圖。

常數值: 0 分 (0x00000000)

欄位

公用方法

equals

public boolean equals (Object o)

檢查 FrequencyCapFilters 物件是否包含相同的資訊。

參數
o Object:要用來比較的參照物件。

傳回
boolean 如果此物件與 obj 引數相同,會傳回 true,否則傳回 false

getKeyedFrequencyCapsForClickEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents ()

取得 KeyedFrequencyCap 物件清單,篩選 AD_EVENT_TYPE_CLICK 事件類型。

上述展示頻率上限適用於與點擊相關聯的事件, 廣告技術使用 AD_EVENT_TYPE_CLICK 事件類型叫用 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API 時,系統會計算點擊事件。

傳回
List<KeyedFrequencyCap> 此值不能為 null

getKeyedFrequencyCapsForImpressionEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents ()

取得 KeyedFrequencyCap 物件清單,篩選 AD_EVENT_TYPE_IMPRESSION 事件類型。

這些展示頻率上限適用於與 廣告技術

請注意,呼叫 AdSelectionManager.reportImpression(ReportImpressionRequest, Executor, OutcomeReceiver) 時,系統不會自動計算事件。相反地,AD_EVENT_TYPE_IMPRESSION 事件類型必須 透過 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API 更新

傳回
List<KeyedFrequencyCap> 此值不能為 null

getKeyedFrequencyCapsForViewEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents ()

取得 KeyedFrequencyCap 物件清單,篩選 AD_EVENT_TYPE_VIEW 事件類型。

上述展示頻率上限適用於 廣告技術使用 AD_EVENT_TYPE_VIEW 事件類型叫用 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API 時,系統會計算檢視事件。

傳回
List<KeyedFrequencyCap> 此值不能為 null

getKeyedFrequencyCapsForWinEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents ()

取得 KeyedFrequencyCap 物件清單,篩選 AD_EVENT_TYPE_WIN 事件類型。

這些展示頻率上限適用於廣告中獲選為勝出廣告的事件 。勝出廣告會自動用來增加 勝出事件類型。

請注意,AD_EVENT_TYPE_WIN 無法使用 AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API。

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