展示頻率上限篩選器
public
final
class
FrequencyCapFilters
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.adservices.common.FrequencyCapFilters |
以展示頻率上限為依據的廣告篩選條件容器。
單一廣告最多只能與 20 個展示頻率上限篩選器建立關聯。
展示頻率上限篩選器可結合一個事件類型和 KeyedFrequencyCap
物件清單,定義一組廣告篩選器。如果針對特定廣告超過上述任一展示頻率上限,系統會將該廣告從提交給買方廣告技術出價函式的廣告群組中移除。
摘要
巢狀類別 | |
---|---|
class |
FrequencyCapFilters.Builder
建立 |
常數 | |
---|---|
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)
檢查 |
List<KeyedFrequencyCap>
|
getKeyedFrequencyCapsForClickEvents()
取得會根據 |
List<KeyedFrequencyCap>
|
getKeyedFrequencyCapsForImpressionEvents()
取得會根據 |
List<KeyedFrequencyCap>
|
getKeyedFrequencyCapsForViewEvents()
取得會根據 |
List<KeyedFrequencyCap>
|
getKeyedFrequencyCapsForWinEvents()
取得會根據 |
int
|
hashCode()
傳回 |
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_事件類型檢視畫面
public static final int AD_EVENT_TYPE_VIEW
常數值:2 (0x00000002)
AD_事件類型_勝出
public static final int AD_EVENT_TYPE_WIN
在 Protected Audience 服務中,系統會針對從 Protected Audience 廣告選擇傳回的任何勝出廣告填入 WIN 廣告事件類型。
不應用來手動更新廣告計數器直方圖。
常數值:0 (0x00000000)
欄位
創作者
public static final Creator<FrequencyCapFilters> CREATOR
公用方法
等於
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 。 |
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 |