报告 API 第 2 版

本指南将向您展示如何实现 Audience Network 报告 API 第 2 版 (v2) 以获取企业表现数据。

前提条件

建议

  • 鉴于每次查询都会返回大量数据,建议使用基于光标的分页 。针对同步请求,系统会立即返回分页结果。对结果分页也是检索细分数据时的首选方法。

限制

  • 所有数据的返回时间均按格林威治标准时间 (GMT) 时区计算
  • 系统基于展示次数返回收入指标
    • 如果数据不可用,我们建议查询总展示次数和收入
  • 变现管理工具或商务管理平台中生成的用户访问口令无法使用

汇总更新

单日展示次数和收入

查询版位在 2022 年 5 月 1 日至 4 日间的展示次数和收入,以及每日细分数据。

可能变更的内容:变更后,可能会有一些数据不可用。

因展示次数不足而无法获得的收入和 CPM 数据点不会包含在 API 响应的 results 字段中。但系统会将相应条目添加到 omitted_results 字段。这些条目包括 time、metric 和 breakdowns 字段,但不包括 value 字段。请参阅本页底部的响应示例。

请求语法

使用 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',...]


至少需要 1 项指标,但请求中可包含的指标数量没有限制。

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 范围时未使用安全连接传输信息。”

确保您的企业已注册变现管理工具,并且已创建至少 1 项资产。

“正在读取不属于查询用户或应用程序的公共主页、企业、应用、域或事件源组的成效分析。”

检查业务设置,以确保请求的数据属于查询的企业。

“不支持 GET 请求。编号为“X”的对象不存在,由于权限缺失无法加载,或不支持此操作。请参阅图谱 API 文档。”

检查资产,以确保请求的是您拥有的资产数据。

“访问报告 API v2.0 的方式已更改。现在需要为应用使用 Facebook 登录才能访问此 API。如需查看说明,请点击此处:https://developers.facebook.com/docs/facebook-login/”

您尝试了使用系统用户口令查询报告 API v2。通过 Facebook 登录进行查询,或还原到 v1(但日后无论如何均需设置 Facebook 登录)。

“参数错误:所有应用程序均应包含资产”

确保您的企业已注册变现管理工具,并且已创建至少 1 项资产。

“请减少请求的数据量,然后重新尝试请求。”

  • 如果使用 dayhour汇总周期,请为限制参数设置 1 个较小值。
  • 如果使用 total 汇总周期,则缩短起始/结束时间参数指定的日期范围持续时间。

“每分钟最多执行 250 次查询”

报告 API V2 允许请求使用多个参数,且允许使用分页功能。请了解尽量少用 API 请求的方式。