ReportEventRequest

public class ReportEventRequest
extends Object

java.lang.Object
   ↳ android.adservices.adselection.ReportEventRequest

広告イベントのレポートに必要な引数をラップするリクエスト オブジェクト。

まとめ

ネストされたクラス

class ReportEventRequest.Builder

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

定数

int FLAG_REPORTING_DESTINATION_BUYER

int FLAG_REPORTING_DESTINATION_SELLER

パブリック メソッド

long getAdSelectionId()

広告選択プロセスのプライマリ ID である adSelectionId を返します。

String getData()

広告イベントデータを返します。

InputEvent getInputEvent()

ユーザー操作に関連付けられた入力イベントを返します。

String getKey()

イベントキー（報告する広告イベントのタイプ）を返します。

int getReportingDestinations()

レポート先（購入者、販売者、またはその両方）となるレポート宛先のビットフィールドを返します。

継承されるメソッド

定数

FLAG_REPORTING_DESTINATION_BUYER

Android UpsideDownCakePrivacySandbox で追加 
public static final int FLAG_REPORTING_DESTINATION_BUYER

定数値: 2 (0x00000002)

FLAG_REPORTING_DESTINATION_SELLER

Android UpsideDownCakePrivacySandbox で追加 
public static final int FLAG_REPORTING_DESTINATION_SELLER

定数値: 1 (0x00000001)

パブリック メソッド

getAdSelectionId

public long getAdSelectionId ()

広告選択プロセスのプライマリ ID である adSelectionId を返します。

戻り値
long

getData

public String getData ()

広告イベントデータを返します。

広告選択後、このデータは呼び出し元によって生成されます。その後、呼び出し元は AdSelectionManager.reportEvent(ReportEventRequest, Executor, OutcomeReceiver) を呼び出せます。このデータは、registerAdBeacon に登録された reportingUri に対する POST リクエストに追加されます。

UTF-8 形式の String#getBytes() のサイズは 64 KB 未満にする必要があります。

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

getInputEvent

public InputEvent getInputEvent ()

ユーザー操作に関連付けられた入力イベントを返します。

このフィールドは、ビュー イベントを表す null、またはクリック イベントを表す InputEvent オブジェクトです。

戻り値
InputEvent

getKey

public String getKey ()

イベントキー（報告する広告イベントの種類）を返します。

このフィールドは、広告選択後に registerAdBeacon に登録された eventKey に関連付けられた reportingUri を取得するために使用されます。

このフィールドは、registerAdBeacon に登録されている eventKey と完全に一致している必要があります。registerAdBeacon の詳細については、AdSelectionManager#reportImpression のドキュメントをご覧ください。

UTF-8 形式のイベントキー（バイト配列を String#getBytes() で検査する場合）は、40 バイトを超えないようにする必要があります。この上限を超えるキーは、registerAdBeacon 呼び出し時に登録されません。

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

getReportingDestinations

public int getReportingDestinations ()

レポート先（購入者、販売者、またはその両方）となるレポート宛先のビットフィールドを返します。

このビットフィールドを作成するには、レポート先となる各 reportingDestination の間に | ビット演算子を配置します。たとえば、購入者にのみ報告するには、reportingDestinations フィールドを FLAG_REPORTING_DESTINATION_BUYER に設定します。販売者にのみ報告するには、reportingDestinations フィールドを FLAG_REPORTING_DESTINATION_SELLER に設定します。購入者と販売者の両方に報告するには、reportingDestinations フィールドを FLAG_REPORTING_DESTINATION_BUYER | FLAG_REPORTING_DESTINATION_SELLER に設定します。

戻り値
int 値は、0 か、FLAG_REPORTING_DESTINATION_SELLER と FLAG_REPORTING_DESTINATION_BUYER の組み合わせのいずれかです。