From d200d69ba0b659b9a1577d8ca423446615bdcbed Mon Sep 17 00:00:00 2001 From: Adobe Date: Wed, 18 Mar 2026 18:40:58 +0000 Subject: [PATCH] TNT-53639: Add Auto Target Activity CRUD API in Honeybee (#575) --- src/admin-api.json | 1509 +++++++++++++++++++++++++++++--------------- 1 file changed, 1017 insertions(+), 492 deletions(-) diff --git a/src/admin-api.json b/src/admin-api.json index 45d8425ad..8f3aca7a8 100644 --- a/src/admin-api.json +++ b/src/admin-api.json @@ -4000,13 +4000,13 @@ } } }, - "/{tenant}/target/activities/autoallocate/{id}": { + "/{tenant}/target/activities/autotarget/{id}": { "get": { "tags": [ "Activities" ], - "summary": "Get Auto-Allocate activity by ID", - "description": "Fetch the current definition of an Auto-Allocate activity as referenced by the provided ID.", + "summary": "Get Auto-Target activity by ID", + "description": "Fetch the current definition of an Auto-Target activity as referenced by the provided ID.", "operationId": "getActivity", "parameters": [ { @@ -4075,7 +4075,7 @@ "content": { "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/AutoAllocateActivity" + "$ref": "#/components/schemas/AutoTargetActivity" } } } @@ -4086,8 +4086,8 @@ "tags": [ "Activities" ], - "summary": "Update Auto-Allocate activity", - "description": "Update the Auto-Allocate activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.", + "summary": "Update Auto-Target activity", + "description": "Update the Auto-Target activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.", "operationId": "updateActivity", "parameters": [ { @@ -4104,7 +4104,7 @@ "content": { "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/AutoAllocateActivity" + "$ref": "#/components/schemas/AutoTargetActivity" } } }, @@ -4166,7 +4166,7 @@ "content": { "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/AutoAllocateActivity" + "$ref": "#/components/schemas/AutoTargetActivity" } } } @@ -4177,8 +4177,8 @@ "tags": [ "Activities" ], - "summary": "Delete Auto-Allocate activity", - "description": "Delete the Auto-Allocate activity referenced by the provided ID.", + "summary": "Delete Auto-Target activity", + "description": "Delete the Auto-Target activity referenced by the provided ID.", "operationId": "deleteActivity", "parameters": [ { @@ -4247,7 +4247,7 @@ "content": { "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/AutoAllocateActivity" + "$ref": "#/components/schemas/AutoTargetActivity" } } } @@ -4255,13 +4255,13 @@ } } }, - "/{tenant}/target/activities/abt/{id}": { + "/{tenant}/target/activities/autoallocate/{id}": { "get": { "tags": [ "Activities" ], - "summary": "Get AP activity by ID", - "description": "Fetch the current definition of an Automated Personalization activity as referenced by the provided ID.", + "summary": "Get Auto-Allocate activity by ID", + "description": "Fetch the current definition of an Auto-Allocate activity as referenced by the provided ID.", "operationId": "getActivity_1", "parameters": [ { @@ -4328,9 +4328,9 @@ "200": { "description": "OK", "content": { - "application/vnd.adobe.target.v2+json": { + "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/ABTActivity" + "$ref": "#/components/schemas/AutoAllocateActivity" } } } @@ -4341,8 +4341,8 @@ "tags": [ "Activities" ], - "summary": "Update AP activity", - "description": "Update the Automated Personalization activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.\u003cbr/\u003e\u003cb\u003eNote:\u003c/b\u003eCreating auto-target activities is currently not supported through the API.", + "summary": "Update Auto-Allocate activity", + "description": "Update the Auto-Allocate activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.", "operationId": "updateActivity_1", "parameters": [ { @@ -4357,9 +4357,9 @@ ], "requestBody": { "content": { - "application/vnd.adobe.target.v2+json": { + "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/ABTActivity" + "$ref": "#/components/schemas/AutoAllocateActivity" } } }, @@ -4419,9 +4419,9 @@ "200": { "description": "OK", "content": { - "application/vnd.adobe.target.v2+json": { + "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/ABTActivity" + "$ref": "#/components/schemas/AutoAllocateActivity" } } } @@ -4432,8 +4432,8 @@ "tags": [ "Activities" ], - "summary": "Delete AP activity", - "description": "Delete the Automated Personalization activity referenced by the provided ID.", + "summary": "Delete Auto-Allocate activity", + "description": "Delete the Auto-Allocate activity referenced by the provided ID.", "operationId": "deleteActivity_1", "parameters": [ { @@ -4500,9 +4500,9 @@ "200": { "description": "OK", "content": { - "application/vnd.adobe.target.v2+json": { + "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/ABTActivity" + "$ref": "#/components/schemas/AutoAllocateActivity" } } } @@ -4510,13 +4510,13 @@ } } }, - "/{tenant}/target/activities/ab/{id}": { + "/{tenant}/target/activities/abt/{id}": { "get": { "tags": [ "Activities" ], - "summary": "Get AB activity by ID", - "description": "Fetch the current definition of an AB activity as referenced by the provided ID.", + "summary": "Get AP activity by ID", + "description": "Fetch the current definition of an Automated Personalization activity as referenced by the provided ID.", "operationId": "getActivity_2", "parameters": [ { @@ -4583,9 +4583,9 @@ "200": { "description": "OK", "content": { - "application/vnd.adobe.target.v3+json": { + "application/vnd.adobe.target.v2+json": { "schema": { - "$ref": "#/components/schemas/ABActivity" + "$ref": "#/components/schemas/ABTActivity" } } } @@ -4596,8 +4596,8 @@ "tags": [ "Activities" ], - "summary": "Update AB activity", - "description": "Update the AB activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.", + "summary": "Update AP activity", + "description": "Update the Automated Personalization activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.\u003cbr/\u003e\u003cb\u003eNote:\u003c/b\u003eCreating auto-target activities is currently not supported through the API.", "operationId": "updateActivity_2", "parameters": [ { @@ -4612,9 +4612,9 @@ ], "requestBody": { "content": { - "application/vnd.adobe.target.v3+json": { + "application/vnd.adobe.target.v2+json": { "schema": { - "$ref": "#/components/schemas/ABActivity" + "$ref": "#/components/schemas/ABTActivity" } } }, @@ -4674,9 +4674,9 @@ "200": { "description": "OK", "content": { - "application/vnd.adobe.target.v3+json": { + "application/vnd.adobe.target.v2+json": { "schema": { - "$ref": "#/components/schemas/ABActivity" + "$ref": "#/components/schemas/ABTActivity" } } } @@ -4687,8 +4687,8 @@ "tags": [ "Activities" ], - "summary": "Delete AB activity", - "description": "Delete the AB activity referenced by the provided ID.", + "summary": "Delete AP activity", + "description": "Delete the Automated Personalization activity referenced by the provided ID.", "operationId": "deleteActivity_2", "parameters": [ { @@ -4755,9 +4755,9 @@ "200": { "description": "OK", "content": { - "application/vnd.adobe.target.v3+json": { + "application/vnd.adobe.target.v2+json": { "schema": { - "$ref": "#/components/schemas/ABActivity" + "$ref": "#/components/schemas/ABTActivity" } } } @@ -4765,13 +4765,13 @@ } } }, - "/{tenant}/target/activities/xt/{id}": { + "/{tenant}/target/activities/ab/{id}": { "get": { "tags": [ "Activities" ], - "summary": "Get XT activity by ID", - "description": "Fetch the current definition of an Experience Targeting activity as referenced by the provided ID.", + "summary": "Get AB activity by ID", + "description": "Fetch the current definition of an AB activity as referenced by the provided ID.", "operationId": "getActivity_3", "parameters": [ { @@ -4851,8 +4851,8 @@ "tags": [ "Activities" ], - "summary": "Update XT activity", - "description": "Update an Experience Targeting activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.", + "summary": "Update AB activity", + "description": "Update the AB activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.", "operationId": "updateActivity_3", "parameters": [ { @@ -4942,8 +4942,8 @@ "tags": [ "Activities" ], - "summary": "Delete XT activity", - "description": "Delete the Experience Targeting activity referenced by the provided ID.", + "summary": "Delete AB activity", + "description": "Delete the AB activity referenced by the provided ID.", "operationId": "deleteActivity_3", "parameters": [ { @@ -5020,15 +5020,25 @@ } } }, - "/{tenant}/target/responsetokens": { + "/{tenant}/target/activities/xt/{id}": { "get": { "tags": [ - "Response tokens" + "Activities" + ], + "summary": "Get XT activity by ID", + "description": "Fetch the current definition of an Experience Targeting activity as referenced by the provided ID.", + "operationId": "getActivity_4", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } ], - "summary": "Get response tokens", - "description": "Retrieve list of response tokens.", - "operationId": "getResponseTokens", - "parameters": [], "responses": { "400": { "description": "Bad Request", @@ -5083,27 +5093,38 @@ "200": { "description": "OK", "content": { - "application/vnd.adobe.target.v1+json": { + "application/vnd.adobe.target.v3+json": { "schema": { - "$ref": "#/components/schemas/ResponseTokenList" + "$ref": "#/components/schemas/ABActivity" } } } } } }, - "post": { + "put": { "tags": [ - "Response tokens" + "Activities" + ], + "summary": "Update XT activity", + "description": "Update an Experience Targeting activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.", + "operationId": "updateActivity_4", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } ], - "summary": "Create response token", - "description": "Create response token.", - "operationId": "createResponseToken", "requestBody": { "content": { - "application/vnd.adobe.target.v1+json": { + "application/vnd.adobe.target.v3+json": { "schema": { - "$ref": "#/components/schemas/ResponseTokenDTO" + "$ref": "#/components/schemas/ABActivity" } } }, @@ -5160,28 +5181,36 @@ } } }, - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { - "application/vnd.adobe.target.v1+json": { + "application/vnd.adobe.target.v3+json": { "schema": { - "$ref": "#/components/schemas/ResponseTokenDTO" + "$ref": "#/components/schemas/ABActivity" } } } } } - } - }, - "/{tenant}/target/properties": { - "get": { + }, + "delete": { "tags": [ - "Properties" + "Activities" + ], + "summary": "Delete XT activity", + "description": "Delete the Experience Targeting activity referenced by the provided ID.", + "operationId": "deleteActivity_4", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } ], - "summary": "List properties", - "description": "Retrieve list of all properties.", - "operationId": "getProperties", - "parameters": [], "responses": { "400": { "description": "Bad Request", @@ -5236,32 +5265,25 @@ "200": { "description": "OK", "content": { - "application/vnd.adobe.target.v1+json": { + "application/vnd.adobe.target.v3+json": { "schema": { - "$ref": "#/components/schemas/PropertyList" + "$ref": "#/components/schemas/ABActivity" } } } } } - }, - "post": { + } + }, + "/{tenant}/target/responsetokens": { + "get": { "tags": [ - "Properties" + "Response tokens" ], - "summary": "Create a property", - "description": "Create a property.", - "operationId": "createProperty", - "requestBody": { - "content": { - "application/vnd.adobe.target.v1+json": { - "schema": { - "$ref": "#/components/schemas/Property" - } - } - }, - "required": true - }, + "summary": "Get response tokens", + "description": "Retrieve list of response tokens.", + "operationId": "getResponseTokens", + "parameters": [], "responses": { "400": { "description": "Bad Request", @@ -5313,33 +5335,30 @@ } } }, - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/Property" + "$ref": "#/components/schemas/ResponseTokenList" } } } } } - } - }, - "/{tenant}/target/offers/recs": { + }, "post": { "tags": [ - "Offers" + "Response tokens" ], - "summary": "Create a new recs offer", - "description": "Creates a new Recommendations offer as defined by the request data.", - "operationId": "createOffer", - "parameters": [], + "summary": "Create response token", + "description": "Create response token.", + "operationId": "createResponseToken", "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/RecommendationOffer" + "$ref": "#/components/schemas/ResponseTokenDTO" } } }, @@ -5401,7 +5420,7 @@ "content": { "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/RecommendationOffer" + "$ref": "#/components/schemas/ResponseTokenDTO" } } } @@ -5409,25 +5428,15 @@ } } }, - "/{tenant}/target/offers/json": { - "post": { + "/{tenant}/target/properties": { + "get": { "tags": [ - "Offers" + "Properties" ], - "summary": "Create a new json offer", - "description": "Creates a new JSON offer as defined by the request data.", - "operationId": "createOffer_1", + "summary": "List properties", + "description": "Retrieve list of all properties.", + "operationId": "getProperties", "parameters": [], - "requestBody": { - "content": { - "application/vnd.adobe.target.v2+json": { - "schema": { - "$ref": "#/components/schemas/JsonOffer" - } - } - }, - "required": true - }, "responses": { "400": { "description": "Bad Request", @@ -5479,25 +5488,271 @@ } } }, - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { - "application/vnd.adobe.target.v2+json": { + "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/JsonOffer" + "$ref": "#/components/schemas/PropertyList" } } } } } - } - }, - "/{tenant}/target/offers/content": { + }, "post": { "tags": [ - "Offers" + "Properties" ], - "summary": "Create a new content offer", + "summary": "Create a property", + "description": "Create a property.", + "operationId": "createProperty", + "requestBody": { + "content": { + "application/vnd.adobe.target.v1+json": { + "schema": { + "$ref": "#/components/schemas/Property" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "407": { + "description": "Proxy Authentication Required", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "406": { + "description": "Not Acceptable", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created", + "content": { + "application/vnd.adobe.target.v1+json": { + "schema": { + "$ref": "#/components/schemas/Property" + } + } + } + } + } + } + }, + "/{tenant}/target/offers/recs": { + "post": { + "tags": [ + "Offers" + ], + "summary": "Create a new recs offer", + "description": "Creates a new Recommendations offer as defined by the request data.", + "operationId": "createOffer", + "parameters": [], + "requestBody": { + "content": { + "application/vnd.adobe.target.v1+json": { + "schema": { + "$ref": "#/components/schemas/RecommendationOffer" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "407": { + "description": "Proxy Authentication Required", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "406": { + "description": "Not Acceptable", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created", + "content": { + "application/vnd.adobe.target.v1+json": { + "schema": { + "$ref": "#/components/schemas/RecommendationOffer" + } + } + } + } + } + } + }, + "/{tenant}/target/offers/json": { + "post": { + "tags": [ + "Offers" + ], + "summary": "Create a new json offer", + "description": "Creates a new JSON offer as defined by the request data.", + "operationId": "createOffer_1", + "parameters": [], + "requestBody": { + "content": { + "application/vnd.adobe.target.v2+json": { + "schema": { + "$ref": "#/components/schemas/JsonOffer" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "407": { + "description": "Proxy Authentication Required", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "406": { + "description": "Not Acceptable", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created", + "content": { + "application/vnd.adobe.target.v2+json": { + "schema": { + "$ref": "#/components/schemas/JsonOffer" + } + } + } + } + } + } + }, + "/{tenant}/target/offers/content": { + "post": { + "tags": [ + "Offers" + ], + "summary": "Create a new content offer", "description": "Creates a new content offer as defined by the request data.", "operationId": "createOffer_2", "parameters": [], @@ -6152,20 +6407,20 @@ } } }, - "/{tenant}/target/activities/autoallocate": { + "/{tenant}/target/activities/autotarget": { "post": { "tags": [ "Activities" ], - "summary": "Create Auto-Allocate activity", - "description": "Create a new Auto-Allocate activity based on the specified contents, and return the created activity.", + "summary": "Create Auto-Target activity", + "description": "Create a new Auto-Target activity based on the specified contents, and return the created activity.", "operationId": "createActivity", "parameters": [], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/AutoAllocateActivity" + "$ref": "#/components/schemas/AutoTargetActivity" } } }, @@ -6227,7 +6482,7 @@ "content": { "application/vnd.adobe.target.v1+json": { "schema": { - "$ref": "#/components/schemas/AutoAllocateActivity" + "$ref": "#/components/schemas/AutoTargetActivity" } } } @@ -6235,12 +6490,188 @@ } } }, - "/{tenant}/target/activities/autoallocate/{id}/qamode": { + "/{tenant}/target/activities/autotarget/{id}/qamode": { "post": { "tags": [ "Activities" ], - "summary": "Create preview links for the Auto-Allocate activity", + "summary": "Create preview links for the Auto-Target activity", + "description": "Get a set of preview links for the Auto-Target activity referenced by the provided ID. The \u003cb\u003eurl\u003c/b\u003e parameter indicates the URL on which the activity will be running. The \u003cb\u003ecurrentActivityOnly\u003c/b\u003e (defaults to true) indicates whether other activities running on the same URL should be ignored. The payload of the request also allows you to specify which segment ids should be evaluated to true by including these in the \u003cb\u003eaudienceIdsEvaluatedAsTrue\u003c/b\u003e list, so that the user doesn\u0027t necessarily have to qualify for these. At the same time you can specify which segments should always evaluate to false by including these in the \u003cb\u003eaudienceIdsEvaluatedAsFalse\u003c/b\u003e list.", + "operationId": "createAutoTargetActivityQAModeResponse", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/vnd.adobe.target.v1+json": { + "schema": { + "$ref": "#/components/schemas/QAModeRequest" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "407": { + "description": "Proxy Authentication Required", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "406": { + "description": "Not Acceptable", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/vnd.adobe.target.v1+json": { + "schema": { + "$ref": "#/components/schemas/ABTQAModeResponseDTO" + } + } + } + } + } + } + }, + "/{tenant}/target/activities/autoallocate": { + "post": { + "tags": [ + "Activities" + ], + "summary": "Create Auto-Allocate activity", + "description": "Create a new Auto-Allocate activity based on the specified contents, and return the created activity.", + "operationId": "createActivity_1", + "parameters": [], + "requestBody": { + "content": { + "application/vnd.adobe.target.v1+json": { + "schema": { + "$ref": "#/components/schemas/AutoAllocateActivity" + } + } + }, + "required": true + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "407": { + "description": "Proxy Authentication Required", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "406": { + "description": "Not Acceptable", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created", + "content": { + "application/vnd.adobe.target.v1+json": { + "schema": { + "$ref": "#/components/schemas/AutoAllocateActivity" + } + } + } + } + } + } + }, + "/{tenant}/target/activities/autoallocate/{id}/qamode": { + "post": { + "tags": [ + "Activities" + ], + "summary": "Create preview links for the Auto-Allocate activity", "description": "Get a set of preview links for the Auto-Allocate activity referenced by the provided ID. The \u003cb\u003eurl\u003c/b\u003e parameter indicates the URL on which the activity will be running. The \u003cb\u003ecurrentActivityOnly\u003c/b\u003e (defaults to true) indicates whether other activities running on the same URL should be ignored. The payload of the request also allows you to specify which segment ids should be evaluated to true by including these in the \u003cb\u003eaudienceIdsEvaluatedAsTrue\u003c/b\u003e list, so that the user doesn\u0027t necessarily have to qualify for these. At the same time you can specify which segments should always evaluate to false by including these in the \u003cb\u003eaudienceIdsEvaluatedAsFalse\u003c/b\u003e list.", "operationId": "createABActivityQAModeResponse", "parameters": [ @@ -6335,7 +6766,7 @@ ], "summary": "Create AP activity", "description": "Create a new Automated Personalization activity based on the specified contents, and return the created activity.\u003cbr/\u003e\u003cb\u003eNote:\u003c/b\u003eCreating auto-target activities is currently not supported through the API.", - "operationId": "createActivity_1", + "operationId": "createActivity_2", "parameters": [], "requestBody": { "content": { @@ -6697,7 +7128,7 @@ ], "summary": "Create AB activity", "description": "Create a new AB activity based on the specified contents, and return the created activity.", - "operationId": "createActivity_2", + "operationId": "createActivity_3", "parameters": [], "requestBody": { "content": { @@ -6780,7 +7211,7 @@ ], "summary": "Create XT activity", "description": "Create a new Experience Targeting activity based on the specified contents, and return the created activity.", - "operationId": "createActivity_3", + "operationId": "createActivity_4", "parameters": [], "requestBody": { "content": { @@ -9468,61 +9899,69 @@ } } }, - "Analytics": { + "AbtMetric": { "type": "object", "properties": { - "dataCollectionHost": { + "metricLocalId": { + "type": "integer", + "format": "int32" + }, + "name": { "type": "string" }, - "reportSuites": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ReportSuites" - } - } - } - }, - "ApplicationContext": { - "type": "object", - "properties": { - "channel": { + "conversion": { + "type": "boolean" + }, + "engagement": { "type": "string", "enum": [ - "web", - "mobile" + "page_count", + "score", + "time_on_site", + "none" ] }, - "applicationVersions": { - "uniqueItems": true, + "optimizationCriteria": { + "type": "string", + "enum": [ + "conversion_rate", + "rpv", + "aov", + "none" + ] + }, + "mboxes": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/MetricMbox" } }, - "mobilePlatformVersions": { - "uniqueItems": true, + "clickTrackSelectors": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ClickTrackSelector" } }, - "deviceType": { - "type": "string", - "enum": [ - "phone", - "tablet" - ] + "analytics": { + "$ref": "#/components/schemas/Analytics" + } + } + }, + "Analytics": { + "type": "object", + "properties": { + "dataCollectionHost": { + "type": "string" }, - "screenOrientation": { - "type": "string", - "enum": [ - "landscape", - "portrait" - ] + "reportSuites": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReportSuites" + } } } }, - "AutoAllocateActivity": { + "AutoTargetActivity": { "type": "object", "properties": { "id": { @@ -9550,14 +9989,11 @@ "type": "integer", "format": "int32" }, - "autoAllocateTraffic": { - "$ref": "#/components/schemas/AutoAllocateTraffic" - }, "entryConstraint": { "$ref": "#/components/schemas/EntryConstraint" }, - "applicationContext": { - "$ref": "#/components/schemas/ApplicationContext" + "locations": { + "$ref": "#/components/schemas/Locations" }, "options": { "type": "array", @@ -9565,25 +10001,22 @@ "$ref": "#/components/schemas/Option" } }, - "locations": { - "$ref": "#/components/schemas/Locations" + "controlExperience": { + "$ref": "#/components/schemas/ControlExperienceDTO" }, - "views": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ViewReference" - } + "targetedExperience": { + "$ref": "#/components/schemas/TargetedExperiencesDTO" }, - "experiences": { + "optionGroups": { "type": "array", "items": { - "$ref": "#/components/schemas/Experience" + "$ref": "#/components/schemas/OptionGroup" } }, "metrics": { "type": "array", "items": { - "$ref": "#/components/schemas/Metric" + "$ref": "#/components/schemas/AbtMetric" } }, "reportingAudiences": { @@ -9630,19 +10063,23 @@ } } }, - "AutoAllocateTraffic": { + "AutomatedExperiencesDTO": { "type": "object", "properties": { - "enabled": { + "locationOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocationSegmentOptionsDTO" + } + }, + "excludeRepeatingOptions": { "type": "boolean" }, - "successEvaluationCriteria": { - "type": "string", - "enum": [ - "conversion_rate", - "rpv", - "engagement" - ] + "manualExclusions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocationOptionExperienceDTO" + } } } }, @@ -9669,22 +10106,23 @@ } } }, - "Conditions": { + "ControlExperienceDTO": { "type": "object", "properties": { - "maxVisitCount": { + "visitorPercentage": { "type": "integer", "format": "int32" }, - "maxImpressionCount": { - "type": "integer", - "format": "int32" + "type": { + "type": "string", + "enum": [ + "random", + "default_content", + "custom" + ] }, - "experiences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExperienceCondition" - } + "custom": { + "$ref": "#/components/schemas/ExperienceDTO" } } }, @@ -9718,167 +10156,107 @@ } } }, - "Experience": { + "ExperienceDTO": { "type": "object", "properties": { "experienceLocalId": { "type": "integer", "format": "int32" }, - "name": { - "type": "string" - }, - "audienceIds": { + "locationOptions": { "type": "array", "items": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/LocationOptionDTO" } + } + } + }, + "ExplicitExperiencesDTO": { + "type": "object", + "properties": { + "optimizeByExperience": { + "type": "boolean" }, - "visitorPercentage": { - "type": "integer", - "format": "int32" - }, - "optionLocations": { + "explicitExperiences": { "type": "array", "items": { - "$ref": "#/components/schemas/OptionLocation" + "$ref": "#/components/schemas/SegmentExperienceDTO" } } } }, - "ExperienceCondition": { + "LocationOptionDTO": { "type": "object", "properties": { - "experienceLocalId": { - "type": "integer", - "format": "int32" - }, - "maxVisitCount": { + "locationLocalId": { "type": "integer", "format": "int32" }, - "maxImpressionCount": { + "optionLocalId": { "type": "integer", "format": "int32" } } }, - "Locations": { + "LocationOptionExperienceDTO": { "type": "object", "properties": { - "mboxes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Mbox" - } - }, - "selectors": { + "locationOptions": { "type": "array", "items": { - "$ref": "#/components/schemas/Selector" + "$ref": "#/components/schemas/LocationOptionDTO" } } } }, - "Mbox": { + "LocationSegmentOptionsDTO": { "type": "object", "properties": { "locationLocalId": { "type": "integer", "format": "int32" }, - "name": { - "type": "string" - }, - "audienceIds": { + "options": { "type": "array", "items": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/SegmentOptionDTO" } } } }, - "Metric": { + "Locations": { "type": "object", "properties": { - "metricLocalId": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "conversion": { - "type": "boolean" - }, - "engagement": { - "type": "string", - "enum": [ - "page_count", - "score", - "time_on_site", - "none" - ] - }, - "action": { - "$ref": "#/components/schemas/MetricAction" - }, "mboxes": { "type": "array", "items": { - "$ref": "#/components/schemas/MetricMbox" - } - }, - "clickTrackSelectors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ClickTrackSelector" + "$ref": "#/components/schemas/Mbox" } }, - "views": { + "selectors": { "type": "array", "items": { - "$ref": "#/components/schemas/MetricView" + "$ref": "#/components/schemas/Selector" } - }, - "analytics": { - "$ref": "#/components/schemas/Analytics" } } }, - "MetricAction": { + "Mbox": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "count_once", - "count_landings", - "always_convert", - "restart_same_experience", - "restart_random_experience", - "restart_new_experience", - "exclude_to_same_experience", - "ban_from_campaign" - ] + "locationLocalId": { + "type": "integer", + "format": "int32" }, - "conditions": { - "$ref": "#/components/schemas/Conditions" + "name": { + "type": "string" }, - "onConditionsMetAction": { - "type": "string", - "enum": [ - "count_once", - "count_landings", - "always_convert", - "restart_same_experience", - "restart_random_experience", - "restart_new_experience", - "exclude_to_same_experience", - "ban_from_campaign" - ] + "audienceIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } } } }, @@ -9904,22 +10282,6 @@ } } }, - "MetricView": { - "type": "object", - "properties": { - "viewLocalId": { - "type": "integer", - "format": "int32" - }, - "audienceIds": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - } - } - }, "OfferTemplate": { "type": "object", "properties": { @@ -9957,16 +10319,22 @@ } } }, - "OptionLocation": { + "OptionGroup": { "type": "object", "properties": { - "locationLocalId": { - "type": "integer", - "format": "int32" + "name": { + "type": "string" }, - "optionLocalId": { + "optionGroupLocalId": { "type": "integer", "format": "int32" + }, + "optionLocalIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } } } }, @@ -10009,6 +10377,47 @@ } } }, + "SegmentExperienceDTO": { + "type": "object", + "properties": { + "experienceLocalId": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "locationOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocationOptionDTO" + } + }, + "segmentIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "SegmentOptionDTO": { + "type": "object", + "properties": { + "optionLocalId": { + "type": "integer", + "format": "int32" + }, + "segmentIds": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, "Selector": { "type": "object", "properties": { @@ -10028,14 +10437,24 @@ "type": "integer", "format": "int64" } + } + } + }, + "TargetedExperiencesDTO": { + "type": "object", + "properties": { + "automatic": { + "$ref": "#/components/schemas/AutomatedExperiencesDTO" }, - "selectorVersion": { - "type": "integer", - "format": "int32" + "explicit": { + "$ref": "#/components/schemas/ExplicitExperiencesDTO" }, - "viewLocalId": { - "type": "integer", - "format": "int32" + "modelProvider": { + "type": "string", + "enum": [ + "target", + "custom_dsw" + ] } } }, @@ -10050,27 +10469,47 @@ } } }, - "ViewReference": { + "ApplicationContext": { "type": "object", "properties": { - "viewLocalId": { - "type": "integer", - "format": "int32" + "channel": { + "type": "string", + "enum": [ + "web", + "mobile" + ] }, - "viewId": { - "type": "integer", - "format": "int64" + "applicationVersions": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } }, - "audienceIds": { + "mobilePlatformVersions": { + "uniqueItems": true, "type": "array", "items": { - "type": "integer", - "format": "int64" + "type": "string" } + }, + "deviceType": { + "type": "string", + "enum": [ + "phone", + "tablet" + ] + }, + "screenOrientation": { + "type": "string", + "enum": [ + "landscape", + "portrait" + ] } } }, - "ABTActivity": { + "AutoAllocateActivity": { "type": "object", "properties": { "id": { @@ -10098,11 +10537,14 @@ "type": "integer", "format": "int32" }, + "autoAllocateTraffic": { + "$ref": "#/components/schemas/AutoAllocateTraffic" + }, "entryConstraint": { "$ref": "#/components/schemas/EntryConstraint" }, - "locations": { - "$ref": "#/components/schemas/Locations" + "applicationContext": { + "$ref": "#/components/schemas/ApplicationContext" }, "options": { "type": "array", @@ -10110,22 +10552,25 @@ "$ref": "#/components/schemas/Option" } }, - "controlExperience": { - "$ref": "#/components/schemas/ControlExperienceDTO" + "locations": { + "$ref": "#/components/schemas/Locations" }, - "targetedExperience": { - "$ref": "#/components/schemas/TargetedExperiencesDTO" + "views": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ViewReference" + } }, - "optionGroups": { + "experiences": { "type": "array", "items": { - "$ref": "#/components/schemas/OptionGroup" + "$ref": "#/components/schemas/Experience" } }, "metrics": { "type": "array", "items": { - "$ref": "#/components/schemas/AbtMetric" + "$ref": "#/components/schemas/Metric" } }, "reportingAudiences": { @@ -10172,7 +10617,88 @@ } } }, - "AbtMetric": { + "AutoAllocateTraffic": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "successEvaluationCriteria": { + "type": "string", + "enum": [ + "conversion_rate", + "rpv", + "engagement" + ] + } + } + }, + "Conditions": { + "type": "object", + "properties": { + "maxVisitCount": { + "type": "integer", + "format": "int32" + }, + "maxImpressionCount": { + "type": "integer", + "format": "int32" + }, + "experiences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExperienceCondition" + } + } + } + }, + "Experience": { + "type": "object", + "properties": { + "experienceLocalId": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "audienceIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + }, + "visitorPercentage": { + "type": "integer", + "format": "int32" + }, + "optionLocations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionLocation" + } + } + } + }, + "ExperienceCondition": { + "type": "object", + "properties": { + "experienceLocalId": { + "type": "integer", + "format": "int32" + }, + "maxVisitCount": { + "type": "integer", + "format": "int32" + }, + "maxImpressionCount": { + "type": "integer", + "format": "int32" + } + } + }, + "Metric": { "type": "object", "properties": { "metricLocalId": { @@ -10187,22 +10713,16 @@ }, "engagement": { "type": "string", - "enum": [ - "page_count", - "score", - "time_on_site", - "none" - ] - }, - "optimizationCriteria": { - "type": "string", - "enum": [ - "conversion_rate", - "rpv", - "aov", + "enum": [ + "page_count", + "score", + "time_on_site", "none" ] }, + "action": { + "$ref": "#/components/schemas/MetricAction" + }, "mboxes": { "type": "array", "items": { @@ -10215,81 +10735,68 @@ "$ref": "#/components/schemas/ClickTrackSelector" } }, - "analytics": { - "$ref": "#/components/schemas/Analytics" - } - } - }, - "AutomatedExperiencesDTO": { - "type": "object", - "properties": { - "locationOptions": { + "views": { "type": "array", "items": { - "$ref": "#/components/schemas/LocationSegmentOptionsDTO" + "$ref": "#/components/schemas/MetricView" } }, - "excludeRepeatingOptions": { - "type": "boolean" - }, - "manualExclusions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LocationOptionExperienceDTO" - } + "analytics": { + "$ref": "#/components/schemas/Analytics" } } }, - "ControlExperienceDTO": { + "MetricAction": { "type": "object", "properties": { - "visitorPercentage": { - "type": "integer", - "format": "int32" - }, "type": { "type": "string", "enum": [ - "random", - "default_content", - "custom" + "count_once", + "count_landings", + "always_convert", + "restart_same_experience", + "restart_random_experience", + "restart_new_experience", + "exclude_to_same_experience", + "ban_from_campaign" ] }, - "custom": { - "$ref": "#/components/schemas/ExperienceDTO" + "conditions": { + "$ref": "#/components/schemas/Conditions" + }, + "onConditionsMetAction": { + "type": "string", + "enum": [ + "count_once", + "count_landings", + "always_convert", + "restart_same_experience", + "restart_random_experience", + "restart_new_experience", + "exclude_to_same_experience", + "ban_from_campaign" + ] } } }, - "ExperienceDTO": { + "MetricView": { "type": "object", "properties": { - "experienceLocalId": { + "viewLocalId": { "type": "integer", "format": "int32" }, - "locationOptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LocationOptionDTO" - } - } - } - }, - "ExplicitExperiencesDTO": { - "type": "object", - "properties": { - "optimizeByExperience": { - "type": "boolean" - }, - "explicitExperiences": { + "audienceIds": { "type": "array", "items": { - "$ref": "#/components/schemas/SegmentExperienceDTO" + "type": "integer", + "format": "int64" } } } }, - "LocationOptionDTO": { + "OptionLocation": { "type": "object", "properties": { "locationLocalId": { @@ -10302,107 +10809,125 @@ } } }, - "LocationOptionExperienceDTO": { - "type": "object", - "properties": { - "locationOptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LocationOptionDTO" - } - } - } - }, - "LocationSegmentOptionsDTO": { + "ViewReference": { "type": "object", "properties": { - "locationLocalId": { + "viewLocalId": { "type": "integer", "format": "int32" }, - "options": { + "viewId": { + "type": "integer", + "format": "int64" + }, + "audienceIds": { "type": "array", "items": { - "$ref": "#/components/schemas/SegmentOptionDTO" + "type": "integer", + "format": "int64" } } } }, - "OptionGroup": { + "ABTActivity": { "type": "object", "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "thirdPartyId": { + "type": "string" + }, "name": { "type": "string" }, - "optionGroupLocalId": { + "startsAt": { + "type": "string", + "format": "date-time" + }, + "endsAt": { + "type": "string", + "format": "date-time" + }, + "state": { + "$ref": "#/components/schemas/ActivityState" + }, + "priority": { "type": "integer", "format": "int32" }, - "optionLocalIds": { + "entryConstraint": { + "$ref": "#/components/schemas/EntryConstraint" + }, + "locations": { + "$ref": "#/components/schemas/Locations" + }, + "options": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/Option" } - } - } - }, - "SegmentExperienceDTO": { - "type": "object", - "properties": { - "experienceLocalId": { - "type": "integer", - "format": "int32" }, - "name": { - "type": "string" + "controlExperience": { + "$ref": "#/components/schemas/ControlExperienceDTO" }, - "locationOptions": { + "targetedExperience": { + "$ref": "#/components/schemas/TargetedExperiencesDTO" + }, + "optionGroups": { "type": "array", "items": { - "$ref": "#/components/schemas/LocationOptionDTO" + "$ref": "#/components/schemas/OptionGroup" } }, - "segmentIds": { + "metrics": { "type": "array", "items": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/AbtMetric" } - } - } - }, - "SegmentOptionDTO": { - "type": "object", - "properties": { - "optionLocalId": { - "type": "integer", - "format": "int32" }, - "segmentIds": { - "uniqueItems": true, + "reportingAudiences": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ReportingAudience" } - } - } - }, - "TargetedExperiencesDTO": { - "type": "object", - "properties": { - "automatic": { - "$ref": "#/components/schemas/AutomatedExperiencesDTO" }, - "explicit": { - "$ref": "#/components/schemas/ExplicitExperiencesDTO" - }, - "modelProvider": { + "reportingSource": { "type": "string", "enum": [ "target", - "custom_dsw" + "analytics", + "customer_journey_analytics" ] + }, + "analytics": { + "$ref": "#/components/schemas/Analytics" + }, + "workspace": { + "$ref": "#/components/schemas/workspace" + }, + "propertyIds": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "modifiedAt": { + "type": "string", + "format": "date-time" + }, + "modifiedByName": { + "type": "string" + }, + "platform": { + "$ref": "#/components/schemas/PlatformMetadata" } } }, @@ -10695,7 +11220,7 @@ } } }, - "ABQAModeExperienceDTO": { + "ABTQAModeExperienceDTO": { "type": "object", "properties": { "url": { @@ -10704,21 +11229,27 @@ "experienceLocalId": { "type": "integer", "format": "int32" + }, + "locationOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocationOptionDTO" + } } } }, - "ABQAModeResponseDTO": { + "ABTQAModeResponseDTO": { "type": "object", "properties": { "qaModeExperiences": { "type": "array", "items": { - "$ref": "#/components/schemas/ABQAModeExperienceDTO" + "$ref": "#/components/schemas/ABTQAModeExperienceDTO" } } } }, - "ABTQAModeExperienceDTO": { + "ABQAModeExperienceDTO": { "type": "object", "properties": { "url": { @@ -10727,22 +11258,16 @@ "experienceLocalId": { "type": "integer", "format": "int32" - }, - "locationOptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LocationOptionDTO" - } } } }, - "ABTQAModeResponseDTO": { + "ABQAModeResponseDTO": { "type": "object", "properties": { "qaModeExperiences": { "type": "array", "items": { - "$ref": "#/components/schemas/ABTQAModeExperienceDTO" + "$ref": "#/components/schemas/ABQAModeExperienceDTO" } } } @@ -11353,11 +11878,11 @@ "chronology": { "$ref": "#/components/schemas/Chronology" }, - "start": { + "end": { "type": "string", "format": "date-time" }, - "end": { + "start": { "type": "string", "format": "date-time" },