Panggilan API

Lihat contoh Panggilan API untuk menggunakan Mesin Aturan Iklan.

Baca Semua Aturan Akun

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

Baca Aturan

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

Perbarui Aturan

Untuk memperbarui spesifikasi, menyediakan semua kolom, termasuk yang tidak berubah. Berikut adalah contoh pembaruan pemicu aturan untuk setiap 1000 impresi. Memperbarui status aturan tidak memerlukan perubahan spesifikasi.

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>

Berikut adalah contoh memperbarui filter untuk memilih semua iklan yang memiliki lebih dari 200 klik. Filter lain seperti entity_type dan time_preset masih harus ada dalam pembaruan ini.

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>

Hapus Aturan

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

Akses Riwayat Pelaksanaan Aturan

Ada endpoint untuk mengakses data historis untuk setiap pelaksanaan aturan. Secara default, endpoint ini menyediakan data yang relevan, seperti hasil dan tindakan. Anda juga bisa memeriksa status aturan di setiap pelaksanaan untuk melacak pengeditan.

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

Selain itu, endpoint ini mendukung tiga mekanisme pemfilteran pada data: object_id, action, dan hide_no_changes. Anda bisa memfilter hasil berdasarkan object_id atau action untuk melihat hasil hanya untuk jenis object_id atau action.

Anda juga bisa memfilter hasil menggunakan tanda hide_no_changes untuk mengecualikan semua pelaksanaan yang tidak ada perubahan sama sekali. Anda bisa mengombinasikan filter ini untuk semakin mempersempit hasil.

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

Akses Riwayat Pelaksanaan Akun

Ada endpoint untuk mengakses data riwayat agregat untuk semua aturan di bawah akun Anda. Secara default, endpoint ini menyediakan data relevan yang sama dengan riwayat pelaksanaan aturan, tetapi juga menyertakan ID aturan untuk setiap entri.

Entri pada endpoint ini diurutkan dari yang terbaru hingga terlama. Endpoint ini juga mendukung mekanisme pemfilteran yang sama seperti di atas: object_id, action, dan hide_no_changes.

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

Pratinjau Aturan

Ada endpoint untuk melihat pratinjau evaluasi Aturan Berbasis Jadwal. Saat permintaan POST dikirim, endpoint ini mengembalikan daftar objek yang memenuhi semua filter aturan yang ditentukan pada saat itu.

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

Eksekusi Aturan Secara Manual

Ada endpoint untuk mengeksekusi Aturan Berbasis Jadwal secara manual. Saat permintaan POST dikirim ke endpoint ini, aturan segera dijadwalkan untuk dijalankan.

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

Hasil dapat diambil dari riwayat pelaksanaan saat pelaksanaan aturan selesai.

Baca Aturan yang Mengatur Suatu Objek

Ada endpoint untuk membaca semua aturan yang mengatur setiap iklan, set iklan, dan kampanye iklan. Secara default, suatu aturan mengatur suatu objek jika aturan tersebut mereferensikannya secara statis melalui filter id atau mereferensikannya secara dinamis melalui filter entity_type.

Endpoint ini juga mendukung pass_evaluation opsional. Dengan ini, Anda bisa lebih membatasi daftar aturan, apakah objek tersebut akan lolos filter aturan pada saat itu atau tidak. Jika pass_evaluation adalah true, kami mengembalikan semua aturan yang ketika dipratinjau, akan mengembalikan objek tersebut. Jika false, kami mengembalikan semua aturan yang tidak salah.

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