分析報告 API 第 2 版

本指南為您介紹透過執行 Audience Network 分析報告 API 第 2 版(v2)獲取企業成效資料的方法。

必要條件

建議

  • 由於每次查詢都有大量資料傳回,我們建議使用游標型分頁 。如果是同步要求,分頁結果會即時傳回。這是檢索資料細節的首選方法。

限制

  • 所有資料將會以格林威治標準時間時區傳回
  • 收益衡量數據根據展示次數傳回
    • 如果資料無法提供,我們建議查詢總展示次數和收益
  • 營利管理工具或企業管理平台產生的用戶存取憑證無法使用

彙總整理功能更新內容

每日展示次數和收益

此例子查詢 2022 年 5 月 1 日至 4 日某版位的展示次數和收益,並且取得當中的每日資料細節。

可能發生的改變:在此變更生效後,您可能無法查看某些資料。

由於 API 回應中的「results」欄位不會顯示數量太少的展示次數,因此系統不會在此處顯示收益和每千次廣告展示成本資料點,而是會在「omitted_results」欄位中加入相應條目,當中會顯示「time」、「metric」和「breakdowns」欄位,但不會顯示具體數值;詳情請參閱本頁面底部的回應範例。

要求語法

使用 GET ID > adnetworkanalytics 端點,取得企業、資產或應用程式的 Audience Network 洞察報告。

GET /<ID>/adnetworkanalytics

GET 要求範例

如要取得洞察報告,請向 /<ID>/adnetworkanalytics 端點傳送 GET 要求,以及衡量數據逗號分隔清單和選用的資料細節逗號分隔清單,其中 <ID> 是您的 Meta 企業編號、資產編號或應用程式編號。下方例子取得單個 24 小時範圍內的衡量數據,並將每個衡量數據的結果限制為 2 個回應。

我們已設定特定格式以便閱讀。請記得以您自己的值取代粗體和斜體的預留位置值。
curl -X GET https://graph.facebook.com/v19.0/BUSINESS_ID/adnetworkanalytics
  ?metrics=["fb_ad_network_request","fb_ad_network_imp","fb_ad_network_click","fb_ad_network_revenue"]
  &breakdowns=["placement","country"]
  &since=2021-08-06
  &until=2021-08-06
  &limit=2

回應範例

{
  "data": [
    {
      "query_id": "531234567890123456789012345683d6",
      "results": [
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_imp",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "1200"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_imp",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AU"
            }
          ],
          "value": "35"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_revenue",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "21.212345"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_request",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AD"
            }
          ],
          "value": "1"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_request",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "12"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_click",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "1"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_click",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "CA"
            }
          ],
          "value": "2"
        }
      ],
      "omitted_results": [
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_revenue",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AU"
            }
          ]
        }
      ]
    }
  ],
  "paging": {
    "cursors": {
      "before": "MAZDZD",
      "after": "MQZDZD"
    },
    "next": "https://graph.facebook.com/v10.0/142440604406900/adnetworkanalytics?access_token=<ACCESS_TOKEN>&since=2021-08-06&until=2021-08-06&breakdowns=%5B%22placement%22%2C%22country%22%5D&limit=2&metrics=%5B%22fb_ad_network_request%22%2C%22fb_ad_network_imp%22%2C%22fb_ad_network_click%22%2C%22fb_ad_network_revenue%22%5D&after=MQZDZD"
  }
}

參考資料

查詢參數

參數說明

aggregation_period

aggregation_period=hour|day|total


day(預設)、hourtotal 彙總結果。限制:如要按小時彙總結果,您必須使用 sinceuntil 查詢最少 2 天的結果。

breakdowns

breakdowns=['breakdown_1', 'breakdown_2',...]


同步要求沒有限制可包含的資料細節數量。

資料細節分類說明

ad_space

按廣告空間細分的資料細節

country

按國家/地區細分的資料細節

delivery_method

如果衡量數據來自透過 Audience Network 出價刊登的廣告,請按 standardbidding 細分資料細節。僅適用於使用營利管理工具的發佈商。

fail_reason

僅適用於 fb_ad_network_no_fillfb_ad_network_no_bid 衡量數據。

placement

按照版位編號細分的資料細節。無法與 placement_name 一同使用。

placement_name

按版位編號和版位名稱細分的資料細節。無法與 placement 一同使用。

platform

按平台細分的資料細節。iosandroidmobile_webinstant_games僅適用於使用營利管理工具的發佈商。

property

按資產編號細分的資料細節

filters

filters=[{'field':'country', 'operator':'in', 'values':['US', 'JP']}]


進一步篩選回應,可取得更精準的結果。fieldoperatorvalues 鍵值組合為必要項目。values 為值的逗號分隔清單。目前僅支援 in 運算子。

fieldvalues

country

雙字母國家/地區縮寫的逗號分隔清單

placement

版位編號。限制:若展示次數不足,此值為「REDACTED」。

delivery_method

standardbidding

platform

可以是 ios(流動應用程式)、android(流動應用程式)、mobile_webinstant_games

limit

limit=500


要傳回的列數。限制:同步要求的上限為 2,000。

metrics

此為必要項目。


metrics=['metric_1', 'metric_2',...]


最少需要一個衡量數據,但一個要求中可包含的衡量數據數量不設上限。

ordering_column

ordering_column=time|value


按時間還是值排列的結果排序。如未加入此參數,則預設為 time

ordering_type

ordering_column=ascending|descending


如未加入此參數,則預設為 descending

since

since=YYYY-MM-DDsince=1548880485


查詢的開始日期限制。如未加入時間範圍,則預設為過去 7 天。

限制:

  • 如需使用 Unix 時戳,您必須查詢 1 小時。
  • 同步要求的最大時間範圍為 8 天。
  • 資料僅保留 540 天。如果要求的資料範圍超出 $currentDate - 539 days,則不會傳回額外資料。

until

until=YYYY-MM-DDuntil=1548880485+86400


查詢的結束日期限制

可用衡量數據

衡量數據說明

fb_ad_network_bidding_bid_rate

出價回應率

fb_ad_network_bidding_request

出價要求次數

fb_ad_network_bidding_response

出價回應次數

fb_ad_network_bidding_win_rate

出價者競投勝出率

fb_ad_network_click

點擊次數

fb_ad_network_cpm

有效每千次廣告展示成本(eCPM)

fb_ad_network_ctr

估計點擊率

fb_ad_network_fill_rate

廣告要求達標率

fb_ad_network_filled_request

廣告要求達標次數

fb_ad_network_imp

展示次數

fb_ad_network_no_bid

無出價主要原因數量


僅適用於用作單一衡量數據 fail_reason 資料細節的情況

fb_ad_network_no_fill

未獲得廣告供應的主要原因數量


僅適用於用作單一衡量數據 fail_reason 資料細節的情況

fb_ad_network_request

廣告要求

fb_ad_network_revenue

估計收益

fb_ad_network_show_rate

展示次數除以達標量

疑難排解

存取憑證除錯工具

使用存取憑證除錯工具 獲取存取憑證的詳細資訊,其中包括與此憑證相關的權限、有效性、資產存取權和應用程式編號。

錯誤訊息

錯誤訊息或問題解決方法

已過期的憑證

如要達至最佳用戶體驗,請使用長期存取憑證

「Facebook 偵測到 [您的應用程式] 使用 read_audience_network_insights 範圍時,並未使用安全連線來傳輸訊息錯誤。」

確保您的企業已啟用營利管理工具,並已建立最少一項資產。

「查閱專頁、企業、應用程式、網域或事件來源群組的分析資料,而相關資料並非由提出查詢的用戶或應用程式所有。」

檢查企業管理平台設定,以確保您索取的資料由您提出查詢時使用的企業所有。

「不受支援的 GET 要求。編號為「X」的物件並不存在、由於欠缺權限而無法載入,或不支援此操作。請參閱 Graph API 文件。」

覆檢該資產,以確保您索取的資料由自己資產所有。

「存取分析報告 API v2.0 的方式經已更改。您現在需要為自家應用程式安裝 Facebook 登入功能,方可使用此 API。請查看此處的指示:https://developers.facebook.com/docs/facebook-login/」

您曾嘗試使用系統用戶憑證來查詢分析報告 API v2。使用 Facebook 登入以提出查詢,或還原至 v1;如果選擇後者,您日後仍將需要安裝 Facebook 登入。

「錯誤數據:所有應用程式均應該擁有資產」

確保您的企業已啟用營利管理工具,並已建立最少一項資產。

「請減少您所要求的資料數量,然後重新提出要求。」

「您每分鐘可提出最多 250 項查詢」

分析報告 API v2 允許包含多項參數的要求,亦允許使用分頁功能。請儘量減少 API 要求數量。