Lệnh gọi API

Hãy xem ví dụ về Lệnh gọi API để sử dụng Công cụ quy tắc quảng cáo.

Đọc tất cả quy tắc của tài khoản

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

Đọc quy tắc

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

Cập nhật quy tắc

Để cập nhật quy cách, hãy cung cấp mọi trường, bao gồm cả những trường không thay đổi. Sau đây là ví dụ cập nhật yếu tố kích hoạt quy tắc cho mỗi 1.000 lượt hiển thị. Bạn không cần phải thay đổi quy cách khi cập nhật trạng thái của quy tắc.

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>

Sau đây là ví dụ cập nhật bộ lọc để chọn tất cả quảng cáo có hơn 200 lượt click. Lần cập nhật này vẫn phải bao gồm các bộ lọc khác như entity_type và 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>

Xóa quy tắc

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

Truy cập lịch sử thực thi của quy tắc

Có một điểm cuối để truy cập dữ liệu thực thi trước đây của từng quy tắc. Theo mặc định, điểm cuối này cung cấp dữ liệu liên quan, chẳng hạn như kết quả và hành động. Bạn cũng có thể kiểm tra trạng thái của quy tắc ở mỗi lần thực thi để theo dõi nội dung chỉnh sửa.

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

Ngoài ra, điểm cuối này hỗ trợ 3 cơ chế lọc dữ liệu, đó là: object_id, action và hide_no_changes. Bạn có thể lọc kết quả theo object_id hoặc action để chỉ xem kết quả cho loại object_id hoặc action đó.

Bạn cũng có thể lọc kết quả bằng cờ hide_no_changes để loại trừ tất cả những lần thực thi không có thay đổi nào cả. Bạn có thể kết hợp các bộ lọc này để thu hẹp kết quả hơn nữa.

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

Truy cập lịch sử thực thi của tài khoản

Có một điểm cuối để truy cập dữ liệu lịch sử dạng tổng hợp cho tất cả quy tắc thuộc tài khoản của bạn. Theo mặc định, điểm cuối này cung cấp dữ liệu liên quan giống như lịch sử thực thi của quy tắc, nhưng bao gồm cả ID của quy tắc cho mỗi mục nhập.

Các mục nhập trong điểm cuối này được sắp xếp theo thứ tự từ mới nhất đến cũ nhất. Điểm cuối này cũng hỗ trợ các cơ chế lọc giống như ở trên, đó là: object_id, action và hide_no_changes.

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

Xem trước quy tắc

Có một điểm cuối để xem trước đánh giá về Quy tắc dựa trên lịch chạy. Khi bạn gửi yêu cầu POST, điểm cuối này sẽ trả về danh sách các đối tượng thỏa mãn tất cả bộ lọc được chỉ định của quy tắc ở thời điểm đó.

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

Thực thi quy tắc theo cách thủ công

Có một điểm cuối để thực thi Quy tắc dựa trên lịch chạy theo cách thủ công. Khi bạn gửi yêu cầu POST đến điểm cuối này, hệ thống sẽ lập tức lên lịch chạy quy tắc đó.

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

Bạn có thể tìm nạp kết quả từ lịch sử thực thi khi quá trình thực thi quy tắc hoàn tất.

Đọc quy tắc chi phối cho đối tượng

Có các điểm cuối để đọc tất cả quy tắc chi phối từng quảng cáo, nhóm quảng cáo và chiến dịch quảng cáo. Theo mặc định, quy tắc sẽ chi phối một đối tượng nếu quy tắc tham chiếu tĩnh đến đối tượng đó theo bộ lọc id hoặc tham chiếu động đến đối tượng theo bộ lọc entity_type.

Điểm cuối này cũng hỗ trợ pass_evaluation không bắt buộc. Với bộ lọc này, bạn có thể giới hạn danh sách quy tắc hơn nữa, bằng cách xem đối tượng có vượt qua các bộ lọc của quy tắc ở thời điểm đó hay không. Nếu pass_evaluation là true, chúng tôi sẽ trả về tất cả những quy tắc có trả về đối tượng khi bạn xem trước. Nếu là false, chúng tôi sẽ trả về tất cả những quy tắc không trả về đối tượng.

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