ProtectedSignalsManager

public class ProtectedSignalsManager
extends Object

java.lang.Object
   ↳ android.adservices.signals.ProtectedSignalsManager

ProtectedSignalsManager מספק ממשקי API לאפליקציות ול-SDK של מודעות לניהול האותות המוגנים שלהם.

סיכום

שיטות ציבוריות

static ProtectedSignalsManager get(Context context)

שיטת היצרן ליצירת מכונה של ProtectedSignalsManager.

void updateSignals(UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)

ה-updateSignals API יאתר קובץ JSON מה-URI שמתאר אילו אותות צריך להוסיף או להסיר.

שיטות שעברו בירושה

שיטות ציבוריות

מקבלים

public static ProtectedSignalsManager get (Context context)

שיטת המפעל ליצירת מופע של ProtectedSignalsManager.

פרמטרים
context Context: ה-Context שבו רוצים להשתמש הערך לא יכול להיות null.
החזרות
ProtectedSignalsManager מופע ProtectedSignalsManager הערך לא יכול להיות null.

updateSignals

public void updateSignals (UpdateSignalsRequest updateSignalsRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

updateSignals API יאחזר קובץ JSON מה-URI שמתאר אילו אותות צריך להוסיף או להסיר. ה-API הזה מאפשר גם לרשום את נקודת הקצה של המקודד. נקודת הקצה משמשת להורדת לוגיקה של קידוד, שמאפשרת לקודד את האותות.

המפתחות ברמה העליונה של ה-JSON חייבים להתאים לאחת מ-5 הפקודות הבאות:

put – הוספת אות חדש, כתיבה מחדש של אותות קיימים עם אותו מפתח. הערך של האובייקט הזה הוא אובייקט JSON שבו המפתחות הם מחרוזות בסיס 64 שתואמות למפתח שעבורו יש להציב, והערכים הם מחרוזת של בסיס 64 שתואמים לערך.

'append' – הוספה של אותות חדשים לסדרת אותות לאורך זמן, והסרה של האותות הישנים ביותר כדי לפנות מקום לאותות החדשים, אם הגודל של הסדרה חורג מהגודל המקסימלי שצוין. הערך של האובייקט הזה הוא אובייקט JSON שבו המפתחות הם מחרוזות בסיס 64 שתואמות למפתח שאליו צריך לצרף, והערכים הם אובייקטים עם שני שדות: 'values' ו-'maxSignals'. 'values' היא רשימה של מחרוזות Base64 שתואמות לערכים של האותות שרוצים לצרף לסדרת הזמן. "maxSignals" הוא מספר הערכים המקסימלי שמותר להזין בציר הזמן הזה. אם המספר הנוכחי של האותות שמשויכים למפתח חורג מ-maxSignals, האותות הישנים ביותר יוסרו. שימו לב שאפשר לצרף למפתח שנוסף באמצעות put. לא שצירוף של יותר ממספר הערכים המקסימלי יגרום לכשל.

put_if_not_present – הוספת אות חדש רק אם אין אותות קיימים עם אותו מפתח. הערך של השדה הזה הוא אובייקט JSON שבו המפתחות הם מחרוזות Base64 שתואמות למפתח שרוצים להוסיף, והערכים הם מחרוזות Base64 שתואמות לערך שרוצים להוסיף.

remove – הסרת האות של מפתח. הערך של השדה הזה הוא רשימה של מחרוזות base64 שמתאימות למפתחות של האותות שרוצים למחוק.

‎"update_encoder" – הפעולה מספקת עדכון של נקודת הקצה ו-URI שאפשר להשתמש בו כדי לאחזר לוגיקה של קידוד. מפתח המשנה לציון פעולת עדכון הוא 'פעולה', והערכים הנתמכים כרגע הם:

  1. 'REGISTER' : המערכת רושמת את נקודת הקצה של הקודק אם היא מסופקת בפעם הראשונה, או מחליפה את הנקודה הקיימת בנקודת הקצה החדשה שצוינה. בשביל הפעולה REGISTER צריך לציין את נקודת הקצה (endpoint).

מפתח המשנה שמספק את נקודת הקצה של המקודד הוא 'endpoint' והערך הוא מחרוזת ה-URI של נקודת הקצה.

ניתן להפעיל את המפתח באמצעות פקודה אחת בלבד לכל JSON. אם שתי פקודות מנסו לפעול על אותו מפתח, השיטה הזו תשליך IllegalArgumentException

השיחה הזו תיכשל עם SecurityException אם

  1. ownerPackageName לא קורא את שם החבילה של האפליקציה ו/או
  2. לקונה אין הרשאה להשתמש ב-API.

הקריאה נכשלת עם קוד השגיאה IllegalArgumentException אם

  1. קובץ ה-JSON שאוחזר מהשרת אינו חוקי.
  2. ה-URI שצוין לא חוקי.

הקריאה נכשלת עם LimitExceededException אם חבילת הקריאה חורגת ממגבלות הקצב המותרות ומופעל עליה הגבלת קצב.

הקריאה הזו נכשלת עם IllegalStateException אם מתרחשת שגיאה פנימית בשירות.
נדרש AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

פרמטרים
updateSignalsRequest UpdateSignalsRequest: הערך לא יכול להיות null.
executor Executor: הערך לא יכול להיות null. אירועי החזרה (callbacks) ואירועי הקשבים (listeners) מועברים דרך Executor הזה, ומאפשרים לכם לשלוט בקלות בשרשור שבו נעשה שימוש. כדי לשלוח אירועים דרך השרשור הראשי של האפליקציה, אפשר להשתמש ב-Context.getMainExecutor(). אם לא, צריך לציין Executor ששולח לשרשור מתאים.
receiver OutcomeReceiver: הערך לא יכול להיות null.