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() で定義された期間内にデバイスでカウントされた広告カウンタキーと広告イベントタイプに一致するイベントがさらにある場合、フリークエンシー キャップを超えるため、この広告は広告選択の対象になりません。

たとえば、1 時間以内の最大カウントを 2 とするフィルタを指定した広告は、 1 時間に 2 回以上イベントがカウントされている場合に、広告選択の対象となる 広告選択プロセスに進みます

戻り値
int

hashCode

public int hashCode ()

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

戻り値
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 の組み合わせのいずれかです。