Adobe Target Modules
- Topics:
- Workfront Fusion
In an Adobe Workfront Fusion scenario, you can automate workflows that use Adobe Target, as well as connect it to multiple third-party applications and services. Adobe Target modules allow you to ,reate, read, update, or delete records,list all records of a given type, search records based on criteria you specify, or perform a custom API call to the Adobe Target API.
If you need instructions on creating a scenario, see the articles under Create a scenario: article index.
For information about modules, see the articles under Modules: article index.
Access requirements
You must have the following access to use the functionality in this article:
Adobe Workfront plan* | Pro or higher |
Adobe Workfront license* | Plan, Work |
Adobe Workfront Fusion license** |
Current license requirement: No Workfront Fusion license requirement. Or Legacy license requirement: Workfront Fusion for Work Automation and Integration |
Product |
Current product requirement: If you have the Select or Prime Adobe Workfront Plan, your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan. Or Legacy product requirement: Your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article. |
To find out what plan, license type, or access you have, contact your Workfront administrator.
For information on Adobe Workfront Fusion licenses, see Adobe Workfront Fusion licenses.
Prerequisites
Before you can use the Adobe Target connector, you must ensure that the following prerequisites are met:
- You must have an active Adobe Target account.
Adobe Target API information
The Adobe Target connector uses the following:
API tag | v1.7.33 |
Create a connection to Adobe Target
- Existing Service Account connections will continue to work until January 2025. You must replace your Service Account connections with Adobe Target Server-to-server connections by January 2024.
- You must be a developer for your organization to create an Adobe Target Server-to-server connection. The developer role is set in the Adobe Admin Console.
To create a connection for your Adobe Target modules:
-
In any module, click Add next to the Connection box.
-
Fill in the following fields:
Connection nameEnter a name for this connection.Connection typeSelect whether you are creating a Service Account connection or an Adobe Target Server-to-server connection.
IMPORTANT: Connections created after June 3, 2024 require an Adobe Target Server-to-server connection. Existing Service Account connections will continue to work until January 2025. You must replace your Service Account connections with Adobe Target Server-to-server connections by January 2024.
EnvironmentSelect whether you are connecting to a production or non-production environment.TypeSelect whether you are connecting to a service account or a personal account.Client IDEnter your Adobe Client ID. This can be found in the Credentials details section of the Adobe Developer Console.Client SecretEnter your Adobe Client Secret. This can be found in the Credentials details section of the Adobe Developer Console.Technical account IDEnter your Adobe Technical account ID. This can be found in the Credentials details section of the Adobe Developer Console.Organization IDEnter your Adobe Organization ID. This can be found in the Credentials details section of the Adobe Developer Console.TenantTo locate your Tenant, log in to the Adobe Experience Cloud, open Target, and click the Target card. Use the Tenant ID value as noted in the URL subdomain.
For example, if your URL when logged in to Adobe Target is
<https://mycompany.experiencecloud.adobe.com/...>
then your Tenant ID is "mycompany."Meta ScopesEnterent_marketing_sdk
Private keyEnter the private key that was generated when your credentials were created in the Adobe Developer Console.
To extract your private key or certificate:
-
Click Extract.
-
Select the type of file you are extracting.
-
Select the file that contains the private key or certificate.
-
Enter the password for the file.
-
Click Save to extract the file and return to the connection setup.
-
-
Click Continue to save the connection and return to the module.
Adobe Target modules and their fields
When you configure Adobe Target modules, Workfront Fusion displays the fields listed below. Along with these, additional Adobe Target fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.
If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another.
Actions
Create a record
This action module creates an AB or XT activity, an offer, or an audience.
Select the type of record that you want to create.
-
Property
For details on fields, see Create a property in the Adobe Target API documentation.
-
Offer Recommendation
For details on fields, see Create a new recs offer in the Adobe Target API documentation.
-
Offer JSON
Continue to Offer fields.
-
Offer Content
Continue to Offer fields.
-
Environment
For details on fields, see Create environment in the Adobe Target API documentation.
-
Audience
For details on fields, see Create audience in the Adobe Target API documentation.
-
AB Activity
For details on fields, see Create AB activity in the Adobe Target API documentation.
-
XT Activity
Continue to XT Activity fields.
-
AP Activity
For details on fields, see Create AP activity in the Adobe Target API documentation.
-
Response Token
For details on fields, see Create Response Token in the Adobe Target API documentation.
XT Activity fields
For each option that you want to add to the activity, click Add item and fill in the following fields:
-
Option local ID
Enter or map a string to be used to track the option across API requests.
-
Name
Enter or map a name for the option. The name must be no more than 250 characters.
-
Offer ID
-
Select or map the Offer associated with the option.
For each Mbox that you want to add to the activity, click Add item and fill in the following fields:
-
Audience IDs
For each audience that you want to add to the Mbox, click Add item and select the Audience ID.
-
Location local ID
Enter or map a string to be used to track the location across API requests.
-
Name
Enter or map a name for the Location. The name must be no more than 250 characters.
A list of locations on the page where the content offer is served. A location contains the following:
-
Experience local ID
Enter or map the ID of the experience
-
Name
Enter or map the name of the experience
-
Audience IDs
For each audience that you want to see the experience, click Add item and enter the Audience ID.
-
Visitor Percentage
Enter or map the percentage of visitors that is allocated to the experience
YYYY-MM-DD hh:mm:ss.z
.YYYY-MM-DD hh:mm:ss.z
.Enter or map the state of the activity.
-
Approved
-
Deactivated
-
Paused
-
Saved
-
Deleted
Enable this option to auto-allocate traffic. Auto-allocating sends more traffic to the more successful experience.
Select or map the evaluation criteria by which to judge which experience is more successful.
For each reporting audience that you want to add to the activity, click Add item and enter the following information:
-
Reporting Audience local ID
Enter or map a string to be used to track the Reporting Audience across API requests.
-
Audience ID
Enter or map the Segment to be used in reporting
-
Metric local ID
Enter or map a string to be used to track the metric across API requests.
Offer fields
Make a custom API call
This module makes a custom API call to the Adobe Target API.
Add the headers of the request in the form of a standard JSON object.
For example, {"Content-type":"application/json"}
Workfront Fusion adds authorization headers and x-api-key headers automatically.
Add the body content for the API call in the form of a standard JSON object.
Note:
When using conditional statements such as if
in your JSON, put the quotation marks outside of the conditional statement.
Delete a record
This action module deletes a single AB activity, XT activity, Offer, or Audience.
Read a record
This action module retrieves data for a single Activity, Offer, Audience, Property, or Report.
Update a record
This action module updates a record in Target.
Select the fields that you want to update. The fields appear below.
For details on fields, see the Adobe Target API documentation.
Searches
Get records
This search module retrieves a list of records of the selected type.
Enter the earliest date that you want to retrieve records for.
For a list of supported date and time formats, see Type coercion in Adobe Workfront Fusion.
Enter the latest date that you want to retrieve records for.
For a list of supported date and time formats, see Type coercion in Adobe Workfront Fusion.
Search
This search module searches for Activities, Offers, or Audiences based on criteria you specify.
Enter the number of the first response that you want the module to return. The first returned response has an offset of 0
. Use this field in combination with the Maximum number of returned results field to paginate the responses.
For example, to see the third page of responses, when each page has ten responses, set Offset to 20 and Maximum number of returned results to 10.
Enter or map the maximum number of records you want the module to return during each scenario execution cycle. Use this field in combination with the Offset field to paginate the responses.
For example, to see the third page of responses, when each page has ten responses, set Offset to 20 and Maximum number of returned results to 10.