Replace an asset group's listing-group tree
curl --request PUT \
--url https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tree": {
"children": [
{
"dimension": {
"productBrand": {
"value": "example"
},
"productCategory": {
"level": "LEVEL1"
}
}
},
{
"dimension": {
"productBrand": {
"value": "example"
},
"productCategory": {
"level": "LEVEL1"
}
}
}
]
}
}
'import requests
url = "https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters"
payload = { "tree": { "children": [{ "dimension": {
"productBrand": { "value": "example" },
"productCategory": { "level": "LEVEL1" }
} }, { "dimension": {
"productBrand": { "value": "example" },
"productCategory": { "level": "LEVEL1" }
} }] } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tree: {
children: [
{
dimension: {productBrand: {value: 'example'}, productCategory: {level: 'LEVEL1'}}
},
{
dimension: {productBrand: {value: 'example'}, productCategory: {level: 'LEVEL1'}}
}
]
}
})
};
fetch('https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters', 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/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'tree' => [
'children' => [
[
'dimension' => [
'productBrand' => [
'value' => 'example'
],
'productCategory' => [
'level' => 'LEVEL1'
]
]
],
[
'dimension' => [
'productBrand' => [
'value' => 'example'
],
'productCategory' => [
'level' => 'LEVEL1'
]
]
]
]
]
]),
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/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters"
payload := strings.NewReader("{\n \"tree\": {\n \"children\": [\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n },\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tree\": {\n \"children\": [\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n },\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tree\": {\n \"children\": [\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n },\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"assetGroupId": "<string>",
"created": 123,
"removed": 123,
"validateOnly": true
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}AIsa Ads
Replace an asset group's listing-group tree
Ad Campaigns. Changes the ad account without starting or raising spend; audited. validateOnly=true checks the request without acting and needs no confirmation. Replaces the product targeting tree of a Performance Max retail asset group; only works on campaigns linked to Merchant Center. The current product (listing-group) tree is removed and the new one created in one atomic request. Read the current tree with GET on the asset group. Requires a campaign linked to Merchant Center. Other campaigns return 400 LISTING_SOURCE_NOT_ALLOWED from Google.
<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->
PUT
https://api.aisa.one
/
apis
/
v1
/
ads
/
campaigns
/
{campaignId}
/
asset-groups
/
{assetGroupId}
/
listing-group-filters
Replace an asset group's listing-group tree
curl --request PUT \
--url https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tree": {
"children": [
{
"dimension": {
"productBrand": {
"value": "example"
},
"productCategory": {
"level": "LEVEL1"
}
}
},
{
"dimension": {
"productBrand": {
"value": "example"
},
"productCategory": {
"level": "LEVEL1"
}
}
}
]
}
}
'import requests
url = "https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters"
payload = { "tree": { "children": [{ "dimension": {
"productBrand": { "value": "example" },
"productCategory": { "level": "LEVEL1" }
} }, { "dimension": {
"productBrand": { "value": "example" },
"productCategory": { "level": "LEVEL1" }
} }] } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tree: {
children: [
{
dimension: {productBrand: {value: 'example'}, productCategory: {level: 'LEVEL1'}}
},
{
dimension: {productBrand: {value: 'example'}, productCategory: {level: 'LEVEL1'}}
}
]
}
})
};
fetch('https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters', 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/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'tree' => [
'children' => [
[
'dimension' => [
'productBrand' => [
'value' => 'example'
],
'productCategory' => [
'level' => 'LEVEL1'
]
]
],
[
'dimension' => [
'productBrand' => [
'value' => 'example'
],
'productCategory' => [
'level' => 'LEVEL1'
]
]
]
]
]
]),
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/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters"
payload := strings.NewReader("{\n \"tree\": {\n \"children\": [\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n },\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tree\": {\n \"children\": [\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n },\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tree\": {\n \"children\": [\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n },\n {\n \"dimension\": {\n \"productBrand\": {\n \"value\": \"example\"\n },\n \"productCategory\": {\n \"level\": \"LEVEL1\"\n }\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"assetGroupId": "<string>",
"created": 123,
"removed": 123,
"validateOnly": true
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}Request contract
- Method and path: PUT /apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters - campaignId: path; required
- assetGroupId: path; required
- connectionId: query; required
- Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
{
"operationId": "put_aisa_ads_apis_v1_ads_campaigns_campaignid_ass_a1f9dd",
"method": "PUT",
"path": "/apis/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"description": "Google Ads campaign id.",
"in": "path",
"name": "campaignId",
"required": true,
"schema": {
"pattern": "^\\d+$",
"type": "string"
}
},
{
"description": "Google asset group id.",
"in": "path",
"name": "assetGroupId",
"required": true,
"schema": {
"pattern": "^\\d+$",
"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"
}
}
],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"connectionId": "adc_7f3k2m9q",
"tree": {
"children": [
{
"dimension": {
"productBrand": {
"value": "example"
},
"productCategory": {
"level": "LEVEL1"
}
}
},
{
"dimension": {
"productBrand": {
"value": "example"
},
"productCategory": {
"level": "LEVEL1"
}
}
}
]
}
},
"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"
},
"tree": {
"description": "The root of a Performance Max retail listing-group tree (listing source SHOPPING). No children targets all products. Requires a campaign linked to Merchant Center.",
"properties": {
"children": {
"items": {
"properties": {
"children": {
"description": "Makes the node a subdivision. Children share one dimension (and level or index) and include exactly one everything-else node.",
"items": {
"description": "Same shape as its parent.",
"type": "object"
},
"minItems": 2,
"type": "array"
},
"dimension": {
"description": "Exactly one key. Omit the value (for example { productBrand: {} }) for the everything-else node of that level.",
"properties": {
"productBrand": {
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
},
"productCategory": {
"properties": {
"categoryId": {
"description": "Google product category id.",
"type": "string"
},
"level": {
"enum": [
"LEVEL1",
"LEVEL2",
"LEVEL3",
"LEVEL4",
"LEVEL5"
],
"type": "string"
}
},
"required": [
"level"
],
"type": "object"
},
"productChannel": {
"properties": {
"channel": {
"enum": [
"ONLINE",
"LOCAL"
],
"type": "string"
}
},
"type": "object"
},
"productCondition": {
"properties": {
"condition": {
"enum": [
"NEW",
"REFURBISHED",
"USED"
],
"type": "string"
}
},
"type": "object"
},
"productCustomAttribute": {
"properties": {
"index": {
"enum": [
"INDEX0",
"INDEX1",
"INDEX2",
"INDEX3",
"INDEX4"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"index"
],
"type": "object"
},
"productItemId": {
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
},
"productType": {
"properties": {
"level": {
"enum": [
"LEVEL1",
"LEVEL2",
"LEVEL3",
"LEVEL4",
"LEVEL5"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"level"
],
"type": "object"
}
},
"type": "object"
},
"excluded": {
"description": "Leaf only. true excludes these products.",
"type": "boolean"
}
},
"required": [
"dimension"
],
"type": "object"
},
"minItems": 2,
"type": "array"
}
},
"type": "object"
},
"validateOnly": {
"default": false,
"type": "boolean"
}
},
"required": [
"tree"
],
"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"
}
}
}
}
Cost and request rules
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Google Ads campaign id.
Pattern:
^\d+$Google asset group id.
Pattern:
^\d+$Query Parameters
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]+$Body
application/json
The root of a Performance Max retail listing-group tree (listing source SHOPPING). No children targets all products. Requires a campaign linked to Merchant Center.
Show child attributes
Show child attributes
The ads connection (adc_...), when not sent as the connectionId query parameter.
Pattern:
^adc_[0-9A-Za-z]+$