我们能为您提供什么帮助?

应用所有者的应用列表 API

  • 更新

概览:获取与您的 AppsFlyer 账户关联的已启用和待处理应用列表。

mceclip0.png

如果您是广告平台,请使用广告平台专用的应用列表 API。

延伸阅读:广告主 API 列表

获取应用列表 API

以下章节介绍使用此 API 所需的信息。 

获取应用列表基本信息

API 基本信息

类别 项目 说明
请求 HTTP 方法 GET
请求路径 https://hq1.appsflyer.com/api/mng/apps
授权请求 header 
 响应 返回格式 JSON
请求频率限制
  • 每分钟 20 次请求
  • 每日 100 次请求
单次请求的记录数限制 每次请求最多返回 1,000 条记录。如果记录数超过 1,000 条,请按照本文介绍的分页机制继续发送请求。

API 请求

API 请求包含 HTTP 方法、请求路径、必需的功能权限参数以及可选的分页参数。令牌需放在授权请求 header中。 

请求方法

GET https://hq1.appsflyer.com/api/mng/apps

获取应用列表的必需参数:

查询参数 说明
   此 API 无必需的查询参数。


分页机制

此 API 始终启用分页机制。 

分页规则: 

  • 每次请求(每页)最多返回 1,000 条记录。
  • JSON 响应中包含以下与分页相关的字段:
    • meta.total_items:所有分页合计需要返回的记录总数。即您拥有所查询功能权限的应用总数。
    • 分页链接(如下方 JSON 所示)包含以下字段:
      • links.prev:如果存在上一页,该字段提供生成上一页数据的请求地址。
      • links.self:当前页的请求地址,即生成当前 JSON(页面)的请求地址。
      • links.next:获取下一页所需的请求地址。如果不存在 next 字段,表示当前页是最后一页。 

 您可以采用以下任一方式控制分页:

  • 【推荐】使用 JSON 中的 links 字段:如果存在 links.next 字段,请使用该字段生成请求下一页的地址。重复此操作,直到收到的 JSON 中不再包含 links.next 字段。
  • 结合 total_items 字段,在程序中使用 limit 和 offset 参数实现分页。

分页链接的 JSON 示例

  • 以下示例展示了第二次请求的结果,其中 data 部分包含 2 条记录(未展示具体内容)。 
  • 所有分页需要返回的记录总数为 6 条。
  • links.next 字段提供了获取下一页(第 5 条和第 6 条记录)的请求地址。 
{                                                                                         
    "data": {[...]},   
    "meta": {
        "total_items": 6
    },
    "links": {
        "prev": "https://hq1.appsflyer.com/api/mng/apps?offset=0&limit=2",
        "self": "https://hq1.appsflyer.com/api/mng/apps?offset=2&limit=2",
        "next": "https://hq1.appsflyer.com/api/mng/apps?offset=4&limit=2"
    }
}

分页参数(可选):

查询参数 说明
limit

每次请求返回的记录数。

  • 最大值:1,000
  • 如果未指定limit,系统默认设置为 1,000。
  • 示例:limit=2
  • 是否必需:否
offset

指定本次请求从第几条记录开始返回。记录编号从 0 开始。 

  • 如果未指定 offset,系统默认设置为 0。
  • 示例:offset=2
  • 是否必需:否

JSON 响应

字段 说明
id 应用 ID。例如:id123456789、com.myapp.com
type 始终返回 app 
name 应用名称
platform 应用平台:iOS 或 Android
currency 应用专属货币代码 
time_zone 应用专属时区
total_items 账户中包含的应用总数
links

分页链接(具体说明见参数章节)

  • prev:生成上一页数据的请求地址
  • self:生成当前页数据的请求地址
  • next:生成下一页数据的请求地址

获取应用列表的 cURL 请求示例及响应

cURL 请求

以下示例展示了完整的 API 请求,其中包含可选的分页参数。 

cURL --location --request GET 'https://hq1.appsflyer.com/api/mng/apps?limit=1000&offset=0' \
-H 'Authorization: Bearer {控制面板中可获取的、长度超过 700 个字符的 API V2.0 令牌。}' \

JSON 响应

{
    "data": [
        {
            "id": "com.appsflyer.xpend_qa1",
            "type": "app",
            "attributes": {
                "name": "com.appsflyer.xpend_qa1",
                "platform": "android",
                "currency": "USD",
                "time_zone": "UTC"
            }
        },
        {
            "id": "com.abc.app",
            "type": "app",
            "attributes": {
                "name": "com.abc.app",
                "platform": "android",
                "currency": "USD",
                "time_zone": "UTC",
                "enable_retargetting": true
            }
        },
        {
            "id": "com.def.app",
            "type": "app",
            "attributes": {
                "name": "com.def.app",
                "platform": "android",
                "currency": "JPY",
                "time_zone": "UTC"
            }
        }
    ],
    "meta": {
        "total_items": 6
    },
    "links": {
        "self": "https://hq1.appsflyer.com/api/mng/apps?offset=0&limit=1000"
           }
}

HTTP 响应状态码

状态码  消息 说明及故障排查
200 OK 请求成功,已返回有效数据。
200 OK

问题:未返回任何数据

解决方法:检查授权请求 header中是否包含身份验证令牌,并确认令牌使用了 Bearer 认证格式。

400 Bad request(请求无效) 请查看 JSON 响应中包含的具体错误信息。
401 Unauthorized(未授权)

错误信息:授权令牌格式不正确

请确认使用了正确的令牌,且令牌长度超过 700 个字符。

404 Not found(未找到)
  • 检查网络连接或防火墙是否存在问题。 
  • 确认已将 AppsFlyer 的IP 地址添加到允许列表。
  • 确认使用的是最近签发的令牌。
  • 如果提示未找到数据,则表示未找到任何应用。 
429 Too many requests(请求次数过多) 请求次数超出频率限制。请减少请求次数,并确保符合 API 的调用限制。