メインコンテンツまでスキップ

添加推广

如下所述,您可以通过开发者控制台或我们的 API,为您在 Aptoide Connect 上的某个应用程序创建一个新的推广。

端点

方法URL
POSThttps://ws.catappult.io/api/promotions

认证

要访问此 API,您需要在 Aptoide Connect 上拥有有效的账户订阅,并使用 API 密钥进行认证(请查看此处了解如何生成密钥)。

⚠️
所需的账户类型

推广只能由 Partner 类型的账户创建、编辑或删除。

标头

标头类型是否必需说明
Api-Keystring必需用于认证您的 API 请求。 该值是您的 Aptoide Connect API 密钥。

正文参数

该端点接受 application/jsonmultipart/form-data。 文件上传需要 multipart/form-data

参数类型是否必需说明
applicationNamestring必需推广所属应用程序的唯一软件包名称(例如 com.example.test)。
namestring必需推广的显示名称。
typestring必需推广类型(例如 SEARCH)。
descriptionstring可选推广的自由文本描述。
eventUidstring可选要将此推广关联到的现有活动的 UUID。 设置后,所创建推广的 event 字段将引用该活动。
startTimestampstring可选推广开始日期/时间。 格式:YYYY-MM-DD HH:mm:ss
endTimestampstring可选推广结束日期/时间。 格式:YYYY-MM-DD HH:mm:ss
files[<index>]file可选展示推广外观的图片文件(例如屏幕截图或横幅素材),以 multipart/form-data 形式发送。 使用带索引的键([0][1]、…)来上传多张图片。

示例

通过 JSON 创建推广

curl -X POST "https://ws.catappult.io/api/promotions" \
-H "Api-Key: <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"applicationName": "com.example.test",
"name": "Spring Promotion",
"type": "SEARCH",
"startTimestamp": "2027-01-01 00:00:00",
"endTimestamp": "2027-01-02 00:00:00"
}'

通过 multipart/form-data 创建带素材文件的推广

curl -X POST "https://ws.catappult.io/api/promotions" \
-H "Api-Key: <YOUR_API_KEY>" \
-F "applicationName=com.example.test" \
-F "name=Spring Promotion" \
-F "type=SEARCH" \
-F "startTimestamp=2027-01-01 00:00:00" \
-F "endTimestamp=2027-01-02 00:00:00" \
-F "files[0]=@/path/to/asset-1.png" \
-F "files[1]=@/path/to/asset-2.png"

响应

成功

如果 API 调用返回 HTTP 200 状态码,则表示请求成功,并且推广已创建。 响应正文是新创建推广的 uid(一个 UUID 字符串)。

响应示例

"9dbf70ff-30a4-4d82-b062-42ab24126e59"