Configure AXE custom-targeting key names
curl --request PUT \
--url https://api.interchange.io/api/v2/storefront/esa/{esaId}/axe-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"axeIncludeKey": "<string>",
"axeExcludeKey": "<string>",
"axeMacroKey": "axem"
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/esa/{esaId}/axe-keys"
payload = {
"axeIncludeKey": "<string>",
"axeExcludeKey": "<string>",
"axeMacroKey": "axem"
}
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({axeIncludeKey: '<string>', axeExcludeKey: '<string>', axeMacroKey: 'axem'})
};
fetch('https://api.interchange.io/api/v2/storefront/esa/{esaId}/axe-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"setupTask": {
"key": "<string>",
"name": "<string>",
"isComplete": true,
"description": "<string>",
"actionUrl": "<string>",
"details": "<string>"
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Storefront Ad Server Buyer Routing
Configure AXE custom-targeting key names
Declare which GAM custom-targeting key names carry Scope3 include, exclude, and emissions-macro targeting on a Google Ad Manager-backed ad server source. axeMacroKey MUST equal literally “axem” — the GAM creative macro %%PATTERN:axem%% only resolves against that exact key name; a rename silently breaks emissions attribution. All three names must already exist as FREEFORM keys in the source’s synced GAM custom-targeting catalog; unknown names are rejected with the list of missing keys.
PUT
/
esa
/
{esaId}
/
axe-keys
Configure AXE custom-targeting key names
curl --request PUT \
--url https://api.interchange.io/api/v2/storefront/esa/{esaId}/axe-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"axeIncludeKey": "<string>",
"axeExcludeKey": "<string>",
"axeMacroKey": "axem"
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/esa/{esaId}/axe-keys"
payload = {
"axeIncludeKey": "<string>",
"axeExcludeKey": "<string>",
"axeMacroKey": "axem"
}
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({axeIncludeKey: '<string>', axeExcludeKey: '<string>', axeMacroKey: 'axem'})
};
fetch('https://api.interchange.io/api/v2/storefront/esa/{esaId}/axe-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"setupTask": {
"key": "<string>",
"name": "<string>",
"isComplete": true,
"description": "<string>",
"actionUrl": "<string>",
"details": "<string>"
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Path Parameters
Ad server source connection id. The wire field remains esaId for API compatibility.
Required range:
0 < x <= 9007199254740991Example:
123
Body
application/json
Response
Configure AXE custom-targeting key names
Show child attributes
Show child attributes