curl --request POST \
--url https://api.interchange.io/api/v2/storefront/esa/{esaId}/sandbox-account/ensure \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/storefront/esa/{esaId}/sandbox-account/ensure"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/storefront/esa/{esaId}/sandbox-account/ensure', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"esaId": "<string>",
"tenantId": "<string>",
"ready": true,
"account": {
"accountId": "<string>",
"name": "<string>",
"status": "<string>",
"advertiserMapped": true,
"operator": "<string>",
"brand": {},
"billing": "<string>",
"gamAdvertiserId": "<string>",
"gamAdvertiserName": "<string>",
"buyerAgentPrincipalId": "<string>",
"sandbox": true
},
"accounts": [
{
"accountId": "<string>",
"name": "<string>",
"status": "<string>",
"advertiserMapped": true,
"operator": "<string>",
"brand": {},
"billing": "<string>",
"gamAdvertiserId": "<string>",
"gamAdvertiserName": "<string>",
"buyerAgentPrincipalId": "<string>",
"sandbox": true
}
],
"missingReason": "<string>",
"ensured": true
}{
"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": {}
}
}Ensure ad server source sandbox account exists
Idempotently create, repair, or reuse the tenant-managed sandbox advertiser account for no-spend buyer-stack tests. An existing sandbox account that is not mapped to the tenant sandbox advertiser is re-ensured upstream so it becomes usable. The caller does not supply a GAM advertiser id; sandbox routing is managed by the source tenant.
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/esa/{esaId}/sandbox-account/ensure \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/storefront/esa/{esaId}/sandbox-account/ensure"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/storefront/esa/{esaId}/sandbox-account/ensure', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"esaId": "<string>",
"tenantId": "<string>",
"ready": true,
"account": {
"accountId": "<string>",
"name": "<string>",
"status": "<string>",
"advertiserMapped": true,
"operator": "<string>",
"brand": {},
"billing": "<string>",
"gamAdvertiserId": "<string>",
"gamAdvertiserName": "<string>",
"buyerAgentPrincipalId": "<string>",
"sandbox": true
},
"accounts": [
{
"accountId": "<string>",
"name": "<string>",
"status": "<string>",
"advertiserMapped": true,
"operator": "<string>",
"brand": {},
"billing": "<string>",
"gamAdvertiserId": "<string>",
"gamAdvertiserName": "<string>",
"buyerAgentPrincipalId": "<string>",
"sandbox": true
}
],
"missingReason": "<string>",
"ensured": true
}{
"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.
0 < x <= 9007199254740991123
Response
Ensure ad server source sandbox account exists
Result of idempotently ensuring the ESA tenant-managed sandbox account.
Sandbox account row from the managed ad-server source tenant. Sandbox accounts route to the tenant-managed sandbox advertiser and do not carry a caller-selected GAM advertiser id.
Show child attributes
Show child attributes
Show child attributes
Show child attributes