API reference contents

应用事件提供商配置

应用事件标签

Web 事件标签

应用列表

转化归因

转化事件

应用事件标签

在 Postman 中运行 ❯

GET accounts/:account_id/app_event_tags¶

检索与当前账号关联的部分或所有应用事件标签的详细信息。

它们定义了针对移动应用转化跟踪的每个转化类型设置的转化窗口。

资源 URL¶

https://ads-api.twitter.com/10/accounts/:account_id/app_event_tags

参数¶

名称	说明
account_id 必需	所使用账号的标识符。出现在资源路径中，通常是所有广告商 API 请求的必要参数，不包含 GET accounts。指定账号必须与已验证的用户关联。类型：string 示例：`18ce54d4x5t`
app_event_tag_ids 可选	通过指定以逗号分隔的标识符列表，将响应范围限定为所需的应用事件标签。最多可提供 200 个 ID。类型：string 示例：`jhp`
count 可选	指定每个不同请求尝试检索的记录数量。类型：int 默认值：`200` 最小值、最大值：`1`、`1000`
cursor 可选	指定光标以获取下一页结果。参阅分页了解更多信息。类型：string 示例：`8x7v00oow`
sort_by 可选	根据支持的属性，按升序或降序排序。参阅排序了解更多信息。类型：string 示例：`created_at-asc`
with_deleted 可选	在请求中包含已删除的结果。类型：boolean 默认值：`false` 可能值：`true`、`false`
with_total_count 可选	包含 `total_count` 响应属性。注意：不包含此参数和 `cursor`。注意：包含 `total_count` 的请求速率限制较低，目前设置为每 15 分钟 200 次。类型：boolean 默认值：`false` 可能值：`true`、`false`

请求示例¶

GET https://ads-api.twitter.com/10/accounts/18ce54d4x5t/app_event_tags?app_event_tag_ids=jhp

响应示例¶

{
  "request": {
    "params": {
      "app_event_tag_ids": [
        "jhp"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "provider_app_event_name": null,
      "app_store_identifier": "co.vine.android",
      "post_view_attribution_window": 1,
      "deep_link_scheme": "vine://",
      "id": "jhp",
      "retargeting_enabled": true,
      "conversion_type": "INSTALL",
      "created_at": "2016-12-08T07:49:58Z",
      "post_engagement_attribution_window": 14,
      "provider_app_event_id": null,
      "updated_at": "2016-12-08T23:07:54Z",
      "os_type": "ANDROID",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/app_event_tags/:app_event_tag_id¶

检索与当前账号关联的特定应用事件标签。

它们定义了针对移动应用转化跟踪的每个转化类型设置的转化窗口。

资源 URL¶

https://ads-api.twitter.com/10/accounts/:account_id/app_event_tags/:app_event_tag_id

参数¶

名称说明

account_id
必需

所使用账号的标识符。出现在资源路径中，通常是所有广告商 API 请求的必要参数，不包含 GET accounts。指定账号必须与已验证的用户关联。

类型：string

示例：18ce54d4x5t

app_event_tag_id
必需

请求中对正在操作的应用事件标签的引用。

类型：string

示例：jhp

with_deleted
可选

在请求中包含已删除的结果。

类型：boolean

默认值：false
可能值：true、false

请求示例¶

GET https://ads-api.twitter.com/10/accounts/18ce54d4x5t/app_event_tags/jhp

响应示例¶

{
  "request": {
    "params": {
      "app_event_tag_id": "jhp",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "provider_app_event_name": null,
    "app_store_identifier": "co.vine.android",
    "post_view_attribution_window": 1,
    "deep_link_scheme": "vine://",
    "id": "jhp",
    "retargeting_enabled": true,
    "conversion_type": "INSTALL",
    "created_at": "2016-12-08T07:49:58Z",
    "post_engagement_attribution_window": 14,
    "provider_app_event_id": null,
    "updated_at": "2016-12-08T23:07:54Z",
    "os_type": "ANDROID",
    "deleted": false
  }
}

POST accounts/:account_id/app_event_tags¶

创建与当前账号关联的新应用事件标签。

资源 URL¶

https://ads-api.twitter.com/10/accounts/:account_id/app_event_tags

参数¶

名称	说明
account_id 必需	所使用账号的标识符。出现在资源路径中，通常是所有广告商 API 请求的必要参数，不包含 GET accounts。指定账号必须与已验证的用户关联。类型：string 示例：`18ce54d4x5t`
app_store_identifier 必需	应用商店标识符。类型：string 示例：`com.twitter.android`
conversion_type 必需	转化事件的类型。类型：enum 可能值：`ACHIEVEMENT_UNLOCKED`、`ADDED_PAYMENT_INFO`、`ADD_TO_CART`、`ADD_TO_WISHLIST`、`CHECKOUT_INITIATED`、`CONTENT_VIEW`、`INSTALL`、`INVITE`、`LEVEL_ACHIEVED`、`LOGIN`、`PURCHASE`、`RATED`、`RESERVATION`、`RE_ENGAGE`、`SEARCH`、`SHARE`、`SIGN_UP`、`SPENT_CREDITS`、`TUTORIAL_COMPLETE`、`UPDATE`
os_type 必需	应用的 OS 类型。类型：enum 可能值：`IOS`、`ANDROID`
provider_app_event_id 必需	提供商网站上转化标签的 ID。类型：string 示例：`provider_tag_j5394`
provider_app_event_name 必需	提供商网站上转化标签的名称。类型：string 示例：`provider_name_a4382`
deep_link_scheme 可选	指定与此标签关联的应用的深层链接 URI。类型：string 示例：`twitter://`
post_engagement_attribution_window 可选	这些事件的互动后归因窗口。类型：int 默认值：30 可能值：`1`、`7`、`14`、`30`
post_view_attribution_window 可选	这些事件的查看后归因窗口。类型：int 默认值：1 可能值：`0`、`1`、`7`、`14`、`30`
retargeting_enabled 可选	指定是否应为此应用事件标签启用重定位。类型：boolean 默认值：true 可能值：`true`、`false`

请求示例¶

POST https://ads-api.twitter.com/10/accounts/18ce54d4x5t/app_event_tags?app_store_identifier=com.twitter.android&os_type=ANDROID&conversion_type=PURCHASE&provider_app_event_id=abc123&provider_app_event_name=test-tag

响应示例¶

{
  "data": {
    "provider_app_event_name": "test-tag",
    "app_store_identifier": "com.twitter.android",
    "post_view_attribution_window": 1,
    "deep_link_scheme": "https://",
    "id": "3p3t",
    "retargeting_enabled": true,
    "conversion_type": "PURCHASE",
    "created_at": "2017-09-06T06:58:22Z",
    "post_engagement_attribution_window": 30,
    "provider_app_event_id": "abc123",
    "updated_at": "2017-09-06T06:58:22Z",
    "os_type": "ANDROID",
    "deleted": false
  },
  "request": {
    "params": {
      "provider_app_event_name": "test-tag",
      "app_store_identifier": "com.twitter.android",
      "account_id": "18ce54d4x5t",
      "conversion_type": "PURCHASE",
      "provider_app_event_id": "abc123",
      "os_type": "ANDROID"
    }
  }
}

DELETE accounts/:account_id/app_event_tags/:id¶

删除属于当前账号的指定应用事件标签。

资源 URL¶

https://ads-api.twitter.com/10/accounts/:account_id/app_event_tags/:id

参数¶

名称说明

account_id
必需

所使用账号的标识符。出现在资源路径中，通常是所有广告商 API 请求的必要参数，不包含 GET accounts。指定账号必须与已验证的用户关联。

类型：string

示例：18ce54d4x5t

id
必需

请求中对正在操作的应用事件标签的引用。

类型：string

示例：jhp

请求示例¶

DELETE https://ads-api.twitter.com/10/accounts/18ce54d4x5t/app_event_tags/jhp

响应示例¶

{
  "data": {
    "provider_app_event_name": null,
    "app_store_identifier": "co.vine.android",
    "post_view_attribution_window": 1,
    "deep_link_scheme": "vine://",
    "id": "jhp",
    "retargeting_enabled": true,
    "conversion_type": "INSTALL",
    "created_at": "2016-12-08T07:49:58Z",
    "post_engagement_attribution_window": 14,
    "provider_app_event_id": null,
    "updated_at": "2017-08-30T05:44:57Z",
    "os_type": "ANDROID",
    "deleted": true
  },
  "request": {
    "params": {
      "id": "jhp",
      "account_id": "5gvk9h"
    }
  }
}