ProtectedSignalsManager
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 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 من عنوان URL الذي يصف الإشارات التي يجب إضافتها أو إزالتها. تسمح واجهة برمجة التطبيقات هذه أيضًا بتسجيل نقطة نهاية برنامج الترميز. تُستخدَم نقطة النهاية لتحميل منطق الترميز الذي يتيح ترميز الإشارات.
يجب أن تتوافق مفاتيح المستوى الأعلى لتنسيق JSON مع أحد الأوامر الخمسة:
"put" - تُضيف إشارة جديدة، وتُلغي أي إشارات حالية باستخدام المفتاح نفسه. وتكون القيمة هي كائن JSON حيث تكون المفاتيح عبارة عن سلاسل أساسية 64 وفقًا للمفتاح المطلوب إدخاله، وتكون القيم هي سلسلة Base 64 وتتجاوب مع القيمة المطلوب إدخالها.
"append": لإلحاق إشارة/إشارات جديدة بسلسلة زمنية من الإشارات، وإزالة الإشارات الأقدم لتوفير مساحة للإشارات الجديدة إذا تجاوز حجم السلسلة الحد الأقصى المحدد. قيمة هذه السمة هي كائن JSON حيث تكون المفاتيح عبارة عن سلاسل أساسية 64 تتوافق مع المفتاح المطلوب إلحاقه والقيم هي عناصر تحتوي على حقلين: "values" و"maxSignals". "values" هي قائمة بسلاسل base 64 تتوافق مع قيم الإشارات لإلحاقها بسلسلة الزمنية. "maxSignals" هي الحد الأقصى لعدد القيم المسموح بها في هذا السلسلة الزمنية. إذا كان العدد الحالي للإشارات المرتبطة بالمفتاح يتجاوز maxSignals، ستتم إزالة الإشارات الأقدم. تجدر الإشارة إلى أنّه يمكنك إلحاق مفتاح تمت إضافته باستخدام put. ولا يعني ذلك أنّ إلحاق أكثر من الحد الأقصى لعدد القيم سيؤدي إلى حدوث خطأ.
"put_if_not_present" - تُضيف إشارة جديدة فقط في حال عدم توفّر إشارات حالية باستخدام المفتاح نفسه. وتكون قيمة هذه كائن JSON حيث تكون المفاتيح عبارة عن سلاسل أساسية 64 تتوافق مع المفتاح المراد وضعه والقيم هي سلسلة الأساس 64 المقابلة للقيمة المراد وضعها.
"remove": لإزالة إشارة مفتاح وتكون هذه القيمة هي قائمة من سلاسل الأساس 64 المقابلة لمفاتيح الإشارات التي يجب حذفها.
"update_encoder": يوفّر إجراءً لتعديل نقطة النهاية وعنوان URL يمكن استخدامه لاسترداد منطق ترميز. المفتاح الفرعي لتقديم إجراء تعديل هو "action"، والقيم المسموح بها حاليًا هي:
- "تسجيل" : لتسجيل نقطة نهاية برنامج الترميز إذا تم تقديمها للمرة الأولى أو استبدال النقطة الحالية بنقطة النهاية المقدَّمة حديثًا. يجب تقديم "نقطة النهاية" لإجراء "REGISTER".
المفتاح الفرعي لتقديم نقطة نهاية لبرنامج الترميز هو "endpoint" والقيمة هي سلسلة 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 . |