ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

ÃÛ¶¹ÊÓƵ Target Modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

In an ÃÛ¶¹ÊÓƵ Workfront Fusion scenario, you can automate workflows that use ÃÛ¶¹ÊÓƵ Target, as well as connect it to multiple third-party applications and services. ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Target API.

If you need instructions on creating a scenario, see Create a scenario.

For information about modules, see Modules in ÃÛ¶¹ÊÓƵ Workfront Fusion.

Access requirements

You must have the following access to use the functionality in this article:

ÃÛ¶¹ÊÓƵ Workfront plan*
Pro or higher
ÃÛ¶¹ÊÓƵ Workfront license*
Plan, Work
ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront plan, your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses.

Prerequisites

Before you can use the ÃÛ¶¹ÊÓƵ Target connector, you must ensure that the following prerequisites are met:

  • You must have an active ÃÛ¶¹ÊÓƵ Target account.

ÃÛ¶¹ÊÓƵ Target API information

The ÃÛ¶¹ÊÓƵ Target connector uses the following:

API tag
v1.7.33

Create a connection to ÃÛ¶¹ÊÓƵ Target

IMPORTANT
Connections created after June 3, 2024 require an ÃÛ¶¹ÊÓƵ Target Server-to-server connection.
  • Existing Service Account connections will continue to work until January 2025. You must replace your Service Account connections with ÃÛ¶¹ÊÓƵ Target Server-to-server connections by January 2024.
  • You must be a developer for your organization to create an ÃÛ¶¹ÊÓƵ Target Server-to-server connection. The developer role is set in the ÃÛ¶¹ÊÓƵ Admin Console.

To create a connection for your ÃÛ¶¹ÊÓƵ Target modules:

  1. Click Add next to the Connection box.

  2. Fill in the following fields:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 layout-auto html-authored no-header
    Connection name Enter a name for this connection.
    Connection type

    Select whether you are creating a Service Account connection or an ÃÛ¶¹ÊÓƵ Target Server-to-server connection.

    IMPORTANT: Connections created after June 3, 2024 require an ÃÛ¶¹ÊÓƵ Target Server-to-server connection. Existing Service Account connections will continue to work until January 2025. You must replace your Service Account connections with ÃÛ¶¹ÊÓƵ Target Server-to-server connections by January 2024.
    Environment Select whether you are connecting to a production or non-production environment.
    Type Select whether you are connecting to a service account or a personal account.
    Client ID Enter your ÃÛ¶¹ÊÓƵ Client ID. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.
    Client Secret Enter your ÃÛ¶¹ÊÓƵ Client Secret. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.
    Technical account ID Enter your ÃÛ¶¹ÊÓƵ Technical account ID. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.
    Organization ID Enter your ÃÛ¶¹ÊÓƵ Organization ID. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.
    Tenant

    To locate your Tenant, log in to the ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Target is <https://mycompany.experiencecloud.adobe.com/...> then your Tenant ID is "mycompany."
    Meta Scopes Enter ent_marketing_sdk
    Private key

    Enter the private key that was generated when your credentials were created in the ÃÛ¶¹ÊÓƵ Developer Console.

    To extract your private key or certificate:

    1. Click Extract.

    2. Select the type of file you are extracting.

    3. Select the file that contains the private key or certificate.

    4. Enter the password for the file.

    5. Click Save to extract the file and return to the connection setup.

  3. Click Continue to save the connection and return to the module.

ÃÛ¶¹ÊÓƵ Target modules and their fields

When you configure ÃÛ¶¹ÊÓƵ Target modules, Workfront Fusion displays the fields listed below. Along with these, additional ÃÛ¶¹ÊÓƵ 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 in ÃÛ¶¹ÊÓƵ Workfront Fusion.

Actions

Create a record

This action module creates an AB or XT activity, an offer, or an audience.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Target, see Create a connection to ÃÛ¶¹ÊÓƵ Target in this article.
Record type

Select the type of record that you want to create.

  • Property

    For details on fields, see in the ÃÛ¶¹ÊÓƵ Target API documentation.

  • Offer Recommendation

    For details on fields, see in the ÃÛ¶¹ÊÓƵ Target API documentation.

  • Offer JSON

    Continue to Offer fields.

  • Offer Content

    Continue to Offer fields.

  • Environment

    For details on fields, see in the ÃÛ¶¹ÊÓƵ Target API documentation.

  • Audience

    For details on fields, see in the ÃÛ¶¹ÊÓƵ Target API documentation.

  • ´¡µþÌý´¡³¦³Ù¾±±¹¾±³Ù²â

    For details on fields, see in the ÃÛ¶¹ÊÓƵ Target API documentation.

  • XT Activity

    Continue to XT Activity fields.

  • ´¡±ÊÌý´¡³¦³Ù¾±±¹¾±³Ù²â

    For details on fields, see in the ÃÛ¶¹ÊÓƵ Target API documentation.

  • Response Token

    For details on fields, see in the ÃÛ¶¹ÊÓƵ Target API documentation.

XT Activity fields
Name
Enter or map a name for this activity. The name can be no more than 250 characters.
Options

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.

Locations

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.

Experiences

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

Metrics
Third Party ID
Enter or map an ID to identify this activity. You can choose this ID. This ID must not be the same as another activity, and can be no more than 250 characters.
Starts at
Enter or map the date and time to start the activity in the format YYYY-MM-DD hh:mm:ss.z.
Ends at
Enter or map the date and time to end the activity in the format YYYY-MM-DD hh:mm:ss.z.
State

Enter or map the state of the activity.

  • Approved

  • Deactivated

  • Paused

  • Saved

  • Deleted

Priority
Enter a number that defines the priority of the activity. Higher numbers have higher priority. This value must be between 0 and 999. The default value is 5.
Auto-allocate traffic

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.

Workspace
Enter or map the workspace that the activity is associated with
Property IDs
For each property that you want to add to the activity, click Add item and select or map the property's ID.
Reporting audiences

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
Name
Enter or map a name for this activity. The name can be no more than 250 characters.
Content
Enter or map the content of the Offer that will be shown to the user.
Workspace
Enter or map the ID of the workspace associated with the offer. If left blank, the offer is associated with the default workspace of the account. This functionality applies only to Target Premium accounts.
Workspace
Enter or map the date and time that this offer was modified.

Make a custom API call

This module makes a custom API call to the ÃÛ¶¹ÊÓƵ Target API.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Target, see Create a connection to ÃÛ¶¹ÊÓƵ Target in this article.
Target Base URL
Enter or map your Target base URL.
Path
Enter a path relative to {baseURL}/
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in ÃÛ¶¹ÊÓƵ Workfront Fusion.
Headers

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.

Query String
Enter the request query string.
Body

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.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Target, see Create a connection to ÃÛ¶¹ÊÓƵ Target in this article.
Record type
Select the type of record that you want to delete.
Record ID
Enter or map the ID of the record you want to delete.

Read a record

This action module retrieves data for a single Activity, Offer, Audience, Property, or Report.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Target, see Create a connection to ÃÛ¶¹ÊÓƵ Target in this article.
Record type
Select the type of record that you want to read.
Record ID
Enter or map the ID of the record you want to read.

Update a record

This action module updates a record in Target.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Target, see Create a connection to ÃÛ¶¹ÊÓƵ Target in this article.
Record type
Select the type of record that you want to update.
Field names

Select the fields that you want to update. The fields appear below.

For details on fields, see .

Searches

Get records

This search module retrieves a list of records of the selected type.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Target, see Create a connection to ÃÛ¶¹ÊÓƵ Target in this article.
Record type
Select the type of record that you want to update.
Sort by
For each field that you want to sort by, click Add item and select the field and whether the returned results should be ascending or descending.
Starts At

Enter the earliest date that you want to retrieve records for.

For a list of supported date and time formats, see Type coercion in ÃÛ¶¹ÊÓƵ Workfront Fusion.

Ends At

Enter the latest date that you want to retrieve records for.

For a list of supported date and time formats, see Type coercion in ÃÛ¶¹ÊÓƵ Workfront Fusion.

This search module searches for Activities, Offers, or Audiences based on criteria you specify.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Target, see Create a connection to ÃÛ¶¹ÊÓƵ Target in this article.
Record type
Select the type of record that you want to update.
Sort by
For each field that you want to sort by, click Add item and select the field and whether the returned results should be ascending or descending.
Search criteria
For each rule you want to set up, select the field, the operator, and the value. Click Add AND rule to create additional rules.
Offset

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.

Limit

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.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43