MeasurementManager
public
class
MeasurementManager
extends Object
| java.lang.Object | |
| ↳ | android.adservices.measurement.MeasurementManager |
MeasurementManager מספק ממשקי API לניהול רישומי מקור ולהפעלת הרשמות.
סיכום
קבועים | |
|---|---|
int |
MEASUREMENT_API_STATE_DISABLED
המצב הזה מציין שממשקי ה-API למדידה לא זמינים. |
int |
MEASUREMENT_API_STATE_ENABLED
המצב הזה מציין שממשקי ה-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)
רישום טריגר שיוך (Attribution) (קליק או צפייה) מהקשר באינטרנט. |
שיטות שעברו בירושה | |
|---|---|
קבועים
MEASUREMENT_API_STATE_DISABLED
public static final int MEASUREMENT_API_STATE_DISABLED
המצב הזה מציין שממשקי ה-API למדידה לא זמינים. הפעלתן תוביל
UnsupportedOperationException
ערך קבוע: 0 (0x00000000)
MEASUREMENT_API_STATE_enabled
public static final int MEASUREMENT_API_STATE_ENABLED
המצב הזה מציין שממשקי ה-API למדידה מופעלים.
ערך קבוע: 1 (0x00000001)
שיטות ציבוריות
מחיקת רישומים
public void deleteRegistrations (DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
מחיקת הרשמות קודמות. אם המחיקה תסתיים בהצלחה, הערך OutcomeReceiver.onResult(R) של הקריאה החוזרת יופעל עם הערך null. במקרה של כשל, Exception הוא
נשלח דרך OutcomeReceiver#onError של הקריאה החוזרת. הצלחה וגם כישלון
המשוב יבוצע בExecutor שסופק.
| פרמטרים | |
|---|---|
deletionRequest |
DeletionRequest: הבקשה למחיקת נתונים.
הערך הזה לא יכול להיות null. |
executor |
Executor: הביצוע להרצת הקריאה החוזרת (callback).
הערך הזה לא יכול להיות null.
אירועי קריאה חוזרת ואירועי האזנה נשלחים באמצעות
Executor, דרך קלה לקבוע איזה שרשור
בשימוש. כדי לשלוח אירועים דרך ה-thread הראשי
אפשר להשתמש
Context.getMainExecutor()
אם לא, צריך לציין Executor ששולח לשרשור מתאים. |
callback |
OutcomeReceiver: מיועד להודיע באופן אסינכרוני על תוצאת ה-API.
הערך הזה לא יכול להיות null. |
מקבלים
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: משמש את הקריאה החוזרת (callback) לשליחת תוצאות.
הערך הזה לא יכול להיות null.
אירועי קריאה חוזרת ואירועי האזנה נשלחים באמצעות
Executor, דרך קלה לקבוע איזה שרשור
בשימוש. כדי לשלוח אירועים דרך ה-thread הראשי
אפשר להשתמש
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 הזה כדי לאחזר מטא-נתונים
המשויך למקור השיוך. המטא-נתונים של המקור מאוחסנים במכשיר, כך
יכול להתאים אותו לטריגרים עתידיים.
הערך הזה לא יכול להיות null. |
inputEvent |
InputEvent: אובייקט InputEvent (לאירוע מסוג קליק) או ערך null (לתצוגה מפורטת)
אירוע). |
executor |
Executor: משמש את הקריאה החוזרת (callback) לשליחת תוצאות.
הערך הזה יכול להיות null.
אירועי קריאה חוזרת ואירועי האזנה נשלחים באמצעות
Executor, דרך קלה לקבוע איזה שרשור
בשימוש. כדי לשלוח אירועים דרך ה-thread הראשי
אפשר להשתמש
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, דרך קלה לקבוע איזה שרשור
בשימוש. כדי לשלוח אירועים דרך ה-thread הראשי
אפשר להשתמש
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: משמש את הקריאה החוזרת (callback) לשליחת תוצאות.
הערך הזה יכול להיות null.
אירועי קריאה חוזרת ואירועי האזנה נשלחים באמצעות
Executor, דרך קלה לקבוע איזה שרשור
בשימוש. כדי לשלוח אירועים דרך ה-thread הראשי
אפשר להשתמש
Context.getMainExecutor()
אם לא, צריך לציין Executor ששולח לשרשור מתאים. |
callback |
OutcomeReceiver: מיועד להודיע באופן אסינכרוני על תוצאת ה-API.
הערך הזה יכול להיות null. |
| קליעות | |
|---|---|
IllegalArgumentException |
אם הסכימה של trigger היא לא HTTPS |
רישום WebSource
public void registerWebSource (WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
רישום מקור שיוך(קליק או צפייה) מהקשר באינטרנט. ה-API הזה לא יעבד
לכתובות אתר אחרות, יש לספק את כל כתובות האתרים לרישום. לפחות אחד מ-
יש לספק פרמטרים של appDestination או webDestination. אם הרישום
הפעולה בוצעה בהצלחה, OutcomeReceiver#onResult של callback הופעל עם null. לחשבון
במקרה של כשל, Exception נשלח דרך OutcomeReceiver.onError(E) של callback. גם משוב על הצלחה וגם משוב על כשלים מתבצעים
Executor
נדרש AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
| פרמטרים | |
|---|---|
request |
WebSourceRegistrationRequest: בקשה לרישום מקור
הערך הזה לא יכול להיות null. |
executor |
Executor: משמש את הקריאה החוזרת (callback) לשליחת תוצאות.
הערך הזה יכול להיות null. |
callback |
OutcomeReceiver: מיועד להודיע באופן אסינכרוני על תוצאת ה-API.
הערך הזה יכול להיות null. |
רישום WebTrigger
public void registerWebTrigger (WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
רישום טריגר שיוך (Attribution) (קליק או צפייה) מהקשר באינטרנט. ה-API הזה לא יעובד
כל כתובות האתרים להפניה מחדש, יש לספק את כל כתובות האתרים לרישום. אם הרישום
הפעולה בוצעה בהצלחה, OutcomeReceiver#onResult של callback הופעל עם null. לחשבון
במקרה של כשל, Exception נשלח דרך OutcomeReceiver.onError(E) של callback. גם משוב על הצלחה וגם משוב על כשלים מתבצעים
Executor
נדרש AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
| פרמטרים | |
|---|---|
request |
WebTriggerRegistrationRequest: הפעלה של בקשת הרשמה
הערך הזה לא יכול להיות null. |
executor |
Executor: משמש את הקריאה החוזרת לשליחת תוצאות
הערך הזה יכול להיות null. |
callback |
OutcomeReceiver: מיועד להודיע באופן אסינכרוני על תוצאת ה-API
הערך הזה יכול להיות null. |