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 已啟用。 |
繼承方法 | |
---|---|
常數
評估 API_STATE_DISABLED
public static final int MEASUREMENT_API_STATE_DISABLED
這個狀態表示 Measurement API 無法使用。叫用這些 API 會導致
UnsupportedOperationException
。
常數值: 0 分 (0x00000000)
評估 API 狀態
public static final int MEASUREMENT_API_STATE_ENABLED
這個狀態表示 Measurement API 已啟用。
常數值: 1 分 (0x00000001)
公用方法
刪除註冊作業
public void deleteRegistrations (DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
刪除先前的註冊。如果刪除成功,系統會以空值叫用回呼的 OutcomeReceiver.onResult(R)
。如果失敗,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 。 |
註冊來源
public void registerSource (Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
登錄歸因來源 (點擊或瀏覽)。
系統需求:AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
參數 | |
---|---|
attributionSource |
Uri :平台會向這個 URI 發出要求,擷取中繼資料
以及與歸因來源相關聯的 Analytics來源中繼資料會儲存在裝置上,
可對應至未來的觸發條件
此值不能為 null 。 |
inputEvent |
InputEvent :InputEvent 物件 (用於點擊事件) 或空值 (用於觀看)
事件)。 |
executor |
Executor :供回呼用來分派結果。
此值可以是 null 。
回呼和事件監聽器事件會透過這個
Executor ,可讓您輕鬆控制
如何透過應用程式的主執行緒分派事件
可以使用
Context.getMainExecutor() 。
否則,請提供會調度至適當執行緒的 Executor 。 |
callback |
OutcomeReceiver :用於以非同步方式通知 API 結果。
值可以是 null 。 |
擲回 | |
---|---|
IllegalArgumentException |
如果 attributionSource 的配置不是 HTTPS |
註冊來源
public void registerSource (SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
從應用程式結構定義登錄歸因來源(點擊或瀏覽)。系統不會處理這個 API
任何重新導向,所有註冊網址均應隨請求提供。
系統需求:AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
參數 | |
---|---|
request |
SourceRegistrationRequest :應用程式來源註冊要求
此值不能為 null 。 |
executor |
Executor :可讓回呼分派結果
這個值可以是 null 。
回呼和事件監聽器事件會透過這個
Executor ,可讓您輕鬆控制
如何透過應用程式的主執行緒分派事件
可以使用
Context.getMainExecutor() 。
否則,請提供會調度至適當執行緒的 Executor 。 |
callback |
OutcomeReceiver :用於以非同步方式通知 API 結果
這個值可以是 null 。 |
註冊觸發條件
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 |
註冊網頁來源
public void registerWebSource (WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
從網路環境登錄歸因來源(點擊或瀏覽)。這個 API 不會處理任何
重新導向時,所有註冊網址均應隨要求提供。至少一個
必須提供 appDestination 或 webDestination 參數。如果註冊
成功,callback
的 OutcomeReceiver#onResult
叫用為空值。於
失敗時,系統會透過 callback
的 OutcomeReceiver.onError(E)
傳送 Exception
。成功和失敗回應都會在提供的
Executor
。
系統需求:AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
參數 | |
---|---|
request |
WebSourceRegistrationRequest :來源登錄要求
此值不能為 null 。 |
executor |
Executor :供回呼用來分派結果。
值可以是 null 。 |
callback |
OutcomeReceiver :用於以非同步方式通知 API 結果。
值可以是 null 。 |
註冊網路觸發條件
public void registerWebTrigger (WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
從網路環境登錄歸因觸發條件(點擊或瀏覽)。系統不會處理這個 API
任何重新導向,所有註冊網址均應隨請求提供。如果註冊
成功,callback
的 OutcomeReceiver#onResult
叫用為空值。於
失敗時,系統會透過 callback
的 OutcomeReceiver.onError(E)
傳送 Exception
。成功和失敗回應都會在提供的
Executor
。
系統需求:AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
參數 | |
---|---|
request |
WebTriggerRegistrationRequest :觸發事件登錄要求
此值不能為 null 。 |
executor |
Executor :可讓回呼分派結果
這個值可以是 null 。 |
callback |
OutcomeReceiver :用於以非同步方式通知 API 結果
這個值可以是 null 。 |