ProtectedSignalsManager
public class ProtectedSignalsManager
extends Object
java.lang.object | |
↳ | android.adservices.signals.ProtectedSignalsManager |
ProtectedSignalsManager API هایی را برای برنامه ها و ad-SDK ها برای مدیریت سیگنال های محافظت شده خود ارائه می دهد.
خلاصه
روش های عمومی | |
---|---|
static ProtectedSignalsManager | get ( Context context) روش کارخانه برای ایجاد یک نمونه از ProtectedSignalsManager. |
void | updateSignals ( UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver < Object , Exception > receiver) API 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)
API updateSignals یک JSON را از URI بازیابی می کند که توضیح می دهد کدام سیگنال ها را اضافه یا حذف کنید. این API همچنین امکان ثبت نقطه پایانی رمزگذار را فراهم می کند. نقطه پایانی برای دانلود یک منطق رمزگذاری استفاده می شود که رمزگذاری سیگنال ها را امکان پذیر می کند.
کلیدهای سطح بالا برای JSON باید با یکی از 5 فرمان مطابقت داشته باشند:
"put" - یک سیگنال جدید اضافه می کند و هر سیگنال موجود را با همان کلید بازنویسی می کند. مقدار برای این یک شی JSON است که در آن کلیدها رشته های پایه 64 مربوط به کلید مورد نظر و مقادیر پایه 64 رشته متناظر با مقدار برای قرار دادن هستند.
"پیوست" - یک سیگنال/سیگنال جدید را به یک سری زمانی از سیگنالها اضافه میکند، و اگر اندازه سری از حداکثر دادهشده بیشتر شود، قدیمیترین سیگنالها را حذف میکند تا جایی برای سیگنالهای جدید باز شود. مقدار برای این یک شی JSON است که در آن کلیدها رشته های پایه 64 مربوط به کلیدی هستند که باید به آن اضافه شود و مقادیر اشیایی با دو فیلد هستند: "values" و "maxSignals". "مقدار" لیستی از رشته های پایه 64 مربوط به مقادیر سیگنال است که باید به سری های زمانی اضافه شوند. "maxSignals" حداکثر تعداد مقادیر مجاز در این سری زمانی است. اگر تعداد فعلی سیگنال های مرتبط با کلید از maxSignals بیشتر شود، قدیمی ترین سیگنال ها حذف خواهند شد. توجه داشته باشید که می توانید به کلید اضافه شده توسط put اضافه کنید. نه اینکه اضافه کردن بیش از حداکثر تعداد مقادیر باعث شکست شود.
"put_if_not_present" - فقط در صورتی سیگنال جدیدی اضافه می کند که سیگنال های موجود با همان کلید وجود نداشته باشد. مقدار برای این یک شی JSON است که در آن کلیدها رشته های پایه 64 مربوط به کلید مورد نظر و مقادیر پایه 64 رشته متناظر با مقدار برای قرار دادن هستند.
"remove" - سیگنال یک کلید را حذف می کند. مقدار این لیستی از رشته های پایه 64 مربوط به کلیدهای سیگنال هایی است که باید حذف شوند.
"update_encoder" - عملی را برای به روز رسانی نقطه پایانی و یک URI ارائه می دهد که می تواند برای بازیابی یک منطق رمزگذاری استفاده شود. کلید فرعی برای ارائه یک اقدام به روز رسانی "عمل" است و مقادیری که در حال حاضر پشتیبانی می شوند عبارتند از:
- "REGISTER" : در صورت ارائه برای اولین بار، نقطه پایان رمزگذار را ثبت می کند یا نقطه پایانی موجود را با نقطه پایانی ارائه شده جدید بازنویسی می کند. ارائه "نقطه پایان" برای اقدام "REGISTER" الزامی است.
کلید فرعی برای ارائه نقطه پایانی رمزگذار "نقطه پایان" و مقدار آن رشته URI برای نقطه پایانی است.
کلید فقط با یک فرمان در هر JSON قابل اجرا است. اگر دو فرمان تلاش کنند روی یک کلید کار کنند، این روش از طریق یک IllegalArgumentException
انجام می شود
این تماس با یک SecurityException
اگر
-
ownerPackageName
با نام بسته برنامه و/یا تماس نمیگیرد - خریدار مجاز به استفاده از API نیست.
این فراخوانی با یک IllegalArgumentException
اگر
- JSON بازیابی شده از سرور معتبر نیست.
- URI ارائه شده نامعتبر است.
این تماس با LimitExceededException
ناموفق است اگر بسته تماس از حد مجاز نرخ مجاز فراتر رود و throttle شود.
اگر با خطای سرویس داخلی مواجه شود، این تماس با یک IllegalStateException
ناموفق است.
به AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE
نیاز دارد.ACCESS_ADSERVICES_CUSTOM_AUDIENCE
پارامترها | |
---|---|
updateSignalsRequest | UpdateSignalsRequest : این مقدار نمی تواند null باشد. |
executor | Executor : این مقدار نمی تواند null باشد. رویدادهای پاسخ به تماس و شنونده از طریق این Executor ارسال میشوند و راهی آسان برای کنترل رشته مورد استفاده ارائه میدهند. برای ارسال رویدادها از طریق رشته اصلی برنامه خود، می توانید از Context.getMainExecutor() استفاده کنید. در غیر این صورت، یک Executor ارائه دهید که به یک موضوع مناسب ارسال می کند. |
receiver | OutcomeReceiver : این مقدار نمی تواند null باشد. |