مدير الإشارات المحمية
public
class
ProtectedSignalsManager
extends Object
java.lang.Object | |
↳ | android.adservices.signals.ProtectedSignalsManager |
توفّر ProtectedSignalsManager واجهات برمجة تطبيقات للتطبيقات وحِزم تطوير البرامج (SDK) للإعلانات لإدارة الإشارات المحمية.
ملخّص
الطرق المتاحة للجميع | |
---|---|
static
ProtectedSignalsManager
|
get(Context context)
طريقة المصنع لإنشاء مثيل ProtectedSignalsManager |
void
|
updateSignals(UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)
ستسترد واجهة برمجة التطبيقات updateSignals ملف JSON من معرّف الموارد المنتظم (URI) الذي يصف الإشارات التي يجب إضافتها أو إزالتها. |
الطرق المكتسبة | |
---|---|
الطرق المتاحة للجميع
احصل على
public static ProtectedSignalsManager get (Context context)
طريقة المصنع لإنشاء مثيل ProtectedSignalsManager
المعلّمات | |
---|---|
context |
Context : لا يمكن استخدام Context لهذه القيمة باعتبارها null . |
الركلات المردودة | |
---|---|
ProtectedSignalsManager |
مثيل ProtectedSignalsManager
لا يمكن أن تكون هذه القيمة null . |
إشارات التحديث
public void updateSignals (UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)
ستسترد واجهة برمجة التطبيقات updateSignals ملف JSON من معرّف الموارد المنتظم (URI) الذي يصف الإشارات التي يجب إضافتها أو إزالتها. وتتيح واجهة برمجة التطبيقات هذه أيضًا تسجيل نقطة نهاية برنامج الترميز. يتم استخدام نقطة النهاية لتنزيل منطق الترميز الذي يفعّل ترميز الإشارات.
يجب أن تتوافق مفاتيح المستوى الأعلى لـ JSON مع أحد الأوامر الخمسة التالية:
"put" - لإضافة إشارة جديدة، واستبدال أي إشارات حالية بالمفتاح نفسه. وتكون قيمة هذا العنصر هي كائن JSON حيث تكون المفاتيح عبارة عن سلاسل أساسية مكونة من 64 سلسلة تقابل المفتاح المطلوب وضعه، وتكون القيم هي سلسلة الأساس 64 المقابلة للقيمة المطلوب وضعها.
"إضافة": لإلحاق إشارة/إشارات جديدة بسلسلة زمنية من الإشارات، ما يؤدي إلى إزالة الإشارات الأقدم لتوفير مساحة للإشارات الجديدة إذا تجاوز حجم السلسلة الحدّ الأقصى المحدّد. وتكون قيمة هذا العنصر هي كائن JSON حيث تكون المفاتيح عبارة عن سلاسل أساسية من 64 تتجاوب مع المفتاح الذي تريد إلحاقه بها، وتكون القيم كائنات لها حقلَين: "values" و "maxSignals" . "القيم" هي قائمة تتضمّن سلاسل 64 أساسية تتوافق مع قيم الإشارات لإلحاقها بالسلسلة الزمنية. "maxSignals" هي الحد الأقصى لعدد القيم المسموح بها في هذه السلسلة الزمنية. إذا كان العدد الحالي للإشارات المرتبطة بالمفتاح يتجاوز الحد الأقصى، ستتم إزالة الإشارات الأقدم. تجدر الإشارة إلى أنه يمكنك إلحاق المفتاح الذي تمت إضافته باستخدام الوضع. لن يؤدي إلحاق أكثر من الحد الأقصى لعدد القيم إلى حدوث خطأ.
"put_if_not_present" - لإضافة إشارة جديدة فقط في حال عدم وجود إشارات حالية لها المفتاح نفسه. وتكون قيمة هذا العنصر هي كائن JSON حيث تكون المفاتيح عبارة عن سلاسل أساسية من 64 تقابل المفتاح المطلوب وضعه، وتكون القيم هي سلسلة أساسية 64 تتوافق مع القيمة المطلوب وضعها.
"إزالة": يؤدي هذا الخيار إلى إزالة إشارة المفتاح. وقيمتها هي قائمة من سلاسل الأساس 64 الأساسية المقابلة لمفاتيح الإشارات التي يجب حذفها.
"update_encoder": يوفر إجراءً لتعديل نقطة النهاية ومعرّف موارد منتظم (URI) يمكن استخدامه لاسترداد منطق الترميز. المفتاح الفرعي لتوفير إجراء تحديث هو "action" (الإجراء) والقيم المتاحة حاليًا هي:
- "REGISTER" : لتسجيل نقطة نهاية برنامج الترميز إذا تم توفيرها للمرة الأولى أو استبدال نقطة النهاية الحالية بنقطة النهاية التي تم توفيرها مؤخرًا. يجب توفير "نقطة النهاية" للإجراء "REGISTER".
المفتاح الفرعي لتوفير نقطة نهاية لبرنامج الترميز هو "نقطة النهاية" والقيمة هي سلسلة معرّف الموارد المنتظم (URI) لنقطة النهاية.
لا يمكن تشغيل المفتاح إلا من خلال أمر واحد لكل JSON. إذا حاول أمران العمل على المفتاح نفسه، ستعمل هذه الطريقة على تنفيذ IllegalArgumentException
.
تعذَّر إجراء هذه المكالمة مع SecurityException
إذا
- لا يتصل
ownerPackageName
باسم حزمة التطبيق و/أو - غير مصرح للمشتري باستخدام واجهة برمجة التطبيقات.
تعذَّر إجراء هذه المكالمة مع IllegalArgumentException
إذا
- ملف JSON الذي تم استرداده من الخادم غير صالح.
- معرّف الموارد المنتظم (URI) المُقدّم غير صالح.
يتعذّر تنفيذ هذا الطلب من خلال LimitExceededException
إذا كانت حزمة الاتصال تتجاوز
حدود السعر المسموح به وتم تقييدها.
يتعذّر تنفيذ هذا الاستدعاء مع ظهور الخطأ IllegalStateException
في حال حدوث خطأ داخلي في الخدمة.
يتطلب AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE
المعلّمات | |
---|---|
updateSignalsRequest |
UpdateSignalsRequest : لا يمكن أن تكون هذه القيمة null . |
executor |
Executor : لا يمكن أن تكون هذه القيمة null .
يتم إرسال أحداث معاودة الاتصال والمستمعين من خلال
Executor ، ما يوفّر طريقة سهلة للتحكّم في سلسلة المحادثات
المستخدَمة. لإرسال الأحداث من خلال سلسلة التعليمات الرئيسية
في تطبيقك، يمكنك استخدام
Context.getMainExecutor() .
وبخلاف ذلك، يمكنك تقديم Executor توجّهها إلى سلسلة محادثات مناسبة. |
receiver |
OutcomeReceiver : لا يمكن أن تكون هذه القيمة null . |