FrequencyCapFilters
public
final
class
FrequencyCapFilters
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.adservices.common.FrequencyCapFilters |
フリークエンシー キャップに基づく広告フィルタのコンテナ。
1 つの広告に関連付けることができるフリークエンシー キャップ フィルタは 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 広告の選択から返された落札広告について、WIN 広告イベントタイプは Protected Audience サービス内で自動的に入力されます。 |
継承される定数 |
|---|
フィールド | |
|---|---|
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 イベントの種類のクリック
public static final int AD_EVENT_TYPE_CLICK
定数値: 3 (0x00000003)
AD_EVENT_TYPE_impressions
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 広告の選択から返された落札広告について、WIN 広告イベントタイプは Protected Audience サービス内で自動的に入力されます。
広告カウンタのヒストグラムを手動で更新するためには使用しないでください。
定数値: 0 (0x00000000)
フィールド
CREATOR
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 オブジェクトのリストを取得します。
これらのフリークエンシー キャップは、広告選択で落札された広告のイベントに適用されます。落札広告は、落札イベントタイプに関連付けられたカウンタキーを自動的にインクリメントするために使用されます。
AD_EVENT_TYPE_WIN イベントタイプは、AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API を使用して手動で更新することはできません。
| 戻り値 | |
|---|---|
List<KeyedFrequencyCap> |
この値が null になることはありません。 |
hashCode
public int hashCode ()
FrequencyCapFilters オブジェクトのデータのハッシュを返します。
| 戻り値 | |
|---|---|
int |
このオブジェクトのハッシュコード値。 |
toString
public String toString ()
オブジェクトの文字列表現を返します。toString メソッドは一般に、オブジェクトを「テキストで表現」した文字列を返します。結果は、簡潔でありながら情報量の多い表現になり、人が簡単に読むことができます。すべてのサブクラスでこのメソッドをオーバーライドすることをおすすめします。
クラス Object の toString メソッドは、オブジェクトがインスタンスになっているクラスの名前、アットマーク文字「@」、オブジェクトのハッシュコードの符号なし 16 進表現で構成される文字列を返します。つまり、このメソッドは以下の値のような文字列を返します。
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 の組み合わせのいずれかです。 |