跳转到主要内容
PUT
Pause or resume a single ad

请求规范

  • 方法与路径: PUT /apis/v1/ads/{adId}/status
  • 可用状态: enabled
  • 请求 URL 模板: https://api.aisa.one/apis/v1/ads/{adId}/status
  • adId: path; 必填
  • connectionId: query; 必填
  • X-Aisa-Confirm: header; 可选
  • Runtime 事实版本: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
完整 OpenAPI 定义 有效请求与价格声明(包括认证和引用的 schema):

费用与请求规则

当前未提供请求参考价格;请使用接口支持的报价功能确认费用。 最终费用以账户适用价格及实际结算为准。 公开参考值不是你的账户报价或最终扣费。对于支持 X-AISA-Cost-Mode: quote 的接口,执行前请针对完整请求获取免费报价;执行后通过响应费用元数据和 Usage Logs 核对结算费用。1 USD 等于 1,000,000 个整数 micro-USD。

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求头

X-Aisa-Confirm
enum<string>

Required with the value "spend" when the request can spend money or change spend. Without it the request is refused with 409 confirmation_required, which describes what would happen; nothing is sent to the ad platform.

可用选项:
spend

路径参数

adId
string
必填

查询参数

connectionId
string
必填

The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.

Pattern: ^adc_[0-9A-Za-z]+$

请求体

application/json
status
enum<string>
必填
可用选项:
active,
paused
connectionId
string

The ads connection (adc_...), when not sent as the connectionId query parameter.

Pattern: ^adc_[0-9A-Za-z]+$

响应

Ad status updated (or skipped when no change was needed)

configuredStatus
string | null

The ad's own on/off switch (ACTIVE / PAUSED), re-read from the platform after the write. Null where the platform exposes no per-ad switch (X) or the read-back failed and the platform does not store one.

message
string

Human-readable summary (present only when skipped), e.g. "No change: the ad's own switch is already off"

skipped
integer

1 when skipped (terminal status, or the ad's own switch already in the target state), else 0

status
string

The ad's delivery status after the call, as the platform reports it when it can be read back (e.g. paused for an ad switched on under a paused campaign)

updated
integer

1 when the switch was written, 0 when skipped