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