FrequencyCapFilters

public final class FrequencyCapFilters
extends Object implements Parcelable

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


フリークエンシー キャップに基づく広告フィルタのコンテナ。

1 つの広告に関連付けることができるフリークエンシー キャップ フィルタは 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

WIN 広告イベントタイプは、Protected Audience サービスで Protected Audience 広告選択から返された落札広告。

継承される定数

フィールド

public static final Creator<FrequencyCapFilters> CREATOR

パブリック メソッド

boolean equals(Object o)

FrequencyCapFilters オブジェクトに同じ情報が含まれているかどうかを確認します。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents()

AD_EVENT_TYPE_CLICK イベントタイプでフィルタする KeyedFrequencyCap オブジェクトのリストを取得します。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents()

AD_EVENT_TYPE_IMPRESSION イベントタイプでフィルタする KeyedFrequencyCap オブジェクトのリストを取得します。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents()

AD_EVENT_TYPE_VIEW イベントタイプでフィルタする KeyedFrequencyCap オブジェクトのリストを取得します。

List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents()

AD_EVENT_TYPE_WIN イベントタイプでフィルタする KeyedFrequencyCap オブジェクトのリストを取得します。

int hashCode()

FrequencyCapFilters オブジェクトのデータのハッシュを返します。

String toString()

オブジェクトの文字列表現を返します。

void writeToParcel(Parcel dest, int flags)

このオブジェクトを Parcel にフラット化します。

継承されるメソッド

定数

広告イベントタイプ クリック

public static final int AD_EVENT_TYPE_CLICK

定数値: 3 個 (0x00000003)

広告イベントタイプ インプレッション

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(広告イベント タイプ_WIN)

public static final int AD_EVENT_TYPE_WIN

WIN 広告イベントタイプは、Protected Audience サービスで Protected Audience 広告選択から返された落札広告。

広告カウンタのヒストグラムを手動で更新する場合には使用しないでください。

定数値: 0 (0x00000000)

フィールド

パブリック メソッド

equals

public boolean equals (Object o)

FrequencyCapFilters オブジェクトに同じ情報が含まれているかどうかを確認します。

パラメータ
o Object: 比較対象の参照オブジェクト。

戻り値
boolean このオブジェクトが obj 引数と同じである場合は true、それ以外の場合は false

getKeyedFrequencyCapsForClickEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents ()

AD_EVENT_TYPE_CLICK イベントタイプでフィルタする KeyedFrequencyCap オブジェクトのリストを取得します。

フリークエンシー キャップは、 アドテック、クリック イベントは、AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API が AD_EVENT_TYPE_CLICK イベントタイプで呼び出されるとカウントされます。

戻り値
List<KeyedFrequencyCap> この値が null になることはありません。

getKeyedFrequencyCapsForImpressionEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents ()

AD_EVENT_TYPE_IMPRESSION イベントタイプでフィルタする KeyedFrequencyCap オブジェクトのリストを取得します。

これらのフリークエンシー キャップは、 アドテック、

なお、AdSelectionManager.reportImpression(ReportImpressionRequest, Executor, OutcomeReceiver) を呼び出しても、イベントは自動的にカウントされません。代わりに、AD_EVENT_TYPE_IMPRESSION イベントタイプを AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API を使用して更新します。

戻り値
List<KeyedFrequencyCap> この値が null になることはありません。

getKeyedFrequencyCapsForViewEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents ()

AD_EVENT_TYPE_VIEW イベントタイプでフィルタする KeyedFrequencyCap オブジェクトのリストを取得します。

これらのフリークエンシー キャップは、 アドテック、ビューイベントは、AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) API が AD_EVENT_TYPE_VIEW イベントタイプで呼び出されるとカウントされます。

戻り値
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 メソッドは一般に、オブジェクトを「テキストで表現」した文字列を返します。結果は、簡潔でありながら情報量の多い表現になり、人が簡単に読むことができます。すべてのサブクラスでこのメソッドをオーバーライドすることをおすすめします。

クラス ObjecttoString メソッドは、オブジェクトがインスタンスになっているクラスの名前、アットマーク文字「@」、オブジェクトのハッシュコードの符号なし 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 の組み合わせのいずれかです。