返回开发者新闻

公共主页成效分析 API 入门指南

2022年11月8日发布者:Laura Dalmolin

公共主页成效分析 API 可为您提供与您 Facebook 公共主页相关的重要指标。本指南涵盖与如何开始使用公共主页成效分析 API 相关的所有必要信息:从生成口令到首次请求,无所不包。

准备工作

  1. 对 HTTP、API 和 JavaScript 对象表示法 (JSON) 有基本的了解;

  2. 具有 Meta 开发者帐户(您可以创建一个);

  3. 对某个应用拥有身份,如管理员、开发者或测试者(若无此类应用,您可以创建一个)。建议使用业务类应用,因为该类应用必要的权限已被预先批准;

  4. 具有可供执行 ANALYZE 任务的 Facebook 公共主页。

生成口令

您将需要具有必要权限的公共主页访问口令,可以使用我们的图谱 API 探索工具生成一个。

使用此 API 所需的权限如下:

  • read_insights
  • pages_show_list
  • pages_read_engagement

选择要查询的指标

公共主页成效分析 API 内含数十种不同的指标。点击此处,访问完整的指标列表。

本教程选择的指标是 page_engaged_users 和 page_impressions。

这样,我们的参数将为:metrics=page_engaged_users,page_impressions。

定义时间间隔

您可以设置 since 和 until 参数,定义数据检索的时间间隔。请务必注意,until 参数不包含当天,并且会将 end_time 视为前一天的午夜。举个例子:

假设我们想要获取 2022 年 7 月整个月的指标。

各参数必须设置为:

since=2022-07-01

until=2022-08-02

这样一来,最后一个返回值的 end_time 将是 2022-08-01 午夜,也就是说,返回的是从 2022-07-31 午夜到 2022-08-01 午夜之间的值。

选择汇总周期

汇总周期是指过去 X 天内指标值的总和。如果为该周期选择了 week 值,您将得到从所查询日期开始最近 7 天内指标值的总和。

您可以同时选择多个汇总周期。在本教程中,我们将选择 period=day,week。

注意:某些汇总周期与某些指标不兼容,请务必查看文档

调用 API

您可以使用很多不同的工具来调用 API,如我们的图谱 API 探索工具、Postman 或 CURL。

最后请求:

https://graph.facebook.com/{page-id}/insights?access_token={page-access-token}&metric=page_engaged_users,page_impressions&since=2022-07-01&until=2022-08-02&period=day,week 

了解响应

API 响应为包含一个数据数组的 JSON。该数组的元素对应于所查询的指标及其汇总周期。对于所查询的每一天,您都可以查看相应的 end_date 和指标值。

2022 年 10 月 2 日,公共主页展示次数为 34,824。如果我们使用周汇总周期来查看同一天,得到的值将是 2,384,604。

响应示例:

{
   "data": [
       {
           "name": "page_impressions_unique",
           "period": "day",
           "values": [
               {
                   "value": 34824,
                   "end_time": "2022-10-03T07:00:00+0000"
               },
               {
                   "value": 38637,
                   "end_time": "2022-10-04T07:00:00+0000"
               }
           ],
           "title": "Daily Total Reach",
           "description": "Daily: The number of people who had any content from your Page or about your Page enter their screen. This includes posts, check-ins, ads, social information from people who interact with your Page and more. (Unique Users)",
           "id": "{page-id}/insights/page_impressions_unique/day"
       },
   ]
}