开始使用预算使用情况 API

您可以在单个广告活动级别和广告组合级别查看预算使用情况。

每种广告类型都有自己的预算使用情况接口。例如，要查看商品推广活动的预算使用情况，您可以使用 POST /sp/campaigns/budget/usage 接口。

提示

对于广告组合，请使用 POST /portfolios/budget/usage 接口。

广告类型	接口
商品推广	POST /sp/campaigns/budget/usage
品牌推广	POST /sb/campaigns/budget/usage
展示型推广	POST /sd/campaigns/budget/usage

检索一个或多个广告活动的预算使用情况百分比

以下示例展示如何检索品牌推广活动的预算使用情况。所有三种广告类型的模式都相同。

POST /sb/campaigns/budget/usage

请求体

使用情况资源的请求对象对每个请求最多支持 100 个广告活动。

{
` `"campaignIds":  [
  "campaign1"
 ]
}

响应体

成功的响应将返回 207，以及一个预算使用情况响应对象列表，其顺序与输入的顺序相同。

{
` `"success":  [
  {
   "lastUpdatedDate":  "2022-01-05T02:45:32.486Z",
   "budgetUsagePercent": 0,
   "campaignId":  "campaign1",
   "index": 0,
   "budget": 0
 }
 ],
 "error":  [
  {
   "code":  "string",
   "campaignId":  "string",
   "index": 0,
   "details":  "string"
  }
 ]
}

其他示例

以下示例展示了检索 usage 资源时可能出现的几种情况。

此示例展示了所有请求的 campaignIds 均已成功检索。

请求体

{
 "campaignIds": [
  "campaign1",
  "campaign2",
  "campaign3"
 ]
}

响应体

{
` `"success":  [
  {
   "lastUpdatedDate":  "2022-01-05T02:45:32.486Z",
   "budgetUsagePercent": 50,
   "campaignId":  "campaign1",
   "index":  0,
   "budget": 100
  }
  {
   "lastUpdatedDate": "2022-01-05T02:45:32.486Z",
   "budgetUsagePercent": 60,
   "campaignId": "campaign2",
   "index": 1,
   "budget": 100
  }
  {
   "lastUpdatedDate": "2022-01-05T02:45:32.486Z",
   "budgetConsumptionPercent": 75,
   "campaignId": "campaign3",
   "index": 2,
   "budget": 100
  }
 ],
 "error":  [
 ]
}

在以下示例中，成功检索到 campaign1，但 campaign2 和 campaign3 收到错误。

请求体

{
 "campaignIds": [
  "campaign1",
  "campaign2",
  "campaign3"
 ]
}

响应体

{
` `"success":  [
  {
   "lastUpdatedDate":  "2022-01-05T02:45:32.486Z",
   "budgetUsagePercent":  50,
   "campaignId":  "campaign1",
   "index":  0,
   "budget":  100
  }
 ],
 "error": [
  {
   "code": "string",
   "campaignId": "campaign2",
   "index": 1,
   "details": "string"
  }
  {
   "code": "string",
   "campaignId": "campaign3",
   "index": 2,
   "details": "string"
  }
 ]
}

检索广告组合的预算使用情况百分比

广告组合是一组可以按品牌、商品品类或按季节组织的广告活动。以下示例展示了所有请求的 portfolioIds 已成功检索。

[请注意] 要查看与每个广告活动相关的单独预算使用情况百分比，您必须使用该广告类型的列表广告活动资源，然后使用消息头中的 portfolioIdFilter 参数获取一组广告活动对象，这些对象与您在 portfolioIdFilter 参数中指定的广告组合编号相关联。然后，如上所述，您可以使用相关的广告活动预算使用情况资源检索每个广告活动预算使用情况百分比。

POST /portfolios/budget/usage

请求体

使用情况资源的请求对象对每个请求最多支持 100 个广告组合。

{
 "portfolioIds": [
  "`portfolio1`",
  "portfolio2",
  "portfolio3"
 ]
}

响应体

{
` `"success":  [
  {
   "lastUpdatedDate":  "2022-01-05T02:45:32.486Z",
   "budgetUsagePercent":  50,
   "portfolioId":  "portfolio1",
   "index":  0,
   "budget":  100
  }
 ],
 "error": [
  {
   "code": "string",
   "portfolioId": "portfolio2",
   "index": 1,
   "details": "string"
  }
  {
   "code": "string",
   "portfolioId": "portfolio3",
   "index": 2,
   "details": "string"
  }
 ]
}