MeasurementManager
public
class
MeasurementManager
extends Object
java.lang.Object | |
↳ | android.adservices.measurement.MeasurementManager |
MeasurementManager menyediakan API untuk mengelola pendaftaran sumber dan pemicu.
Ringkasan
Konstanta | |
---|---|
int |
MEASUREMENT_API_STATE_DISABLED
Status ini menunjukkan bahwa Measurement API tidak tersedia. |
int |
MEASUREMENT_API_STATE_ENABLED
Status ini menunjukkan bahwa Measurement API diaktifkan. |
Metode publik | |
---|---|
void
|
deleteRegistrations(DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
Menghapus pendaftaran sebelumnya. |
static
MeasurementManager
|
get(Context context)
Metode factory untuk membuat instance MeasurementManager. |
void
|
getMeasurementApiStatus(Executor executor, OutcomeReceiver<Integer, Exception> callback)
Mendapatkan status Measurement API. |
void
|
registerSource(Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
Mendaftarkan sumber atribusi (klik atau tampilan). |
void
|
registerSource(SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Mendaftarkan sumber atribusi(klik atau tampilan) dari konteks aplikasi. |
void
|
registerTrigger(Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
Daftarkan pemicu (konversi). |
void
|
registerWebSource(WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Mendaftarkan sumber atribusi(klik atau tampilan) dari konteks web. |
void
|
registerWebTrigger(WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Mendaftarkan pemicu atribusi(klik atau tampilan) dari konteks web. |
Metode turunan | |
---|---|
Konstanta
MEASUREMENT_API_STATE_DISABLED
public static final int MEASUREMENT_API_STATE_DISABLED
Status ini menunjukkan bahwa Measurement API tidak tersedia. Memanggilnya akan menghasilkan
UnsupportedOperationException
.
Nilai Konstanta: 0 (0x00000000)
MEASUREMENT_API_STATE_ENABLED
public static final int MEASUREMENT_API_STATE_ENABLED
Status ini menunjukkan bahwa Measurement API diaktifkan.
Nilai Konstanta: 1 (0x00000001)
Metode publik
deleteRegistrations
public void deleteRegistrations (DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
Menghapus pendaftaran sebelumnya. Jika penghapusan berhasil, OutcomeReceiver.onResult(R)
callback akan dipanggil dengan null. Jika terjadi kegagalan, Exception
akan dikirim melalui OutcomeReceiver#onError
callback. Masukan keberhasilan dan kegagalan dijalankan di Executor
yang disediakan.
Parameter | |
---|---|
deletionRequest |
DeletionRequest : Permintaan untuk menghapus data.
Nilai ini tidak boleh null . |
executor |
Executor : Eksekutor untuk menjalankan callback.
Nilai ini tidak boleh null .
Peristiwa callback dan pemroses dikirim melalui Executor ini, yang memberikan cara mudah untuk mengontrol thread mana yang digunakan. Untuk mengirim peristiwa melalui thread utama
aplikasi, Anda dapat menggunakan
Context.getMainExecutor() .
Jika tidak, berikan Executor yang dikirimkan ke thread yang sesuai. |
callback |
OutcomeReceiver : dimaksudkan untuk memberi tahu hasil API secara asinkron.
Nilai ini tidak boleh null . |
dapatkan
public static MeasurementManager get (Context context)
Metode factory untuk membuat instance MeasurementManager.
Parameter | |
---|---|
context |
Context : Context yang akan digunakan
Nilai ini tidak boleh null . |
Return | |
---|---|
MeasurementManager |
Instance MeasurementManager
Nilai ini tidak boleh null . |
getMeasurementApiStatus
public void getMeasurementApiStatus (Executor executor, OutcomeReceiver<Integer, Exception> callback)
Mendapatkan status Measurement API.
Nilai Integer
callback adalah salah satu dari MeasurementApiState
.
Memerlukan AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parameter | |
---|---|
executor |
Executor : digunakan oleh callback untuk mengirim hasil.
Nilai ini tidak boleh null .
Peristiwa callback dan pemroses dikirim melalui Executor ini, yang memberikan cara mudah untuk mengontrol thread mana yang digunakan. Untuk mengirim peristiwa melalui thread utama
aplikasi, Anda dapat menggunakan
Context.getMainExecutor() .
Jika tidak, berikan Executor yang dikirimkan ke thread yang sesuai. |
callback |
OutcomeReceiver : dimaksudkan untuk memberi tahu hasil API secara asinkron.
Nilai ini tidak boleh null . |
registerSource
public void registerSource (Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
Mendaftarkan sumber atribusi (klik atau tampilan).
Memerlukan AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parameter | |
---|---|
attributionSource |
Uri : platform mengirimkan permintaan ke URI ini untuk mengambil metadata
yang terkait dengan sumber atribusi. Metadata sumber disimpan di perangkat, sehingga memenuhi syarat untuk dicocokkan dengan pemicu mendatang.
Nilai ini tidak boleh null . |
inputEvent |
InputEvent : objek InputEvent (untuk peristiwa klik) atau null (untuk peristiwa
tampilan). |
executor |
Executor : digunakan oleh callback untuk mengirim hasil.
Nilai ini mungkin null .
Peristiwa callback dan pemroses dikirim melalui Executor ini, yang memberikan cara mudah untuk mengontrol thread mana yang digunakan. Untuk mengirim peristiwa melalui thread utama
aplikasi, Anda dapat menggunakan
Context.getMainExecutor() .
Jika tidak, berikan Executor yang dikirimkan ke thread yang sesuai. |
callback |
OutcomeReceiver : dimaksudkan untuk memberi tahu hasil API secara asinkron.
Nilai ini mungkin null . |
Menampilkan | |
---|---|
IllegalArgumentException |
jika skema untuk attributionSource bukan HTTPS |
registerSource
public void registerSource (SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Mendaftarkan sumber atribusi(klik atau tampilan) dari konteks aplikasi. API ini tidak akan memproses
pengalihan apa pun. Semua URL pendaftaran harus disertakan dengan permintaan.
Memerlukan AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parameter | |
---|---|
request |
SourceRegistrationRequest : permintaan pendaftaran sumber aplikasi
Nilai ini tidak boleh null . |
executor |
Executor : digunakan oleh callback untuk mengirim hasil
Nilai ini mungkin null .
Peristiwa callback dan pemroses dikirim melalui Executor ini, yang memberikan cara mudah untuk mengontrol thread mana yang digunakan. Untuk mengirim peristiwa melalui thread utama
aplikasi, Anda dapat menggunakan
Context.getMainExecutor() .
Jika tidak, berikan Executor yang dikirimkan ke thread yang sesuai. |
callback |
OutcomeReceiver : dimaksudkan untuk memberi tahu hasil API secara asinkron
Nilai ini mungkin null . |
registerTrigger
public void registerTrigger (Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
Daftarkan pemicu (konversi).
Memerlukan AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parameter | |
---|---|
trigger |
Uri : API mengeluarkan permintaan ke URI ini untuk mengambil metadata yang terkait dengan
pemicu. Metadata pemicu disimpan di perangkat, dan memenuhi syarat untuk dicocokkan dengan
sumber selama proses atribusi.
Nilai ini tidak boleh null . |
executor |
Executor : digunakan oleh callback untuk mengirim hasil.
Nilai ini mungkin null .
Peristiwa callback dan pemroses dikirim melalui Executor ini, yang memberikan cara mudah untuk mengontrol thread mana yang digunakan. Untuk mengirim peristiwa melalui thread utama
aplikasi, Anda dapat menggunakan
Context.getMainExecutor() .
Jika tidak, berikan Executor yang dikirimkan ke thread yang sesuai. |
callback |
OutcomeReceiver : dimaksudkan untuk memberi tahu hasil API secara asinkron.
Nilai ini mungkin null . |
Menampilkan | |
---|---|
IllegalArgumentException |
jika skema untuk trigger bukan HTTPS |
registerWebSource
public void registerWebSource (WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Mendaftarkan sumber atribusi(klik atau tampilan) dari konteks web. API ini tidak akan memproses
pengalihan apa pun. Semua URL pendaftaran harus disertakan dengan permintaan. Setidaknya salah satu
parameter appDestination atau webDestination harus diberikan. Jika pendaftaran berhasil, OutcomeReceiver#onResult
callback
akan dipanggil dengan null. Jika terjadi kegagalan, Exception
akan dikirim melalui OutcomeReceiver.onError(E)
callback
. Masukan keberhasilan dan kegagalan dijalankan di Executor
yang disediakan.
Memerlukan AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parameter | |
---|---|
request |
WebSourceRegistrationRequest : permintaan pendaftaran sumber
Nilai ini tidak boleh null . |
executor |
Executor : digunakan oleh callback untuk mengirim hasil.
Nilai ini mungkin null . |
callback |
OutcomeReceiver : dimaksudkan untuk memberi tahu hasil API secara asinkron.
Nilai ini mungkin null . |
registerWebTrigger
public void registerWebTrigger (WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
Mendaftarkan pemicu atribusi(klik atau tampilan) dari konteks web. API ini tidak akan memproses
pengalihan apa pun. Semua URL pendaftaran harus disertakan dengan permintaan. Jika pendaftaran berhasil, OutcomeReceiver#onResult
callback
akan dipanggil dengan null. Jika terjadi kegagalan, Exception
akan dikirim melalui OutcomeReceiver.onError(E)
callback
. Masukan keberhasilan dan kegagalan dijalankan di Executor
yang disediakan.
Memerlukan AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
Parameter | |
---|---|
request |
WebTriggerRegistrationRequest : permintaan pendaftaran pemicu
Nilai ini tidak boleh null . |
executor |
Executor : digunakan oleh callback untuk mengirim hasil
Nilai ini mungkin null . |
callback |
OutcomeReceiver : dimaksudkan untuk memberi tahu hasil API secara asinkron
Nilai ini mungkin null . |