تخطَّ إلى المحتوى

السياسات

كائنا القاعدة والإصدار

Section titled “كائنا القاعدة والإصدار”
{
"version": 3,
"policyHash": "9b1c...",
"rules": [
{ "id": "no-alcohol", "text": "No ads showing alcoholic drinks, bars, or alcohol brands.", "lang": "en", "label": "Alcohol" },
{ "id": "no-riba", "text": "لا إعلانات عن القروض بفائدة أو البطاقات الائتمانية.", "lang": "ar" }
],
"note": "Added riba",
"createdAt": "2026-10-27T10:00:00Z",
"createdBy": "user:31"
}
حقل القاعدةالشروط
idمطلوب. [A-Za-z0-9_.-]، من 1 إلى 64 حرفًا، ولا يتكرر داخل السياسة.
textمطلوب. من 1 إلى 500 حرف بلغة طبيعية، بالإنجليزية أو العربية.
langاختياري: en أو ar. للعرض فقط.
labelاسم للعرض، اختياري، حتى 60 حرفًا. للعرض فقط.

تضم السياسة من 1 إلى 20 قاعدة. الحقلان id وtext هما ما يحدد الإصدار وpolicyHash، أما lang وlabel فلا يؤثران فيهما.

GET /v1/apps/{appId}/policy

النطاق read:verdicts. يرجع الإصدار الحالي. ويرد بالرمز 404 إن لم تكن للتطبيق سياسة بعد (أو لم يكن التطبيق موجودًا).

Terminal window
curl -s https://api.ad80.dev/v1/apps/com.example.news/policy -H "Authorization: Bearer $AD80_API_KEY"
PUT /v1/apps/{appId}/policy

النطاق write:policies. الجسم: rules (مطلوب) وnote (اختياري، حتى 200 حرف).

Terminal window
curl -s -X PUT https://api.ad80.dev/v1/apps/com.example.news/policy \
-H "Authorization: Bearer $AD80_API_KEY" -H "Content-Type: application/json" \
-d '{
"note": "Initial policy",
"rules": [
{"id": "no-alcohol", "text": "No ads showing alcoholic drinks, bars, or alcohol brands.", "lang": "en"},
{"id": "no-gambling", "text": "No ads for gambling: casinos, betting, lotteries or slot machines.", "lang": "en"}
]
}'

الرد:

{
"version": { "version": 4, "policyHash": "...", "rules": [ "..." ], "note": "Initial policy", "createdAt": "...", "createdBy": "key:ck_3" },
"unchanged": false,
"rescore": { "creatives": 120, "classifications": 120, "remaining": 186, "allowed": true }
}
  • إن كانت القواعد مطابقة تمامًا للحالية فلن يُنشأ إصدار جديد: يرجع unchanged: true مع الإصدار الحالي.
  • في الباقات التي تشمل الربط مع SDK، يعيد الحفظ تقييم إعلانات SDK في هذا التطبيق التي شوهدت خلال آخر 7 أيام. وهذا لا يستهلك من الفحوص اليدوية.
  • يقدّر rescore عدد الفحوص اليدوية التي ستستهلكها تجربة مسودّة على إعلانات التطبيق الأخيرة.
  • أول سياسة للتطبيق تُحسب ضمن حدّ السياسات العاملة في باقتك؛ وإن تجاوزته يكون الرد 403 مع entitlement: max_active_policies.
  • يشرح لك الرد 400 سبب رفض أي قاعدة (العدد، أو المعرّف، أو الطول، أو تكرار المعرّف، أو اللغة، أو الاسم).
GET /v1/apps/{appId}/policy/versions

النطاق read:verdicts. كل الإصدارات، الأحدث أولًا: {"versions": [ ... ]}.

POST /v1/apps/{appId}/policy/estimate

النطاق read:verdicts. لا يغيّر شيئًا. الجسم: rules (مسودّة) وsampleSize (من 1 إلى 200، وهو عدد أحدث إعلانات التطبيق).

Terminal window
curl -s -X POST https://api.ad80.dev/v1/apps/com.example.news/policy/estimate \
-H "Authorization: Bearer $AD80_API_KEY" -H "Content-Type: application/json" \
-d '{"sampleSize": 50, "rules": [{"id": "no-alcohol", "text": "No ads showing alcohol."}]}'
{
"playground": { "creatives": 50, "classifications": 50, "remaining": 186, "allowed": true },
"rescore": { "creatives": 50, "classifications": 50, "remaining": 186, "allowed": true }
}

classifications هو عدد الفحوص اليدوية التي سيستهلكها التشغيل (الإعلانات التي سبق تقييمها بهذه المسودّة نفسها تمامًا مجانية). وremaining هو ما تبقّى لك في هذه الفترة (null = لا حدّ ثابت). وتكون allowed بقيمة false إن كان التشغيل سيتجاوز المتبقّي.

POST /v1/apps/{appId}/policy/playground

النطاق write:policies. الجسم نفسه الذي يأخذه التقدير. يقيّم المسودّة على أحدث sampleSize من الإعلانات، ويضع النتيجة بجانب أحكامها الحالية. لا تصبح المسودّة أبدًا سياسة التطبيق، ولا تصبح نتائجها أحكامه. كل إعلان يُقيَّم للمسودّة يستهلك فحصًا يدويًا واحدًا؛ وإن لم يكفِ الرصيد للتشغيل كاملًا يكون الرد 403 مع entitlement. ويكون الرد 503 حين تتعذّر تجربة المسودّات مؤقتًا.

{
"runId": "...",
"charged": 50,
"remaining": 136,
"currentVersion": 3,
"rows": [
{
"creativeId": "ad80px1:...",
"width": 960,
"height": 150,
"imageUrl": "https://api.ad80.dev/v1/images/...",
"current": { "state": "OK", "violates": false, "scores": [ "..." ], "policyVersion": 3 },
"draft": { "state": "OK", "violates": true, "scores": [ "..." ] }
}
]
}