自 2025 年 6 月 10 日起,为了提高整体 API 性能,对于应用 breakdowns 并使用超过 13 个月的 start_date 的标准查询,将不再返回 reach。(对这些请求返回的响应将省略 reach 和相关字段,例如 frequency 和 cpp。)
如要应用 breakdowns 且仍然检索时间跨度超过 13 个月的 reach 值,您可以使用异步任务让每个广告账户每天最多发送 10 个请求。查看 x-Fb-Ads-Insights-Reach-Throttle 标头,以监控您距离流量上限的剩余流量,并注意一旦突破流量上限,请求将省略 reach 和相关字段。
覆盖人数相关细分数据超出自身流量限制阈值时,API 将返回以下错误消息:
Reach-related metric breakdowns are unavailable due to rate limit threshold.
Facebook 成效分析 API 可提供 Facebook 营销活动的表现数据。为保护系统的性能和稳定性,我们采取了保护措施,以便将系统资源公平地分配给各个应用程序。下面所述政策均可能会有更改。
我们使用单次调用数据限制来防止每次查询检索到的数据多到超出系统的处理能力。数据限制有以下 2 种:
这些限制同时适用于同步和异步 /insights 调用,超出限制后系统会返回如下错误:
error_code = 100, CodeException (error subcode: 1487534)
action_target_id 或 product_id 等高基数细分数据,以及广告发布期间等较宽泛的日期范围。/insights 连线,以便检索这一层级的详细数据。例如,首先使用账户层级的查询,通过 level 和 filtering 参数获取较低层级对象的编号清单。在下面的示例中,我们获取记录了一些展示次数的所有广告系列:curl -G \
-d 'access_token=<ACCESS_TOKEN>' \
-d 'level=campaign' \
-d 'filtering=[{field:"ad.impressions",operator:"GREATER_THAN",value:0}]' \
'https://graph.facebook.com/v2.7/act_<ACCOUNT_ID>/insights'
/<campaign_id>/insights 和返回的各个值,在单次调用中查询并为这些广告系列批量发出成效分析请求:curl \
-F 'access_token=<ACCESS_TOKEN>' \
-F 'batch=[ \
{ \
"method": "GET", \
"relative_url": "v24.0/<CAMPAIGN_ID_1>/insights?fields=impressions,spend,ad_id,adset_id&level=ad" \
}, \
{ \
"method": "GET", \
"relative_url": "v24.0/<CAMPAIGN_ID_2>/insights?fields=impressions,spend,ad_id,adset_id&level=ad" \
}, \
{ \
"method": "GET", \
"relative_url": "v24.0/<CAMPAIGN_ID_3>/insights?fields=impressions,spend,ad_id,adset_id&level=ad" \
} \
]' \
'https://graph.facebook.com'
filtering 参数仅检索包含数据的广告对象的成效分析。在 filtering 中指定的字段值使用点号表示对象下包含的字段。请注意,用 STARTS_WITH 和 CONTAIN 筛选时不会更改摘要数据。在此情况下,要使用 IN 运算符。查看 filtering 请求示例:curl -G \
-d 'access_token=<ACCESS_TOKEN>' \
-d 'level=ad' \
-d 'filtering=[{field:"ad.impressions",operator:"GREATER_THAN",value:0},]' \
'https://graph.facebook.com/v24.0/act_<ACCOUNT_ID>/insights'date_preset。自定义日期范围在系统中的运行效率较低。我们更改了广告账户层级的流量限制,以更好地反映所需的 API 调用量,此更改将于 v3.3 版发布起 90 天生效,且适用于所有公开版本。我们会为您的市场营销 API 访问级别和拥有您应用的公司计算出流量限制配额。请参阅访问权限和身份验证。此更改适用于所有广告成效分析 API 端点:GET {adaccount_ID}/insights、GET {campaign_ID}/insights、GET {adset_ID}/insights、GET {ad_ID}/insights、POST {adaccount_ID}/insights、POST {campaign_ID}/insights、POST {adset_ID}/insights、POST {ad_ID}/insights。
我们使用负载限制的目的在于提供最优质的报告体验。我们会衡量 API 调用的流量,以及调用所需的资源。每个应用程序每秒有一个固定的负载限制。超出此限制后,系统会拒绝您的请求。
检查每一次 API 响应中的 x-fb-ads-insights-throttle HTTP 标头,即可了解您的应用是否快要达到其限制,并预估特定查询的负载量。成效分析调用也需遵守 x-ad-account-usage HTTP 标头中所示的默认广告账户限制。如需获取更多详情,请参阅此处的市场营销 API > 最佳实践
应用达到其限制后,发出调用就会收到一个带有 error_code = 4, CodedException 的错误响应。您的负载应低于限制。如果应用达到允许的限制,则只有特定百分比的请求可以成功,具体取决于查询和流量。
我们对每个联合发送同步与异步 /insights 调用的应用使用流量限制。系统会按照应用程序和广告账户来计算这两个主要的参数限制。
下面是 HTTP 标头的示例,将应用程序的累计负载作为限制的百分比:
X-FB-Ads-Insights-Throttle: { "app_id_util_pct": 100, "acc_id_util_pct": 10, "ads_api_access_tier": "standard_access" }“x-fb-ads-insights-throttle”标头是 JSON 值,包含以下信息:
app_id_util_pct — 表示相关 app_id(应用编号)所消耗的流量在额定容量中所占的百分比。acc_id_util_pct — 表示相关 ad account_id(广告账户编号)所消耗的流量在额定容量中所占的百分比。ads_api_access_tier — 允许您的应用访问市场营销 API 的级别。其中的 standard_access 使用较低的流量限制。在 /insights 端点的全球负载升高期间,系统可以限制请求数量,以便保护后端。在过多高复杂度查询(时间范围大、指标复杂和/或广告对象编号数量庞大)同时出现这样的极少数情况下,可发生上述情况。这一情况将在错误中得以体现,如下所示:
error_code = 4, CodeException (error subcode: 1504022), error_title: Too many API requests
在此期间,建议减少调用,稍等片刻,再进行查询。
/insights 查询。/insights 查询。ads_api_access_tier。默认情况下,应用为 development_access 级别,standard_access 则使用较低的流量限制。如需获取更高的流量上限并达到标准级别,您可以申请广告管理标准访问权功能的“高级访问级别”。获取许多对象的统计数据,并应用筛选条件和排序;我们已简化异步工作流程:
<AD_OBJECT>/insights 端点发送 POST 请求,响应中将提供广告报告运行的 id。{
"report_run_id": 6023920149050,
}
请勿保存 report_run_id 以备长期使用,其有效期只有 30 天。
async_status。当 async_status 为 Job Completed,且 async_percent_completion 为 100 后,再轮询此字段。{
"id": "6044775548468",
"account_id": "1010035716096012",
"time_ref": 1459788928,
"time_completed": 1459788990,
"async_status": "Job Completed",
"async_percent_completion": 100
}
<AD_REPORT_RUN_ID>/insights 连线,获取最终成效数据。{
"data": [
{
"impressions": "9708",
"date_start": "2009-03-28",
"date_stop": "2016-04-04"
},
{
"impressions": "18841",
"date_start": "2009-03-28",
"date_stop": "2016-04-04"
}
],
"paging": {
"cursors": {
"before": "MAZDZD",
"after": "MQZDZD"
}
}
}
此任务将获得对应账户的所有统计数据,并返回一个异步任务编号:
curl \ -F 'level=campaign' \ -F 'access_token=<ACCESS_TOKEN>' \ https://graph.facebook.com/v24.0/<CAMPAIGN_ID>/insights curl -G \ -d 'access_token=<ACCESS_TOKEN>' \ https://graph.facebook.com/v24.0/1000002 curl -G \ -d 'access_token=<ACCESS_TOKEN>' \ https://graph.facebook.com/v24.0/1000003/insights
| 状态 | 描述 |
|---|---|
| 任务尚未开始。 |
| 任务已开始,但尚未运行。 |
| 任务已开始运行。 |
| 任务成功完成。 |
| 任务失败。请审核您的查询,并重试。 |
| 任务已过期并跳过。请重新提交任务,并重试。 |
我们提供了一个便捷端点,用于将 <AD_REPORT_RUN_ID> 导出为经本地化的人类可读格式。
注意:此端点不属于我们正式版本图谱 API 的组成部分,因此不符合其破坏性更改政策。导出结果的格式可能会意外改变,因此脚本和程序不应依赖结果的格式。
curl -G \ -d 'report_run_id=<AD_REPORT_RUN_ID>' \ -d 'name=myreport' \ -d 'format=xls' \ 'https://www.facebook.com/ads/ads_insights/export_report/'
| 名称 | 描述 |
|---|---|
字符串 | 已下载文件的名称 |
enum{csv,xls} | 文件格式 |
整数 | 待运行报告的编号 |
字符串 | 已登录用户授予的权限。提供此权限才能导出其他用户的报告。 |