Preview catalog activation plan
curl --request POST \
--url https://api.interchange.io/api/v2/buyer/advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.interchange.io/api/v2/buyer/advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.interchange.io/api/v2/buyer/advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"plan": {
"planId": "<string>",
"catalogId": "<string>",
"platformCatalogId": "<string>",
"catalogVersionId": "<string>",
"transformId": "<string>",
"planHash": "<string>",
"itemCount": 4503599627370495,
"campaignGroups": [
{
"key": "<string>",
"name": "<string>",
"fieldValues": {},
"itemIds": [
"<string>"
],
"itemCount": 4503599627370495,
"budget": {
"amount": 1,
"currency": "<string>"
}
}
],
"creativeAssets": [
{
"key": "<string>",
"prompt": "<string>",
"fieldValues": {},
"itemIds": [
"<string>"
],
"itemCount": 4503599627370495
}
],
"syndicationTargets": [
{
"adcpAgentId": "<string>",
"shareStatus": "ready",
"deliveryMode": "native_catalog",
"usesTransformedCatalog": true,
"requiresCreativeAssembly": true,
"creativeAgentId": "<string>",
"reason": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"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": {}
}
}Advertisers
Preview catalog activation plan
Preview or persist the activation plan produced from the current catalog items and a catalog transform.
POST
/
advertisers
/
{advertiserId}
/
catalogs
/
{catalogId}
/
activation-plan
/
preview
Preview catalog activation plan
curl --request POST \
--url https://api.interchange.io/api/v2/buyer/advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.interchange.io/api/v2/buyer/advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.interchange.io/api/v2/buyer/advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"plan": {
"planId": "<string>",
"catalogId": "<string>",
"platformCatalogId": "<string>",
"catalogVersionId": "<string>",
"transformId": "<string>",
"planHash": "<string>",
"itemCount": 4503599627370495,
"campaignGroups": [
{
"key": "<string>",
"name": "<string>",
"fieldValues": {},
"itemIds": [
"<string>"
],
"itemCount": 4503599627370495,
"budget": {
"amount": 1,
"currency": "<string>"
}
}
],
"creativeAssets": [
{
"key": "<string>",
"prompt": "<string>",
"fieldValues": {},
"itemIds": [
"<string>"
],
"itemCount": 4503599627370495
}
],
"syndicationTargets": [
{
"adcpAgentId": "<string>",
"shareStatus": "ready",
"deliveryMode": "native_catalog",
"usesTransformedCatalog": true,
"requiresCreativeAssembly": true,
"creativeAgentId": "<string>",
"reason": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"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
Advertiser ID
Minimum string length:
1Buyer-assigned catalog_id or platform catalog id returned by list catalogs
Minimum string length:
1Body
application/json
Optional ad hoc transform. If omitted, the active catalog transform is used.
Show child attributes
Show child attributes
Optional seller agents to evaluate for upstream catalog/creative syndication. If omitted, enabled catalog syndication targets are used.
Minimum string length:
1Persist this activation plan against the latest catalog version. Requires an active saved transform when transform is omitted.
Response
Preview catalog activation plan
Show child attributes
Show child attributes