استدعاءات API

راجع أمثلة على استدعاءات API لاستخدام محرك قواعد الإعلانات.

قراءة كل قواعد الحساب

curl -G   \
-d 'fields=name,evaluation_spec,execution_spec,status'   \
-d 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_ACCOUNT_ID>/adrules_library

قراءة قاعدة

curl -G   \
-d 'fields=name,evaluation_spec,execution_spec,status'   \
-d 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

تحديث قاعدة

لتحديث إحدى المواصفات، قم بتوفير كل الحقول، بما في ذلك تلك التي لم تتغير. فيما يلي مثال على تحديث قواعد التشغيل لكل 1000 مرة ظهور. لا يتطلب تحديث حالة القاعدة أي تغييرات في المواصفات.

curl \
-F 'evaluation_spec={
      "evaluation_type": ...,
      "trigger" : {
        "type": "STATS_MILESTONE",
        "field": "impressions",
        "value": 1000,
        "operator": "EQUAL"
      },
      "filters": ...
     ]
   }' \
-F 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

فيما يلي مثال على تحديث الفلاتر لتحديد كل الإعلانات التي لديها أكثر من 200 نقرة. يجب أن تظل الفلاتر الأخرى مثل entity_type وtime_preset في هذا التحديث.

curl \
-F 'evaluation_spec={
      "evaluation_type": ...,
      "filters" : [
       {
         "field": "clicks",
         "value": 200,
         "operator": "GREATER_THAN",
       },
       {
       ...
     ]
   }' \
-F 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

حذف قاعدة

curl -X DELETE \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

الوصول إلى سجل تنفيذ القاعدة

توجد نقطة نهاية للوصول إلى البيانات القديمة لعمليات تنفيذ كل قاعدة. بشكل افتراضي، توفر نقطة النهاية هذه بيانات ذات صلة، مثل النتائج والإجراءات. كما يمكنك أيضًا التحقق من حالة القاعدة في كل تنفيذ لتتبع التعديلات.

curl -G   \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/history

بالإضافة إلى ذلك، تدعم نقطة النهاية هذه ثلاث آليات لفلترة البيانات: object_id وaction وhide_no_changes. يمكنك فلترة النتائج حسب object_id أو action لعرض النتائج فقط لنوع object_id أو action.

كما يمكنك فلترة النتائج باستخدام العلامة hide_no_changes لاستثناء كل التنفيذات التي لا توجد تغييرات عليها على الإطلاق. يمكنك الجمع بين هذه الفلاتر لتضييق نطاق النتائج بشكل أكبر.

curl -G   \
-d 'object_id=123' \
-d 'action=CHANGED_BID' \
-d 'hide_no_changes=true' \
-d "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/history

الوصول إلى سجل تنفيذ الحساب

توجد نقطة نهاية للوصول إلى سجل البيانات المجمعة لكل القواعد ضمن الحساب. بشكل افتراضي، توفر نقطة النهاية هذه البيانات ذات الصلة ذاتها مثل سجل تنفيذ القواعد، ولكن تتضمن أيضًا معرف القواعد لكل إدخال.

يتم ترتيب الإدخالات في نقطة النهاية هذه من الأحدث إلى الأقدم. تدعم نقطة النهاية هذه أيضًا آليات الفلترة ذاتها المذكورة أعلاه: object_id وaction وhide_no_changes.

curl -G   \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_ACCOUNT_ID>/adrules_history

معاينة القاعدة

توجد نقطة نهاية لمعاينة تقييم القاعدة التي تستند إلى الجدولة. عند إرسال طلب POST، ترجع نقطة النهاية هذه قائمة كائنات تعمل على استيفاء كل الفلاتر المحددة للقاعدة في ذلك الوقت.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/preview

تنفيذ قاعدة يدويًا

توجد نقطة نهاية لتنفيذ القاعدة التي تستند إلى الجدولة يدويًا. عند إرسال طلب POST إلى نقطة النهاية هذه، تتم جدولة القاعدة على الفور للتشغيل.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/execute

يمكن الحصول على النتائج من سجل التنفيذ عندما يكتمل تنفيذ القاعدة.

قراءة القواعد السارية للكائن

توجد نقاط نهاية لقراءة كل القواعد السارية لكل إعلان ومجموعة إعلانية وحملة إعلانية. بشكل افتراضي، تسري القاعدة على الكائن إذا كانت تشير إليه بشكل ثابت من خلال فلتر id أو تشير إليه ديناميكيًا من خلال فلتر entity_type.

تدعم نقطة النهاية هذه أيضًا pass_evaluation اختياريًا. من خلاله، يمكنك تقييد قائمة القواعد بشكل أكبر، عن طريق ما إذا كان الكائن سيُدخل فلاتر القاعدة أو لا في ذلك الوقت. إذا تم تعيين pass_evaluation على true، فسنرجع كل القواعد التي ترجع الكائن عند المعاينة. إذا تم التعيين على false، فسنرجع كل القواعد التي لن تفعل ذلك.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_OBJECT_ID>/adrules_governed