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

编辑推广

您可以通过 Aptoide Connect 开发者控制台 或以编程方式通过此 API 端点更新现有的推广。

端点

方法URL
PATCHhttps://ws.catappult.io/api/promotions/{uid}

身份验证

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

⚠️
所需账户类型

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

请求头

请求头类型是否必需描述
Api-Keystring必需用于对您的 API 请求进行身份验证。其值为您的 Aptoide Connect API 密钥。

路径参数

参数类型描述
uidstring推广的唯一标识符(UUID)(例如 9dbf70ff-30a4-4d82-b062-42ab24126e59)。

请求体参数

所有请求体参数均为 可选 ——只有您在请求中包含的字段才会被更新。该端点接受 application/jsonmultipart/form-data

参数类型描述
namestring更新推广的显示名称。
descriptionstring更新推广的自由文本描述。
eventUidstring通过 UUID 将此推广关联到现有事件。推广的 event 字段将被更新以引用该事件。
startTimestampstring新的推广开始日期/时间。格式:YYYY-MM-DD HH:mm:ss
endTimestampstring新的推广结束日期/时间。格式:YYYY-MM-DD HH:mm:ss
partnerNamestring更新所属合作伙伴标识符。有效值请参阅列出可用合作伙伴
files[<index>]file展示推广外观的图片文件(例如屏幕截图或横幅素材),以 multipart/form-data 形式发送。使用带索引的键([0][1]……)可上传多张图片。
filesIdsstring要保留的现有文件 ID 的逗号分隔列表(例如 385,386)。任何 ID 被列出的现有文件都将被移除。可与 files[<index>] 组合使用,以保留部分文件并添加新文件。
⚠️
注意

要在编辑时保留先前上传的文件,请在 filesIds 中列出它们的 ID。省略它们将移除已存储的文件。

文件上传需要 multipart/form-data ——无法通过 JSON 发送。

示例

通过 JSON 更新文本字段

curl -X PATCH "https://ws.catappult.io/api/promotions/9dbf70ff-30a4-4d82-b062-42ab24126e59" \
-H "Api-Key: <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Promotion Name",
"startTimestamp": "2026-03-16 00:00:00",
"endTimestamp": "2026-04-30 00:00:00"
}'

保留现有文件并添加新文件

curl -X PATCH "https://ws.catappult.io/api/promotions/9dbf70ff-30a4-4d82-b062-42ab24126e59" \
-H "Api-Key: <YOUR_API_KEY>" \
-F "filesIds=385" \
-F "files[0]=@/path/to/new-asset.png"

响应

成功

如果 API 调用返回 HTTP 200 状态码,则表示请求 成功,推广已被更新。

响应示例

"Promotion updated."