Schedule a budget increase

curl --request POST \
  --url https://api.aisa.one/apis/v1/ads/high-demand-periods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budgetValue": 10,
  "budgetValueType": "ABSOLUTE",
  "timeEnd": 10,
  "timeStart": 10
}
'

import requests

url = "https://api.aisa.one/apis/v1/ads/high-demand-periods"

payload = {
    "budgetValue": 10,
    "budgetValueType": "ABSOLUTE",
    "timeEnd": 10,
    "timeStart": 10
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({budgetValue: 10, budgetValueType: 'ABSOLUTE', timeEnd: 10, timeStart: 10})
};

fetch('https://api.aisa.one/apis/v1/ads/high-demand-periods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/ads/high-demand-periods",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'budgetValue' => 10,
    'budgetValueType' => 'ABSOLUTE',
    'timeEnd' => 10,
    'timeStart' => 10
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/ads/high-demand-periods"

	payload := strings.NewReader("{\n  \"budgetValue\": 10,\n  \"budgetValueType\": \"ABSOLUTE\",\n  \"timeEnd\": 10,\n  \"timeStart\": 10\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/ads/high-demand-periods")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"budgetValue\": 10,\n  \"budgetValueType\": \"ABSOLUTE\",\n  \"timeEnd\": 10,\n  \"timeStart\": 10\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/high-demand-periods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"budgetValue\": 10,\n  \"budgetValueType\": \"ABSOLUTE\",\n  \"timeEnd\": 10,\n  \"timeStart\": 10\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "objectId": "<string>"
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

AIsa Ads

Schedule a budget increase

Ad Accounts. Can spend money or change spend: needs the ads:spend scope and X-Aisa-Confirm: spend; without the header the request is refused with confirmation_required and nothing is sent. Schedules a budget increase for a period. Schedules a temporary budget increase on a Meta campaign or ad set for a busy period, like Black Friday or a launch. Same target rule as the GET: exactly one of `campaignId` / `adSetId`. ### Meta constraints `timeStart` / `timeEnd` must fall on a 15-minute boundary. A campaign cannot mix `ABSOLUTE` and `MULTIPLIER` across its schedules.  当前未提供请求参考价格；请使用接口支持的报价功能确认费用。最终费用以账户适用价格及实际结算为准。

POST

https://api.aisa.one

apis

ads

high-demand-periods

Schedule a budget increase

curl --request POST \
  --url https://api.aisa.one/apis/v1/ads/high-demand-periods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budgetValue": 10,
  "budgetValueType": "ABSOLUTE",
  "timeEnd": 10,
  "timeStart": 10
}
'

import requests

url = "https://api.aisa.one/apis/v1/ads/high-demand-periods"

payload = {
    "budgetValue": 10,
    "budgetValueType": "ABSOLUTE",
    "timeEnd": 10,
    "timeStart": 10
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({budgetValue: 10, budgetValueType: 'ABSOLUTE', timeEnd: 10, timeStart: 10})
};

fetch('https://api.aisa.one/apis/v1/ads/high-demand-periods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/ads/high-demand-periods",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'budgetValue' => 10,
    'budgetValueType' => 'ABSOLUTE',
    'timeEnd' => 10,
    'timeStart' => 10
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/ads/high-demand-periods"

	payload := strings.NewReader("{\n  \"budgetValue\": 10,\n  \"budgetValueType\": \"ABSOLUTE\",\n  \"timeEnd\": 10,\n  \"timeStart\": 10\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/ads/high-demand-periods")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"budgetValue\": 10,\n  \"budgetValueType\": \"ABSOLUTE\",\n  \"timeEnd\": 10,\n  \"timeStart\": 10\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/high-demand-periods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"budgetValue\": 10,\n  \"budgetValueType\": \"ABSOLUTE\",\n  \"timeEnd\": 10,\n  \"timeStart\": 10\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "objectId": "<string>"
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

请求规范

方法与路径: POST /apis/v1/ads/high-demand-periods
可用状态: enabled
请求 URL 模板: https://api.aisa.one/apis/v1/ads/high-demand-periods
connectionId: query; 必填
X-Aisa-Confirm: header; 可选
Runtime 事实版本: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09

完整 OpenAPI 定义有效请求与价格声明（包括认证和引用的 schema）：

{
  "operationId": "post_aisa_ads_apis_v1_ads_high_demand_periods",
  "method": "POST",
  "path": "/apis/v1/ads/high-demand-periods",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "description": "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.",
      "in": "query",
      "name": "connectionId",
      "required": true,
      "schema": {
        "pattern": "^adc_[0-9A-Za-z]+$",
        "type": "string"
      }
    },
    {
      "description": "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.",
      "in": "header",
      "name": "X-Aisa-Confirm",
      "required": false,
      "schema": {
        "enum": [
          "spend"
        ],
        "type": "string"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "example": {
          "budgetValue": 10,
          "budgetValueType": "ABSOLUTE",
          "connectionId": "adc_7f3k2m9q",
          "timeEnd": 10,
          "timeStart": 10
        },
        "schema": {
          "additionalProperties": true,
          "properties": {
            "adSetId": {
              "description": "Platform ad set id. Exactly one of campaignId / adSetId. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
              "type": "string"
            },
            "budgetValue": {
              "description": "With ABSOLUTE, a budget in the ad account's currency in WHOLE units (50 = $50.00). With MULTIPLIER, a factor of the existing budget (2 = double it) and NOT a currency amount.",
              "type": "number"
            },
            "budgetValueType": {
              "enum": [
                "ABSOLUTE",
                "MULTIPLIER"
              ],
              "type": "string"
            },
            "campaignId": {
              "description": "Platform campaign id. Exactly one of campaignId / adSetId. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
              "type": "string"
            },
            "connectionId": {
              "description": "The ads connection (adc_...), when not sent as the connectionId query parameter.",
              "pattern": "^adc_[0-9A-Za-z]+$",
              "type": "string"
            },
            "currency": {
              "description": "Ad account currency, for the ABSOLUTE minor-unit conversion. Ignored for MULTIPLIER.",
              "type": "string"
            },
            "recurrenceType": {
              "enum": [
                "ONE_TIME",
                "WEEKLY",
                "MONTHLY"
              ],
              "type": "string"
            },
            "timeEnd": {
              "description": "Unix seconds, on a 15-minute boundary and after timeStart.",
              "type": "integer"
            },
            "timeStart": {
              "description": "Unix seconds, on a 15-minute boundary (:00, :15, :30, :45).",
              "type": "integer"
            }
          },
          "required": [
            "budgetValue",
            "budgetValueType",
            "timeEnd",
            "timeStart"
          ],
          "type": "object"
        }
      }
    },
    "required": true
  },
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "description": "Ads operations are free. Ad spend is billed by the ad platform to the connected ad account, never by AIsa.",
    "kind": "no_customer_charge"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

费用与请求规则

当前未提供请求参考价格；请使用接口支持的报价功能确认费用。最终费用以账户适用价格及实际结算为准。公开参考值不是你的账户报价或最终扣费。对于支持 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

查询参数

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

budgetValue

number

必填

With ABSOLUTE, a budget in the ad account's currency in WHOLE units (50 = $50.00). With MULTIPLIER, a factor of the existing budget (2 = double it) and NOT a currency amount.

budgetValueType

enum<string>

必填

可用选项:

ABSOLUTE,

MULTIPLIER

timeEnd

integer

必填

Unix seconds, on a 15-minute boundary and after timeStart.

timeStart

integer

必填

Unix seconds, on a 15-minute boundary (:00, :15, :30, :45).

adSetId

string

Platform ad set id. Exactly one of campaignId / adSetId. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.

campaignId

string

Platform campaign id. Exactly one of campaignId / adSetId. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.

connectionId

string

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

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

currency

string

Ad account currency, for the ABSOLUTE minor-unit conversion. Ignored for MULTIPLIER.

recurrenceType

enum<string>

可用选项:

ONE_TIME,

WEEKLY,

MONTHLY

响应

Budget schedule created

string

Meta budget schedule id.

objectId

string

The campaign / ad set the schedule was attached to.

​请求规范

​费用与请求规则

授权

请求头

查询参数

请求体

响应

请求规范

费用与请求规则