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 UpsideDownCake プライバシー サンドボックスで追加 
public static final int FLAG_REPORTING_DESTINATION_BUYER

定数値: 2 （0x00000002）

FLAG_REPORTING_DESTINATION_SELLER

Android UpsideDownCake プライバシー サンドボックスで追加 
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 ()

ユーザー インタラクションに関連する入力イベントを返します。

このフィールドは、view イベントを表す 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 の組み合わせのいずれかです。