> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative. > - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key. > - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste. > - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`. > - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt # Pause or enable a Search keyword > Ad Campaigns. A pause needs ads:write. A change to active turns delivery on: it needs ads:spend and X-Aisa-Confirm: spend. Pauses or re-enables a single Google Search keyword. Changes `ad_group_criterion.status` for one keyword criterion (M.140). Negative keywords have no status on Google and cannot be paused or enabled. 当前未提供请求参考价格；请使用接口支持的报价功能确认费用。 最终费用以账户适用价格及实际结算为准。 ## 请求规范 * **方法与路径:** PATCH /apis/v1/ads/keywords/\{keywordId} * **可用状态:** enabled * **请求 URL 模板:** `https://api.aisa.one/apis/v1/ads/keywords/{keywordId}` * **keywordId:** path; 必填 * **connectionId:** query; 必填 * **X-Aisa-Confirm:** header; 可选 * **Runtime 事实版本:** fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09 [完整 OpenAPI 定义](https://aisa.one/docs/reference-contracts/zh/aisa-ads.json) 有效请求与价格声明（包括认证和引用的 schema）： ```json theme={null} { "operationId": "patch_aisa_ads_apis_v1_ads_keywords_keywordid", "method": "PATCH", "path": "/apis/v1/ads/keywords/{keywordId}", "servers": [ { "url": "https://api.aisa.one" } ], "parameters": [ { "description": "1234567890~987654321). A bare criterion id is rejected because it is only unique within its ad group.", "in": "path", "name": "keywordId", "required": true, "schema": { "type": "string" } }, { "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": { "connectionId": "adc_7f3k2m9q", "status": "active" }, "schema": { "additionalProperties": true, "properties": { "connectionId": { "description": "The ads connection (adc_...), when not sent as the connectionId query parameter.", "pattern": "^adc_[0-9A-Za-z]+$", "type": "string" }, "status": { "enum": [ "active", "paused" ], "type": "string" } }, "required": [ "status" ], "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。 ## OpenAPI ````yaml reference-contracts/zh/aisa-ads.json PATCH /apis/v1/ads/keywords/{keywordId} openapi: 3.1.0 info: description: '' title: AIsa Ads version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-configured-paths: [] x-aisa-document: facts_hash: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09 generator_version: '3' protocol_version: '1' schema_version: '1' composer_version: '27' response_pending: [] document_hash: sha256:ba353f59e89e1ebabe0e301d8ef57d3cbfa6bb406a8c591ee9c3833d64b60520 x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: aisa-ads x-aisa-catalogs: aisa-ads: title: AIsa Ads description: '' x-aisa-document: facts_hash: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09 generator_version: '3' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/ads/keywords/{keywordId}: patch: summary: Pause or enable a Search keyword description: >- Ad Campaigns. A pause needs ads:write. A change to active turns delivery on: it needs ads:spend and X-Aisa-Confirm: spend. Pauses or re-enables a single Google Search keyword. Changes `ad_group_criterion.status` for one keyword criterion (M.140). Negative keywords have no status on Google and cannot be paused or enabled. 当前未提供请求参考价格；请使用接口支持的报价功能确认费用。 最终费用以账户适用价格及实际结算为准。 operationId: patch_aisa_ads_apis_v1_ads_keywords_keywordid parameters: - description: >- 1234567890~987654321). A bare criterion id is rejected because it is only unique within its ad group. in: path name: keywordId required: true schema: type: string - 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 requestBody: content: application/json: example: connectionId: adc_7f3k2m9q status: active schema: additionalProperties: true properties: connectionId: description: >- The ads connection (adc_...), when not sent as the connectionId query parameter. pattern: ^adc_[0-9A-Za-z]+$ type: string status: enum: - active - paused type: string required: - status type: object required: true responses: '200': content: application/json: schema: properties: keyword: properties: adAccountId: description: Google customer ID type: string adSetId: description: Google ad group ID type: string adSetName: type: - string - 'null' adSetStatus: type: - string - 'null' campaignId: type: string campaignName: type: - string - 'null' campaignStatus: type: - string - 'null' connectionId: description: The ads connection (adc_...) the object belongs to. type: - string - 'null' id: description: >- Accepted as `keywordId` by PATCH/DELETE /apis/v1/ads/keywords/{keywordId}. type: string keyword: type: string matchType: enum: - exact - phrase - broad - unknown type: string metrics: description: >- Trailing 30-day window. Null on rows synced before the metrics columns existed (re-synced on the keyword's next daily sweep). properties: clicks: type: integer conversions: type: number cost: description: Account currency, not USD-normalized type: number firstPageCpc: description: Account currency type: - number - 'null' firstPositionCpc: description: Account currency type: - number - 'null' impressions: type: integer windowDays: type: integer type: - object - 'null' negative: type: boolean platform: enum: - google type: string platformCriterionId: description: >- Google ad_group_criterion.criterion_id. Unique only within its ad group (`adSetId`), not across the account. type: string quality: description: >- Google Quality Score and the three component ratings behind it (`ad_group_criterion.quality_info`). Every field is null until Google has rated the keyword: a keyword with too little traffic is unrated, and negatives are never rated. properties: adRelevance: description: >- How closely the ad matches the intent behind the search (`creative_quality_score`). enum: - BELOW_AVERAGE - AVERAGE - ABOVE_AVERAGE - null type: - string - 'null' expectedCtr: description: >- How the click-through rate compares with other ads in the same position (`search_predicted_ctr`). enum: - BELOW_AVERAGE - AVERAGE - ABOVE_AVERAGE - null type: - string - 'null' landingPageExperience: description: >- How relevant and useful the landing page is to people who click (`post_click_quality_score`). enum: - BELOW_AVERAGE - AVERAGE - ABOVE_AVERAGE - null type: - string - 'null' score: description: Quality Score, 1-10. type: - integer - 'null' type: object qualityScore: description: >- Deprecated, use `quality.score`. Google Quality Score, 1-10. Null when unrated. type: - integer - 'null' resourceName: description: >- Google resource name, customers/{adAccountId}/adGroupCriteria/{adSetId}~{platformCriterionId}. type: string status: enum: - active - paused type: string syncedAt: format: date-time type: - string - 'null' type: object type: object description: Keyword updated default: content: application/json: schema: properties: error: properties: code: type: - string - 'null' details: additionalProperties: {} type: - object - 'null' message: type: - string - 'null' param: type: - string - 'null' retryHint: type: - string - 'null' retryable: type: - boolean - 'null' type: type: - string - 'null' type: - object - 'null' type: object description: Error. The code field is stable; see the error catalog. components: securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.