Trình quản lý đo lường
public
class
MeasurementManager
extends Object
java.lang.Object | |
↳ | android.adservices.measurement.MeasurementManager |
MeasurementManager cung cấp các API để quản lý hoạt động đăng ký nguồn và điều kiện kích hoạt.
Tóm tắt
Hằng số | |
---|---|
int |
MEASUREMENT_API_STATE_DISABLED
Trạng thái này cho biết các API Đo lường không có sẵn. |
int |
MEASUREMENT_API_STATE_ENABLED
Trạng thái này cho biết các API Đo lường đã được bật. |
Phương thức công khai | |
---|---|
void
|
deleteRegistrations(DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
Xoá các yêu cầu đăng ký trước đây. |
static
MeasurementManager
|
get(Context context)
Phương thức ban đầu để tạo một thực thể của MeasurementManager. |
void
|
getMeasurementApiStatus(Executor executor, OutcomeReceiver<Integer, Exception> callback)
Xem trạng thái của Measurement API. |
void
|
registerSource(Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
Đăng ký một nguồn phân bổ (lượt nhấp hoặc lượt xem). |
void
|
registerSource(SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Đăng ký các nguồn phân bổ(lượt nhấp hoặc lượt xem) từ bối cảnh ứng dụng. |
void
|
registerTrigger(Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
Đăng ký một điều kiện kích hoạt (lượt chuyển đổi). |
void
|
registerWebSource(WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Đăng ký một nguồn phân bổ(lượt nhấp hoặc lượt xem) từ ngữ cảnh web. |
void
|
registerWebTrigger(WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Đăng ký một điều kiện kích hoạt phân bổ(lượt nhấp hoặc lượt xem) từ ngữ cảnh web. |
Các phương thức kế thừa | |
---|---|
Hằng số
MEASUREMENT_API_STATE_DISABLED
public static final int MEASUREMENT_API_STATE_DISABLED
Trạng thái này cho biết các API Đo lường không có sẵn. Việc gọi chúng sẽ dẫn đến
UnsupportedOperationException
.
Giá trị hằng số: 0 (0x00000000)
MEASUREMENT_API_STATE_ENABLED
public static final int MEASUREMENT_API_STATE_ENABLED
Trạng thái này cho biết các API Đo lường đã được bật.
Giá trị không đổi: 1 (0x00000001)
Phương thức công khai
xoá đơn đăng ký
public void deleteRegistrations (DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
Xoá các yêu cầu đăng ký trước đây. Nếu xoá thành công, OutcomeReceiver.onResult(R)
của lệnh gọi lại sẽ được gọi bằng giá trị rỗng. Trong trường hợp không thành công, Exception
sẽ được
được gửi qua OutcomeReceiver#onError
của lệnh gọi lại. Cả thành công lẫn thất bại
phản hồi sẽ được thực thi trên Executor
được cung cấp.
Tham số | |
---|---|
deletionRequest |
DeletionRequest : Yêu cầu xoá dữ liệu.
Giá trị này không được là null . |
executor |
Executor : Trình thực thi để chạy lệnh gọi lại.
Giá trị này không được là null .
Các sự kiện gọi lại và trình nghe được gửi thông qua
Executor , giúp bạn dễ dàng kiểm soát luồng nào
đã sử dụng. Để gửi sự kiện thông qua chuỗi chính của
ứng dụng, bạn có thể sử dụng
Context.getMainExecutor() .
Nếu không, hãy cung cấp Executor để gửi đến một luồng phù hợp. |
callback |
OutcomeReceiver : nhằm thông báo không đồng bộ kết quả API.
Giá trị này không được là null . |
get
public static MeasurementManager get (Context context)
Phương thức ban đầu để tạo một thực thể của MeasurementManager.
Tham số | |
---|---|
context |
Context : Context để sử dụng
Giá trị này không được là null . |
Giá trị trả về | |
---|---|
MeasurementManager |
Một thực thể MeasurementManager
Giá trị này không được là null . |
getMeasurementApiStatus
public void getMeasurementApiStatus (Executor executor, OutcomeReceiver<Integer, Exception> callback)
Xem trạng thái của Measurement API.
Giá trị Integer
của lệnh gọi lại là một trong MeasurementApiState
.
Cần có AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Tham số | |
---|---|
executor |
Executor : được lệnh gọi lại sử dụng để gửi kết quả.
Giá trị này không được là null .
Các sự kiện gọi lại và trình nghe được gửi thông qua
Executor , giúp bạn dễ dàng kiểm soát luồng nào
đã sử dụng. Để gửi sự kiện thông qua chuỗi chính của
ứng dụng, bạn có thể sử dụng
Context.getMainExecutor() .
Nếu không, hãy cung cấp Executor để gửi đến một luồng phù hợp. |
callback |
OutcomeReceiver : nhằm thông báo không đồng bộ kết quả API.
Giá trị này không được là null . |
subscriptionSource
public void registerSource (Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
Đăng ký một nguồn phân bổ (lượt nhấp hoặc lượt xem).
Cần có AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Tham số | |
---|---|
attributionSource |
Uri : nền tảng đưa ra yêu cầu cho URI này để tìm nạp siêu dữ liệu
được liên kết với nguồn phân bổ. Siêu dữ liệu nguồn được lưu trữ trên thiết bị, giúp
mã đó đủ điều kiện để được so khớp với các điều kiện kích hoạt trong tương lai.
Giá trị này không được là null . |
inputEvent |
InputEvent : đối tượng InputEvent (đối với sự kiện nhấp chuột) hoặc giá trị rỗng (đối với khung hiển thị)
sự kiện). |
executor |
Executor : được lệnh gọi lại sử dụng để gửi kết quả.
Giá trị này có thể là null .
Các sự kiện gọi lại và trình nghe được gửi thông qua
Executor , giúp bạn dễ dàng kiểm soát luồng nào
đã sử dụng. Để gửi sự kiện thông qua chuỗi chính của
ứng dụng, bạn có thể sử dụng
Context.getMainExecutor() .
Nếu không, hãy cung cấp Executor để gửi đến một luồng phù hợp. |
callback |
OutcomeReceiver : nhằm thông báo không đồng bộ kết quả API.
Giá trị này có thể là null . |
Gửi | |
---|---|
IllegalArgumentException |
nếu lược đồ cho attributionSource không phải là HTTPS |
subscriptionSource
public void registerSource (SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Đăng ký các nguồn phân bổ(lượt nhấp hoặc lượt xem) từ bối cảnh ứng dụng. API này sẽ không xử lý
mọi lệnh chuyển hướng, tất cả URL đăng ký đều phải được cung cấp cùng với yêu cầu.
Cần có AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Tham số | |
---|---|
request |
SourceRegistrationRequest : yêu cầu đăng ký nguồn ứng dụng
Giá trị này không được là null . |
executor |
Executor : được lệnh gọi lại sử dụng để gửi kết quả
Giá trị này có thể là null .
Các sự kiện gọi lại và trình nghe được gửi thông qua
Executor , giúp bạn dễ dàng kiểm soát luồng nào
đã sử dụng. Để gửi sự kiện thông qua chuỗi chính của
ứng dụng, bạn có thể sử dụng
Context.getMainExecutor() .
Nếu không, hãy cung cấp Executor để gửi đến một luồng phù hợp. |
callback |
OutcomeReceiver : nhằm thông báo không đồng bộ kết quả API
Giá trị này có thể là null . |
đăng ký điều kiện kích hoạt
public void registerTrigger (Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
Đăng ký một điều kiện kích hoạt (lượt chuyển đổi).
Cần có AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Tham số | |
---|---|
trigger |
Uri : API đưa ra yêu cầu cho URI này để tìm nạp siêu dữ liệu được liên kết với
điều kiện kích hoạt. Siêu dữ liệu của điều kiện kích hoạt được lưu trữ trên thiết bị và đủ điều kiện để so khớp với
trong quá trình phân bổ.
Giá trị này không được là null . |
executor |
Executor : được lệnh gọi lại sử dụng để gửi kết quả.
Giá trị này có thể là null .
Các sự kiện gọi lại và trình nghe được gửi thông qua
Executor , giúp bạn dễ dàng kiểm soát luồng nào
đã sử dụng. Để gửi sự kiện thông qua chuỗi chính của
ứng dụng, bạn có thể sử dụng
Context.getMainExecutor() .
Nếu không, hãy cung cấp Executor để gửi đến một luồng phù hợp. |
callback |
OutcomeReceiver : nhằm thông báo không đồng bộ kết quả API.
Giá trị này có thể là null . |
Gửi | |
---|---|
IllegalArgumentException |
nếu lược đồ cho trigger không phải là HTTPS |
Đăng kýWebSource
public void registerWebSource (WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Đăng ký một nguồn phân bổ(lượt nhấp hoặc lượt xem) từ ngữ cảnh web. API này sẽ không xử lý bất kỳ
chuyển hướng, bạn phải cung cấp tất cả URL đăng ký cùng với yêu cầu. Ít nhất một trong số
Bạn phải cung cấp tham số appDestination hoặc webDestination. Nếu việc đăng ký
thành công, OutcomeReceiver#onResult
của callback
sẽ được gọi bằng giá trị rỗng. Trong
trong trường hợp không thành công, Exception
sẽ được gửi qua OutcomeReceiver.onError(E)
của callback
. Cả phản hồi thành công và không thành công đều được thực thi trên
Executor
.
Cần có AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Tham số | |
---|---|
request |
WebSourceRegistrationRequest : yêu cầu đăng ký nguồn
Giá trị này không được là null . |
executor |
Executor : được lệnh gọi lại sử dụng để gửi kết quả.
Giá trị này có thể là null . |
callback |
OutcomeReceiver : nhằm thông báo không đồng bộ kết quả API.
Giá trị này có thể là null . |
Đăng kýWebTrigger
public void registerWebTrigger (WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Đăng ký một điều kiện kích hoạt phân bổ(lượt nhấp hoặc lượt xem) từ ngữ cảnh web. API này sẽ không xử lý
mọi lệnh chuyển hướng, tất cả URL đăng ký đều phải được cung cấp cùng với yêu cầu. Nếu việc đăng ký
thành công, OutcomeReceiver#onResult
của callback
sẽ được gọi bằng giá trị rỗng. Trong
trong trường hợp không thành công, Exception
sẽ được gửi qua OutcomeReceiver.onError(E)
của callback
. Cả phản hồi thành công và không thành công đều được thực thi trên
Executor
.
Cần có AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Tham số | |
---|---|
request |
WebTriggerRegistrationRequest : yêu cầu đăng ký kích hoạt
Giá trị này không được là null . |
executor |
Executor : được lệnh gọi lại sử dụng để gửi kết quả
Giá trị này có thể là null . |
callback |
OutcomeReceiver : nhằm thông báo không đồng bộ kết quả API
Giá trị này có thể là null . |