List Search keywords

curl --request GET \
  --url https://api.aisa.one/apis/v1/ads/keywords \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/ads/keywords', 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/keywords",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.aisa.one/apis/v1/ads/keywords"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/keywords")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "keywords": [
    {
      "adAccountId": "<string>",
      "adSetId": "<string>",
      "adSetName": "<string>",
      "adSetStatus": "<string>",
      "campaignId": "<string>",
      "campaignName": "<string>",
      "campaignStatus": "<string>",
      "connectionId": "<string>",
      "id": "<string>",
      "keyword": "<string>",
      "matchType": "exact",
      "metrics": {
        "clicks": 123,
        "conversions": 123,
        "cost": 123,
        "firstPageCpc": 123,
        "firstPositionCpc": 123,
        "impressions": 123,
        "windowDays": 123
      },
      "negative": true,
      "platform": "google",
      "platformCriterionId": "<string>",
      "quality": {
        "adRelevance": "BELOW_AVERAGE",
        "expectedCtr": "BELOW_AVERAGE",
        "landingPageExperience": "BELOW_AVERAGE",
        "score": 123
      },
      "qualityScore": 123,
      "resourceName": "<string>",
      "status": "active",
      "syncedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "page": 123,
    "pages": 123,
    "total": 123
  }
}

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

AIsa Ads

List Search keywords

Ad Campaigns. Read only. Lists the keywords and negative keywords in your Google Search ad groups. Returns the Google Search keyword criteria (positive and negative) synced from connected Google Ads accounts, one row per ad-group keyword. Campaign-level negative keywords are not included; only ad-group-level criteria are. ### Freshness  当前未提供请求参考价格；请使用接口支持的报价功能确认费用。最终费用以账户适用价格及实际结算为准。

GET

https://api.aisa.one

apis

ads

keywords

List Search keywords

curl --request GET \
  --url https://api.aisa.one/apis/v1/ads/keywords \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/ads/keywords', 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/keywords",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.aisa.one/apis/v1/ads/keywords"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/keywords")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "keywords": [
    {
      "adAccountId": "<string>",
      "adSetId": "<string>",
      "adSetName": "<string>",
      "adSetStatus": "<string>",
      "campaignId": "<string>",
      "campaignName": "<string>",
      "campaignStatus": "<string>",
      "connectionId": "<string>",
      "id": "<string>",
      "keyword": "<string>",
      "matchType": "exact",
      "metrics": {
        "clicks": 123,
        "conversions": 123,
        "cost": 123,
        "firstPageCpc": 123,
        "firstPositionCpc": 123,
        "impressions": 123,
        "windowDays": 123
      },
      "negative": true,
      "platform": "google",
      "platformCriterionId": "<string>",
      "quality": {
        "adRelevance": "BELOW_AVERAGE",
        "expectedCtr": "BELOW_AVERAGE",
        "landingPageExperience": "BELOW_AVERAGE",
        "score": 123
      },
      "qualityScore": 123,
      "resourceName": "<string>",
      "status": "active",
      "syncedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "page": 123,
    "pages": 123,
    "total": 123
  }
}

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

请求规范

方法与路径: GET /apis/v1/ads/keywords
可用状态: enabled
请求 URL 模板: https://api.aisa.one/apis/v1/ads/keywords
connectionId: query; 必填
page: query; 可选
limit: query; 可选
adAccountId: query; 可选
campaignId: query; 可选
adSetId: query; 可选
status: query; 可选
matchType: query; 可选
negative: query; 可选
search: query; 可选
Runtime 事实版本: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09

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

{
  "operationId": "get_aisa_ads_apis_v1_ads_keywords",
  "method": "GET",
  "path": "/apis/v1/ads/keywords",
  "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": "Page number (1-based)",
      "in": "query",
      "name": "page",
      "required": false,
      "schema": {
        "default": 1,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "in": "query",
      "name": "limit",
      "required": false,
      "schema": {
        "default": 50,
        "maximum": 500,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "Platform ad account ID (Google customer ID). Mirrors the same filter on /apis/v1/ads.",
      "in": "query",
      "name": "adAccountId",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Platform campaign ID Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
      "in": "query",
      "name": "campaignId",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Platform ad group ID (Google ad group) Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
      "in": "query",
      "name": "adSetId",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Keyword criterion status",
      "in": "query",
      "name": "status",
      "required": false,
      "schema": {
        "enum": [
          "active",
          "paused"
        ],
        "type": "string"
      }
    },
    {
      "description": "Accepted in any case.",
      "in": "query",
      "name": "matchType",
      "required": false,
      "schema": {
        "enum": [
          "exact",
          "phrase",
          "broad",
          "unknown"
        ],
        "type": "string"
      }
    },
    {
      "description": "true = negative keywords only, false = positive only. Omit for both.",
      "in": "query",
      "name": "negative",
      "required": false,
      "schema": {
        "type": "boolean"
      }
    },
    {
      "description": "Case-insensitive substring match on the keyword text",
      "in": "query",
      "name": "search",
      "required": false,
      "schema": {
        "maxLength": 200,
        "type": "string"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "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.

查询参数

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]+$

page

integer

默认值:1

Page number (1-based)

必填范围: x >= 1

limit

integer

默认值:50

必填范围: 1 <= x <= 500

adAccountId

string

Platform ad account ID (Google customer ID). Mirrors the same filter on /apis/v1/ads.

campaignId

string

Platform campaign ID Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.

adSetId

string

Platform ad group ID (Google ad group) Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.

status

enum<string>

Keyword criterion status

可用选项:

active,

paused

matchType

enum<string>

Accepted in any case.

可用选项:

exact,

phrase,

broad,

unknown

negative

boolean

true = negative keywords only, false = positive only. Omit for both.

string

Case-insensitive substring match on the keyword text

Maximum string length: 200

响应

Paginated keywords

keywords

object[]

Show child attributes

pagination

object

Show child attributes

​请求规范

​费用与请求规则

授权

查询参数

响应

请求规范

费用与请求规则