MeasurementManager
public
class
MeasurementManager
extends Object
java.lang.Object | |
↳ | android.adservices.measurement.MeasurementManager |
MeasurementManager は、ソースとトリガーの登録を管理するための API を提供します。
概要
定数 | |
---|---|
int |
MEASUREMENT_API_STATE_DISABLED
この状態は、Measurement API が利用できないことを示します。 |
int |
MEASUREMENT_API_STATE_ENABLED
この状態は、Measurement API が有効であることを示します。 |
パブリック メソッド | |
---|---|
void
|
deleteRegistrations(DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
以前の登録を削除する。 |
static
MeasurementManager
|
get(Context context)
MeasurementManager のインスタンスを作成するためのファクトリ メソッド。 |
void
|
getMeasurementApiStatus(Executor executor, OutcomeReceiver<Integer, Exception> callback)
Measurement API のステータスを取得します。 |
void
|
registerSource(Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
アトリビューション ソース(クリックまたはビュー)を登録します。 |
void
|
registerSource(SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
アプリのコンテキストからアトリビューション ソース(クリックまたはビュー)を登録します。 |
void
|
registerTrigger(Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
トリガー(コンバージョン)を登録します。 |
void
|
registerWebSource(WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
ウェブ コンテキストからアトリビューション ソース(クリックまたはビュー)を登録します。 |
void
|
registerWebTrigger(WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
ウェブ コンテキストからアトリビューション トリガー(クリックまたはビュー)を登録します。 |
継承されるメソッド | |
---|---|
定数
MEASUREMENT_API_STATE_DISABLED
public static final int MEASUREMENT_API_STATE_DISABLED
この状態は、Measurement API が利用できないことを示します。これらを呼び出すと、
UnsupportedOperationException
。
定数値: 0 (0x00000000)
MEASUREMENT_API_STATE_ENABLED
public static final int MEASUREMENT_API_STATE_ENABLED
この状態は、Measurement API が有効であることを示します。
定数値: 1 個 (0x00000001)
パブリック メソッド
deleteRegistrations
public void deleteRegistrations (DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
以前の登録を削除する。削除に成功すると、コールバックの OutcomeReceiver.onResult(R)
が null で呼び出されます。失敗した場合、Exception
は
コールバックの OutcomeReceiver#onError
を通じて送信されます。成功と失敗の両方
フィードバックは、指定された Executor
に対して実行されます。
パラメータ | |
---|---|
deletionRequest |
DeletionRequest : データ削除リクエスト。
この値が null になることはありません。 |
executor |
Executor : コールバックを実行するエグゼキュータ。
この値が null になることはありません。
コールバック イベントとリスナー イベントは、この
Executor : どのスレッドを表示するかを簡単に制御できます。
分析できますアプリケーションのメインスレッドを介してイベントをディスパッチするには、
作成する場合は、
Context.getMainExecutor() 。
それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。 |
callback |
OutcomeReceiver : API の結果を非同期で通知します。
この値が null になることはありません。 |
get
public static MeasurementManager get (Context context)
MeasurementManager のインスタンスを作成するためのファクトリ メソッド。
パラメータ | |
---|---|
context |
Context : 使用する Context
この値が null になることはありません。 |
戻り値 | |
---|---|
MeasurementManager |
MeasurementManager インスタンス
この値が null になることはありません。 |
getMeasurementApiStatus
public void getMeasurementApiStatus (Executor executor, OutcomeReceiver<Integer, Exception> callback)
Measurement API のステータスを取得します。
コールバックの Integer
値が MeasurementApiState
のいずれか。
AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
が必要です
パラメータ | |
---|---|
executor |
Executor : 結果をディスパッチするためにコールバックで使用されます。
この値が null になることはありません。
コールバック イベントとリスナー イベントは、この
Executor : どのスレッドを表示するかを簡単に制御できます。
分析できますアプリケーションのメインスレッドを介してイベントをディスパッチするには、
作成する場合は、
Context.getMainExecutor() 。
それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。 |
callback |
OutcomeReceiver : API の結果を非同期で通知します。
この値が null になることはありません。 |
registerSource
public void registerSource (Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
アトリビューション ソース(クリックまたはビュー)を登録します。
AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
が必要です
パラメータ | |
---|---|
attributionSource |
Uri : プラットフォームは、メタデータを取得するために、この URI にリクエストを発行します。
関連付けられます。ソース メタデータはデバイスに保存されるため、
将来のトリガーと照合できます
この値が null になることはありません。 |
inputEvent |
InputEvent : InputEvent オブジェクト(クリック イベントの場合)または null(ビューの場合)
あります。 |
executor |
Executor : 結果をディスパッチするためにコールバックで使用されます。
この値は null の場合があります。
コールバック イベントとリスナー イベントは、この
Executor : どのスレッドを表示するかを簡単に制御できます。
分析できますアプリケーションのメインスレッドを介してイベントをディスパッチするには、
作成する場合は、
Context.getMainExecutor() 。
それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。 |
callback |
OutcomeReceiver : API の結果を非同期で通知します。
この値は null であっても構いません。 |
例外 | |
---|---|
IllegalArgumentException |
attributionSource のスキームが HTTPS でない場合 |
registerSource
public void registerSource (SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
アプリのコンテキストからアトリビューション ソース(クリックまたはビュー)を登録します。この API は
リクエストとともにすべての登録 URL を指定する必要があります。
AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
が必要です
パラメータ | |
---|---|
request |
SourceRegistrationRequest : アプリソースの登録リクエスト
この値が null になることはありません。 |
executor |
Executor : 結果をディスパッチするためにコールバックで使用
この値は null の場合があります。
コールバック イベントとリスナー イベントは、この
Executor : どのスレッドを表示するかを簡単に制御できます。
分析できますアプリケーションのメインスレッドを介してイベントをディスパッチするには、
作成する場合は、
Context.getMainExecutor() 。
それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。 |
callback |
OutcomeReceiver : API の結果を非同期で通知します。
この値は null の場合があります。 |
registerTrigger
public void registerTrigger (Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
トリガー(コンバージョン)を登録します。
AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
が必要です
パラメータ | |
---|---|
trigger |
Uri : API はこの URI にリクエストを発行し、
トリガーされます。トリガーのメタデータはデバイス上に保存され、以下と照合できます。
アトリビューションプロセス中に発生し
この値が null になることはありません。 |
executor |
Executor : 結果をディスパッチするためにコールバックで使用されます。
この値は null の場合があります。
コールバック イベントとリスナー イベントは、この
Executor : どのスレッドを表示するかを簡単に制御できます。
分析できますアプリケーションのメインスレッドを介してイベントをディスパッチするには、
作成する場合は、
Context.getMainExecutor() 。
それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。 |
callback |
OutcomeReceiver : API の結果を非同期で通知します。
この値は null であっても構いません。 |
例外 | |
---|---|
IllegalArgumentException |
trigger のスキームが HTTPS でない場合 |
registerWebSource
public void registerWebSource (WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
ウェブ コンテキストからアトリビューション ソース(クリックまたはビュー)を登録します。この API は
リクエストとともにすべての登録 URL を指定する必要があります。少なくとも 1 つ
appDestination パラメータまたは webDestination パラメータを指定する必要があります。登録が
成功すると、callback
の OutcomeReceiver#onResult
が null で呼び出されます。イン
失敗した場合、callback
の OutcomeReceiver.onError(E)
を介して Exception
が送信されます。成功と失敗の両方のフィードバックが、提供された
Executor
。
AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
が必要です
パラメータ | |
---|---|
request |
WebSourceRegistrationRequest : ソース登録リクエスト
この値が null になることはありません。 |
executor |
Executor : 結果をディスパッチするためにコールバックで使用されます。
この値は null であっても構いません。 |
callback |
OutcomeReceiver : API の結果を非同期で通知します。
この値は null であっても構いません。 |
registerWebTrigger
public void registerWebTrigger (WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
ウェブ コンテキストからアトリビューション トリガー(クリックまたはビュー)を登録します。この API は
リクエストとともにすべての登録 URL を指定する必要があります。登録が
成功すると、callback
の OutcomeReceiver#onResult
が null で呼び出されます。イン
失敗した場合、callback
の OutcomeReceiver.onError(E)
を介して Exception
が送信されます。成功と失敗の両方のフィードバックが、提供された
Executor
。
AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
が必要です
パラメータ | |
---|---|
request |
WebTriggerRegistrationRequest : トリガー登録リクエスト
この値が null になることはありません。 |
executor |
Executor : 結果をディスパッチするためにコールバックで使用
この値は null の場合があります。 |
callback |
OutcomeReceiver : API の結果を非同期で通知します。
この値は null の場合があります。 |