AdData

public final class AdData
extends Object implements Parcelable

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

広告の選択とレンダリングに必要な、広告固有のデータを表します。

概要

ネストされたクラス

class AdData.Builder

AdData オブジェクトのビルダー。 

継承される定数

フィールド

public static final Creator<AdData> CREATOR

パブリック メソッド

boolean equals(Object o)

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

Set<Integer> getAdCounterKeys()

イベントのカウントに使用されるキーのセットを取得します。

AdFilters getAdFilters()

広告に関連付けられているすべての AdFilters を取得します。

String getAdRenderId()

サーバー オークションの広告レンダリング ID を取得します。

String getMetadata()

広告選択プロセスで使用される購入者の広告メタデータを取得します。

Uri getRenderUri()

広告のレンダリング アセットを指す URI を取得します。

int hashCode()

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

String toString()

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

void writeToParcel(Parcel dest, int flags)

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

継承されるメソッド

フィールド

CREATOR

API レベル 34 で追加されました。
Ad Services Extensions 4 にも追加 
public static final Creator<AdData> CREATOR

パブリック メソッド

equals

API レベル 34 で追加されました 
public boolean equals (Object o)

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

パラメータ
o Object: 比較対象の参照オブジェクト。
戻り値
boolean このオブジェクトが obj 引数と同じである場合は true、それ以外の場合は false。

getAdCounterKeys

public Set<Integer> getAdCounterKeys ()

イベントのカウントに使用されるキーのセットを取得します。

1 つの広告に関連付けることができる広告カウンタキーは 10 個までです。

キーとキーごとのカウントは、広告選択時に実施されるフリークエンシー キャップ フィルタリングで使用され、上限を超えた関連広告が入札から除外されるようにします。

これらのキーは、カスタム オーディエンスの日次更新の際に、カスタム オーディエンスの広告や他の入札データとともに上書きされる可能性があります。

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

getAdFilters

public AdFilters getAdFilters ()

広告に関連付けられているすべての AdFilters を取得します。

フィルタは、条件が満たされるか超過した場合、関連する広告を広告選択から除外します。省略可能で、null を指定した場合、この広告にはフィルタが適用されません。

戻り値
AdFilters

getAdRenderId

public String getAdRenderId ()

サーバー オークションの広告レンダリング ID を取得します。

サーバー オークションのリクエストを受信すると、AdData ごとに広告レンダリング ID が収集されます。

広告レンダリング ID のない AdData は、サーバーサイド オークションに参加できません。

戻り値
String この値は null であっても構いません。

getMetadata

API レベル 34 で追加されました。
Ad Services Extensions 4 にも追加 
public String getMetadata ()

広告選択プロセスで使用される購入者の広告メタデータを取得します。

メタデータには、文字列としてシリアル化された有効な JSON オブジェクトを指定してください。メタデータは、広告固有の入札情報を表します。この入札情報は、広告選択時に入札生成の一環として使用され、隔離された実行環境で実行される購入者の JavaScript ロジックで使用されるものです。

メタデータが、購入者の JS で処理できる有効な JSON オブジェクトでない場合、その広告は広告選択の対象になりません。

戻り値
String この値が null になることはありません。

getRenderUri

API レベル 34 で追加されました。
Ad Services Extensions 4 にも追加 
public Uri getRenderUri ()

広告のレンダリング アセットを指す URI を取得します。URI には HTTPS を使用する必要があります。

戻り値
Uri この値が null になることはありません。

hashCode

API レベル 34 で追加されました 
public int hashCode ()

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

戻り値
int このオブジェクトのハッシュコード値。

toString

API レベル 34 で追加されました 
public String toString ()

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

クラス Object の toString メソッドは、オブジェクトがインスタンスになっているクラスの名前、アットマーク文字「@」、オブジェクトのハッシュコードの符号なし 16 進表現で構成される文字列を返します。つまり、このメソッドは以下の値のような文字列を返します。

 getClass().getName() + '@' + Integer.toHexString(hashCode())

戻り値
String オブジェクトの文字列表現。

writeToParcel

API レベル 34 で追加されました 
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 の組み合わせのいずれかです。